diff --git a/plugins/modules/vcenter_domain_user_group_info.py b/plugins/modules/vcenter_domain_user_group_info.py index 4200784ecd..9992f00cc8 100644 --- a/plugins/modules/vcenter_domain_user_group_info.py +++ b/plugins/modules/vcenter_domain_user_group_info.py @@ -37,17 +37,17 @@ type: str exact_match: description: - - If I(exact_match) is C(true), it indicates the I(search_string) passed should match a user or group name exactly. + - If V(true), it indicates the O(search_string) passed should match a user or group name exactly. type: bool default: false find_users: description: - - If I(find_users) is C(true), domain users will be included in the result. + - If V(true), domain users will be included in the result. type: bool default: true find_groups: description: - - If I(find_groups) is C(true), domain groups will be included in the result. + - If V(true), domain groups will be included in the result. type: bool default: true extends_documentation_fragment: diff --git a/plugins/modules/vcenter_extension.py b/plugins/modules/vcenter_extension.py index cca92fcaea..f877d6bfb7 100644 --- a/plugins/modules/vcenter_extension.py +++ b/plugins/modules/vcenter_extension.py @@ -30,36 +30,36 @@ type: str name: description: - - Required for C(state=present). The name of the extension you are installing. + - Required for O(state=present). The name of the extension you are installing. type: str company: description: - - Required for C(state=present). The name of the company that makes the extension. + - Required for O(state=present). The name of the company that makes the extension. type: str description: description: - - Required for C(state=present). A short description of the extension. + - Required for O(state=present). A short description of the extension. type: str email: description: - - Required for C(state=present). Administrator email to use for extension. + - Required for O(state=present). Administrator email to use for extension. type: str url: description: - - Required for C(state=present). Link to server hosting extension zip file to install. + - Required for O(state=present). Link to server hosting extension zip file to install. type: str ssl_thumbprint: description: - - Required for C(state=present). SSL thumbprint of the extension hosting server. + - Required for O(state=present). SSL thumbprint of the extension hosting server. type: str server_type: description: - - Required for C(state=present). Type of server being used to install the extension (SOAP, REST, HTTP, etc.). + - Required for O(state=present). Type of server being used to install the extension (SOAP, REST, HTTP, etc.). default: vsphere-client-serenity type: str client_type: description: - - Required for C(state=present). Type of client the extension is (win32, .net, linux, etc.). + - Required for O(state=present). Type of client the extension is (win32, .net, linux, etc.). default: vsphere-client-serenity type: str visible: diff --git a/plugins/modules/vcenter_folder.py b/plugins/modules/vcenter_folder.py index 149e3ed33a..7103e62851 100644 --- a/plugins/modules/vcenter_folder.py +++ b/plugins/modules/vcenter_folder.py @@ -45,12 +45,12 @@ folder_type: description: - This is type of folder. - - "If set to C(vm), then 'VM and Template Folder' is created under datacenter." - - "If set to C(host), then 'Host and Cluster Folder' is created under datacenter." - - "If set to C(datastore), then 'Storage Folder' is created under datacenter." - - "If set to C(network), then 'Network Folder' is created under datacenter." - - This parameter is required, if C(state) is set to C(present) and parent_folder is absent. - - This option is ignored, if C(parent_folder) is set. + - "If set to V(vm), then 'VM and Template Folder' is created under datacenter." + - "If set to V(host), then 'Host and Cluster Folder' is created under datacenter." + - "If set to V(datastore), then 'Storage Folder' is created under datacenter." + - "If set to V(network), then 'Network Folder' is created under datacenter." + - This parameter is required, if O(state=absent) and O(parent_folder) is not set. + - This option is ignored, if O(parent_folder) is set. default: vm type: str required: false @@ -58,9 +58,9 @@ state: description: - State of folder. - - If set to C(present) without parent folder parameter, then folder with C(folder_type) is created. - - If set to C(present) with parent folder parameter, then folder in created under parent folder. C(folder_type) is ignored. - - If set to C(absent), then folder is unregistered and destroyed. + - If set to V(present) without parent folder parameter, then folder with V(folder_type) is created. + - If set to V(present) with parent folder parameter, then folder in created under parent folder. V(folder_type) is ignored. + - If set to V(absent), then folder is unregistered and destroyed. default: present choices: [ present, absent ] type: str diff --git a/plugins/modules/vcenter_license.py b/plugins/modules/vcenter_license.py index 6836d03e0c..c7e09d3e5a 100644 --- a/plugins/modules/vcenter_license.py +++ b/plugins/modules/vcenter_license.py @@ -31,7 +31,7 @@ type: str state: description: - - Whether to add (C(present)) or remove (C(absent)) the license key. + - Whether to add (V(present)) or remove (V(absent)) the license key. choices: [absent, present] default: present type: str @@ -54,9 +54,9 @@ an evaluation license only. - The evaluation license (00000-00000-00000-00000-00000) is not listed when unused. -- If C(esxi_hostname) is specified, then will assign the C(license) key to +- If O(esxi_hostname) is specified, then will assign the O(license) key to the ESXi host. -- If C(esxi_hostname) is not specified, then will just register the C(license) key to +- If O(esxi_hostname) is not specified, then will just register the O(license) key to vCenter inventory without assigning it to an ESXi host. extends_documentation_fragment: - community.vmware.vmware.vcenter_documentation diff --git a/plugins/modules/vcenter_standard_key_provider.py b/plugins/modules/vcenter_standard_key_provider.py index f931ebf38c..8ce8f48c6b 100644 --- a/plugins/modules/vcenter_standard_key_provider.py +++ b/plugins/modules/vcenter_standard_key_provider.py @@ -27,14 +27,14 @@ required: true mark_default: description: - - Set specified Key Provider with name C(name) as the default Key Provider. + - Set specified Key Provider with name O(name) as the default Key Provider. - If new added Key Provider is the only key provider in vCenter, then will mark it as default after adding. type: bool default: false state: description: - - If set to C(absent), the named Key Provider will be removed from vCenter. - - If set to C(present), the named existing Key Provider will be reconfigured or new Key Provider will be added. + - If set to V(absent), the named Key Provider will be removed from vCenter. + - If set to V(present), the named existing Key Provider will be reconfigured or new Key Provider will be added. type: str choices: - present @@ -43,9 +43,9 @@ kms_info: description: - The information of an external key server (KMS). - - C(kms_name), C(kms_ip) are required when adding a Standard Key Provider. - - If C(kms_port) is not specified, the default port 5696 will be used. - - C(kms_ip), C(kms_port) can be reconfigured for an existing KMS with name C(kms_name). + - O(kms_info.kms_name), O(kms_info.kms_ip) are required when adding a Standard Key Provider. + - If O(kms_info.kms_port) is not specified, the default port 5696 will be used. + - O(kms_info.kms_ip), O(kms_info.kms_port) can be reconfigured for an existing KMS with name O(kms_info.kms_name). type: list default: [] elements: dict @@ -60,7 +60,7 @@ description: Port of the external KMS. type: int remove_kms: - description: Remove the configured KMS with name C(kms_name) from the KMIP cluster. + description: Remove the configured KMS with name O(kms_info.kms_name) from the KMIP cluster. type: bool proxy_server: description: Address of the proxy server to connect to KMS. @@ -79,10 +79,10 @@ - After adding the Standard Key Provider to the vCenter Server, you can establish a trusted connection, the exact process depends on the certificates that the key provider accepts, and on your company policy. - Three methods implemented here, - (1) upload client certificate and private key through C(upload_client_cert) and C(upload_client_key) parameters, - (2) generate, update, download vCenter self signed certificate through C(download_self_signed_cert) parameter, - (3) download generated Certificate Signing Request(CSR) through C(download_client_csr) parameter, send it to - KMS then upload the KMS signed CSR through C(upload_kms_signed_client_csr) parameter. + (1) upload client certificate and private key through O(make_kms_trust_vc.upload_client_cert) and O(make_kms_trust_vc.upload_client_key) parameters, + (2) generate, update, download vCenter self signed certificate through O(make_kms_trust_vc.download_self_signed_cert) parameter, + (3) download generated Certificate Signing Request(CSR) through O(make_kms_trust_vc.download_client_csr) parameter, send it to + KMS then upload the KMS signed CSR through O(make_kms_trust_vc.upload_kms_signed_client_csr) parameter. - This is not set to be mandatory, if not set, please go to vCenter to setup trust connection with KMS manually. type: dict suboptions: @@ -93,7 +93,7 @@ - The certificate might be already trusted by the KMS server. type: path upload_client_key: - description: The absolute file path of client private key to be uploaded together with C(upload_client_cert). + description: The absolute file path of client private key to be uploaded together with O(make_kms_trust_vc.upload_client_cert). type: path download_self_signed_cert: description: The absolute path on local machine for keeping vCenter generated self signed client cert. @@ -101,10 +101,10 @@ download_client_csr: description: - The absolute path on local machine for keeping vCenter generated CSR. - - Then upload the KMS signed CSR using C(upload_kms_signed_client_csr) to vCenter. + - Then upload the KMS signed CSR using O(make_kms_trust_vc.upload_kms_signed_client_csr) to vCenter. type: path upload_kms_signed_client_csr: - description: The absolute file path of KMS signed CSR downloaded from C(download_client_csr). + description: The absolute file path of KMS signed CSR downloaded from O(make_kms_trust_vc.download_client_csr). type: path extends_documentation_fragment: - community.vmware.vmware.documentation diff --git a/plugins/modules/vmware_category.py b/plugins/modules/vmware_category.py index b64d94034d..3b47f6a772 100644 --- a/plugins/modules/vmware_category.py +++ b/plugins/modules/vmware_category.py @@ -31,8 +31,8 @@ category_description: description: - The category description. - - This is required only if C(state) is set to C(present). - - This parameter is ignored, when C(state) is set to C(absent). + - This is required if O(state=present). + - This parameter is ignored when O(state=absent). default: '' type: str category_cardinality: @@ -50,10 +50,10 @@ state: description: - The state of category. - - If set to C(present) and category does not exists, then category is created. - - If set to C(present) and category exists, then category is updated. - - If set to C(absent) and category exists, then category is deleted. - - If set to C(absent) and category does not exists, no action is taken. + - If set to V(present) and category does not exists, then category is created. + - If set to V(present) and category exists, then category is updated. + - If set to V(absent) and category exists, then category is deleted. + - If set to V(absent) and category does not exists, no action is taken. - Process of updating category only allows name, description change. default: 'present' choices: [ 'present', 'absent' ] diff --git a/plugins/modules/vmware_cfg_backup.py b/plugins/modules/vmware_cfg_backup.py index 1a3a78813b..60a6806411 100644 --- a/plugins/modules/vmware_cfg_backup.py +++ b/plugins/modules/vmware_cfg_backup.py @@ -29,9 +29,9 @@ type: str dest: description: - - The destination where the ESXi configuration bundle will be saved. The I(dest) can be a folder or a file. - - If I(dest) is a folder, the backup file will be saved in the folder with the default filename generated from the ESXi server. - - If I(dest) is a file, the backup file will be saved with that filename. The file extension will always be .tgz. + - The destination where the ESXi configuration bundle will be saved. Can be a folder or a file. + - If a folder, the backup file will be saved in the folder with the default filename generated from the ESXi server. + - If a file, the backup file will be saved with that filename. The file extension will always be .tgz. type: path src: description: @@ -39,9 +39,9 @@ type: path state: description: - - If C(saved), the .tgz backup bundle will be saved in I(dest). - - If C(absent), the host configuration will be reset to default values. - - If C(loaded), the backup file in I(src) will be loaded to the ESXi host rewriting the hosts settings. + - If V(saved), the .tgz backup bundle will be saved in O(dest). + - If V(absent), the host configuration will be reset to default values. + - If V(loaded), the backup file in O(src) will be loaded to the ESXi host rewriting the hosts settings. choices: [saved, absent, loaded] type: str required: true diff --git a/plugins/modules/vmware_cluster.py b/plugins/modules/vmware_cluster.py index 6007b2f087..479d31520e 100644 --- a/plugins/modules/vmware_cluster.py +++ b/plugins/modules/vmware_cluster.py @@ -16,7 +16,7 @@ short_description: Manage VMware vSphere clusters description: - Adds or removes VMware vSphere clusters. - - To manage DRS, HA and VSAN related configurations, use the new modules vmware_cluster_drs, vmware_cluster_ha and vmware_cluster_vsan. + - To manage DRS, HA and VSAN related configurations, use the modules vmware_cluster_drs, vmware_cluster_ha and vmware_cluster_vsan. - All values and VMware object names are case sensitive. author: - Joseph Callen (@jcpowermac) @@ -35,7 +35,7 @@ aliases: [ datacenter_name ] state: description: - - Create C(present) or remove C(absent) a VMware vSphere cluster. + - Create V(present) or remove V(absent) a VMware vSphere cluster. choices: [ absent, present ] default: present type: str diff --git a/plugins/modules/vmware_cluster_dpm.py b/plugins/modules/vmware_cluster_dpm.py index 5ba62b2f96..61551263c2 100644 --- a/plugins/modules/vmware_cluster_dpm.py +++ b/plugins/modules/vmware_cluster_dpm.py @@ -46,7 +46,7 @@ host_power_action_rate: description: - specify host power action rate - - 1 is the lowest and 5 the highest + - V(1) is the lowest and V(5) the highest type: int default: 3 choices: [1, 2, 3, 4, 5] diff --git a/plugins/modules/vmware_cluster_drs.py b/plugins/modules/vmware_cluster_drs.py index 8954ff1883..3027c29100 100644 --- a/plugins/modules/vmware_cluster_drs.py +++ b/plugins/modules/vmware_cluster_drs.py @@ -40,24 +40,24 @@ drs_enable_vm_behavior_overrides: description: - Whether DRS Behavior overrides for individual virtual machines are enabled. - - If set to C(true), overrides C(drs_default_vm_behavior). + - If set to V(true), overrides O(drs_default_vm_behavior). type: bool default: true drs_default_vm_behavior: description: - Specifies the cluster-wide default DRS behavior for virtual machines. - - If set to C(partiallyAutomated), vCenter generates recommendations for virtual machine migration and + - If set to V(partiallyAutomated), vCenter generates recommendations for virtual machine migration and for the placement with a host, then automatically implements placement recommendations at power on. - - If set to C(manual), then vCenter generates recommendations for virtual machine migration and + - If set to V(manual), then vCenter generates recommendations for virtual machine migration and for the placement with a host, but does not implement the recommendations automatically. - - If set to C(fullyAutomated), then vCenter automates both the migration of virtual machines + - If set to V(fullyAutomated), then vCenter automates both the migration of virtual machines and their placement with a host at power on. type: str default: fullyAutomated choices: [ fullyAutomated, manual, partiallyAutomated ] drs_vmotion_rate: description: - - Threshold for generated ClusterRecommendations ranging from 1 (lowest) to 5 (highest). + - Threshold for generated ClusterRecommendations ranging from V(1) (lowest) to V(5) (highest). type: int default: 3 choices: [ 1, 2, 3, 4, 5 ] diff --git a/plugins/modules/vmware_cluster_ha.py b/plugins/modules/vmware_cluster_ha.py index d9896caa24..1ad532d4ba 100644 --- a/plugins/modules/vmware_cluster_ha.py +++ b/plugins/modules/vmware_cluster_ha.py @@ -41,35 +41,35 @@ ha_host_monitoring: description: - Whether HA restarts virtual machines after a host fails. - - If set to C(enabled), HA restarts virtual machines after a host fails. - - If set to C(disabled), HA does not restart virtual machines after a host fails. - - If C(enable) is set to C(false), then this value is ignored. + - If set to V(enabled), HA restarts virtual machines after a host fails. + - If set to V(disabled), HA does not restart virtual machines after a host fails. + - If O(enable=false), this value is ignored. type: str choices: [ 'enabled', 'disabled' ] default: 'enabled' ha_vm_monitoring: description: - State of virtual machine health monitoring service. - - If set to C(vmAndAppMonitoring), HA response to both virtual machine and application heartbeat failure. - - If set to C(vmMonitoringDisabled), virtual machine health monitoring is disabled. - - If set to C(vmMonitoringOnly), HA response to virtual machine heartbeat failure. - - If C(enable) is set to C(false), then this value is ignored. + - If set to V(vmAndAppMonitoring), HA response to both virtual machine and application heartbeat failure. + - If set to V(vmMonitoringDisabled), virtual machine health monitoring is disabled. + - If set to V(vmMonitoringOnly), HA response to virtual machine heartbeat failure. + - If O(enable=false), then this value is ignored. type: str choices: ['vmAndAppMonitoring', 'vmMonitoringOnly', 'vmMonitoringDisabled'] default: 'vmMonitoringDisabled' host_isolation_response: description: - Indicates whether or VMs should be powered off if a host determines that it is isolated from the rest of the compute resource. - - If set to C(none), do not power off VMs in the event of a host network isolation. - - If set to C(powerOff), power off VMs in the event of a host network isolation. - - If set to C(shutdown), shut down VMs guest operating system in the event of a host network isolation. + - If set to V(none), do not power off VMs in the event of a host network isolation. + - If set to V(powerOff), power off VMs in the event of a host network isolation. + - If set to V(shutdown), shut down VMs guest operating system in the event of a host network isolation. type: str choices: ['none', 'powerOff', 'shutdown'] default: 'none' slot_based_admission_control: description: - Configure slot based admission control policy. - - C(slot_based_admission_control), C(reservation_based_admission_control) and C(failover_host_admission_control) are mutually exclusive. + - O(slot_based_admission_control), O(reservation_based_admission_control) and O(failover_host_admission_control) are mutually exclusive. suboptions: failover_level: description: @@ -80,7 +80,7 @@ reservation_based_admission_control: description: - Configure reservation based admission control policy. - - C(slot_based_admission_control), C(reservation_based_admission_control) and C(failover_host_admission_control) are mutually exclusive. + - O(slot_based_admission_control), O(reservation_based_admission_control) and O(failover_host_admission_control) are mutually exclusive. suboptions: failover_level: description: @@ -89,27 +89,29 @@ required: true auto_compute_percentages: description: - - By default, C(failover_level) is used to calculate C(cpu_failover_resources_percent) and C(memory_failover_resources_percent). + - By default, O(reservation_based_admission_control.failover_level) is used to calculate + O(reservation_based_admission_control.cpu_failover_resources_percent) + and O(reservation_based_admission_control.memory_failover_resources_percent). If a user wants to override the percentage values, he has to set this field to false. type: bool default: true cpu_failover_resources_percent: description: - Percentage of CPU resources in the cluster to reserve for failover. - Ignored if C(auto_compute_percentages) is not set to false. + Ignored if O(reservation_based_admission_control.auto_compute_percentages) is not set to false. type: int default: 50 memory_failover_resources_percent: description: - Percentage of memory resources in the cluster to reserve for failover. - Ignored if C(auto_compute_percentages) is not set to false. + Ignored if O(reservation_based_admission_control.auto_compute_percentages) is not set to false. type: int default: 50 type: dict failover_host_admission_control: description: - Configure dedicated failover hosts. - - C(slot_based_admission_control), C(reservation_based_admission_control) and C(failover_host_admission_control) are mutually exclusive. + - O(slot_based_admission_control), O(reservation_based_admission_control) and O(failover_host_admission_control) are mutually exclusive. suboptions: failover_hosts: description: @@ -122,7 +124,7 @@ description: - The number of seconds after which virtual machine is declared as failed if no heartbeat has been received. - - This setting is only valid if C(ha_vm_monitoring) is set to, either C(vmAndAppMonitoring) or C(vmMonitoringOnly). + - This setting is only valid if O(ha_vm_monitoring=vmAndAppMonitoring) or O(ha_vm_monitoring=vmMonitoringOnly). - Unit is seconds. type: int default: 30 @@ -130,22 +132,22 @@ description: - The number of seconds for the virtual machine's heartbeats to stabilize after the virtual machine has been powered on. - - Valid only when I(ha_vm_monitoring) is set to either C(vmAndAppMonitoring) or C(vmMonitoringOnly). + - Valid only when O(ha_vm_monitoring=vmAndAppMonitoring) or O(ha_vm_monitoring=vmMonitoringOnly). - Unit is seconds. type: int default: 120 ha_vm_max_failures: description: - Maximum number of failures and automated resets allowed during the time - that C(ha_vm_max_failure_window) specifies. - - Valid only when I(ha_vm_monitoring) is set to either C(vmAndAppMonitoring) or C(vmMonitoringOnly). + that O(ha_vm_max_failure_window) specifies. + - Valid only when O(ha_vm_monitoring=vmAndAppMonitoring) or O(ha_vm_monitoring=vmMonitoringOnly). type: int default: 3 ha_vm_max_failure_window: description: - - The number of seconds for the window during which up to C(ha_vm_max_failures) resets + - The number of seconds for the window during which up to O(ha_vm_max_failures) resets can occur before automated responses stop. - - Valid only when I(ha_vm_monitoring) is set to either C(vmAndAppMonitoring) or C(vmMonitoringOnly). + - Valid only when O(ha_vm_monitoring=vmAndAppMonitoring) or O(ha_vm_monitoring=vmMonitoringOnly). - Unit is seconds. - Default specifies no failure window. type: int @@ -154,13 +156,13 @@ description: - Priority HA gives to a virtual machine if sufficient capacity is not available to power on all failed virtual machines. - - Valid only if I(ha_vm_monitoring) is set to either C(vmAndAppMonitoring) or C(vmMonitoringOnly). - - If set to C(disabled), then HA is disabled for this virtual machine. - - If set to C(high), then virtual machine with this priority have a higher chance of powering on after a failure, + - Valid only when O(ha_vm_monitoring=vmAndAppMonitoring) or O(ha_vm_monitoring=vmMonitoringOnly). + - If set to V(disabled), then HA is disabled for this virtual machine. + - If set to V(high), then virtual machine with this priority have a higher chance of powering on after a failure, when there is insufficient capacity on hosts to meet all virtual machine needs. - - If set to C(medium), then virtual machine with this priority have an intermediate chance of powering on after a failure, + - If set to V(medium), then virtual machine with this priority have an intermediate chance of powering on after a failure, when there is insufficient capacity on hosts to meet all virtual machine needs. - - If set to C(low), then virtual machine with this priority have a lower chance of powering on after a failure, + - If set to V(low), then virtual machine with this priority have a lower chance of powering on after a failure, when there is insufficient capacity on hosts to meet all virtual machine needs. type: str default: 'medium' @@ -179,18 +181,16 @@ apd_delay: description: - The response recovery delay time in sec for storage failures categorized as All Paths Down (APD). - - Only set if C(apd_response) is C(restartConservative) or C(restartAggressive). + - Only set if O(apd_response=restartConservative) or O(apd_response=restartAggressive). type: int default: 180 - version_added: '2.9.0' apd_reaction: description: - VM response recovery reaction for storage failures categorized as All Paths Down (APD). - - Only set if C(apd_response) is C(restartConservative) or C(restartAggressive). + - Only set if O(apd_response=restartConservative) or O(apd_response=restartAggressive). type: str default: 'reset' choices: [ 'reset', 'none' ] - version_added: '2.9.0' pdl_response: description: - VM storage protection setting for storage failures categorized as Permenant Device Loss (PDL). diff --git a/plugins/modules/vmware_cluster_info.py b/plugins/modules/vmware_cluster_info.py index f078abe73d..5830345264 100644 --- a/plugins/modules/vmware_cluster_info.py +++ b/plugins/modules/vmware_cluster_info.py @@ -24,26 +24,26 @@ datacenter: description: - Datacenter to search for cluster/s. - - This parameter is required, if C(cluster_name) is not supplied. + - This parameter is required, if O(cluster_name) is not supplied. required: false type: str cluster_name: description: - Name of the cluster. - If set, information of this cluster will be returned. - - This parameter is required, if C(datacenter) is not supplied. + - This parameter is required, if O(datacenter) is not supplied. required: false type: str show_tag: description: - - Tags related to cluster are shown if set to C(true). + - Tags related to cluster are shown if set to V(true). default: false type: bool schema: description: - Specify the output schema desired. - - The 'summary' output schema is the legacy output from the module. - - The 'vsphere' output schema is the vSphere API class definition which requires pyvmomi>6.7.1. + - The V(summary) output schema is the legacy output from the module. + - The V(vsphere) output schema is the vSphere API class definition which requires pyvmomi>6.7.1. choices: ['summary', 'vsphere'] default: 'summary' type: str @@ -56,7 +56,7 @@ - ' "configuration.dasConfig.enabled",' - ' "summary.totalCpu"' - ' ]' - - Only valid when C(schema) is C(vsphere). + - Only valid when O(schema=vsphere). type: list elements: str extends_documentation_fragment: diff --git a/plugins/modules/vmware_cluster_vsan.py b/plugins/modules/vmware_cluster_vsan.py index a78aa15755..9f82aada8d 100644 --- a/plugins/modules/vmware_cluster_vsan.py +++ b/plugins/modules/vmware_cluster_vsan.py @@ -57,7 +57,7 @@ disable_site_read_locality: description: - For vSAN stretched clusters, reads to vSAN objects occur on the site the VM resides on. - - Setting to C(true) will force reads across all mirrors. + - Setting to V(true) will force reads across all mirrors. type: bool large_cluster_support: description: @@ -69,7 +69,7 @@ type: int thin_swap: description: - - When C(enabled), swap objects would not reserve 100% space of their size on vSAN datastore. + - When V(true), swap objects would not reserve 100% space of their size on vSAN datastore. type: bool type: dict extends_documentation_fragment: diff --git a/plugins/modules/vmware_content_deploy_template.py b/plugins/modules/vmware_content_deploy_template.py index 6a10d7daa9..3e0603373e 100644 --- a/plugins/modules/vmware_content_deploy_template.py +++ b/plugins/modules/vmware_content_deploy_template.py @@ -58,7 +58,7 @@ datastore: description: - Name of the datastore to store deployed VM and disk. - - Required if I(datastore_cluster) is not provided. + - Required if O(datastore_cluster) is not provided. type: str required: false datastore_cluster: @@ -66,7 +66,7 @@ - Name of the datastore cluster to store deployed VM and disk. - Please make sure Storage DRS is active for recommended datastore from the given datastore cluster. - If Storage DRS is not enabled, datastore with largest free storage space is selected. - - Required if I(datastore) is not provided. + - Required if O(datastore) is not provided. type: str required: false folder: @@ -78,31 +78,31 @@ description: - Name of the ESX Host in datacenter in which to place deployed VM. - The host has to be a member of the cluster that contains the resource pool. - - Required with I(resource_pool) to find resource pool details. This will be used as additional + - Required with O(resource_pool) to find resource pool details. This will be used as additional information when there are resource pools with same name. type: str required: false resource_pool: description: - Name of the resource pool in datacenter in which to place deployed VM. - - Required if I(cluster) is not specified. - - For default or non-unique resource pool names, specify I(host) and I(cluster). + - Required if O(cluster) is not specified. + - For default or non-unique resource pool names, specify O(host) and O(cluster). - C(Resources) is the default name of resource pool. type: str required: false cluster: description: - Name of the cluster in datacenter in which to place deployed VM. - - Required if I(resource_pool) is not specified. + - Required if O(resource_pool) is not specified. type: str required: false state: description: - The state of Virtual Machine deployed from template in content library. - - If set to C(present) and VM does not exists, then VM is created. - - If set to C(present) and VM exists, no action is taken. - - If set to C(poweredon) and VM does not exists, then VM is created with powered on state. - - If set to C(poweredon) and VM exists, no action is taken. + - If set to V(present) and VM does not exists, then VM is created. + - If set to V(present) and VM exists, no action is taken. + - If set to V(poweredon) and VM does not exists, then VM is created with powered on state. + - If set to V(poweredon) and VM exists, no action is taken. type: str required: false default: 'present' diff --git a/plugins/modules/vmware_content_library_manager.py b/plugins/modules/vmware_content_library_manager.py index 4b52b6cd1f..932b77b6d0 100644 --- a/plugins/modules/vmware_content_library_manager.py +++ b/plugins/modules/vmware_content_library_manager.py @@ -31,16 +31,16 @@ library_description: description: - The content library description. - - This is required only if I(state) is set to C(present). - - This parameter is ignored, when I(state) is set to C(absent). + - This is required only if O(state=present). + - This parameter is ignored, when O(state=absent). - Process of updating content library only allows description change. type: str required: false library_type: description: - The content library type. - - This is required only if I(state) is set to C(present). - - This parameter is ignored, when I(state) is set to C(absent). + - This is required only if O(state=resent). + - This parameter is ignored, when O(state=absent). type: str required: false default: 'local' @@ -48,8 +48,8 @@ datastore_name: description: - Name of the datastore on which backing content library is created. - - This is required only if I(state) is set to C(present). - - This parameter is ignored, when I(state) is set to C(absent). + - This is required if O(state=present). + - This parameter is ignored, when O(state=absent). - Currently only datastore backing creation is supported. type: str required: false @@ -57,16 +57,16 @@ subscription_url: description: - The url of the content library to subscribe to. - - This is required only if I(library_type) is set to C(subscribed). - - This parameter is ignored, when I(state) is set to C(absent). + - This is required if O(library_type=subscribed). + - This parameter is ignored, when O(state=absent). type: str default: '' required: false ssl_thumbprint: description: - The SHA1 SSL thumbprint of the subscribed content library to subscribe to. - - This is required only if I(library_type) is set to C(subscribed) and the library is https. - - This parameter is ignored, when I(state) is set to C(absent). + - This is required if O(library_type=subscribed) and the library is https. + - This parameter is ignored, when O(state=absent). - 'The information can be extracted using openssl using the following example: C(echo | openssl s_client -connect test-library.com:443 |& openssl x509 -fingerprint -noout)' type: str @@ -75,19 +75,19 @@ update_on_demand: description: - Whether to download all content on demand. - - If set to C(true), all content will be downloaded on demand. - - If set to C(false) content will be downloaded ahead of time. - - This is required only if I(library_type) is set to C(subscribed). - - This parameter is ignored, when I(state) is set to C(absent). + - If set to V(true), all content will be downloaded on demand. + - If set to V(false) content will be downloaded ahead of time. + - This is required if O(library_type=subscribed). + - This parameter is ignored, when O(state=absent). type: bool default: false state: description: - The state of content library. - - If set to C(present) and library does not exists, then content library is created. - - If set to C(present) and library exists, then content library is updated. - - If set to C(absent) and library exists, then content library is deleted. - - If set to C(absent) and library does not exists, no action is taken. + - If set to V(present) and library does not exists, then content library is created. + - If set to V(present) and library exists, then content library is updated. + - If set to V(absent) and library exists, then content library is deleted. + - If set to V(absent) and library does not exists, no action is taken. type: str required: false default: 'present' diff --git a/plugins/modules/vmware_custom_attribute.py b/plugins/modules/vmware_custom_attribute.py index 618aa6fe09..2d33ba254e 100644 --- a/plugins/modules/vmware_custom_attribute.py +++ b/plugins/modules/vmware_custom_attribute.py @@ -43,10 +43,10 @@ state: description: - Manage definition of custom attributes. - - If set to C(present) and definition not present, then custom attribute definition is created. - - If set to C(present) and definition is present, then no action taken. - - If set to C(absent) and definition is present, then custom attribute definition is removed. - - If set to C(absent) and definition is absent, then no action taken. + - If set to V(present) and definition not present, then custom attribute definition is created. + - If set to V(present) and definition is present, then no action taken. + - If set to V(absent) and definition is present, then custom attribute definition is removed. + - If set to V(absent) and definition is absent, then no action taken. default: 'present' choices: ['present', 'absent'] type: str diff --git a/plugins/modules/vmware_custom_attribute_manager.py b/plugins/modules/vmware_custom_attribute_manager.py index 65ad207c42..0eef521824 100644 --- a/plugins/modules/vmware_custom_attribute_manager.py +++ b/plugins/modules/vmware_custom_attribute_manager.py @@ -22,7 +22,7 @@ custom_attributes: description: - A list of name and value of custom attributes that needs to be manage. - - Value of custom attribute is not required and will be ignored, if C(state) is set to C(absent). + - Value of custom attribute is not required and will be ignored if O(state=absent). suboptions: name: description: @@ -59,8 +59,8 @@ required: true state: description: - - If set to C(present), the custom attribute is set to the given value. - - If set to C(absent), the custom attribute is cleared. The given value is ignored in this case. + - If set to V(present), the custom attribute is set to the given value. + - If set to V(absent), the custom attribute is cleared. The given value is ignored in this case. default: 'present' choices: ['present', 'absent'] type: str diff --git a/plugins/modules/vmware_datacenter_info.py b/plugins/modules/vmware_datacenter_info.py index de1f7addf9..3b8dfc878b 100644 --- a/plugins/modules/vmware_datacenter_info.py +++ b/plugins/modules/vmware_datacenter_info.py @@ -28,8 +28,8 @@ schema: description: - Specify the output schema desired. - - The 'summary' output schema is the legacy output from the module. - - The 'vsphere' output schema is the vSphere API class definition which requires pyvmomi>6.7.1. + - The V(summary) output schema is the legacy output from the module. + - The V(vsphere) output schema is the vSphere API class definition which requires pyvmomi>6.7.1. choices: ['summary', 'vsphere'] default: 'summary' type: str @@ -42,12 +42,12 @@ - ' properties: [' - ' "overallStatus"' - ' ]' - - Only valid when C(schema) is C(vsphere). + - Only valid when O(schema=vsphere). type: list elements: str show_tag: description: - - Tags related to Datacenter are shown if set to C(true). + - Tags related to Datacenter are shown if set to V(true). default: false type: bool extends_documentation_fragment: diff --git a/plugins/modules/vmware_datastore_maintenancemode.py b/plugins/modules/vmware_datastore_maintenancemode.py index df14e4bda8..079bdbeb45 100644 --- a/plugins/modules/vmware_datastore_maintenancemode.py +++ b/plugins/modules/vmware_datastore_maintenancemode.py @@ -22,25 +22,25 @@ datastore: description: - Name of datastore to manage. - - If C(datastore_cluster) or C(cluster_name) are not set, this parameter is required. + - If O(datastore_cluster) or O(cluster_name) are not set, this parameter is required. type: str datastore_cluster: description: - Name of the datastore cluster from all child datastores to be managed. - - If C(datastore) or C(cluster_name) are not set, this parameter is required. + - If O(datastore) or O(cluster_name) are not set, this parameter is required. type: str cluster_name: description: - Name of the cluster where datastore is connected to. - - If multiple datastores are connected to the given cluster, then all datastores will be managed by C(state). - - If C(datastore) or C(datastore_cluster) are not set, this parameter is required. + - If multiple datastores are connected to the given cluster, then all datastores will be managed by O(state). + - If O(datastore) or O(datastore_cluster) are not set, this parameter is required. type: str state: description: - - If set to C(present), then enter datastore into maintenance mode. - - If set to C(present) and datastore is already in maintenance mode, then no action will be taken. - - If set to C(absent) and datastore is in maintenance mode, then exit maintenance mode. - - If set to C(absent) and datastore is not in maintenance mode, then no action will be taken. + - If set to V(present), then enter datastore into maintenance mode. + - If set to V(present) and datastore is already in maintenance mode, then no action will be taken. + - If set to V(absent) and datastore is in maintenance mode, then exit maintenance mode. + - If set to V(absent) and datastore is not in maintenance mode, then no action will be taken. choices: [ present, absent ] default: present required: false diff --git a/plugins/modules/vmware_deploy_ovf.py b/plugins/modules/vmware_deploy_ovf.py index cdd9346302..b5ca28193f 100644 --- a/plugins/modules/vmware_deploy_ovf.py +++ b/plugins/modules/vmware_deploy_ovf.py @@ -34,15 +34,15 @@ cluster: description: - Cluster to deploy to. - - This is a required parameter, if C(esxi_hostname) is not set and C(hostname) is set to the vCenter server. - - C(esxi_hostname) and C(cluster) are mutually exclusive parameters. + - This is a required parameter, if O(esxi_hostname) is not set and O(hostname) is set to the vCenter server. + - O(esxi_hostname) and O(cluster) are mutually exclusive parameters. - This parameter is case sensitive. type: str esxi_hostname: description: - The ESXi hostname where the virtual machine will run. - - This is a required parameter, if C(cluster) is not set and C(hostname) is set to the vCenter server. - - C(esxi_hostname) and C(cluster) are mutually exclusive parameters. + - This is a required parameter, if O(cluster) is not set and O(hostname) is set to the vCenter server. + - O(esxi_hostname) and O(cluster) are mutually exclusive parameters. - This parameter is case sensitive. type: str datastore: @@ -109,16 +109,16 @@ ovf: description: - 'Path to OVF or OVA file to deploy.' - - This is a required parameter, if C(ovf) is not set and C(url) parameter must be set. - - C(ovf) and C(url) are mutually exclusive parameters. + - Required if O(url) is not set. + - O(ovf) and O(url) are mutually exclusive parameters. aliases: - ova type: path url: description: - 'URL for OVA file to deploy.' - - This is a required parameter, if C(url) is not set and C(ovf) parameter must be set. - - C(url) and C(ovf) are mutually exclusive parameters. + - Required if O(ovf) is not set. + - O(url) and O(ovf) are mutually exclusive parameters. type: str version_added: '3.9.0' power_on: