mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-27 04:41:26 -07:00
Add types to vmware REST client/VCA doc fragments (#50001)
This commit is contained in:
parent
653c3da500
commit
3bcc0c0498
2 changed files with 39 additions and 37 deletions
|
@ -1,3 +1,5 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright: (c) 2018, Ansible Project
|
||||
# Copyright: (c) 2018, Abhijeet Kasurde <akasurde@redhat.com>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
@ -5,35 +7,36 @@
|
|||
|
||||
class ModuleDocFragment(object):
|
||||
# Parameters for VMware REST Client based modules
|
||||
DOCUMENTATION = '''
|
||||
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.
|
||||
required: False
|
||||
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.
|
||||
aliases: ['user', 'admin']
|
||||
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.
|
||||
required: False
|
||||
aliases: ['pass', 'pwd']
|
||||
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.
|
||||
- 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.
|
||||
default: True
|
||||
type: bool
|
||||
required: False
|
||||
default: true
|
||||
protocol:
|
||||
description:
|
||||
- The connection to protocol.
|
||||
choices: ['https', 'http']
|
||||
default: 'https'
|
||||
required: False
|
||||
type: str
|
||||
choices: [ https, http ]
|
||||
default: https
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue