Implement semantic markup (3)

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:

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:

plugins/modules/vcenter_folder.py

@@ -45,22 +45,22 @@
   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
     choices: [ datastore, host, network, vm ]
   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

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

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,18 +93,18 @@
           - 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.
         type: path
       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

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' ]

plugins/modules/vmware_cfg_backup.py

@@ -29,19 +29,19 @@
         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:
             - The file containing the ESXi configuration that will be restored.
         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

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

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]

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 ]