mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
bd1c1b257f
Start using semantic markup (#6627)
* Start using semantic markup.
* Forgot some places.
* Fix typo.
* Use 'ignore:' prefix until https://github.com/ansible-community/antsibull-docs/pull/155 is out.
* Break too long line.
(cherry picked from commit 011b2f8bdc)
Co-authored-by: Felix Fontein <felix@fontein.de>
41 lines
1.5 KiB
Python
41 lines
1.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright (c) 2018, Bojan Vitnik <bvitnik@mainstream.rs>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
# Common parameters for XenServer modules
|
|
DOCUMENTATION = r'''
|
|
options:
|
|
hostname:
|
|
description:
|
|
- The hostname or IP address of the XenServer host or XenServer pool master.
|
|
- If the value is not specified in the task, the value of environment variable C(XENSERVER_HOST) will be used instead.
|
|
type: str
|
|
default: localhost
|
|
aliases: [ host, pool ]
|
|
username:
|
|
description:
|
|
- The username to use for connecting to XenServer.
|
|
- If the value is not specified in the task, the value of environment variable C(XENSERVER_USER) will be used instead.
|
|
type: str
|
|
default: root
|
|
aliases: [ admin, user ]
|
|
password:
|
|
description:
|
|
- The password to use for connecting to XenServer.
|
|
- If the value is not specified in the task, the value of environment variable C(XENSERVER_PASSWORD) will be used instead.
|
|
type: str
|
|
aliases: [ pass, pwd ]
|
|
validate_certs:
|
|
description:
|
|
- Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
|
|
- If the value is not specified in the task, the value of environment variable C(XENSERVER_VALIDATE_CERTS) will be used instead.
|
|
type: bool
|
|
default: true
|
|
'''
|