Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue 1660 part 4 #1668

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ Examples
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
service_name: ntpd
service_policy: on
service_policy: 'on'
state: present
delegate_to: localhost

Expand Down
18 changes: 9 additions & 9 deletions plugins/connection/vmware_tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
vars:
- name: ansible_host
- name: ansible_vmware_host
required: True
required: true
vmware_user:
description:
- Username for the connection.
Expand All @@ -40,7 +40,7 @@
- name: VMWARE_USER
vars:
- name: ansible_vmware_user
required: True
required: true
vmware_password:
description:
- Password for the connection.
Expand All @@ -49,7 +49,7 @@
- name: VMWARE_PASSWORD
vars:
- name: ansible_vmware_password
required: True
required: true
vmware_port:
description:
- Port for the connection.
Expand All @@ -59,7 +59,7 @@
vars:
- name: ansible_port
- name: ansible_vmware_port
required: False
required: false
default: 443
validate_certs:
description:
Expand All @@ -69,7 +69,7 @@
- name: VMWARE_VALIDATE_CERTS
vars:
- name: ansible_vmware_validate_certs
default: True
default: true
type: bool
vm_path:
description:
Expand All @@ -83,15 +83,15 @@
- Folder I(vm) is not visible in the vSphere Web Client but necessary for VMware API to work.
vars:
- name: ansible_vmware_guest_path
required: False
required: false
vm_uuid:
description:
- Mutually exclusive with vm_path
- VM UUID to the connection.
- UUID of the virtual machine from property config.uuid of vmware_vm_inventory plugin
vars:
- name: ansible_vmware_guest_uuid
required: False
required: false
vm_user:
description:
- VM username.
Expand All @@ -100,14 +100,14 @@
vars:
- name: ansible_user
- name: ansible_vmware_tools_user
required: True
required: true
vm_password:
description:
- Password for the user in guest operating system.
vars:
- name: ansible_password
- name: ansible_vmware_tools_password
required: True
required: true
exec_command_sleep_interval:
description:
- Time in seconds to sleep between execution of command.
Expand Down
8 changes: 4 additions & 4 deletions plugins/doc_fragments/vmware.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@ class ModuleDocFragment(object):
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_HOST) will be used instead.
- This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
type: str
required: False
required: false
proxy_port:
description:
- Port of the HTTP proxy that will receive all HTTPS requests and relay them.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_PORT) will be used instead.
type: int
required: False
required: false
'''

# This doc fragment is specific to vcenter modules like vcenter_license
Expand Down Expand Up @@ -113,11 +113,11 @@ class ModuleDocFragment(object):
- The format is a hostname or a IP.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_HOST) will be used instead.
type: str
required: False
required: false
proxy_port:
description:
- Port of the HTTP proxy that will receive all HTTPS requests and relay them.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_PORT) will be used instead.
type: int
required: False
required: false
'''
4 changes: 2 additions & 2 deletions plugins/doc_fragments/vmware_rest_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ class ModuleDocFragment(object):
- The format is a hostname or a IP.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_HOST) will be used instead.
type: str
required: False
required: false
proxy_port:
description:
- Port of the HTTP proxy that will receive all HTTPS requests and relay them.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_PORT) will be used instead.
type: int
required: False
required: false
'''
22 changes: 11 additions & 11 deletions plugins/inventory/vmware_host_inventory.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,23 @@
options:
hostname:
description: Name of vCenter or ESXi server.
required: True
required: true
env:
- name: VMWARE_HOST
- name: VMWARE_SERVER
username:
description:
- Name of vSphere user.
- Accepts vault encrypted variable.
required: True
required: true
env:
- name: VMWARE_USER
- name: VMWARE_USERNAME
password:
description:
- Password of vSphere user.
- Accepts vault encrypted variable.
required: True
required: true
env:
- name: VMWARE_PASSWORD
port:
Expand All @@ -53,7 +53,7 @@
description:
- Allows connection when SSL certificates are not valid.
- Set to C(false) when certificates are not trusted.
default: True
default: true
type: bool
env:
- name: VMWARE_VALIDATE_CERTS
Expand All @@ -63,7 +63,7 @@
- Requires 'vSphere Automation SDK' library to be installed on the given controller machine.
- Please refer following URLs for installation steps
- U(https://code.vmware.com/web/sdk/7.0/vsphere-automation-python)
default: False
default: false
type: bool
hostnames:
description:
Expand Down Expand Up @@ -91,7 +91,7 @@
description:
- This option transform flatten properties name to nested dictionary.
type: bool
default: True
default: true
keyed_groups:
description:
- Add hosts to group based on the values of a variable.
Expand All @@ -111,36 +111,36 @@
- A list of resources to limit search scope.
- Each resource item is represented by exactly one C('vim_type_snake_case):C(list of resource names) pair and optional nested I(resources)
- Key name is based on snake case of a vim type name; e.g C(host_system) correspond to C(vim.HostSystem)
required: False
required: false
type: list
elements: dict
default: []
with_path:
description:
- Include ESXi hostsystem's path.
- Set this option to a string value to replace root name from I('Datacenters').
default: False
default: false
type: bool
with_sanitized_property_name:
description:
- This option allows property name sanitization to create safe property names for use in Ansible.
- Also, transforms property name to snake case.
type: bool
default: False
default: false
proxy_host:
description:
- Address of a proxy that will receive all HTTPS requests and relay them.
- The format is a hostname or a IP.
- This feature depends on a version of pyvmomi>=v6.7.1.2018.12.
type: str
required: False
required: false
env:
- name: VMWARE_PROXY_HOST
proxy_port:
description:
- Port of the HTTP proxy that will receive all HTTPS requests and relay them.
type: int
required: False
required: false
env:
- name: VMWARE_PROXY_PORT
"""
Expand Down
22 changes: 11 additions & 11 deletions plugins/inventory/vmware_vm_inventory.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,23 @@
options:
hostname:
description: Name of vCenter or ESXi server.
required: True
required: true
env:
- name: VMWARE_HOST
- name: VMWARE_SERVER
username:
description:
- Name of vSphere user.
- Accepts vault encrypted variable.
required: True
required: true
env:
- name: VMWARE_USER
- name: VMWARE_USERNAME
password:
description:
- Password of vSphere user.
- Accepts vault encrypted variable.
required: True
required: true
env:
- name: VMWARE_PASSWORD
port:
Expand All @@ -53,7 +53,7 @@
description:
- Allows connection when SSL certificates are not valid.
- Set to C(false) when certificates are not trusted.
default: True
default: true
type: bool
env:
- name: VMWARE_VALIDATE_CERTS
Expand All @@ -63,7 +63,7 @@
- Requires 'vSphere Automation SDK' library to be installed on the given controller machine.
- Please refer following URLs for installation steps
- U(https://code.vmware.com/web/sdk/7.0/vsphere-automation-python)
default: False
default: false
type: bool
hostnames:
description:
Expand Down Expand Up @@ -100,7 +100,7 @@
- This option transform flatten properties name to nested dictionary.
- From 1.10.0 and onwards, default value is set to C(True).
type: bool
default: True
default: true
keyed_groups:
description:
- Add hosts to group based on the values of a variable.
Expand All @@ -122,36 +122,36 @@
- Each resource item is represented by exactly one C('vim_type_snake_case):C(list of resource names) pair and optional nested I(resources)
- Key name is based on snake case of a vim type name; e.g C(host_system) correspond to C(vim.HostSystem)
- See L(VIM Types,https://pubs.vmware.com/vi-sdk/visdk250/ReferenceGuide/index-mo_types.html)
required: False
required: false
type: list
elements: dict
default: []
with_path:
description:
- Include virtual machines path.
- Set this option to a string value to replace root name from I('Datacenters').
default: False
default: false
type: bool
with_sanitized_property_name:
description:
- This option allows property name sanitization to create safe property names for use in Ansible.
- Also, transforms property name to snake case.
type: bool
default: False
default: false
proxy_host:
description:
- Address of a proxy that will receive all HTTPS requests and relay them.
- The format is a hostname or a IP.
- This feature depends on a version of pyvmomi>=v6.7.1.2018.12.
type: str
required: False
required: false
env:
- name: VMWARE_PROXY_HOST
proxy_port:
description:
- Port of the HTTP proxy that will receive all HTTPS requests and relay them.
type: int
required: False
required: false
env:
- name: VMWARE_PROXY_PORT
'''
Expand Down
8 changes: 4 additions & 4 deletions plugins/modules/vcenter_domain_user_group_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
- The I(search_string) is a string to be specified searching.
- Specify the domain user or group name to be searched.
type: str
required: True
required: true
belongs_to_group:
description:
- If a group existing, returned contains only users or groups that directly belong to the specified group.
Expand All @@ -39,17 +39,17 @@
description:
- If I(exact_match) is C(True), it indicates the I(search_string) passed should match a user or group name exactly.
type: bool
default: False
default: false
find_users:
description:
- If I(find_users) is C(True), domain users will be included in the result.
type: bool
default: True
default: true
find_groups:
description:
- If I(find_groups) is C(True), domain groups will be included in the result.
type: bool
default: True
default: true
extends_documentation_fragment:
- community.vmware.vmware.documentation
'''
Expand Down
6 changes: 3 additions & 3 deletions plugins/modules/vcenter_extension.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@
extension_key:
description:
- The extension key of the extension to install or uninstall.
required: True
required: true
type: str
version:
description:
- The version of the extension you are installing or uninstalling.
required: True
required: true
type: str
name:
description:
Expand Down Expand Up @@ -65,7 +65,7 @@
visible:
description:
- Show the extension in solution manager inside vCenter.
default: True
default: true
type: bool
state:
description:
Expand Down
Loading