Issue 1660 part 6 (#1671)

Issue 1660 part 6

SUMMARY
Follow-up to #1669
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
various
ADDITIONAL INFORMATION
#1660

plugins/doc_fragments/vmware_rest_client.py

@@ -33,7 +33,7 @@ class ModuleDocFragment(object):
   validate_certs:
     description:
     - Allows connection when SSL certificates are not valid.
-    - Set to C(False) when certificates are not trusted.
+    - Set to C(false) when certificates are not trusted.
     - If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead.
     type: bool
     default: true

plugins/inventory/vmware_vm_inventory.py

@@ -98,7 +98,7 @@
         with_nested_properties:
             description:
             - This option transform flatten properties name to nested dictionary.
-            - From 1.10.0 and onwards, default value is set to C(True).
+            - From 1.10.0 and onwards, default value is set to C(true).
             type: bool
             default: true
         keyed_groups:

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 I(exact_match) is C(true), it indicates the I(search_string) passed should match a user or group name exactly.
     type: bool
     default: false
   find_users:
     description:
-      - If I(find_users) is C(True), domain users will be included in the result.
+      - If I(find_users) is C(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 I(find_groups) is C(true), domain groups will be included in the result.
     type: bool
     default: true
 extends_documentation_fragment:

plugins/modules/vmware_cluster_drs.py

@@ -40,7 +40,7 @@
     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 C(true), overrides C(drs_default_vm_behavior).
       type: bool
       default: true
     drs_default_vm_behavior:

plugins/modules/vmware_cluster_ha.py

@@ -43,7 +43,7 @@
       - 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 C(enable) is set to C(false), then this value is ignored.
       type: str
       choices: [ 'enabled', 'disabled' ]
       default: 'enabled'
@@ -53,7 +53,7 @@
       - 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 C(enable) is set to C(false), then this value is ignored.
       type: str
       choices: ['vmAndAppMonitoring', 'vmMonitoringOnly', 'vmMonitoringDisabled']
       default: 'vmMonitoringDisabled'

plugins/modules/vmware_cluster_info.py

@@ -36,7 +36,7 @@
      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 C(true).
     default: false
     type: bool
    schema:

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 C(true) will force reads across all mirrors.
           type: bool
         large_cluster_support:
           description:

plugins/modules/vmware_content_library_manager.py

@@ -75,8 +75,8 @@
     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.
+      - 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).
       type: bool

plugins/modules/vmware_datacenter_info.py

@@ -47,7 +47,7 @@
       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 C(true).
       default: false
       type: bool
 extends_documentation_fragment:

plugins/modules/vmware_datastore_info.py

@@ -65,7 +65,7 @@
      type: str
    show_tag:
      description:
-     - Tags related to Datastore are shown if set to C(True).
+     - Tags related to Datastore are shown if set to C(true).
      default: false
      type: bool
    properties:

plugins/modules/vmware_guest.py

@@ -621,7 +621,7 @@
         existing_vm:
             type: bool
             description:
-            - If set to C(True), do OS customization on the specified virtual machine directly.
+            - If set to C(true), do OS customization on the specified virtual machine directly.
             - Common for Linux and Windows customization.
         dns_servers:
             type: list
@@ -678,7 +678,7 @@
             description:
             - Number of autologon after reboot.
             - Specific to Windows customization.
-            - Ignored if C(autologon) is unset or set to C(False).
+            - Ignored if C(autologon) is unset or set to C(false).
             - If unset, 1 will be used.
         domainadmin:
             type: str

plugins/modules/vmware_guest_boot_manager.py

@@ -63,18 +63,18 @@
      type: int
    enter_bios_setup:
      description:
-     - If set to C(True), the virtual machine automatically enters BIOS setup the next time it boots.
+     - If set to C(true), the virtual machine automatically enters BIOS setup the next time it boots.
      - The virtual machine resets this flag, so that the machine boots proceeds normally.
      type: 'bool'
    boot_retry_enabled:
      description:
-     - If set to C(True), the virtual machine that fails to boot, will try to boot again after C(boot_retry_delay) is expired.
-     - If set to C(False), the virtual machine waits indefinitely for user intervention.
+     - If set to C(true), the virtual machine that fails to boot, will try to boot again after C(boot_retry_delay) is expired.
+     - If set to C(false), the virtual machine waits indefinitely for user intervention.
      type: 'bool'
    boot_retry_delay:
      description:
      - Specify the time in milliseconds between virtual machine boot failure and subsequent attempt to boot again.
-     - If set, will automatically set C(boot_retry_enabled) to C(True) as this parameter is required.
+     - If set, will automatically set C(boot_retry_enabled) to C(true) as this parameter is required.
      type: int
    boot_firmware:
      description:

plugins/modules/vmware_guest_controller.py

@@ -117,7 +117,7 @@
    gather_disk_controller_facts:
      description:
      - Whether to collect existing disk and USB controllers facts only.
-     - When this parameter is set to C(True), C(controllers) parameter will be ignored.
+     - When this parameter is set to C(true), C(controllers) parameter will be ignored.
      type: bool
      default: false
    sleep_time:

plugins/modules/vmware_guest_disk.py

@@ -112,8 +112,8 @@
        cluster_disk:
          description:
            - This value allows for the sharing of an RDM between two machines.
-           - The primary machine holding the RDM uses the default C(False).
-           - The secondary machine holding the RDM uses C(True).
+           - The primary machine holding the RDM uses the default C(false).
+           - The secondary machine holding the RDM uses C(true).
          type: bool
          default: false
        compatibility_mode:

plugins/modules/vmware_guest_info.py

@@ -69,14 +69,14 @@
    tags:
      description:
      - Whether to show tags or not.
-     - If set C(True), shows tags information. Returns a list of tag names.
-     - If set C(False), hides tags information.
+     - If set C(true), shows tags information. Returns a list of tag names.
+     - If set C(false), hides tags information.
      - vSphere Automation SDK is required.
      default: false
      type: bool
    tag_details:
      description:
-     - If set C(True), detail information about 'tags' returned.
+     - If set C(true), detail information about 'tags' returned.
      - Without this flag, the 'tags' returns a list of tag names.
      - With this flag, the 'tags' returns a list of dict about tag information with additional details like category name, category id, and tag id.
      - This parameter is added to maintain backward compatability.

plugins/modules/vmware_guest_video.py

@@ -59,14 +59,14 @@
      type: str
    gather_video_facts:
      description:
-     - If set to C(True), return settings of the video card, other attributes are ignored.
-     - If set to C(False), will do reconfiguration and return video card settings.
+     - If set to C(true), return settings of the video card, other attributes are ignored.
+     - If set to C(false), will do reconfiguration and return video card settings.
      type: bool
      default: false
    use_auto_detect:
      description:
-     - 'If set to C(True), applies common video settings to the guest operating system, attributes C(display_number) and C(video_memory_mb) are ignored.'
-     - 'If set to C(False), the number of display and the total video memory will be reconfigured using C(display_number) and C(video_memory_mb).'
+     - 'If set to C(true), applies common video settings to the guest operating system, attributes C(display_number) and C(video_memory_mb) are ignored.'
+     - 'If set to C(false), the number of display and the total video memory will be reconfigured using C(display_number) and C(video_memory_mb).'
      type: bool
    display_number:
      description:

plugins/modules/vmware_host.py

@@ -51,7 +51,7 @@
     type: str
   add_connected:
     description:
-    - If set to C(True), then the host should be connected as soon as it is added.
+    - If set to C(true), then the host should be connected as soon as it is added.
     - This parameter is ignored if state is set to a value other than C(present).
     default: true
     type: bool

plugins/modules/vmware_host_facts.py

@@ -34,7 +34,7 @@
     type: str
   show_tag:
     description:
-    - Tags related to Host are shown if set to C(True).
+    - Tags related to Host are shown if set to C(true).
     default: false
     type: bool
     required: false

plugins/modules/vmware_local_role_manager.py

@@ -43,7 +43,7 @@
     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 C(false) then prevents the role from being removed if any permissions are using it.
     default: false
     type: bool
   action:

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 C(true), evacuate all powered off VMs.
         default: false
         required: false
         type: bool

plugins/modules/vmware_tag.py

@@ -26,7 +26,7 @@
     tag_name:
       description:
       - The name of tag to manage.
-      required: True
+      required: true
       aliases: [ 'tag', 'name' ]
       type: str
     tag_description:
@@ -35,7 +35,7 @@
       - This is required only if C(state) is set to C(present).
       - This parameter is ignored, when C(state) is set to C(absent).
       - Process of updating tag only allows description change.
-      required: False
+      required: false
       default: ''
       aliases: [ 'description' ]
       type: str
@@ -44,13 +44,13 @@
       - The unique ID generated by vCenter should be used to.
       - User can get this unique ID from facts module.
       - Required if C(category_name) is not set.
-      required: False
+      required: false
       type: str
     category_name:
       description:
       - The name of category.
       - Required if C(category_id) is not set.
-      required: False
+      required: false
       aliases: [ 'category' ]
       type: str
       version_added: '3.5.0'
@@ -61,7 +61,7 @@
       - If set to C(present) and tag exists, then tag is updated.
       - If set to C(absent) and tag exists, then tag is deleted.
       - If set to C(absent) and tag does not exists, no action is taken.
-      required: False
+      required: false
       default: 'present'
       choices: [ 'present', 'absent' ]
       type: str

plugins/modules/vmware_target_canonical_info.py

@@ -24,7 +24,7 @@
     description:
     - The target id based on order of scsi device.
     - version 2.6 onwards, this parameter is optional.
-    required: False
+    required: false
     type: int
   cluster_name:
     description:

plugins/modules/vmware_vc_infraprofile_info.py

@@ -27,35 +27,35 @@
       description:
       - decryption_key argument for while doing import profile task as of now its not taken into account form API team.
       type: str
-      required: False
+      required: false
     encryption_key:
       description:
       - encryption_key argument for while doing import profile task as of now its not taken into account form API team.
       type: str
-      required: False
+      required: false
     api:
       description:
       - API which needs to be executed
       type: str
-      required: False
+      required: false
       choices: [ export, import, list, validate ]
     config_path:
       description:
       - Config file path which contains infra profile config JSON data, supports both relative and absolute path.
       - This parameter is required only when C(import),C(validate) APIs are being used.
       type: str
-      required: False
+      required: false
     profiles:
       description:
       - A list of profile names to be exported, imported, and validated.
       - This parameter is not required while running for List API, not for C(export),C(import) and C(validate).
       type: str
-      required: False
+      required: false
     description:
       description:
       - Description of about encryption or decryption key.
       type: str
-      required: False
+      required: false
 extends_documentation_fragment:
 - community.vmware.vmware_rest_client.documentation
 '''