diff options
Diffstat (limited to 'lib/ansible/utils/module_docs_fragments/vmware_rest_client.py')
| -rw-r--r-- | lib/ansible/utils/module_docs_fragments/vmware_rest_client.py | 25 |
1 files changed, 14 insertions, 11 deletions
diff --git a/lib/ansible/utils/module_docs_fragments/vmware_rest_client.py b/lib/ansible/utils/module_docs_fragments/vmware_rest_client.py index 5d1ec27fed..7cdbefb8eb 100644 --- a/lib/ansible/utils/module_docs_fragments/vmware_rest_client.py +++ b/lib/ansible/utils/module_docs_fragments/vmware_rest_client.py @@ -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 ''' |