mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -07:00
e775434a52
- More info added to module docs. - Fixed errors and typos in module docs. - Added parameter types to module docs. - Some error messages are fixed and/or changed to be more helpful. - Some code comments changed and added. - Updated unit tests that test changed error messages. - Improved module examples. - Improved docs for custom_params xenserver_guest module parameter
37 lines
1.4 KiB
Python
37 lines
1.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2018, Bojan Vitnik <bvitnik@mainstream.rs>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
|
|
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 C(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: yes
|
|
'''
|