mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 20:01:25 -07:00
25323155d2
* module_utils: Clean up parameter types (cloud) This PR includes: - Parameter types added - Copyright format fixes - Short license statement - Description fixes (only for a few files, then I stopped :-)) * More cloud stuff * Fix reported issue * Fix quotes * Use correct type * Fix quotes * Fix quotes * Fix quotes * Fix typo * Fix boolean
90 lines
3.9 KiB
Python
90 lines
3.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2016, Charles Paul <cpaul@ansible.com>
|
|
# Copyright: (c) 2018, Ansible Project
|
|
# Copyright: (c) 2019, Abhijeet Kasurde <akasurde@redhat.com>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
# Parameters for VMware modules
|
|
DOCUMENTATION = r'''
|
|
options:
|
|
hostname:
|
|
description:
|
|
- The hostname or IP address of the vSphere vCenter or ESXi server.
|
|
- If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead.
|
|
- Environment variable support added in Ansible 2.6.
|
|
type: str
|
|
username:
|
|
description:
|
|
- The username of the vSphere vCenter or ESXi server.
|
|
- If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead.
|
|
- Environment variable support added in Ansible 2.6.
|
|
type: str
|
|
aliases: [ admin, user ]
|
|
password:
|
|
description:
|
|
- The password of the vSphere vCenter or ESXi server.
|
|
- If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead.
|
|
- Environment variable support added in Ansible 2.6.
|
|
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(VMWARE_VALIDATE_CERTS) will be used instead.
|
|
- Environment variable support added in Ansible 2.6.
|
|
- If set to C(yes), please make sure Python >= 2.7.9 is installed on the given machine.
|
|
type: bool
|
|
default: yes
|
|
port:
|
|
description:
|
|
- The port number of the vSphere vCenter or ESXi server.
|
|
- If the value is not specified in the task, the value of environment variable C(VMWARE_PORT) will be used instead.
|
|
- Environment variable support added in Ansible 2.6.
|
|
type: int
|
|
default: 443
|
|
version_added: '2.5'
|
|
'''
|
|
|
|
# This doc fragment is specific to vcenter modules like vcenter_license
|
|
VCENTER_DOCUMENTATION = r'''
|
|
options:
|
|
hostname:
|
|
description:
|
|
- The hostname or IP address of the vSphere vCenter server.
|
|
- If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead.
|
|
- Environment variable supported added in Ansible 2.6.
|
|
type: str
|
|
username:
|
|
description:
|
|
- The username of the vSphere vCenter server.
|
|
- If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead.
|
|
- Environment variable supported added in Ansible 2.6.
|
|
type: str
|
|
aliases: [ admin, user ]
|
|
password:
|
|
description:
|
|
- The password of the vSphere vCenter server.
|
|
- If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead.
|
|
- Environment variable supported added in Ansible 2.6.
|
|
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(VMWARE_VALIDATE_CERTS) will be used instead.
|
|
- Environment variable supported added in Ansible 2.6.
|
|
- If set to C(yes), please make sure Python >= 2.7.9 is installed on the given machine.
|
|
type: bool
|
|
default: yes
|
|
port:
|
|
description:
|
|
- The port number of the vSphere vCenter server.
|
|
- If the value is not specified in the task, the value of environment variable C(VMWARE_PORT) will be used instead.
|
|
- Environment variable supported added in Ansible 2.6.
|
|
type: int
|
|
default: 443
|
|
version_added: '2.5'
|
|
'''
|