From fe63d19156ddd04470d2d7f03321e1bc5cfa2089 Mon Sep 17 00:00:00 2001 From: Mario Lenz Date: Wed, 25 Oct 2023 14:34:53 +0200 Subject: [PATCH 1/2] Implement semantic markup (7) --- plugins/modules/vmware_host_ntp_info.py | 4 ++-- plugins/modules/vmware_host_package_info.py | 4 ++-- plugins/modules/vmware_host_passthrough.py | 10 ++++------ plugins/modules/vmware_host_powermgmt_policy.py | 4 ++-- plugins/modules/vmware_host_powerstate.py | 16 ++++++++-------- plugins/modules/vmware_host_scsidisk_info.py | 4 ++-- plugins/modules/vmware_host_service_info.py | 4 ++-- plugins/modules/vmware_host_service_manager.py | 16 ++++++++-------- plugins/modules/vmware_host_snmp.py | 8 ++++---- plugins/modules/vmware_host_sriov.py | 8 ++++---- plugins/modules/vmware_host_ssl_info.py | 4 ++-- plugins/modules/vmware_host_user_manager.py | 6 +++--- plugins/modules/vmware_host_vmhba_info.py | 8 ++++---- plugins/modules/vmware_host_vmnic_info.py | 13 ++++--------- plugins/modules/vmware_local_role_manager.py | 10 +++++----- plugins/modules/vmware_local_user_manager.py | 2 +- plugins/modules/vmware_maintenancemode.py | 2 +- .../vmware_object_custom_attributes_info.py | 2 +- plugins/modules/vmware_object_rename.py | 4 ++-- plugins/modules/vmware_object_role_permission.py | 8 ++++---- .../vmware_object_role_permission_info.py | 4 ++-- plugins/modules/vmware_portgroup.py | 8 ++++---- plugins/modules/vmware_portgroup_info.py | 4 ++-- plugins/modules/vmware_resource_pool.py | 16 ++++++++-------- 24 files changed, 81 insertions(+), 88 deletions(-) diff --git a/plugins/modules/vmware_host_ntp_info.py b/plugins/modules/vmware_host_ntp_info.py index 1515328a8..0bc976d54 100644 --- a/plugins/modules/vmware_host_ntp_info.py +++ b/plugins/modules/vmware_host_ntp_info.py @@ -22,13 +22,13 @@ description: - Name of the cluster. - NTP config information about each ESXi server will be returned for the given cluster. - - If C(esxi_hostname) is not given, this parameter is required. + - If O(esxi_hostname) is not given, this parameter is required. type: str esxi_hostname: description: - ESXi hostname. - NTP config information about this ESXi server will be returned. - - If C(cluster_name) is not given, this parameter is required. + - If O(cluster_name) is not given, this parameter is required. type: str extends_documentation_fragment: - community.vmware.vmware.documentation diff --git a/plugins/modules/vmware_host_package_info.py b/plugins/modules/vmware_host_package_info.py index 9e53f69da..fd0a27cd8 100644 --- a/plugins/modules/vmware_host_package_info.py +++ b/plugins/modules/vmware_host_package_info.py @@ -22,13 +22,13 @@ description: - Name of the cluster. - Package information about each ESXi server will be returned for given cluster. - - If C(esxi_hostname) is not given, this parameter is required. + - If O(esxi_hostname) is not given, this parameter is required. type: str esxi_hostname: description: - ESXi hostname. - Package information about this ESXi server will be returned. - - If C(cluster_name) is not given, this parameter is required. + - If O(cluster_name) is not given, this parameter is required. type: str extends_documentation_fragment: - community.vmware.vmware.documentation diff --git a/plugins/modules/vmware_host_passthrough.py b/plugins/modules/vmware_host_passthrough.py index 9693a9d01..3b8b36633 100644 --- a/plugins/modules/vmware_host_passthrough.py +++ b/plugins/modules/vmware_host_passthrough.py @@ -16,20 +16,18 @@ - sky-joker (@sky-joker) description: - This module can be managed PCI device passthrough settings on host. -notes: - - Supports C(check_mode). options: cluster: description: - Name of the cluster from which all host systems will be used. - - This parameter is required if C(esxi_hostname) is not specified. + - This parameter is required if O(esxi_hostname) is not specified. aliases: - cluster_name type: str esxi_hostname: description: - Name of the host system to work with. - - This parameter is required if C(cluster_name) is not specified. + - This parameter is required if O(cluster_name) is not specified. - User can specify specific host from the cluster. type: str devices: @@ -48,8 +46,8 @@ type: list state: description: - - If I(state=present), passthrough of PCI device will be enabled. - - If I(state=absent), passthrough of PCI device will be disabled. + - If V(state=present), passthrough of PCI device will be enabled. + - If V(state=absent), passthrough of PCI device will be disabled. choices: - present - absent diff --git a/plugins/modules/vmware_host_powermgmt_policy.py b/plugins/modules/vmware_host_powermgmt_policy.py index 6573e591c..4bce43970 100644 --- a/plugins/modules/vmware_host_powermgmt_policy.py +++ b/plugins/modules/vmware_host_powermgmt_policy.py @@ -27,12 +27,12 @@ esxi_hostname: description: - Name of the host system to work with. - - This is required parameter if C(cluster_name) is not specified. + - This is required parameter if O(cluster_name) is not specified. type: str cluster_name: description: - Name of the cluster from which all host systems will be used. - - This is required parameter if C(esxi_hostname) is not specified. + - This is required parameter if O(esxi_hostname) is not specified. type: str extends_documentation_fragment: - community.vmware.vmware.documentation diff --git a/plugins/modules/vmware_host_powerstate.py b/plugins/modules/vmware_host_powerstate.py index a68cac141..fad0af4bb 100644 --- a/plugins/modules/vmware_host_powerstate.py +++ b/plugins/modules/vmware_host_powerstate.py @@ -30,27 +30,27 @@ esxi_hostname: description: - Name of the host system to work with. - - This is required parameter if C(cluster_name) is not specified. + - This is required parameter if O(cluster_name) is not specified. type: str cluster_name: description: - Name of the cluster from which all host systems will be used. - - This is required parameter if C(esxi_hostname) is not specified. + - This is required parameter if O(esxi_hostname) is not specified. type: str force: description: - 'This parameter specify if the host should be proceeding with user defined powerstate regardless of whether it is in maintenance mode.' - - 'If C(state) set to C(reboot-host) and C(force) as C(true), then host system is rebooted regardless of whether it is in maintenance mode.' - - 'If C(state) set to C(shutdown-host) and C(force) as C(true), then host system is shutdown regardless of whether it is in maintenance mode.' - - 'If C(state) set to C(power-down-to-standby) and C(force) to C(true), then all powered off VMs will evacuated.' - - 'Not applicable if C(state) set to C(power-up-from-standby).' + - 'If O(state=reboot-host) and O(force=true), then host system is rebooted regardless of whether it is in maintenance mode.' + - 'If O(state=shutdown-host) and O(force=true), then host system is shutdown regardless of whether it is in maintenance mode.' + - 'If O(state=power-down-to-standby) and O(force=true), then all powered off VMs will evacuated.' + - 'Not applicable if O(state=power-up-from-standby).' type: bool default: false timeout: description: - - 'This parameter defines timeout for C(state) set to C(power-down-to-standby) or C(power-up-from-standby).' - - 'Ignored if C(state) set to C(reboot-host) or C(shutdown-host).' + - 'This parameter defines timeout for O(state=power-down-to-standby) or O(state=power-up-from-standby).' + - 'Ignored if O(state=reboot-host) or O(state=shutdown-host).' - 'This parameter is defined in seconds.' default: 600 type: int diff --git a/plugins/modules/vmware_host_scsidisk_info.py b/plugins/modules/vmware_host_scsidisk_info.py index 00cfb027a..7619edebe 100644 --- a/plugins/modules/vmware_host_scsidisk_info.py +++ b/plugins/modules/vmware_host_scsidisk_info.py @@ -23,13 +23,13 @@ description: - Name of the host system to work with. - SCSI disk information about this ESXi server will be returned. - - This parameter is required if I(cluster_name) is not specified. + - This parameter is required if O(cluster_name) is not specified. type: str cluster_name: description: - Name of the cluster from which all host systems will be used. - SCSI disk information about each ESXi server will be returned for the given cluster. - - This parameter is required if I(esxi_hostname) is not specified. + - This parameter is required if O(esxi_hostname) is not specified. type: str extends_documentation_fragment: - community.vmware.vmware.documentation diff --git a/plugins/modules/vmware_host_service_info.py b/plugins/modules/vmware_host_service_info.py index fe3b83573..21e45ca74 100644 --- a/plugins/modules/vmware_host_service_info.py +++ b/plugins/modules/vmware_host_service_info.py @@ -24,13 +24,13 @@ description: - Name of the cluster. - Service information about each ESXi server will be returned for given cluster. - - If C(esxi_hostname) is not given, this parameter is required. + - If O(esxi_hostname) is not given, this parameter is required. type: str esxi_hostname: description: - ESXi hostname. - Service information about this ESXi server will be returned. - - If C(cluster_name) is not given, this parameter is required. + - If O(cluster_name) is not given, this parameter is required. type: str extends_documentation_fragment: - community.vmware.vmware.documentation diff --git a/plugins/modules/vmware_host_service_manager.py b/plugins/modules/vmware_host_service_manager.py index 543ffcf31..f63a80435 100644 --- a/plugins/modules/vmware_host_service_manager.py +++ b/plugins/modules/vmware_host_service_manager.py @@ -24,29 +24,29 @@ description: - Name of the cluster. - Service settings are applied to every ESXi host system/s in given cluster. - - If C(esxi_hostname) is not given, this parameter is required. + - If O(esxi_hostname) is not given, this parameter is required. type: str esxi_hostname: description: - ESXi hostname. - Service settings are applied to this ESXi host system. - - If C(cluster_name) is not given, this parameter is required. + - If O(cluster_name) is not given, this parameter is required. type: str state: description: - Desired state of service. - - "State value 'start' and 'present' has same effect." - - "State value 'stop' and 'absent' has same effect." - - State value C(unchanged) is added in version 1.14.0 to allow defining startup policy without defining or changing service state. + - V(start) and V(present) has same effect. + - V(stop) and V(absent) has same effect. + - V(unchanged) allows defining O(service_policy) without defining or changing service state. choices: [ absent, present, restart, start, stop, unchanged ] type: str default: 'start' service_policy: description: - Set of valid service policy strings. - - If set C(on), then service should be started when the host starts up. - - If set C(automatic), then service should run if and only if it has open firewall ports. - - If set C(off), then Service should not be started when the host starts up. + - If set V(on), then service should be started when the host starts up. + - If set V(automatic), then service should run if and only if it has open firewall ports. + - If set V(off), then Service should not be started when the host starts up. choices: [ 'automatic', 'off', 'on' ] type: str service_name: diff --git a/plugins/modules/vmware_host_snmp.py b/plugins/modules/vmware_host_snmp.py index f8713b963..095bd9a63 100644 --- a/plugins/modules/vmware_host_snmp.py +++ b/plugins/modules/vmware_host_snmp.py @@ -26,13 +26,13 @@ description: - Name of cluster. - All host system from given cluster used to manage SNMP agent. - - Required parameter, if C(esxi_hostname) is not set. + - Required parameter, if O(esxi_hostname) is not set. type: str version_added: '3.11.0' esxi_hostname: description: - List of ESXi hostname to manage SNMP agent. - - Required parameter, if C(cluster_name) is not set. + - Required parameter, if O(cluster_name) is not set. type: list elements: str version_added: '3.11.0' @@ -64,7 +64,7 @@ description: - A list of trap oids for traps not to be sent by agent, e.g. [ 1.3.6.1.4.1.6876.4.1.1.0, 1.3.6.1.4.1.6876.4.1.1.1 ] - - Use value C(reset) to clear settings. + - Use value V(reset) to clear settings. type: list elements: str send_trap: @@ -75,7 +75,7 @@ hw_source: description: - Source hardware events from IPMI sensors or CIM Indications. - - The embedded SNMP agent receives hardware events either from IPMI sensors C(sensors) or CIM indications C(indications). + - The embedded SNMP agent receives hardware events either from IPMI sensors V(sensors) or CIM indications V(indications). type: str choices: [ indications, sensors ] default: indications diff --git a/plugins/modules/vmware_host_sriov.py b/plugins/modules/vmware_host_sriov.py index 5277dc6ba..69e391f13 100644 --- a/plugins/modules/vmware_host_sriov.py +++ b/plugins/modules/vmware_host_sriov.py @@ -24,13 +24,13 @@ esxi_hostname: description: - Name of the host system to work with. - - This parameter is required if C(cluster_name) is not specified. + - This parameter is required if O(cluster_name) is not specified. - User can specify specific host from the cluster. type: str cluster_name: description: - Name of the cluster from which all host systems will be used. - - This parameter is required if C(esxi_hostname) is not specified. + - This parameter is required if O(esxi_hostname) is not specified. type: str vmnic: description: @@ -46,8 +46,8 @@ required: true sriov_on: description: - - optional parameter, related to C(num_virt_func). - - SR-IOV can be enabled only if C(num_virt_func) > 0. + - optional parameter, related to O(num_virt_func). + - SR-IOV can be enabled only if O(num_virt_func) > 0. type: bool required: false extends_documentation_fragment: diff --git a/plugins/modules/vmware_host_ssl_info.py b/plugins/modules/vmware_host_ssl_info.py index 9530e96dd..de3162d4b 100644 --- a/plugins/modules/vmware_host_ssl_info.py +++ b/plugins/modules/vmware_host_ssl_info.py @@ -22,13 +22,13 @@ description: - Name of the cluster. - SSL thumbprint information about all ESXi host system in the given cluster will be reported. - - If C(esxi_hostname) is not given, this parameter is required. + - If O(esxi_hostname) is not given, this parameter is required. type: str esxi_hostname: description: - ESXi hostname. - SSL thumbprint information of this ESXi host system will be reported. - - If C(cluster_name) is not given, this parameter is required. + - If O(cluster_name) is not given, this parameter is required. type: str extends_documentation_fragment: - community.vmware.vmware.documentation diff --git a/plugins/modules/vmware_host_user_manager.py b/plugins/modules/vmware_host_user_manager.py index 7a81f5f0a..33a7949c4 100644 --- a/plugins/modules/vmware_host_user_manager.py +++ b/plugins/modules/vmware_host_user_manager.py @@ -32,7 +32,7 @@ user_password: description: - The local user password. - - If you'd like to update the password, require the I(override_user_password) is true. + - If you'd like to update the password, requires O(override_user_password=true). aliases: - local_user_password type: str @@ -49,8 +49,8 @@ type: bool state: description: - - If set to C(present), add a new local user or update information. - - If set to C(absent), delete the local user. + - If set to V(present), add a new local user or update information. + - If set to V(absent), delete the local user. default: present type: str choices: diff --git a/plugins/modules/vmware_host_vmhba_info.py b/plugins/modules/vmware_host_vmhba_info.py index 5d625b774..178d806a8 100644 --- a/plugins/modules/vmware_host_vmhba_info.py +++ b/plugins/modules/vmware_host_vmhba_info.py @@ -15,8 +15,8 @@ short_description: Gathers info about vmhbas available on the given ESXi host description: - This module can be used to gather information about vmhbas available on the given ESXi host. -- If C(cluster_name) is provided, then vmhba information about all hosts from given cluster will be returned. -- If C(esxi_hostname) is provided, then vmhba information about given host system will be returned. +- If O(cluster_name) is provided, then vmhba information about all hosts from given cluster will be returned. +- If O(esxi_hostname) is provided, then vmhba information about given host system will be returned. author: - Christian Kotte (@ckotte) options: @@ -24,13 +24,13 @@ description: - Name of the host system to work with. - Vmhba information about this ESXi server will be returned. - - This parameter is required if C(cluster_name) is not specified. + - This parameter is required if O(cluster_name) is not specified. type: str cluster_name: description: - Name of the cluster from which all host systems will be used. - Vmhba information about each ESXi server will be returned for the given cluster. - - This parameter is required if C(esxi_hostname) is not specified. + - This parameter is required if O(esxi_hostname) is not specified. type: str extends_documentation_fragment: - community.vmware.vmware.documentation diff --git a/plugins/modules/vmware_host_vmnic_info.py b/plugins/modules/vmware_host_vmnic_info.py index 02a5ac827..af6bfc6f9 100644 --- a/plugins/modules/vmware_host_vmnic_info.py +++ b/plugins/modules/vmware_host_vmnic_info.py @@ -16,10 +16,8 @@ short_description: Gathers info about vmnics available on the given ESXi host description: - This module can be used to gather information about vmnics available on the given ESXi host. -- If C(cluster_name) is provided, then vmnic information about all hosts from given cluster will be returned. -- If C(esxi_hostname) is provided, then vmnic information about given host system will be returned. -- Additional details about vswitch and dvswitch with respective vmnic is also provided which is added in 2.7 version. -- Additional details about lldp added in 1.11.0 +- If O(cluster_name) is provided, then vmnic information about all hosts from given cluster will be returned. +- If O(esxi_hostname) is provided, then vmnic information about given host system will be returned. author: - Abhijeet Kasurde (@Akasurde) - Christian Kotte (@ckotte) @@ -43,13 +41,13 @@ description: - Name of the host system to work with. - Vmnic information about this ESXi server will be returned. - - This parameter is required if C(cluster_name) is not specified. + - This parameter is required if O(cluster_name) is not specified. type: str cluster_name: description: - Name of the cluster from which all host systems will be used. - Vmnic information about each ESXi server will be returned for the given cluster. - - This parameter is required if C(esxi_hostname) is not specified. + - This parameter is required if O(esxi_hostname) is not specified. type: str extends_documentation_fragment: - community.vmware.vmware.documentation @@ -81,9 +79,6 @@ description: - dict with hostname as key and dict with vmnics information as value. - for C(num_vmnics), only NICs starting with vmnic are counted. NICs like vusb* are not counted. - - details about vswitch and dvswitch was added in version 2.7. - - details about vmnics was added in version 2.8. - - details about lldp was added in version 1.11.0 returned: hosts_vmnics_info type: dict sample: diff --git a/plugins/modules/vmware_local_role_manager.py b/plugins/modules/vmware_local_role_manager.py index e4c672d2c..cebf4000e 100644 --- a/plugins/modules/vmware_local_role_manager.py +++ b/plugins/modules/vmware_local_role_manager.py @@ -37,21 +37,21 @@ state: description: - Indicate desired state of the role. - - If the role already exists when C(state=present), the role info is updated. + - If the role already exists when V(present), the role info is updated. choices: ['present', 'absent'] default: present type: str force_remove: description: - - If set to C(false) then prevents the role from being removed if any permissions are using it. + - If set to V(false) then prevents the role from being removed if any permissions are using it. default: false type: bool action: description: - This parameter is only valid while updating an existing role with privileges. - - C(add) will add the privileges to the existing privilege list. - - C(remove) will remove the privileges from the existing privilege list. - - C(set) will replace the privileges of the existing privileges with user defined list of privileges. + - V(add) will add the privileges to the existing privilege list. + - V(remove) will remove the privileges from the existing privilege list. + - V(set) will replace the privileges of the existing privileges with user defined list of privileges. default: set choices: [ add, remove, set ] type: str diff --git a/plugins/modules/vmware_local_user_manager.py b/plugins/modules/vmware_local_user_manager.py index 3a95ae2d2..065e8e0a0 100644 --- a/plugins/modules/vmware_local_user_manager.py +++ b/plugins/modules/vmware_local_user_manager.py @@ -38,7 +38,7 @@ type: str state: description: - - Indicate desired state of the user. If the user already exists when C(state=present), the user info is updated + - Indicate desired state of the user. If the user already exists when V(present), the user info is updated choices: ['present', 'absent'] default: present type: str diff --git a/plugins/modules/vmware_maintenancemode.py b/plugins/modules/vmware_maintenancemode.py index ed198b7cf..faeda3a31 100644 --- a/plugins/modules/vmware_maintenancemode.py +++ b/plugins/modules/vmware_maintenancemode.py @@ -38,7 +38,7 @@ type: str evacuate: description: - - If set to C(true), evacuate all powered off VMs. + - If set to V(true), evacuate all powered off VMs. default: false required: false type: bool diff --git a/plugins/modules/vmware_object_custom_attributes_info.py b/plugins/modules/vmware_object_custom_attributes_info.py index 465e84fbf..7d2fa00e5 100644 --- a/plugins/modules/vmware_object_custom_attributes_info.py +++ b/plugins/modules/vmware_object_custom_attributes_info.py @@ -43,7 +43,7 @@ moid: description: - Managed Object ID of the instance to get if known, this is a unique identifier only within a single vCenter instance. - - This is required if C(object_name) is not supplied. + - This is required if O(object_name) is not supplied. type: str extends_documentation_fragment: - community.vmware.vmware.documentation diff --git a/plugins/modules/vmware_object_rename.py b/plugins/modules/vmware_object_rename.py index 0827c9369..8f5cbb752 100644 --- a/plugins/modules/vmware_object_rename.py +++ b/plugins/modules/vmware_object_rename.py @@ -41,12 +41,12 @@ object_name: description: - Name of the object to work with. - - Mutually exclusive with C(object_moid). + - Mutually exclusive with O(object_moid). type: str object_moid: description: - Managed object id of the VMware object to work with. - - Mutually exclusive with C(object_name). + - Mutually exclusive with O(object_name). type: str new_name: description: diff --git a/plugins/modules/vmware_object_role_permission.py b/plugins/modules/vmware_object_role_permission.py index 98bd2b649..d17b2fa38 100644 --- a/plugins/modules/vmware_object_role_permission.py +++ b/plugins/modules/vmware_object_role_permission.py @@ -32,13 +32,13 @@ principal: description: - The user to be assigned permission. - - Required if C(group) is not specified. + - Required if O(group) is not specified. - If specifying domain user, required separator of domain uses backslash. type: str group: description: - The group to be assigned permission. - - Required if C(principal) is not specified. + - Required if O(principal) is not specified. type: str object_name: description: @@ -62,8 +62,8 @@ state: description: - Indicate desired state of the object's permission. - - When C(state=present), the permission will be added if it doesn't already exist. - - When C(state=absent), the permission is removed if it exists. + - When V(present), the permission will be added if it doesn't already exist. + - When V(absent), the permission is removed if it exists. choices: ['present', 'absent'] default: present type: str diff --git a/plugins/modules/vmware_object_role_permission_info.py b/plugins/modules/vmware_object_role_permission_info.py index 08b668798..d6049ad7b 100644 --- a/plugins/modules/vmware_object_role_permission_info.py +++ b/plugins/modules/vmware_object_role_permission_info.py @@ -33,7 +33,7 @@ object_name: description: - The object name to assigned permission. - - Mutually exclusive with I(moid). + - Mutually exclusive with O(moid). type: str object_type: description: @@ -47,7 +47,7 @@ moid: description: - Managed object ID for the given object. - - Mutually exclusive with I(object_name). + - Mutually exclusive with O(object_name). aliases: ['object_moid'] type: 'str' extends_documentation_fragment: diff --git a/plugins/modules/vmware_portgroup.py b/plugins/modules/vmware_portgroup.py index 7f5e57d83..c4e569b87 100644 --- a/plugins/modules/vmware_portgroup.py +++ b/plugins/modules/vmware_portgroup.py @@ -87,13 +87,13 @@ type: list description: - List of active adapters used for load balancing. - - All vmnics are used as active adapters if C(active_adapters) and C(standby_adapters) are not defined. + - All vmnics are used as active adapters if O(teaming.active_adapters) and O(teaming.standby_adapters) are not defined. elements: str standby_adapters: type: list description: - List of standby adapters used for failover. - - All vmnics are used as active adapters if C(active_adapters) and C(standby_adapters) are not defined. + - All vmnics are used as active adapters if O(teaming.active_adapters) and O(teaming.standby_adapters) are not defined. elements: str required: false aliases: [ 'teaming_policy' ] @@ -120,13 +120,13 @@ description: - Name of cluster name for host membership. - Portgroup will be created on all hosts of the given cluster. - - This option is required if C(hosts) is not specified. + - This option is required if O(hosts) is not specified. aliases: [ 'cluster' ] type: str hosts: description: - List of name of host or hosts on which portgroup needs to be added. - - This option is required if C(cluster_name) is not specified. + - This option is required if O(cluster_name) is not specified. aliases: [ esxi_hostname ] type: list elements: str diff --git a/plugins/modules/vmware_portgroup_info.py b/plugins/modules/vmware_portgroup_info.py index b94be38db..6d3fa00ab 100644 --- a/plugins/modules/vmware_portgroup_info.py +++ b/plugins/modules/vmware_portgroup_info.py @@ -30,12 +30,12 @@ description: - Name of the cluster. - Info will be returned for all hostsystem belonging to this cluster name. - - If C(esxi_hostname) is not given, this parameter is required. + - If O(esxi_hostname) is not given, this parameter is required. type: str esxi_hostname: description: - ESXi hostname to gather information from. - - If C(cluster_name) is not given, this parameter is required. + - If O(cluster_name) is not given, this parameter is required. type: str extends_documentation_fragment: - community.vmware.vmware.documentation diff --git a/plugins/modules/vmware_resource_pool.py b/plugins/modules/vmware_resource_pool.py index 2ed81f821..319542c54 100644 --- a/plugins/modules/vmware_resource_pool.py +++ b/plugins/modules/vmware_resource_pool.py @@ -26,21 +26,21 @@ cluster: description: - Name of the cluster to configure the resource pool. - - This parameter is required if C(esxi_hostname) or C(parent_resource_pool) is not specified. - - The C(cluster), C(esxi_hostname) and C(parent_resource_pool) parameters are mutually exclusive. + - This parameter is required if O(esxi_hostname) or O(parent_resource_pool) is not specified. + - The O(cluster), O(esxi_hostname) and O(parent_resource_pool) parameters are mutually exclusive. type: str esxi_hostname: description: - Name of the host to configure the resource pool. - The host must not be member of a cluster. - - This parameter is required if C(cluster) or C(parent_resource_pool) is not specified. - - The C(cluster), C(esxi_hostname) and C(parent_resource_pool) parameters are mutually exclusive. + - This parameter is required if O(cluster) or O(parent_resource_pool) is not specified. + - The O(cluster), O(esxi_hostname) and O(parent_resource_pool) parameters are mutually exclusive. type: str parent_resource_pool: description: - Name of the parent resource pool. - - This parameter is required if C(cluster) or C(esxi_hostname) is not specified. - - The C(cluster), C(esxi_hostname) and C(parent_resource_pool) parameters are mutually exclusive. + - This parameter is required if O(cluster) or O(esxi_hostname) is not specified. + - The O(cluster), O(esxi_hostname) and O(parent_resource_pool) parameters are mutually exclusive. type: str resource_pool: description: @@ -76,7 +76,7 @@ cpu_allocation_shares: description: - The number of cpu shares allocated. - - This value is only set if I(cpu_shares) is set to C(custom). + - This value is only set if O(cpu_shares=custom). type: int default: 4000 mem_expandable_reservations: @@ -108,7 +108,7 @@ mem_allocation_shares: description: - The number of memory shares allocated. - - This value is only set if I(mem_shares) is set to C(custom). + - This value is only set if O(mem_shares=custom). type: int default: 163840 state: From 557ea0942c2b07c80a880608497336059da4f71d Mon Sep 17 00:00:00 2001 From: Mario Lenz Date: Wed, 25 Oct 2023 14:41:16 +0200 Subject: [PATCH 2/2] Remove plugin docs from repo (6) --- ...ity.vmware.vmware_host_ntp_info_module.rst | 273 ------- ...vmware.vmware_host_package_info_module.rst | 273 ------- ....vmware.vmware_host_passthrough_module.rst | 376 --------- ...re.vmware_host_powermgmt_policy_module.rst | 292 ------- ...y.vmware.vmware_host_powerstate_module.rst | 347 --------- ...mware.vmware_host_scsidisk_info_module.rst | 271 ------- ...vmware.vmware_host_service_info_module.rst | 274 ------- ...are.vmware_host_service_manager_module.rst | 332 -------- ...mmunity.vmware.vmware_host_snmp_module.rst | 486 ------------ ...munity.vmware.vmware_host_sriov_module.rst | 352 --------- ...ity.vmware.vmware_host_ssl_info_module.rst | 288 ------- ...vmware.vmware_host_user_manager_module.rst | 364 --------- ...y.vmware.vmware_host_vmhba_info_module.rst | 275 ------- ...y.vmware.vmware_host_vmnic_info_module.rst | 339 --------- ...mware.vmware_local_role_manager_module.rst | 465 ------------ ...mware.vmware_local_user_manager_module.rst | 264 ------- ...y.vmware.vmware_maintenancemode_module.rst | 360 --------- ...e_object_custom_attributes_info_module.rst | 320 -------- ...ity.vmware.vmware_object_rename_module.rst | 363 --------- ...are_object_role_permission_info_module.rst | 320 -------- ...e.vmware_object_role_permission_module.rst | 413 ---------- ...ty.vmware.vmware_portgroup_info_module.rst | 291 ------- ...mmunity.vmware.vmware_portgroup_module.rst | 714 ------------------ ...ity.vmware.vmware_resource_pool_module.rst | 571 -------------- 24 files changed, 8623 deletions(-) delete mode 100644 docs/community.vmware.vmware_host_ntp_info_module.rst delete mode 100644 docs/community.vmware.vmware_host_package_info_module.rst delete mode 100644 docs/community.vmware.vmware_host_passthrough_module.rst delete mode 100644 docs/community.vmware.vmware_host_powermgmt_policy_module.rst delete mode 100644 docs/community.vmware.vmware_host_powerstate_module.rst delete mode 100644 docs/community.vmware.vmware_host_scsidisk_info_module.rst delete mode 100644 docs/community.vmware.vmware_host_service_info_module.rst delete mode 100644 docs/community.vmware.vmware_host_service_manager_module.rst delete mode 100644 docs/community.vmware.vmware_host_snmp_module.rst delete mode 100644 docs/community.vmware.vmware_host_sriov_module.rst delete mode 100644 docs/community.vmware.vmware_host_ssl_info_module.rst delete mode 100644 docs/community.vmware.vmware_host_user_manager_module.rst delete mode 100644 docs/community.vmware.vmware_host_vmhba_info_module.rst delete mode 100644 docs/community.vmware.vmware_host_vmnic_info_module.rst delete mode 100644 docs/community.vmware.vmware_local_role_manager_module.rst delete mode 100644 docs/community.vmware.vmware_local_user_manager_module.rst delete mode 100644 docs/community.vmware.vmware_maintenancemode_module.rst delete mode 100644 docs/community.vmware.vmware_object_custom_attributes_info_module.rst delete mode 100644 docs/community.vmware.vmware_object_rename_module.rst delete mode 100644 docs/community.vmware.vmware_object_role_permission_info_module.rst delete mode 100644 docs/community.vmware.vmware_object_role_permission_module.rst delete mode 100644 docs/community.vmware.vmware_portgroup_info_module.rst delete mode 100644 docs/community.vmware.vmware_portgroup_module.rst delete mode 100644 docs/community.vmware.vmware_resource_pool_module.rst diff --git a/docs/community.vmware.vmware_host_ntp_info_module.rst b/docs/community.vmware.vmware_host_ntp_info_module.rst deleted file mode 100644 index b4cf2be1e..000000000 --- a/docs/community.vmware.vmware_host_ntp_info_module.rst +++ /dev/null @@ -1,273 +0,0 @@ -.. _community.vmware.vmware_host_ntp_info_module: - - -************************************* -community.vmware.vmware_host_ntp_info -************************************* - -**Gathers info about NTP configuration on an ESXi host** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to gather information about NTP configurations on an ESXi host. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_name - -
- string -
- 		- -
Name of the cluster.
-
NTP config information about each ESXi server will be returned for the given cluster.
-
If esxi_hostname is not given, this parameter is required.
-
-
- esxi_hostname - -
- string -
- 		- -
ESXi hostname.
-
NTP config information about this ESXi server will be returned.
-
If cluster_name is not given, this parameter is required.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather NTP info about all ESXi Host in the given Cluster - community.vmware.vmware_host_ntp_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - cluster_name: cluster_name - delegate_to: localhost - register: cluster_host_ntp - - - name: Gather NTP info about ESXi Host - community.vmware.vmware_host_ntp_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_hostname }}' - delegate_to: localhost - register: host_ntp - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- hosts_ntp_info - -
- dictionary -
- 		hosts_ntp_info -
dict with hostname as key and dict with NTP infos as value
-
-
Sample:
-
{'10.76.33.226': [{'ntp_servers': [], 'time_zone_description': 'UTC', 'time_zone_gmt_offset': 0, 'time_zone_identifier': 'UTC', 'time_zone_name': 'UTC'}]}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Abhijeet Kasurde (@Akasurde) diff --git a/docs/community.vmware.vmware_host_package_info_module.rst b/docs/community.vmware.vmware_host_package_info_module.rst deleted file mode 100644 index da4c8ba6d..000000000 --- a/docs/community.vmware.vmware_host_package_info_module.rst +++ /dev/null @@ -1,273 +0,0 @@ -.. _community.vmware.vmware_host_package_info_module: - - -***************************************** -community.vmware.vmware_host_package_info -***************************************** - -**Gathers info about available packages on an ESXi host** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to gather information about available packages and their status on an ESXi host. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_name - -
- string -
- 		- -
Name of the cluster.
-
Package information about each ESXi server will be returned for given cluster.
-
If esxi_hostname is not given, this parameter is required.
-
-
- esxi_hostname - -
- string -
- 		- -
ESXi hostname.
-
Package information about this ESXi server will be returned.
-
If cluster_name is not given, this parameter is required.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather info about all ESXi Host in given Cluster - community.vmware.vmware_host_package_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - cluster_name: cluster_name - delegate_to: localhost - register: cluster_host_packages - - - name: Gather info about ESXi Host - community.vmware.vmware_host_package_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_hostname }}' - delegate_to: localhost - register: host_packages - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- hosts_package_info - -
- dictionary -
- 		hosts_package_info -
dict with hostname as key and dict with package information as value
-
-
Sample:
-
{'hosts_package_info': {'localhost.localdomain': []}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Abhijeet Kasurde (@Akasurde) diff --git a/docs/community.vmware.vmware_host_passthrough_module.rst b/docs/community.vmware.vmware_host_passthrough_module.rst deleted file mode 100644 index 915ec57ea..000000000 --- a/docs/community.vmware.vmware_host_passthrough_module.rst +++ /dev/null @@ -1,376 +0,0 @@ -.. _community.vmware.vmware_host_passthrough_module: - - -**************************************** -community.vmware.vmware_host_passthrough -**************************************** - -**Manage PCI device passthrough settings on host** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be managed PCI device passthrough settings on host. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster - -
- string -
- 		- -
Name of the cluster from which all host systems will be used.
-
This parameter is required if esxi_hostname is not specified.
-

aliases: cluster_name
-
-
- devices - -
- list - / elements=dictionary - / required -
- 		- -
List of PCI device name or id.
-
-
- device - -
- string -
- 		- -
Name of PCI device to enable passthrough.
-

aliases: name, device_name
-
-
- esxi_hostname - -
- string -
- 		- -
Name of the host system to work with.
-
This parameter is required if cluster_name is not specified.
-
User can specify specific host from the cluster.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
If state=present, passthrough of PCI device will be enabled.
-
If state=absent, passthrough of PCI device will be disabled.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - Supports ``check_mode``. - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Enable PCI device passthrough against the whole ESXi in a cluster - community.vmware.vmware_host_passthrough: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - validate_certs: false - cluster: "{{ ccr1 }}" - devices: - - device_name: "Dual Band Wireless AC 3165" - state: present - - - name: Enable PCI device passthrough against one ESXi - community.vmware.vmware_host_passthrough: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - validate_certs: false - esxi_hostname: "{{ esxi1 }}" - devices: - - device_name: "Dual Band Wireless AC 3165" - state: present - - - name: Enable PCI device passthrough with PCI ids - community.vmware.vmware_host_passthrough: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - validate_certs: false - esxi_hostname: "{{ esxi1 }}" - devices: - - device: '0000:03:00.0' - - device: '0000:00:02.0' - state: present - - - name: Disable PCI device passthrough against the whole ESXi in a cluster - community.vmware.vmware_host_passthrough: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - validate_certs: false - cluster: "{{ ccr1 }}" - devices: - - device_name: "Dual Band Wireless AC 3165" - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- passthrough_configs - -
- list - / elements=dictionary -
- 		changed -
list of that PCI devices have been enabled passthrough for each host system.
-
-
Sample:
-
[ - { - "esxi-01.example.com": [ - { - "device_id": "0000:03:00.0", - "device_name": "Dual Band Wireless AC 3165", - "passthruEnabled": true - } - ] - }, - { - "esxi-02.example.com": [ - { - "device_id": "0000:03:00.0", - "device_name": "Dual Band Wireless AC 3165", - "passthruEnabled": true - } - ] - } - ]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- sky-joker (@sky-joker) diff --git a/docs/community.vmware.vmware_host_powermgmt_policy_module.rst b/docs/community.vmware.vmware_host_powermgmt_policy_module.rst deleted file mode 100644 index 58bb2c51c..000000000 --- a/docs/community.vmware.vmware_host_powermgmt_policy_module.rst +++ /dev/null @@ -1,292 +0,0 @@ -.. _community.vmware.vmware_host_powermgmt_policy_module: - - -********************************************* -community.vmware.vmware_host_powermgmt_policy -********************************************* - -**Manages the Power Management Policy of an ESXI host system** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to manage the Power Management Policy of ESXi host systems in given vCenter infrastructure. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_name - -
- string -
- 		- -
Name of the cluster from which all host systems will be used.
-
This is required parameter if esxi_hostname is not specified.
-
-
- esxi_hostname - -
- string -
- 		- -
Name of the host system to work with.
-
This is required parameter if cluster_name is not specified.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- policy - -
- string -
- 		-
    Choices: -
  • high-performance
    • -
  • balanced ←
    • -
  • low-power
    • -
  • custom
    • -
- 		-
Set the Power Management Policy of the host system.
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Set the Power Management Policy of a host system to high-performance - community.vmware.vmware_host_powermgmt_policy: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_host }}' - policy: high-performance - delegate_to: localhost - - - name: Set the Power Management Policy of all host systems from cluster to high-performance - community.vmware.vmware_host_powermgmt_policy: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - cluster_name: '{{ cluster_name }}' - policy: high-performance - delegate_to: localhost - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- result - -
- dictionary -
- 		always -
metadata about host system's Power Management Policy
-
-
Sample:
-
{'changed': True, 'result': {'esxi01': {'changed': True, 'current_state': 'high-performance', 'desired_state': 'high-performance', 'msg': 'Power policy changed', 'previous_state': 'balanced'}}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Christian Kotte (@ckotte) diff --git a/docs/community.vmware.vmware_host_powerstate_module.rst b/docs/community.vmware.vmware_host_powerstate_module.rst deleted file mode 100644 index 7d7773af8..000000000 --- a/docs/community.vmware.vmware_host_powerstate_module.rst +++ /dev/null @@ -1,347 +0,0 @@ -.. _community.vmware.vmware_host_powerstate_module: - - -*************************************** -community.vmware.vmware_host_powerstate -*************************************** - -**Manages power states of host systems in vCenter** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to manage power states of host systems in given vCenter infrastructure. -- User can set power state to 'power-down-to-standby', 'power-up-from-standby', 'shutdown-host' and 'reboot-host'. -- State 'reboot-host', 'shutdown-host' and 'power-down-to-standby' are not supported by all the host systems. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_name - -
- string -
- 		- -
Name of the cluster from which all host systems will be used.
-
This is required parameter if esxi_hostname is not specified.
-
-
- esxi_hostname - -
- string -
- 		- -
Name of the host system to work with.
-
This is required parameter if cluster_name is not specified.
-
-
- force - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
This parameter specify if the host should be proceeding with user defined powerstate regardless of whether it is in maintenance mode.
-
If state set to reboot-host and force as true, then host system is rebooted regardless of whether it is in maintenance mode.
-
If state set to shutdown-host and force as true, then host system is shutdown regardless of whether it is in maintenance mode.
-
If state set to power-down-to-standby and force to true, then all powered off VMs will evacuated.
-
Not applicable if state set to power-up-from-standby.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- state - -
- string -
- 		-
    Choices: -
  • power-down-to-standby
    • -
  • power-up-from-standby
    • -
  • shutdown-host ←
    • -
  • reboot-host
    • -
- 		-
Set the state of the host system.
-
-
- timeout - -
- integer -
- 		- Default:
600
- 		-
This parameter defines timeout for state set to power-down-to-standby or power-up-from-standby.
-
Ignored if state set to reboot-host or shutdown-host.
-
This parameter is defined in seconds.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Set the state of a host system to reboot - community.vmware.vmware_host_powerstate: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_hostname }}' - state: reboot-host - delegate_to: localhost - register: reboot_host - - - name: Set the state of a host system to power down to standby - community.vmware.vmware_host_powerstate: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_hostname }}' - state: power-down-to-standby - delegate_to: localhost - register: power_down - - - name: Set the state of all host systems from cluster to reboot - community.vmware.vmware_host_powerstate: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - cluster_name: '{{ cluster_name }}' - state: reboot-host - delegate_to: localhost - register: reboot_host - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- result - -
- dictionary -
- 		always -
metadata about host system's state
-
-
Sample:
-
{'esxi01': {'msg': "power down 'esxi01' to standby", 'error': ''}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Abhijeet Kasurde (@Akasurde) diff --git a/docs/community.vmware.vmware_host_scsidisk_info_module.rst b/docs/community.vmware.vmware_host_scsidisk_info_module.rst deleted file mode 100644 index b0162cb79..000000000 --- a/docs/community.vmware.vmware_host_scsidisk_info_module.rst +++ /dev/null @@ -1,271 +0,0 @@ -.. _community.vmware.vmware_host_scsidisk_info_module: - - -****************************************** -community.vmware.vmware_host_scsidisk_info -****************************************** - -**Gather information about SCSI disk attached to the given ESXi** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to gather information about SCSI disk attached to the given ESXi. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_name - -
- string -
- 		- -
Name of the cluster from which all host systems will be used.
-
SCSI disk information about each ESXi server will be returned for the given cluster.
-
This parameter is required if esxi_hostname is not specified.
-
-
- esxi_hostname - -
- string -
- 		- -
Name of the host system to work with.
-
SCSI disk information about this ESXi server will be returned.
-
This parameter is required if cluster_name is not specified.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather information SCSI disk attached to the given ESXi - community.vmware.vmware_host_scsidisk_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_hostname }}' - delegate_to: localhost - - - name: Gather information of all host systems from the given cluster - community.vmware.vmware_host_scsidisk_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - cluster_name: '{{ cluster_name }}' - delegate_to: localhost - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- hosts_scsidisk_info - -
- dictionary -
- 		always -
metadata about host system SCSI disk information
-
-
Sample:
-
{'10.65.201.106': [{'block': 41943040, 'block_size': 512, 'canonical_name': 't10.ATA_QEMU_HARDDISK_QM00001_', 'device_name': '/vmfs/devices/disks/t10.ATA_QEMU_HARDDISK_QM00001_', 'device_path': '/vmfs/devices/disks/t10.ATA_QEMU_HARDDISK_QM00001_', 'device_type': 'disk', 'display_name': 'Local ATA Disk (t10.ATA_QEMU_HARDDISK_QM00001_)', 'key': 'key-vim.host.ScsiDisk-0100000000514d30303030312020202020202020202020202051454d552048', 'local_disk': True, 'lun_type': 'disk', 'model': 'QEMU HARDDISK ', 'perenniallyReserved': None, 'protocol_endpoint': False, 'revision': '1.5.', 'scsi_disk_type': 'native512', 'scsi_level': 5, 'serial_number': 'unavailable', 'ssd': False, 'uuid': '0100000000514d30303030312020202020202020202020202051454d552048', 'vStorageSupport': 'vStorageUnsupported', 'vendor': 'ATA '}]}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Abhijeet Kasurde (@Akasurde) diff --git a/docs/community.vmware.vmware_host_service_info_module.rst b/docs/community.vmware.vmware_host_service_info_module.rst deleted file mode 100644 index 246abc5eb..000000000 --- a/docs/community.vmware.vmware_host_service_info_module.rst +++ /dev/null @@ -1,274 +0,0 @@ -.. _community.vmware.vmware_host_service_info_module: - - -***************************************** -community.vmware.vmware_host_service_info -***************************************** - -**Gathers info about an ESXi host's services** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to gather information about an ESXi host's services. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_name - -
- string -
- 		- -
Name of the cluster.
-
Service information about each ESXi server will be returned for given cluster.
-
If esxi_hostname is not given, this parameter is required.
-
-
- esxi_hostname - -
- string -
- 		- -
ESXi hostname.
-
Service information about this ESXi server will be returned.
-
If cluster_name is not given, this parameter is required.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - If source package name is not available then fact is populated as null. - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather info about all ESXi Host in given Cluster - community.vmware.vmware_host_service_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - cluster_name: cluster_name - delegate_to: localhost - register: cluster_host_services - - - name: Gather info about ESXi Host - community.vmware.vmware_host_service_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_hostname }}' - delegate_to: localhost - register: host_services - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- host_service_info - -
- dictionary -
- 		always -
dict with hostname as key and dict with host service config information
-
-
Sample:
-
{'10.76.33.226': [{'key': 'DCUI', 'label': 'Direct Console UI', 'policy': 'on', 'required': False, 'running': True, 'uninstallable': False, 'source_package_name': 'esx-base', 'source_package_desc': 'This VIB contains all of the base functionality of vSphere ESXi.'}, {'key': 'TSM', 'label': 'ESXi Shell', 'policy': 'off', 'required': False, 'running': False, 'uninstallable': False, 'source_package_name': 'esx-base', 'source_package_desc': 'This VIB contains all of the base functionality of vSphere ESXi.'}]}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Abhijeet Kasurde (@Akasurde) diff --git a/docs/community.vmware.vmware_host_service_manager_module.rst b/docs/community.vmware.vmware_host_service_manager_module.rst deleted file mode 100644 index 7066e4f72..000000000 --- a/docs/community.vmware.vmware_host_service_manager_module.rst +++ /dev/null @@ -1,332 +0,0 @@ -.. _community.vmware.vmware_host_service_manager_module: - - -******************************************** -community.vmware.vmware_host_service_manager -******************************************** - -**Manage services on a given ESXi host** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to manage (start, stop, restart) services on a given ESXi host. -- If cluster_name is provided, specified service will be managed on all ESXi host belonging to that cluster. -- If specific esxi_hostname is provided, then specified service will be managed on given ESXi host only. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_name - -
- string -
- 		- -
Name of the cluster.
-
Service settings are applied to every ESXi host system/s in given cluster.
-
If esxi_hostname is not given, this parameter is required.
-
-
- esxi_hostname - -
- string -
- 		- -
ESXi hostname.
-
Service settings are applied to this ESXi host system.
-
If cluster_name is not given, this parameter is required.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- service_name - -
- string - / required -
- 		- -
Name of Service to be managed. This is a brief identifier for the service, for example, ntpd, vxsyslogd etc.
-
This value should be a valid ESXi service name.
-
-
- service_policy - -
- string -
- 		-
    Choices: -
  • automatic
    • -
  • off
    • -
  • on
    • -
- 		-
Set of valid service policy strings.
-
If set on, then service should be started when the host starts up.
-
If set automatic, then service should run if and only if it has open firewall ports.
-
If set off, then Service should not be started when the host starts up.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present
    • -
  • restart
    • -
  • start ←
    • -
  • stop
    • -
  • unchanged
    • -
- 		-
Desired state of service.
-
State value 'start' and 'present' has same effect.
-
State value 'stop' and 'absent' has same effect.
-
State value unchanged is added in version 1.14.0 to allow defining startup policy without defining or changing service state.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Start ntpd service setting for all ESXi Host in given Cluster - community.vmware.vmware_host_service_manager: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - cluster_name: '{{ cluster_name }}' - service_name: ntpd - state: present - delegate_to: localhost - - - name: Start ntpd setting for an ESXi Host - community.vmware.vmware_host_service_manager: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_hostname }}' - service_name: ntpd - state: present - delegate_to: localhost - - - name: Start ntpd setting for an ESXi Host with Service policy - community.vmware.vmware_host_service_manager: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_hostname }}' - service_name: ntpd - service_policy: 'on' - state: present - delegate_to: localhost - - - name: Stop ntpd setting for an ESXi Host - community.vmware.vmware_host_service_manager: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_hostname }}' - service_name: ntpd - state: absent - delegate_to: localhost - - - - -Status ------- - - -Authors -~~~~~~~ - -- Abhijeet Kasurde (@Akasurde) diff --git a/docs/community.vmware.vmware_host_snmp_module.rst b/docs/community.vmware.vmware_host_snmp_module.rst deleted file mode 100644 index 36fc8ec2b..000000000 --- a/docs/community.vmware.vmware_host_snmp_module.rst +++ /dev/null @@ -1,486 +0,0 @@ -.. _community.vmware.vmware_host_snmp_module: - - -********************************* -community.vmware.vmware_host_snmp -********************************* - -**Configures SNMP on an ESXi host system** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to configure the embedded SNMP agent on an ESXi host. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_name - -
- string -
-
added in 3.10.0
- 		- -
Name of cluster.
-
All host system from given cluster used to manage SNMP agent.
-
Required parameter, if esxi_hostname is not set.
-
-
- community - -
- list - / elements=string -
- 		- Default:
[]
- 		-
List of SNMP community strings.
-
-
- esxi_hostname - -
- list - / elements=string -
-
added in 3.10.0
- 		- -
List of ESXi hostname to manage SNMP agent.
-
Required parameter, if cluster_name is not set.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- hw_source - -
- string -
- 		-
    Choices: -
  • indications ←
    • -
  • sensors
    • -
- 		-
Source hardware events from IPMI sensors or CIM Indications.
-
The embedded SNMP agent receives hardware events either from IPMI sensors sensors or CIM indications indications.
-
-
- log_level - -
- string -
- 		-
    Choices: -
  • debug
    • -
  • info ←
    • -
  • warning
    • -
  • error
    • -
- 		-
Syslog logging level.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- send_trap - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Send a test trap to validate the configuration.
-
-
- snmp_port - -
- integer -
- 		- Default:
161
- 		-
Port used by the SNMP agent.
-
-
- state - -
- string -
- 		-
    Choices: -
  • disabled ←
    • -
  • enabled
    • -
  • reset
    • -
- 		-
Enable, disable, or reset the SNMP agent.
-
-
- sys_contact - -
- string -
- 		- -
System contact who manages the system.
-
-
- sys_location - -
- string -
- 		- -
System location.
-
-
- trap_filter - -
- list - / elements=string -
- 		- -
A list of trap oids for traps not to be sent by agent, e.g. [ 1.3.6.1.4.1.6876.4.1.1.0, 1.3.6.1.4.1.6876.4.1.1.1 ]
-
Use value reset to clear settings.
-
-
- trap_targets - -
- list - / elements=dictionary -
- 		- Default:
[]
- 		-
A list of trap targets.
-
You need to use hostname, port, and community for each trap target.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - You need to reset the agent (to factory defaults) if you want to clear all community strings, trap targets, or filters - - SNMP v3 configuration isn't implemented yet - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Enable and configure SNMP community on standalone ESXi host - community.vmware.vmware_host_snmp: - hostname: '{{ esxi_hostname }}' - username: '{{ esxi_username }}' - password: '{{ esxi_password }}' - community: [ test ] - state: enabled - delegate_to: localhost - - - name: Configure SNMP traps and filters on cluster - community.vmware.vmware_host_snmp: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - cluster_name: '{{ cluster_name }}' - community: [ test ] - trap_targets: - - hostname: 192.168.1.100 - port: 162 - community: test123 - - hostname: 192.168.1.101 - port: 162 - community: test1234 - trap_filter: - - 1.3.6.1.4.1.6876.4.1.1.0 - - 1.3.6.1.4.1.6876.4.1.1.1 - state: enabled - delegate_to: localhost - - - name: Enable and configure SNMP system contact and location on simple ESXi host in vCenter - community.vmware.vmware_host_snmp: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_hostname }}' - sys_contact: "admin@testemail.com" - sys_location: "Austin, USA" - state: enabled - delegate_to: localhost - - - name: Disable SNMP on standalone ESXi host - community.vmware.vmware_host_snmp: - hostname: '{{ esxi_hostname }}' - username: '{{ esxi_username }}' - password: '{{ esxi_password }}' - state: disabled - delegate_to: localhost - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- results - -
- dictionary -
- 		always -
metadata about host system's SNMP configuration
-
-
Sample:
-
{'changed': True, 'esx01.example.local': {'changed': True, 'community': ['test'], 'community_previous': [], 'hw_source': 'indications', 'log_level': 'info', 'log_level_previous': 'warning', 'msg': 'SNMP state, community list, log level, sys contact, and sys location changed', 'port': 161, 'state': 'enabled', 'state_previous': 'disabled', 'sys_contact_previous': '', 'sys_location_previous': '', 'trap_filter': None, 'trap_targets': []}, 'failed': False}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Christian Kotte (@ckotte) -- Alexander Nikitin (@ihumster) diff --git a/docs/community.vmware.vmware_host_sriov_module.rst b/docs/community.vmware.vmware_host_sriov_module.rst deleted file mode 100644 index f4645203c..000000000 --- a/docs/community.vmware.vmware_host_sriov_module.rst +++ /dev/null @@ -1,352 +0,0 @@ -.. _community.vmware.vmware_host_sriov_module: - - -********************************** -community.vmware.vmware_host_sriov -********************************** - -**Manage SR-IOV settings on host** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to configure, enable or disable SR-IOV functions on ESXi host. -- Module does not reboot the host after changes, but puts it in output "rebootRequired" state. -- User can specify an ESXi hostname or Cluster name. In case of cluster name, all ESXi hosts are updated. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_name - -
- string -
- 		- -
Name of the cluster from which all host systems will be used.
-
This parameter is required if esxi_hostname is not specified.
-
-
- esxi_hostname - -
- string -
- 		- -
Name of the host system to work with.
-
This parameter is required if cluster_name is not specified.
-
User can specify specific host from the cluster.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- num_virt_func - -
- integer - / required -
- 		- -
number of functions to activate on interface.
-
0 means SR-IOV disabled.
-
number greater than 0 means SR-IOV enabled.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- sriov_on - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
optional parameter, related to num_virt_func.
-
SR-IOV can be enabled only if num_virt_func > 0.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- vmnic - -
- string - / required -
- 		- -
Interface name, like vmnic0.
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: enable SR-IOV on vmnic0 with 8 functions - community.vmware.vmware_host_sriov: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - esxi_hostname: "{{ esxi1 }}" - vmnic: vmnic0 - sriov_on: true - num_virt_func: 8 - - - name: enable SR-IOV on already enabled interface vmnic0 - community.vmware.vmware_host_sriov: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - esxi_hostname: "{{ esxi1 }}" - vmnic: vmnic0 - sriov_on: true - num_virt_func: 8 - - - name: enable SR-IOV on vmnic0 with big number of functions - community.vmware.vmware_host_sriov: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - esxi_hostname: "{{ esxi1 }}" - vmnic: vmnic0 - sriov_on: true - num_virt_func: 100 - ignore_errors: true - - - name: disable SR-IOV on vmnic0 - community.vmware.vmware_host_sriov: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - esxi_hostname: "{{ esxi1 }}" - vmnic: vmnic0 - sriov_on: false - num_virt_func: 0 - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- host_sriov_diff - -
- dictionary -
- 		always -
contains info about SR-IOV status on vmnic before, after and requested changes
-
sometimes vCenter slowly update info, as result "after" contains same info as "before" need to run again in check_mode or reboot host, as ESXi requested
-
-
Sample:
-
{'changed': True, 'diff': {'after': {'host_test': {'sriovActive': False, 'sriovEnabled': True, 'maxVirtualFunctionSupported': 63, 'numVirtualFunction': 0, 'numVirtualFunctionRequested': 8, 'rebootRequired': True, 'sriovCapable': True}}, 'before': {'host_test': {'sriovActive': False, 'sriovEnabled': False, 'maxVirtualFunctionSupported': 63, 'numVirtualFunction': 0, 'numVirtualFunctionRequested': 0, 'rebootRequired': False, 'sriovCapable': True}}, 'changes': {'host_test': {'numVirtualFunction': 8, 'rebootRequired': True, 'sriovEnabled': True}}}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Viktor Tsymbalyuk (@victron) diff --git a/docs/community.vmware.vmware_host_ssl_info_module.rst b/docs/community.vmware.vmware_host_ssl_info_module.rst deleted file mode 100644 index 5ea83fe11..000000000 --- a/docs/community.vmware.vmware_host_ssl_info_module.rst +++ /dev/null @@ -1,288 +0,0 @@ -.. _community.vmware.vmware_host_ssl_info_module: - - -************************************* -community.vmware.vmware_host_ssl_info -************************************* - -**Gather info of ESXi host system about SSL** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to gather information of the SSL thumbprint information for a host. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_name - -
- string -
- 		- -
Name of the cluster.
-
SSL thumbprint information about all ESXi host system in the given cluster will be reported.
-
If esxi_hostname is not given, this parameter is required.
-
-
- esxi_hostname - -
- string -
- 		- -
ESXi hostname.
-
SSL thumbprint information of this ESXi host system will be reported.
-
If cluster_name is not given, this parameter is required.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather SSL thumbprint information about all ESXi Hosts in given Cluster - community.vmware.vmware_host_ssl_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - cluster_name: '{{ cluster_name }}' - delegate_to: localhost - register: all_host_ssl_info - - - name: Get SSL Thumbprint info about "{{ esxi_hostname }}" - community.vmware.vmware_host_ssl_info: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - esxi_hostname: '{{ esxi_hostname }}' - register: ssl_info - - set_fact: - ssl_thumbprint: "{{ ssl_info['host_ssl_info'][esxi_hostname]['ssl_thumbprints'][0] }}" - - debug: - msg: "{{ ssl_thumbprint }}" - - name: Add ESXi Host to vCenter - vmware_host: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - datacenter_name: '{{ datacenter_name }}' - cluster_name: '{{ cluster_name }}' - esxi_hostname: '{{ esxi_hostname }}' - esxi_username: '{{ esxi_username }}' - esxi_password: '{{ esxi_password }}' - esxi_ssl_thumbprint: '{{ ssl_thumbprint }}' - state: present - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- host_ssl_info - -
- dictionary -
- 		info -
dict with hostname as key and dict with SSL thumbprint related info
-
-
Sample:
-
{'10.76.33.215': {'owner_tag': '', 'principal': 'vpxuser', 'ssl_thumbprints': ['E3:E8:A9:20:8D:32:AE:59:C6:8D:A5:91:B0:20:EF:00:A2:7C:27:EE', 'F1:AC:DA:6E:D8:1E:37:36:4A:5C:07:E5:04:0B:87:C8:75:FB:42:01']}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Abhijeet Kasurde (@Akasurde) diff --git a/docs/community.vmware.vmware_host_user_manager_module.rst b/docs/community.vmware.vmware_host_user_manager_module.rst deleted file mode 100644 index 9f7f6b322..000000000 --- a/docs/community.vmware.vmware_host_user_manager_module.rst +++ /dev/null @@ -1,364 +0,0 @@ -.. _community.vmware.vmware_host_user_manager_module: - - -***************************************** -community.vmware.vmware_host_user_manager -***************************************** - -**Manage users of ESXi** - - -Version added: 2.1.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can add, update or delete local users on ESXi host. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- esxi_hostname - -
- string - / required -
- 		- -
Name of the ESXi host that is managing the local user.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- override_user_password - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
If the local user exists and updates the password, change this parameter value is true.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
If set to present, add a new local user or update information.
-
If set to absent, delete the local user.
-
-
- user_description - -
- string -
- 		- -
The local user description.
-

aliases: local_user_description
-
-
- user_name - -
- string - / required -
- 		- -
Name of the local user.
-

aliases: local_user_name
-
-
- user_password - -
- string -
- 		- -
The local user password.
-
If you'd like to update the password, require the override_user_password is true.
-

aliases: local_user_password
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Add new local user to ESXi host - community.vmware.vmware_host_user_manager: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - validate_certs: false - esxi_hostname: "{{ esxi1 }}" - user_name: example - user_description: "example user" - user_password: "{{ local_user_password }}" - state: present - - - name: Update the local user password in ESXi host - community.vmware.vmware_host_user_manager: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - validate_certs: false - esxi_hostname: "{{ esxi1 }}" - user_name: example - user_description: "example user" - user_password: "{{ local_user_password }}" - override_user_password: true - state: present - - - name: Delete the local user in ESXi host - community.vmware.vmware_host_user_manager: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - validate_certs: false - esxi_hostname: "{{ esxi1 }}" - user_name: example - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
The executed result for the module.
-
-
Sample:
-
{ - "msg": "Added the new user. - }
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- sky-joker (@sky-joker) diff --git a/docs/community.vmware.vmware_host_vmhba_info_module.rst b/docs/community.vmware.vmware_host_vmhba_info_module.rst deleted file mode 100644 index f817bb845..000000000 --- a/docs/community.vmware.vmware_host_vmhba_info_module.rst +++ /dev/null @@ -1,275 +0,0 @@ -.. _community.vmware.vmware_host_vmhba_info_module: - - -*************************************** -community.vmware.vmware_host_vmhba_info -*************************************** - -**Gathers info about vmhbas available on the given ESXi host** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to gather information about vmhbas available on the given ESXi host. -- If ``cluster_name`` is provided, then vmhba information about all hosts from given cluster will be returned. -- If ``esxi_hostname`` is provided, then vmhba information about given host system will be returned. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_name - -
- string -
- 		- -
Name of the cluster from which all host systems will be used.
-
Vmhba information about each ESXi server will be returned for the given cluster.
-
This parameter is required if esxi_hostname is not specified.
-
-
- esxi_hostname - -
- string -
- 		- -
Name of the host system to work with.
-
Vmhba information about this ESXi server will be returned.
-
This parameter is required if cluster_name is not specified.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather info about vmhbas of all ESXi Host in the given Cluster - community.vmware.vmware_host_vmhba_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - cluster_name: '{{ cluster_name }}' - delegate_to: localhost - register: cluster_host_vmhbas - - - name: Gather info about vmhbas of an ESXi Host - community.vmware.vmware_host_vmhba_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_hostname }}' - delegate_to: localhost - register: host_vmhbas - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- hosts_vmhbas_info - -
- dictionary -
- 		hosts_vmhbas_info -
dict with hostname as key and dict with vmhbas information as value.
-
-
Sample:
-
{'10.76.33.204': {'vmhba_details': [{'adapter': 'HPE Smart Array P440ar', 'bus': 3, 'device': 'vmhba0', 'driver': 'nhpsa', 'location': '0000:03:00.0', 'model': 'Smart Array P440ar', 'node_wwn': '50:01:43:80:37:18:9e:a0', 'status': 'unknown', 'type': 'SAS'}, {'adapter': 'QLogic Corp ISP2532-based 8Gb Fibre Channel to PCI Express HBA', 'bus': 5, 'device': 'vmhba1', 'driver': 'qlnativefc', 'location': '0000:05:00.0', 'model': 'ISP2532-based 8Gb Fibre Channel to PCI Express HBA', 'node_wwn': '57:64:96:32:15:90:23:95:82', 'port_type': 'unknown', 'port_wwn': '57:64:96:32:15:90:23:95:82', 'speed': 8, 'status': 'online', 'type': 'Fibre Channel'}, {'adapter': 'QLogic Corp ISP2532-based 8Gb Fibre Channel to PCI Express HBA', 'bus': 8, 'device': 'vmhba2', 'driver': 'qlnativefc', 'location': '0000:08:00.0', 'model': 'ISP2532-based 8Gb Fibre Channel to PCI Express HBA', 'node_wwn': '57:64:96:32:15:90:23:95:21', 'port_type': 'unknown', 'port_wwn': '57:64:96:32:15:90:23:95:21', 'speed': 8, 'status': 'online', 'type': 'Fibre Channel'}]}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Christian Kotte (@ckotte) diff --git a/docs/community.vmware.vmware_host_vmnic_info_module.rst b/docs/community.vmware.vmware_host_vmnic_info_module.rst deleted file mode 100644 index c76f45259..000000000 --- a/docs/community.vmware.vmware_host_vmnic_info_module.rst +++ /dev/null @@ -1,339 +0,0 @@ -.. _community.vmware.vmware_host_vmnic_info_module: - - -*************************************** -community.vmware.vmware_host_vmnic_info -*************************************** - -**Gathers info about vmnics available on the given ESXi host** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to gather information about vmnics available on the given ESXi host. -- If ``cluster_name`` is provided, then vmnic information about all hosts from given cluster will be returned. -- If ``esxi_hostname`` is provided, then vmnic information about given host system will be returned. -- Additional details about vswitch and dvswitch with respective vmnic is also provided which is added in 2.7 version. -- Additional details about lldp added in 1.11.0 - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- capabilities - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Gather information about general capabilities (Auto negotiation, Wake On LAN, and Network I/O Control).
-
-
- cluster_name - -
- string -
- 		- -
Name of the cluster from which all host systems will be used.
-
Vmnic information about each ESXi server will be returned for the given cluster.
-
This parameter is required if esxi_hostname is not specified.
-
-
- directpath_io - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Gather information about DirectPath I/O capabilities and configuration.
-
-
- esxi_hostname - -
- string -
- 		- -
Name of the host system to work with.
-
Vmnic information about this ESXi server will be returned.
-
This parameter is required if cluster_name is not specified.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- sriov - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Gather information about SR-IOV capabilities and configuration.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather info about vmnics of all ESXi Host in the given Cluster - community.vmware.vmware_host_vmnic_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - cluster_name: '{{ cluster_name }}' - delegate_to: localhost - register: cluster_host_vmnics - - - name: Gather info about vmnics of an ESXi Host - community.vmware.vmware_host_vmnic_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_hostname }}' - delegate_to: localhost - register: host_vmnics - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- hosts_vmnics_info - -
- dictionary -
- 		hosts_vmnics_info -
dict with hostname as key and dict with vmnics information as value.
-
for num_vmnics, only NICs starting with vmnic are counted. NICs like vusb* are not counted.
-
details about vswitch and dvswitch was added in version 2.7.
-
details about vmnics was added in version 2.8.
-
details about lldp was added in version 1.11.0
-
-
Sample:
-
{'10.76.33.204': {'all': ['vmnic0', 'vmnic1'], 'available': [], 'dvswitch': {'dvs_0002': ['vmnic1']}, 'num_vmnics': 2, 'used': ['vmnic1', 'vmnic0'], 'vmnic_details': [{'actual_duplex': 'Full Duplex', 'actual_speed': 10000, 'adapter': 'Intel(R) 82599 10 Gigabit Dual Port Network Connection', 'configured_duplex': 'Auto negotiate', 'configured_speed': 'Auto negotiate', 'device': 'vmnic0', 'driver': 'ixgbe', 'lldp_info': {'Aggregated Port ID': '0', 'Aggregation Status': '1', 'Enabled Capabilities': {'_vimtype': 'vim.host.PhysicalNic.CdpDeviceCapability', 'host': False, 'igmpEnabled': False, 'networkSwitch': False, 'repeater': False, 'router': True, 'sourceRouteBridge': False, 'transparentBridge': True}, 'MTU': '9216', 'Port Description': 'switch port description', 'Samples': 18814, 'System Description': 'omitted from output', 'System Name': 'sw1', 'TimeOut': 30, 'Vlan ID': '1'}, 'location': '0000:01:00.0', 'mac': 'aa:bb:cc:dd:ee:ff', 'status': 'Connected'}, {'actual_duplex': 'Full Duplex', 'actual_speed': 10000, 'adapter': 'Intel(R) 82599 10 Gigabit Dual Port Network Connection', 'configured_duplex': 'Auto negotiate', 'configured_speed': 'Auto negotiate', 'device': 'vmnic1', 'driver': 'ixgbe', 'lldp_info': 'N/A', 'location': '0000:01:00.1', 'mac': 'ab:ba:cc:dd:ee:ff', 'status': 'Connected'}], 'vswitch': {'vSwitch0': ['vmnic0']}}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Abhijeet Kasurde (@Akasurde) -- Christian Kotte (@ckotte) diff --git a/docs/community.vmware.vmware_local_role_manager_module.rst b/docs/community.vmware.vmware_local_role_manager_module.rst deleted file mode 100644 index 05014bdd1..000000000 --- a/docs/community.vmware.vmware_local_role_manager_module.rst +++ /dev/null @@ -1,465 +0,0 @@ -.. _community.vmware.vmware_local_role_manager_module: - - -****************************************** -community.vmware.vmware_local_role_manager -****************************************** - -**Manage local roles on an ESXi host or vCenter** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to manage local roles on an ESXi host or vCenter. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- action - -
- string -
- 		-
    Choices: -
  • add
    • -
  • remove
    • -
  • set ←
    • -
- 		-
This parameter is only valid while updating an existing role with privileges.
-
add will add the privileges to the existing privilege list.
-
remove will remove the privileges from the existing privilege list.
-
set will replace the privileges of the existing privileges with user defined list of privileges.
-
-
- force_remove - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
If set to false then prevents the role from being removed if any permissions are using it.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- local_privilege_ids - -
- list - / elements=string -
- 		- Default:
[]
- 		-
The list of privileges that role needs to have.
- -
-
- local_role_name - -
- string - / required -
- 		- -
The local role name to be managed.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Indicate desired state of the role.
-
If the role already exists when state=present, the role info is updated.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - Be sure that the user used for login, has the appropriate rights to create / delete / edit roles - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Add local role to ESXi - community.vmware.vmware_local_role_manager: - hostname: '{{ esxi_hostname }}' - username: '{{ esxi_username }}' - password: '{{ esxi_password }}' - local_role_name: vmware_qa - state: present - delegate_to: localhost - - - name: Add local role with privileges to vCenter - community.vmware.vmware_local_role_manager: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - local_role_name: vmware_qa - local_privilege_ids: [ 'Folder.Create', 'Folder.Delete'] - state: present - delegate_to: localhost - - - name: Remove local role from ESXi - community.vmware.vmware_local_role_manager: - hostname: '{{ esxi_hostname }}' - username: '{{ esxi_username }}' - password: '{{ esxi_password }}' - local_role_name: vmware_qa - state: absent - delegate_to: localhost - - - name: Add a privilege to an existing local role - community.vmware.vmware_local_role_manager: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - local_role_name: vmware_qa - local_privilege_ids: [ 'Folder.Create' ] - action: add - delegate_to: localhost - - - name: Remove a privilege to an existing local role - community.vmware.vmware_local_role_manager: - hostname: '{{ esxi_hostname }}' - username: '{{ esxi_username }}' - password: '{{ esxi_password }}' - local_role_name: vmware_qa - local_privilege_ids: [ 'Folder.Create' ] - action: remove - delegate_to: localhost - - - name: Set a privilege to an existing local role - community.vmware.vmware_local_role_manager: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - local_role_name: vmware_qa - local_privilege_ids: [ 'Folder.Create' ] - action: set - delegate_to: localhost - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- local_role_name - -
- string -
- 		always -
Name of local role
-
-
-
- new_privileges - -
- list -
- 		always -
List of privileges
-
-
-
- old_privileges - -
- list -
- 		on update -
List of privileges of role before the update
-
-
-
- privileges - -
- list -
- 		always -
List of privileges
-
-
-
- privileges_previous - -
- list -
- 		on update -
List of privileges of role before the update
-
-
-
- role_id - -
- integer -
- 		always -
Generated local role id
-
-
-
- role_name - -
- string -
- 		always -
Name of local role
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Abhijeet Kasurde (@Akasurde) -- Christian Kotte (@ckotte) diff --git a/docs/community.vmware.vmware_local_user_manager_module.rst b/docs/community.vmware.vmware_local_user_manager_module.rst deleted file mode 100644 index 431e048bc..000000000 --- a/docs/community.vmware.vmware_local_user_manager_module.rst +++ /dev/null @@ -1,264 +0,0 @@ -.. _community.vmware.vmware_local_user_manager_module: - - -****************************************** -community.vmware.vmware_local_user_manager -****************************************** - -**Manage local users on an ESXi host** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Manage local users on an ESXi host - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- local_user_description - -
- string -
- 		- -
Description for the user.
-
-
- local_user_name - -
- string - / required -
- 		- -
The local user name to be changed.
-
-
- local_user_password - -
- string -
- 		- -
The password to be set.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Indicate desired state of the user. If the user already exists when state=present, the user info is updated
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - Be sure that the ESXi user used for login, has the appropriate rights to create / delete / edit users - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Add local user to ESXi - community.vmware.vmware_local_user_manager: - hostname: esxi_hostname - username: root - password: vmware - local_user_name: foo - local_user_password: password - delegate_to: localhost - - - - -Status ------- - - -Authors -~~~~~~~ - -- Andreas Nafpliotis (@nafpliot-ibm) diff --git a/docs/community.vmware.vmware_maintenancemode_module.rst b/docs/community.vmware.vmware_maintenancemode_module.rst deleted file mode 100644 index 265dcb808..000000000 --- a/docs/community.vmware.vmware_maintenancemode_module.rst +++ /dev/null @@ -1,360 +0,0 @@ -.. _community.vmware.vmware_maintenancemode_module: - - -*************************************** -community.vmware.vmware_maintenancemode -*************************************** - -**Place a host into maintenance mode** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used for placing a ESXi host into maintenance mode. -- Support for VSAN compliant maintenance mode when selected. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- esxi_hostname - -
- string - / required -
- 		- -
Name of the host as defined in vCenter.
-
-
- evacuate - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
If set to true, evacuate all powered off VMs.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Enter or exit maintenance mode.
-
-
- timeout - -
- integer -
- 		- Default:
0
- 		-
Specify a timeout for the operation.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- vsan - -
- string -
- 		-
    Choices: -
  • ensureObjectAccessibility
    • -
  • evacuateAllData
    • -
  • noAction
    • -
- 		-
Specify which VSAN compliant mode to enter.
-

aliases: vsan_mode
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Enter VSAN-Compliant Maintenance Mode - community.vmware.vmware_maintenancemode: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - esxi_hostname: "{{ esxi_hostname }}" - vsan: ensureObjectAccessibility - evacuate: true - timeout: 3600 - state: present - delegate_to: localhost - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- hostname - -
- string -
- 		always -
Name of host in vCenter
-
-
Sample:
-
esxi.local.domain
-
-
- hostsystem - -
- string -
- 		always -
Name of vim reference
-
-
Sample:
-
'vim.HostSystem:host-236'
-
-
- status - -
- string -
- 		always -
Action taken
-
-
Sample:
-
ENTER
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Jay Jahns (@jjahns) -- Abhijeet Kasurde (@Akasurde) diff --git a/docs/community.vmware.vmware_object_custom_attributes_info_module.rst b/docs/community.vmware.vmware_object_custom_attributes_info_module.rst deleted file mode 100644 index 70cfd1f2b..000000000 --- a/docs/community.vmware.vmware_object_custom_attributes_info_module.rst +++ /dev/null @@ -1,320 +0,0 @@ -.. _community.vmware.vmware_object_custom_attributes_info_module: - - -***************************************************** -community.vmware.vmware_object_custom_attributes_info -***************************************************** - -**Gather custom attributes of an object** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be gathered custom attributes of an object. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- moid - -
- string -
- 		- -
Managed Object ID of the instance to get if known, this is a unique identifier only within a single vCenter instance.
-
This is required if object_name is not supplied.
-
-
- object_name - -
- string -
- 		- -
Name of the object to work with.
-

aliases: name
-
-
- object_type - -
- string - / required -
- 		-
    Choices: -
  • Datacenter
    • -
  • Cluster
    • -
  • HostSystem
    • -
  • ResourcePool
    • -
  • Folder
    • -
  • VirtualMachine
    • -
  • DistributedVirtualSwitch
    • -
  • DistributedVirtualPortgroup
    • -
  • Datastore
    • -
- 		-
Type of an object to work with.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - Supports ``check_mode``. - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather custom attributes of a virtual machine - community.vmware.vmware_object_custom_attributes_info: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - validate_certs: false - object_type: VirtualMachine - object_name: "{{ object_name }}" - register: vm_attributes - - - name: Gather custom attributes of a virtual machine with moid - community.vmware.vmware_object_custom_attributes_info: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - validate_certs: false - object_type: VirtualMachine - moid: "{{ moid }}" - register: vm_attributes - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- custom_attributes - -
- list -
- 		always -
list of custom attributes of an object.
-
-
Sample:
-
[ - { - "attribute": "example01", - "key": 132, - "type": "VirtualMachine", - "value": "10" - }, - { - "attribute": "example02", - "key": 131, - "type": "VirtualMachine", - "value": "20" - }, - { - "attribute": "example03", - "key": 130, - "type": "VirtualMachine", - "value": null - } - ]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- sky-joker (@sky-joker) diff --git a/docs/community.vmware.vmware_object_rename_module.rst b/docs/community.vmware.vmware_object_rename_module.rst deleted file mode 100644 index fad6d8a0f..000000000 --- a/docs/community.vmware.vmware_object_rename_module.rst +++ /dev/null @@ -1,363 +0,0 @@ -.. _community.vmware.vmware_object_rename_module: - - -************************************* -community.vmware.vmware_object_rename -************************************* - -**Renames VMware objects** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to rename VMware objects. -- All variables and VMware object names are case sensitive. -- Renaming Host and Network is not supported by VMware APIs. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- vSphere Automation SDK - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- hostname - -
- string -
- 		- -
The hostname or IP address of the vSphere vCenter server.
-
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
-
-
- new_name - -
- string - / required -
- 		- -
New name for VMware object.
-

aliases: object_new_name
-
-
- object_moid - -
- string -
- 		- -
Managed object id of the VMware object to work with.
-
Mutually exclusive with object_name.
-
-
- object_name - -
- string -
- 		- -
Name of the object to work with.
-
Mutually exclusive with object_moid.
-
-
- object_type - -
- string - / required -
- 		-
    Choices: -
  • ClusterComputeResource
    • -
  • Cluster
    • -
  • Datacenter
    • -
  • Datastore
    • -
  • Folder
    • -
  • Network
    • -
  • ResourcePool
    • -
  • VM
    • -
  • VirtualMachine
    • -
- 		-
Type of object to work with.
-
Valid options are Cluster, ClusterComputeResource, Datacenter, Datastore, Folder, ResourcePool, VM or VirtualMachine.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
-
- protocol - -
- string -
- 		-
    Choices: -
  • http
    • -
  • https ←
    • -
- 		-
The connection to protocol.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid.
-
Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
-
- - - - -Examples --------- - -.. code-block:: yaml - - - name: Rename a virtual machine - community.vmware.vmware_object_rename: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - new_name: Fedora_31 - object_name: Fedora_VM - object_type: VirtualMachine - delegate_to: localhost - - - name: Rename a virtual machine using moid - community.vmware.vmware_object_rename: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - new_name: Fedora_31 - object_moid: vm-14 - object_type: VirtualMachine - delegate_to: localhost - - - name: Rename a datacenter - community.vmware.vmware_object_rename: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - new_name: Asia_Datacenter - object_name: dc1 - object_type: Datacenter - delegate_to: localhost - - - name: Rename a folder with moid - community.vmware.vmware_object_rename: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - new_name: backup - object_moid: group-v46 - object_type: Folder - delegate_to: localhost - - - name: Rename a cluster with moid - community.vmware.vmware_object_rename: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - new_name: CCR_1 - object_moid: domain-c33 - object_type: Cluster - delegate_to: localhost - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- rename_status - -
- dictionary -
- 		on success -
metadata about VMware object rename operation
-
-
Sample:
-
{'current_name': 'Fedora_31', 'desired_name': 'Fedora_31', 'previous_name': 'Fedora_VM'}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Abhijeet Kasurde (@Akasurde) diff --git a/docs/community.vmware.vmware_object_role_permission_info_module.rst b/docs/community.vmware.vmware_object_role_permission_info_module.rst deleted file mode 100644 index 1343a8493..000000000 --- a/docs/community.vmware.vmware_object_role_permission_info_module.rst +++ /dev/null @@ -1,320 +0,0 @@ -.. _community.vmware.vmware_object_role_permission_info_module: - - -*************************************************** -community.vmware.vmware_object_role_permission_info -*************************************************** - -**Gather information about object's permissions** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to gather object permissions on the given VMware object. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- moid - -
- string -
- 		- -
Managed object ID for the given object.
-
Mutually exclusive with object_name.
-

aliases: object_moid
-
-
- object_name - -
- string -
- 		- -
The object name to assigned permission.
-
Mutually exclusive with moid.
-
-
- object_type - -
- string -
- 		-
    Choices: -
  • Folder ←
    • -
  • VirtualMachine
    • -
  • Datacenter
    • -
  • ResourcePool
    • -
  • Datastore
    • -
  • Network
    • -
  • HostSystem
    • -
  • ComputeResource
    • -
  • ClusterComputeResource
    • -
  • DistributedVirtualSwitch
    • -
  • DistributedVirtualPortgroup
    • -
  • StoragePod
    • -
- 		-
The object type being targeted.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- principal - -
- string -
- 		- -
The optional name of an entity, such as a user, assigned permissions on an object.
-
If provided, actual permissions on the specified object are returned for the principal, instead of roles.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - The ESXi or vCenter login user must have the appropriate rights to administer permissions. - - Supports check mode. - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather role information about Datastore - community.vmware.vmware_object_role_permission_info: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - validate_certs: false - object_name: ds_200 - object_type: Datastore - - - name: Gather permissions on Datastore for a User - community.vmware.vmware_object_role_permission_info: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - validate_certs: false - principal: some.user@company.com - object_name: ds_200 - object_type: Datastore - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- permission_info - -
- list -
- 		always -
information about object's permission
-
-
Sample:
-
[{'principal': 'VSPHERE.LOCAL\\vpxd-extension-12e0b667-892c-4694-8a5e-f13147e45dbd', 'propagate': True, 'role_id': -1, 'role_name': 'Admin'}]
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Abhijeet Kasurde (@Akasurde) diff --git a/docs/community.vmware.vmware_object_role_permission_module.rst b/docs/community.vmware.vmware_object_role_permission_module.rst deleted file mode 100644 index 0b8f74b91..000000000 --- a/docs/community.vmware.vmware_object_role_permission_module.rst +++ /dev/null @@ -1,413 +0,0 @@ -.. _community.vmware.vmware_object_role_permission_module: - - -********************************************** -community.vmware.vmware_object_role_permission -********************************************** - -**Manage local roles on an ESXi host or vCenter** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to manage object permissions on the given host or vCenter. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- group - -
- string -
- 		- -
The group to be assigned permission.
-
Required if principal is not specified.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- object_name - -
- string - / required -
- 		- -
The object name to assigned permission.
-
-
- object_type - -
- string -
- 		-
    Choices: -
  • Folder ←
    • -
  • VirtualMachine
    • -
  • Datacenter
    • -
  • ResourcePool
    • -
  • Datastore
    • -
  • Network
    • -
  • HostSystem
    • -
  • ComputeResource
    • -
  • ClusterComputeResource
    • -
  • DistributedVirtualSwitch
    • -
  • DistributedVirtualPortgroup
    • -
  • StoragePod
    • -
- 		-
The object type being targeted.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- principal - -
- string -
- 		- -
The user to be assigned permission.
-
Required if group is not specified.
-
If specifying domain user, required separator of domain uses backslash.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- recursive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Should the permissions be recursively applied.
-
-
- role - -
- string - / required -
- 		- -
The role to be assigned permission.
-
User can also specify role name presented in Web UI. Supported added in 1.5.0.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Indicate desired state of the object's permission.
-
When state=present, the permission will be added if it doesn't already exist.
-
When state=absent, the permission is removed if it exists.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - The login user must have the appropriate rights to administer permissions. - - Permissions for a distributed switch must be defined and managed on either the datacenter or a folder containing the switch. - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Assign user to VM folder - community.vmware.vmware_object_role_permission: - hostname: '{{ esxi_hostname }}' - username: '{{ esxi_username }}' - password: '{{ esxi_password }}' - role: Admin - principal: user_bob - object_name: services - state: present - delegate_to: localhost - - - name: Remove user from VM folder - community.vmware.vmware_object_role_permission: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - role: Admin - principal: user_bob - object_name: services - state: absent - delegate_to: localhost - - - name: Assign finance group to VM folder - community.vmware.vmware_object_role_permission: - hostname: '{{ esxi_hostname }}' - username: '{{ esxi_username }}' - password: '{{ esxi_password }}' - role: Limited Users - group: finance - object_name: Accounts - state: present - delegate_to: localhost - - - name: Assign view_user Read Only permission at root folder - community.vmware.vmware_object_role_permission: - hostname: '{{ esxi_hostname }}' - username: '{{ esxi_username }}' - password: '{{ esxi_password }}' - role: ReadOnly - principal: view_user - object_name: rootFolder - state: present - delegate_to: localhost - - - name: Assign domain user to VM folder - community.vmware.vmware_object_role_permission: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - validate_certs: false - role: Admin - principal: "vsphere.local\\domainuser" - object_name: services - state: present - delegate_to: localhost - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
whether or not a change was made to the object's role
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Derek Rushing (@kryptsi) -- Joseph Andreatta (@vmwjoseph) diff --git a/docs/community.vmware.vmware_portgroup_info_module.rst b/docs/community.vmware.vmware_portgroup_info_module.rst deleted file mode 100644 index edf3ad7d2..000000000 --- a/docs/community.vmware.vmware_portgroup_info_module.rst +++ /dev/null @@ -1,291 +0,0 @@ -.. _community.vmware.vmware_portgroup_info_module: - - -************************************** -community.vmware.vmware_portgroup_info -************************************** - -**Gathers info about an ESXi host's Port Group configuration** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to gather information about an ESXi host's Port Group configuration when ESXi hostname or Cluster name is given. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_name - -
- string -
- 		- -
Name of the cluster.
-
Info will be returned for all hostsystem belonging to this cluster name.
-
If esxi_hostname is not given, this parameter is required.
-
-
- esxi_hostname - -
- string -
- 		- -
ESXi hostname to gather information from.
-
If cluster_name is not given, this parameter is required.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- policies - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Gather information about Security, Traffic Shaping, as well as Teaming and failover.
-
The property ts stands for Traffic Shaping and lb for Load Balancing.
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Gather portgroup info about all ESXi Host in given Cluster - community.vmware.vmware_portgroup_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - cluster_name: '{{ cluster_name }}' - delegate_to: localhost - - - name: Gather portgroup info about ESXi Host system - community.vmware.vmware_portgroup_info: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - esxi_hostname: '{{ esxi_hostname }}' - delegate_to: localhost - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- hosts_portgroup_info - -
- dictionary -
- 		on success -
metadata about host's portgroup configuration
-
-
Sample:
-
{'esx01': [{'failback': True, 'failover_active': ['vmnic0', 'vmnic1'], 'failover_standby': [], 'failure_detection': 'link_status_only', 'lb': 'loadbalance_srcid', 'notify': True, 'portgroup': 'Management Network', 'security': [False, False, False], 'ts': 'No override', 'vlan_id': 0, 'vswitch': 'vSwitch0'}, {'failback': True, 'failover_active': ['vmnic2'], 'failover_standby': ['vmnic3'], 'failure_detection': 'No override', 'lb': 'No override', 'notify': True, 'portgroup': 'vMotion', 'security': [False, False, False], 'ts': 'No override', 'vlan_id': 33, 'vswitch': 'vSwitch1'}]}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Abhijeet Kasurde (@Akasurde) -- Christian Kotte (@ckotte) diff --git a/docs/community.vmware.vmware_portgroup_module.rst b/docs/community.vmware.vmware_portgroup_module.rst deleted file mode 100644 index cb7e67684..000000000 --- a/docs/community.vmware.vmware_portgroup_module.rst +++ /dev/null @@ -1,714 +0,0 @@ -.. _community.vmware.vmware_portgroup_module: - - -********************************* -community.vmware.vmware_portgroup -********************************* - -**Create a VMware portgroup** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Create a VMware Port Group on a VMware Standard Switch (vSS) for given ESXi host(s) or hosts of given cluster. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_name - -
- string -
- 		- -
Name of cluster name for host membership.
-
Portgroup will be created on all hosts of the given cluster.
-
This option is required if hosts is not specified.
-

aliases: cluster
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- hosts - -
- list - / elements=string -
- 		- -
List of name of host or hosts on which portgroup needs to be added.
-
This option is required if cluster_name is not specified.
-

aliases: esxi_hostname
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- portgroup - -
- string - / required -
- 		- -
Portgroup name to add.
-

aliases: portgroup_name
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- security - -
- dictionary -
- 		- -
Network policy specifies layer 2 security settings for a portgroup such as promiscuous mode, where guest adapter listens to all the packets, MAC address changes and forged transmits.
-
Dict which configures the different security values for portgroup.
-

aliases: security_policy, network_policy
-
-
- forged_transmits - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Indicates whether forged transmits are allowed.
-
-
- mac_changes - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Indicates whether mac changes are allowed.
-
-
- promiscuous_mode - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Indicates whether promiscuous mode is allowed.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Determines if the portgroup should be present or not.
-
-
- switch - -
- string - / required -
- 		- -
vSwitch to modify.
-

aliases: switch_name, vswitch
-
-
- teaming - -
- dictionary -
- 		- -
Dictionary which configures the different teaming values for portgroup.
-

aliases: teaming_policy
-
-
- active_adapters - -
- list - / elements=string -
- 		- -
List of active adapters used for load balancing.
-
All vmnics are used as active adapters if active_adapters and standby_adapters are not defined.
-
-
- failback - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Indicate whether or not to use a failback when restoring links.
-
-
- load_balancing - -
- string -
- 		-
    Choices: -
  • loadbalance_ip
    • -
  • loadbalance_srcmac
    • -
  • loadbalance_srcid
    • -
  • failover_explicit
    • -
- 		-
Network adapter teaming policy.
-

aliases: load_balance_policy
-
-
- network_failure_detection - -
- string -
- 		-
    Choices: -
  • link_status_only
    • -
  • beacon_probing
    • -
- 		-
Network failure detection.
-
-
- notify_switches - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Indicate whether or not to notify the physical switch if a link fails.
-
-
- standby_adapters - -
- list - / elements=string -
- 		- -
List of standby adapters used for failover.
-
All vmnics are used as active adapters if active_adapters and standby_adapters are not defined.
-
-
- traffic_shaping - -
- dictionary -
- 		- -
Dictionary which configures traffic shaping for the switch.
-
-
- average_bandwidth - -
- integer -
- 		- -
Average bandwidth (kbit/s).
-
-
- burst_size - -
- integer -
- 		- -
Burst size (KB).
-
-
- enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Status of Traffic Shaping Policy.
-
-
- peak_bandwidth - -
- integer -
- 		- -
Peak bandwidth (kbit/s).
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- vlan_id - -
- integer -
- 		- Default:
0
- 		-
VLAN ID to assign to portgroup.
-
Set to 0 (no VLAN tagging) by default.
-

aliases: vlan
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Add Management Network VM Portgroup - community.vmware.vmware_portgroup: - hostname: "{{ esxi_hostname }}" - username: "{{ esxi_username }}" - password: "{{ esxi_password }}" - switch: "{{ vswitch_name }}" - portgroup: "{{ portgroup_name }}" - vlan_id: "{{ vlan_id }}" - delegate_to: localhost - - - name: Add Portgroup with Promiscuous Mode Enabled - community.vmware.vmware_portgroup: - hostname: "{{ esxi_hostname }}" - username: "{{ esxi_username }}" - password: "{{ esxi_password }}" - switch: "{{ vswitch_name }}" - portgroup: "{{ portgroup_name }}" - security: - promiscuous_mode: true - delegate_to: localhost - - - name: Add Management Network VM Portgroup to specific hosts - community.vmware.vmware_portgroup: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - hosts: [esxi_hostname_one] - switch: "{{ vswitch_name }}" - portgroup: "{{ portgroup_name }}" - vlan_id: "{{ vlan_id }}" - delegate_to: localhost - - - name: Add Management Network VM Portgroup to all hosts in a cluster - community.vmware.vmware_portgroup: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - cluster_name: "{{ cluster_name }}" - switch: "{{ vswitch_name }}" - portgroup: "{{ portgroup_name }}" - vlan_id: "{{ vlan_id }}" - delegate_to: localhost - - - name: Remove Management Network VM Portgroup to all hosts in a cluster - community.vmware.vmware_portgroup: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - cluster_name: "{{ cluster_name }}" - switch: "{{ vswitch_name }}" - portgroup: "{{ portgroup_name }}" - vlan_id: "{{ vlan_id }}" - state: absent - delegate_to: localhost - - - name: Add Portgroup with all settings defined - community.vmware.vmware_portgroup: - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - esxi_hostname: "{{ inventory_hostname }}" - switch: "{{ vswitch_name }}" - portgroup: "{{ portgroup_name }}" - vlan_id: 10 - security: - promiscuous_mode: false - mac_changes: false - forged_transmits: false - traffic_shaping: - enabled: true - average_bandwidth: 100000 - peak_bandwidth: 100000 - burst_size: 102400 - teaming: - load_balancing: failover_explicit - network_failure_detection: link_status_only - notify_switches: true - failback: true - active_adapters: - - vmnic0 - standby_adapters: - - vmnic1 - delegate_to: localhost - register: teaming_result - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- result - -
- dictionary -
- 		always -
metadata about the portgroup
-
-
Sample:
-
{'esxi01.example.com': {'changed': True, 'failback': 'No override', 'failover_active': 'No override', 'failover_standby': 'No override', 'failure_detection': 'No override', 'load_balancing': 'No override', 'msg': 'Port Group added', 'notify_switches': 'No override', 'portgroup': 'vMotion', 'sec_forged_transmits': False, 'sec_mac_changes': False, 'sec_promiscuous_mode': False, 'traffic_shaping': 'No override', 'vlan_id': 33, 'vswitch': 'vSwitch1'}}
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Joseph Callen (@jcpowermac) -- Russell Teague (@mtnbikenc) -- Abhijeet Kasurde (@Akasurde) -- Christian Kotte (@ckotte) diff --git a/docs/community.vmware.vmware_resource_pool_module.rst b/docs/community.vmware.vmware_resource_pool_module.rst deleted file mode 100644 index 11748a5fc..000000000 --- a/docs/community.vmware.vmware_resource_pool_module.rst +++ /dev/null @@ -1,571 +0,0 @@ -.. _community.vmware.vmware_resource_pool_module: - - -************************************* -community.vmware.vmware_resource_pool -************************************* - -**Add/remove resource pools to/from vCenter** - - - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- This module can be used to add/remove a resource pool to/from vCenter - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster - -
- string -
- 		- -
Name of the cluster to configure the resource pool.
-
This parameter is required if esxi_hostname or parent_resource_pool is not specified.
-
The cluster, esxi_hostname and parent_resource_pool parameters are mutually exclusive.
-
-
- cpu_allocation_shares - -
- integer -
- 		- Default:
4000
- 		-
The number of cpu shares allocated.
-
This value is only set if cpu_shares is set to custom.
-
-
- cpu_expandable_reservations - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
In a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value.
-
-
- cpu_limit - -
- integer -
- 		- Default:
-1
- 		-
The utilization of a virtual machine/resource pool will not exceed this limit, even if there are available resources.
-
The default value -1 indicates no limit.
-
-
- cpu_reservation - -
- integer -
- 		- Default:
0
- 		-
Amount of resource that is guaranteed available to the virtual machine or resource pool.
-
-
- cpu_shares - -
- string -
- 		-
    Choices: -
  • high
    • -
  • custom
    • -
  • low
    • -
  • normal ←
    • -
- 		-
Memory shares are used in case of resource contention.
-
-
- datacenter - -
- string - / required -
- 		- -
Name of the datacenter.
-
-
- esxi_hostname - -
- string -
- 		- -
Name of the host to configure the resource pool.
-
The host must not be member of a cluster.
-
This parameter is required if cluster or parent_resource_pool is not specified.
-
The cluster, esxi_hostname and parent_resource_pool parameters are mutually exclusive.
-
-
- hostname - -
- string -
- 		- -
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 VMWARE_HOST will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- mem_allocation_shares - -
- integer -
- 		- Default:
163840
- 		-
The number of memory shares allocated.
-
This value is only set if mem_shares is set to custom.
-
-
- mem_expandable_reservations - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
In a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value.
-
-
- mem_limit - -
- integer -
- 		- Default:
-1
- 		-
The utilization of a virtual machine/resource pool will not exceed this limit, even if there are available resources.
-
The default value -1 indicates no limit.
-
-
- mem_reservation - -
- integer -
- 		- Default:
0
- 		-
Amount of resource that is guaranteed available to the virtual machine or resource pool.
-
-
- mem_shares - -
- string -
- 		-
    Choices: -
  • high
    • -
  • custom
    • -
  • low
    • -
  • normal ←
    • -
- 		-
Memory shares are used in case of resource contention.
-
-
- parent_resource_pool - -
- string -
- 		- -
Name of the parent resource pool.
-
This parameter is required if cluster or esxi_hostname is not specified.
-
The cluster, esxi_hostname and parent_resource_pool parameters are mutually exclusive.
-
-
- password - -
- string -
- 		- -
The password of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: pass, pwd
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
The port number of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
-
Environment variable support added in Ansible 2.6.
-
-
- proxy_host - -
- string -
- 		- -
Address of a proxy that will receive all HTTPS requests and relay them.
-
The format is a hostname or a IP.
-
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
-
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
-
-
- proxy_port - -
- integer -
- 		- -
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 VMWARE_PROXY_PORT will be used instead.
-
-
- resource_pool - -
- string - / required -
- 		- -
Resource pool name to manage.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Add or remove the resource pool
-
-
- username - -
- string -
- 		- -
The username of the vSphere vCenter or ESXi server.
-
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
-
Environment variable support added in Ansible 2.6.
-

aliases: admin, user
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
-
Environment variable support added in Ansible 2.6.
-
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
-
-
- - -Notes ------ - -.. note:: - - All modules requires API write access and hence is not supported on a free ESXi license. - - - -Examples --------- - -.. code-block:: yaml - - - name: Add resource pool to vCenter - community.vmware.vmware_resource_pool: - hostname: '{{ vcenter_hostname }}' - username: '{{ vcenter_username }}' - password: '{{ vcenter_password }}' - datacenter: '{{ datacenter_name }}' - cluster: '{{ cluster_name }}' - resource_pool: '{{ resource_pool_name }}' - mem_shares: normal - mem_limit: -1 - mem_reservation: 0 - mem_expandable_reservations: true - cpu_shares: normal - cpu_limit: -1 - cpu_reservation: 0 - cpu_expandable_reservations: true - state: present - delegate_to: localhost - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- instance - -
- dictionary -
- 		always -
metadata about the new resource pool
-
-
Sample:
-
None
-
-
- resource_pool_config - -
- dictionary -
- 		always -
config data about the resource pool, version added 1.4.0
-
-
Sample:
-
{ - "_vimtype": "vim.ResourceConfigSpec", - "changeVersion": null, - "cpuAllocation": { - "_vimtype": "vim.ResourceAllocationInfo", - "expandableReservation": true, - "limit": -1, - "overheadLimit": null, - "reservation": 0, - "shares": { - "_vimtype": "vim.SharesInfo", - "level": "normal", - "shares": 4000 - } - }, - "entity": "vim.ResourcePool:resgroup-1108", - "lastModified": null, - "memoryAllocation": { - "_vimtype": "vim.ResourceAllocationInfo", - "expandableReservation": true, - "limit": -1, - "overheadLimit": null, - "reservation": 0, - "shares": { - "_vimtype": "vim.SharesInfo", - "level": "high", - "shares": 327680 - } - }, - "name": "test_pr1", - "scaleDescendantsShares": null - }
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Davis Phillips (@dav1x)