From 5613bb311fa1cbef9d67dd5debfcce1fc309fb3d Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Mon, 21 Jan 2019 22:04:22 +0530 Subject: [PATCH] Merge pull request #51118 from Akasurde/backport/2.6/51047 [backport/2.6] Update vmware.py minor typo --- .../vmware_guest-documentation_fix.yaml | 3 +++ .../utils/module_docs_fragments/vmware.py | 26 +++++++++---------- 2 files changed, 16 insertions(+), 13 deletions(-) create mode 100644 changelogs/fragments/vmware_guest-documentation_fix.yaml diff --git a/changelogs/fragments/vmware_guest-documentation_fix.yaml b/changelogs/fragments/vmware_guest-documentation_fix.yaml new file mode 100644 index 00000000000..f9c70d4376c --- /dev/null +++ b/changelogs/fragments/vmware_guest-documentation_fix.yaml @@ -0,0 +1,3 @@ +--- +minor_changes: +- Fixed typo in vmware documentation fragment. Changed "supported added" to "support added". diff --git a/lib/ansible/utils/module_docs_fragments/vmware.py b/lib/ansible/utils/module_docs_fragments/vmware.py index 23a302d7996..5cd89cf1972 100644 --- a/lib/ansible/utils/module_docs_fragments/vmware.py +++ b/lib/ansible/utils/module_docs_fragments/vmware.py @@ -11,36 +11,36 @@ options: 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 supported added in version 2.6. - required: False + - Environment variable support added in version 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 supported added in version 2.6. - required: False - aliases: ['user', 'admin'] + - Environment variable support added in version 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 supported added in version 2.6. - required: False - aliases: ['pass', 'pwd'] + - Environment variable support added in version 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 version 2.6. - - If set to C(True), please make sure Python >= 2.7.9 is installed on the given machine. - default: 'True' + - Environment variable support added in version 2.6. + - If set to C(yes), please make sure Python >= 2.7.9 is installed on the given machine. + default: 'yes' type: bool 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 supported added in version 2.6. - required: False + - Environment variable support added in version 2.6. + type: int default: 443 version_added: 2.5 '''