[PR #10466/7b05484d backport][stable-10] doc style adjustments: modules [rtuvx]* (#10488)

doc style adjustments: modules [rtuvx]* (#10466)

* doc style adjustments: modules r*

* doc style adjustments: modules t*

* doc style adjustments: modules u*

* doc style adjustments: modules v*

* doc style adjustments: modules x*

* Update plugins/modules/redis_data.py



---------


(cherry picked from commit 7b05484d8f)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>

plugins/modules/redfish_command.py

@@ -229,8 +229,8 @@ options:
     description:
       - Custom OEM properties for HTTP Multipart Push updates.
       - If set, then O(update_custom_oem_header) is required too.
-      - The properties will be passed raw without any validation or conversion by Ansible. This means the content can be a
+      - The properties are passed raw without any validation or conversion by Ansible. This means the content can be a file,
-        file, a string, or any other data. If the content is a dict that should be converted to JSON, then the content must
+        a string, or any other data. If the content is a dictionary that should be converted to JSON, then the content must
         be converted to JSON before passing it to this module using the P(ansible.builtin.to_json#filter) filter.
     type: raw
     version_added: '10.1.0'
@@ -830,15 +830,16 @@ return_values:
   returned: on success
   type: dict
   version_added: 6.1.0
-  sample: {
+  sample:
-    "update_status": {
+    {
-      "handle": "/redfish/v1/TaskService/TaskMonitors/735",
+      "update_status": {
-      "messages": [],
+        "handle": "/redfish/v1/TaskService/TaskMonitors/735",
-      "resets_requested": [],
+        "messages": [],
-      "ret": true,
+        "resets_requested": [],
-      "status": "New"
+        "ret": true,
+        "status": "New"
+      }
     }
-  }
 """
 
 from ansible.module_utils.basic import AnsibleModule

plugins/modules/redfish_config.py

@@ -166,9 +166,9 @@ options:
   volume_details:
     required: false
     description:
-      - Setting dict of volume to be created.
+      - Setting dictionary of volume to be created.
-      - If C(CapacityBytes) key is not specified in this dictionary, the size of the volume will be determined by the Redfish
+      - If C(CapacityBytes) key is not specified in this dictionary, the size of the volume is determined by the Redfish service.
-        service. It is possible the size will not be the maximum available size.
+        It is possible the size is not the maximum available size.
     type: dict
     default: {}
     version_added: '7.5.0'

plugins/modules/redhat_subscription.py

@@ -21,7 +21,7 @@ notes:
   - 'The module tries to use the D-Bus C(rhsm) service (part of C(subscription-manager)) to register, starting from community.general
     6.5.0: this is done so credentials (username, password, activation keys) can be passed to C(rhsm) in a secure way. C(subscription-manager)
     itself gets credentials only as arguments of command line parameters, which is I(not) secure, as they can be easily stolen
-    by checking the process listing on the system. Due to limitations of the D-Bus interface of C(rhsm), the module will I(not)
+    by checking the process listing on the system. Due to limitations of the D-Bus interface of C(rhsm), the module does I(not)
     use D-Bus for registration when trying either to register using O(token), or when specifying O(environment), or when the
     system is old (typically RHEL 7 older than 7.4, RHEL 6, and older).'
   - In order to register a system, subscription-manager requires either a username and password, or an activationkey and an
@@ -132,10 +132,9 @@ options:
   pool_ids:
     description:
       - Specify subscription pool IDs to consume.
-      - 'A pool ID may be specified as a C(string) - just the pool ID (for example
+      - 'A pool ID may be specified as a C(string) - just the pool ID (for example V(0123456789abcdef0123456789abcdef)), or
-        V(0123456789abcdef0123456789abcdef)), or as a C(dict) with the pool ID as the key, and a quantity as the value (for
+        as a C(dict) with the pool ID as the key, and a quantity as the value (for example V(0123456789abcdef0123456789abcdef:
-        example V(0123456789abcdef0123456789abcdef: 2). If the quantity is provided, it is used to consume multiple entitlements
+        2). If the quantity is provided, it is used to consume multiple entitlements from a pool (the pool must support this).'
-        from a pool (the pool must support this).'
     default: []
     type: list
     elements: raw
@@ -167,8 +166,8 @@ options:
       - Set syspurpose attributes in file C(/etc/rhsm/syspurpose/syspurpose.json) and synchronize these attributes with RHSM
         server. Syspurpose attributes help attach the most appropriate subscriptions to the system automatically. When C(syspurpose.json)
         file already contains some attributes, then new attributes overwrite existing attributes. When some attribute is not
-        listed in the new list of attributes, the existing attribute will be removed from C(syspurpose.json) file. Unknown
+        listed in the new list of attributes, the existing attribute is removed from C(syspurpose.json) file. Unknown attributes
-        attributes are ignored.
+        are ignored.
     type: dict
     suboptions:
       usage:
@@ -187,7 +186,7 @@ options:
       sync:
         description:
           - When this option is V(true), then syspurpose attributes are synchronized with RHSM server immediately. When this
-            option is V(false), then syspurpose attributes will be synchronized with RHSM server by rhsmcertd daemon.
+            option is V(false), then syspurpose attributes are synchronized with RHSM server by rhsmcertd daemon.
         type: bool
         default: false
 """

plugins/modules/redis_data.py

@@ -33,7 +33,7 @@ options:
     type: str
   expiration:
     description:
-      - Expiration time in milliseconds. Setting this flag will always result in a change in the database.
+      - Expiration time in milliseconds. Setting this option always results in a change in the database.
     required: false
     type: int
   non_existing:

plugins/modules/redis_data_incr.py

@@ -21,8 +21,8 @@ attributes:
     support: partial
     details:
       - For C(check_mode) to work, the specified O(login_user) needs permission to run the C(GET) command on the key, otherwise
-        the module will fail.
+        the module fails.
-      - When using C(check_mode) the module will try to calculate the value that Redis would return. If the key is not present,
+      - When using C(check_mode) the module tries to calculate the value that Redis would return. If the key is not present,
         V(0.0) is used as value.
   diff_mode:
     support: none

plugins/modules/rhsm_release.py

@@ -14,8 +14,8 @@ short_description: Set or Unset RHSM Release version
 description:
   - Sets or unsets the release version used by RHSM repositories.
 notes:
-  - This module will fail on an unregistered system. Use the M(community.general.redhat_subscription) module to register a
+  - This module fails on an unregistered system. Use the M(community.general.redhat_subscription) module to register a system
-    system prior to setting the RHSM release.
+    prior to setting the RHSM release.
   - It is possible to interact with C(subscription-manager) only as root, so root permissions are required to successfully
     run this module.
 requirements:

plugins/modules/rhsm_repository.py

@@ -48,7 +48,7 @@ options:
   purge:
     description:
       - Disable all currently enabled repositories that are not not specified in O(name). Only set this to V(true) if passing
-        in a list of repositories to the O(name) field. Using this with C(loop) will most likely not have the desired result.
+        in a list of repositories to the O(name) field. Using this with C(loop) is likely not to have the desired result.
     type: bool
     default: false
 """

plugins/modules/riak.py

@@ -62,8 +62,8 @@ options:
     type: str
   validate_certs:
     description:
-      - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
+      - If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
-        self-signed certificates.
+        certificates.
     type: bool
     default: true
 """

plugins/modules/rocketchat.py

@@ -69,7 +69,7 @@ options:
     description:
       - Emoji for the message sender. The representation for the available emojis can be got from Rocket Chat.
       - For example V(:thumbsup:).
-      - If O(icon_emoji) is set, O(icon_url) will not be used.
+      - If O(icon_emoji) is set, O(icon_url) is not used.
   link_names:
     type: int
     description:
@@ -80,8 +80,8 @@ options:
       - 0
   validate_certs:
     description:
-      - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
+      - If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
-        self-signed certificates.
+        certificates.
     type: bool
     default: true
   color:
@@ -102,10 +102,10 @@ options:
       - Define a list of attachments.
   is_pre740:
     description:
-      - If V(true), the payload matches Rocket.Chat prior to 7.4.0 format.
+      - If V(true), the payload matches Rocket.Chat prior to 7.4.0 format. This format has been used by the module since its
-        This format has been used by the module since its inception, but is no longer supported by Rocket.Chat 7.4.0.
+        inception, but is no longer supported by Rocket.Chat 7.4.0.
-      - The default value of the option will change to V(false) eventually.
+      - The default value of the option is going to change to V(false) eventually.
-      - This parameter will be removed in a future release when Rocket.Chat 7.4.0 becomes the minimum supported version.
+      - This parameter is going to be removed in a future release when Rocket.Chat 7.4.0 becomes the minimum supported version.
     type: bool
     default: true
     version_added: 10.5.0

plugins/modules/rollbar_deployment.py

@@ -61,7 +61,7 @@ options:
     default: 'https://api.rollbar.com/api/1/deploy/'
   validate_certs:
     description:
-      - If V(false), SSL certificates for the target URL will not be validated. This should only be used on personally controlled
+      - If V(false), SSL certificates for the target URL are not validated. This should only be used on personally controlled
         sites using self-signed certificates.
     required: false
     default: true

plugins/modules/rpm_ostree_pkg.py

@@ -101,7 +101,7 @@ packages:
   description: A list of packages specified.
   returned: always
   type: list
-  sample: ['nfs-utils']
+  sample: ["nfs-utils"]
 stdout:
   description: Stdout of rpm-ostree command.
   returned: always

plugins/modules/rundeck_job_run.py

@@ -62,7 +62,7 @@ options:
     type: int
     description:
       - Job execution wait timeout in seconds.
-      - If the timeout is reached, the job will be aborted.
+      - If the timeout is reached, the job is aborted.
       - Keep in mind that there is a sleep based on O(wait_execution_delay) after each job status check.
     default: 120
   abort_on_timeout:

plugins/modules/runit.py

@@ -30,9 +30,10 @@ options:
     required: true
   state:
     description:
-      - V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. V(restarted) will always
+      - V(started)/V(stopped) are idempotent actions that do not run commands unless necessary.
-        bounce the service (sv restart) and V(killed) will always bounce the service (sv force-stop). V(reloaded) will send
+      - V(restarted) always bounces the service (sv restart) and V(killed) always bounces the service (sv force-stop).
-        a HUP (sv reload). V(once) will run a normally downed sv once (sv once), not really an idempotent operation.
+      - V(reloaded) always sends a HUP (sv reload).
+      - V(once) runs a normally downed sv once (sv once), not really an idempotent operation.
     type: str
     choices: [killed, once, reloaded, restarted, started, stopped]
   enabled:

plugins/modules/telegram.py

@@ -21,7 +21,7 @@ description:
   - Send notifications using telegram bot, to a verified group or user.
   - Also, the user may try to use any other telegram bot API method, if you specify O(api_method) argument.
 notes:
-  - You will require a telegram account and create telegram bot to use this module.
+  - You need a telegram account and create telegram bot to use this module.
 extends_documentation_fragment:
   - community.general.attributes
 attributes:

plugins/modules/terraform.py

@@ -58,19 +58,19 @@ options:
   purge_workspace:
     description:
       - Only works with state = absent.
-      - If true, the workspace will be deleted after the "terraform destroy" action.
+      - If V(true), the O(workspace) is deleted after the C(terraform destroy) action.
-      - The 'default' workspace will not be deleted.
+      - If O(workspace=default) then it is not deleted.
     default: false
     type: bool
   plan_file:
     description:
-      - The path to an existing Terraform plan file to apply. If this is not specified, Ansible will build a new TF plan and
+      - The path to an existing Terraform plan file to apply. If this is not specified, Ansible builds a new TF plan and execute
-        execute it. Note that this option is required if 'state' has the 'planned' value.
+        it. Note that this option is required if O(state=planned).
     type: path
   state_file:
     description:
       - The path to an existing Terraform state file to use when building plan. If this is not specified, the default C(terraform.tfstate)
-        will be used.
+        is used.
       - This option is ignored when plan is specified.
     type: path
   variables_files:
@@ -91,7 +91,7 @@ options:
       - Ansible dictionaries are mapped to terraform objects.
       - Ansible lists are mapped to terraform lists.
       - Ansible booleans are mapped to terraform booleans.
-      - B(Note) passwords passed as variables will be visible in the log output. Make sure to use C(no_log=true) in production!.
+      - B(Note) passwords passed as variables are visible in the log output. Make sure to use C(no_log=true) in production!.
     type: dict
   complex_vars:
     description:
@@ -104,7 +104,7 @@ options:
     version_added: 5.7.0
   targets:
     description:
-      - A list of specific resources to target in this plan/application. The resources selected here will also auto-include
+      - A list of specific resources to target in this plan/application. The resources selected here are also auto-include
         any dependencies.
     type: list
     elements: str
@@ -120,7 +120,7 @@ options:
     type: int
   force_init:
     description:
-      - To avoid duplicating infra, if a state file cannot be found this will force a C(terraform init). Generally, this should
+      - To avoid duplicating infra, if a state file cannot be found this forces a C(terraform init). Generally, this should
         be turned off unless you intend to provision an entirely new Terraform deployment.
     default: false
     type: bool

plugins/modules/utm_aaa_group.py

@@ -28,7 +28,7 @@ attributes:
 options:
   name:
     description:
-      - The name of the object. Will be used to identify the entry.
+      - The name of the object that identifies the entry.
     type: str
     required: true
   adirectory_groups:

plugins/modules/utm_aaa_group_info.py

@@ -29,7 +29,7 @@ options:
   name:
     type: str
     description:
-      - The name of the object. Will be used to identify the entry.
+      - The name of the object that identifies the entry.
     required: true
 
 extends_documentation_fragment:

plugins/modules/utm_ca_host_key_cert.py

@@ -29,7 +29,7 @@ attributes:
 options:
   name:
     description:
-      - The name of the object. Will be used to identify the entry.
+      - The name of the object that identifies the entry.
     required: true
     type: str
   ca:

plugins/modules/utm_ca_host_key_cert_info.py

@@ -28,7 +28,7 @@ options:
   name:
     type: str
     description:
-      - The name of the object. Will be used to identify the entry.
+      - The name of the object that identifies the entry.
     required: true
 
 extends_documentation_fragment:

plugins/modules/utm_dns_host.py

@@ -29,7 +29,7 @@ options:
   name:
     type: str
     description:
-      - The name of the object. Will be used to identify the entry.
+      - The name of the object that identifies the entry.
     required: true
   address:
     type: str
@@ -130,7 +130,7 @@ result:
       description: Whether the ipv6 address is resolved or not.
       type: bool
     timeout:
-      description: The timeout until a new resolving will be attempted.
+      description: The timeout until a new resolving is attempted.
       type: int
 """
 

plugins/modules/utm_network_interface_address.py

@@ -29,7 +29,7 @@ options:
   name:
     type: str
     description:
-      - The name of the object. Will be used to identify the entry.
+      - The name of the object that identifies the entry.
     required: true
   address:
     type: str

plugins/modules/utm_network_interface_address_info.py

@@ -27,7 +27,7 @@ options:
   name:
     type: str
     description:
-      - The name of the object. Will be used to identify the entry.
+      - The name of the object that identifies the entry.
     required: true
 
 extends_documentation_fragment:

plugins/modules/utm_proxy_auth_profile.py

@@ -30,7 +30,7 @@ options:
   name:
     type: str
     description:
-      - The name of the object. Will be used to identify the entry.
+      - The name of the object that identifies the entry.
     required: true
   aaa:
     type: list

plugins/modules/utm_proxy_exception.py

@@ -29,7 +29,7 @@ attributes:
 options:
   name:
     description:
-      - The name of the object. Will be used to identify the entry.
+      - The name of the object that identifies the entry.
     required: true
     type: str
   op:

plugins/modules/utm_proxy_frontend.py

@@ -30,7 +30,7 @@ options:
   name:
     type: str
     description:
-      - The name of the object. Will be used to identify the entry.
+      - The name of the object that identifies the entry.
     required: true
   add_content_type_header:
     description:
@@ -76,12 +76,12 @@ options:
     default: []
   htmlrewrite:
     description:
-      - Whether to enable html rewrite or not.
+      - Whether to enable HTML rewrite or not.
     type: bool
     default: false
   htmlrewrite_cookies:
     description:
-      - Whether to enable html rewrite cookie or not.
+      - Whether to enable HTML rewrite cookie or not.
     type: bool
     default: false
   implicitredirect:
@@ -204,7 +204,7 @@ result:
       description: List of associated proxy exceptions.
       type: list
     htmlrewrite:
-      description: State of html rewrite.
+      description: State of HTML rewrite.
       type: bool
     htmlrewrite_cookies:
       description: Whether the HTML rewrite cookie is set.

plugins/modules/utm_proxy_frontend_info.py

@@ -29,7 +29,7 @@ options:
   name:
     type: str
     description:
-      - The name of the object. Will be used to identify the entry.
+      - The name of the object that identifies the entry.
     required: true
 
 extends_documentation_fragment:
@@ -90,7 +90,7 @@ result:
       description: List of associated proxy exceptions.
       type: list
     htmlrewrite:
-      description: State of html rewrite.
+      description: State of HTML rewrite.
       type: bool
     htmlrewrite_cookies:
       description: Whether the HTML rewrite cookie is set.

plugins/modules/utm_proxy_location.py

@@ -30,7 +30,7 @@ options:
   name:
     type: str
     description:
-      - The name of the object. Will be used to identify the entry.
+      - The name of the object that identifies the entry.
     required: true
   access_control:
     description:

plugins/modules/utm_proxy_location_info.py

@@ -29,7 +29,7 @@ options:
   name:
     type: str
     description:
-      - The name of the object. Will be used to identify the entry.
+      - The name of the object that identifies the entry.
     required: true
 
 extends_documentation_fragment:

plugins/modules/vdo.py

@@ -48,8 +48,8 @@ options:
     default: present
   activated:
     description:
-      - The C(activate) status for a VDO volume. If this is set to V(false), the VDO volume cannot be started, and it will
+      - The C(activate) status for a VDO volume. If this is set to V(false), the VDO volume cannot be started, and it does
-        not start on system startup. However, on initial creation, a VDO volume with "activated" set to "off" will be running,
+        not start on system startup. However, on initial creation, a VDO volume with O(activated=false) is set to be running
         until stopped. This is the default behavior of the C(vdo create) command; it provides the user an opportunity to write
         a base amount of metadata (filesystem, LVM headers, and so on) to the VDO volume prior to stopping the volume, and
         leaving it deactivated until ready to use.

plugins/modules/vmadm.py

@@ -107,7 +107,8 @@ options:
   flexible_disk_size:
     required: false
     description:
-      - This sets an upper bound for the amount of space that a bhyve instance may use for its disks and snapshots of those disks (in MiBs).
+      - This sets an upper bound for the amount of space that a bhyve instance may use for its disks and snapshots of those
+        disks (in MiBs).
     type: int
     version_added: 10.5.0
   force:

plugins/modules/xcc_redfish_command.py

@@ -273,33 +273,34 @@ redfish_facts:
   description: Resource content.
   returned: when command == GetResource or command == GetCollectionResource
   type: dict
-  sample: '{
+  sample:
-    "redfish_facts": {
+    {
-      "data": {
+      "redfish_facts": {
-        "@odata.etag": "\"3179bf00d69f25a8b3c\"",
+        "data": {
-        "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Lenovo/DNS",
+          "@odata.etag": "\"3179bf00d69f25a8b3c\"",
-        "@odata.type": "#LenovoDNS.v1_0_0.LenovoDNS",
+          "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Lenovo/DNS",
-        "DDNS": [
+          "@odata.type": "#LenovoDNS.v1_0_0.LenovoDNS",
-          {
+          "DDNS": [
-            "DDNSEnable": true,
+            {
-            "DomainName": "",
+              "DDNSEnable": true,
-            "DomainNameSource": "DHCP"
+              "DomainName": "",
-          }
+              "DomainNameSource": "DHCP"
-        ],
+            }
-        "DNSEnable": true,
+          ],
-        "Description": "This resource is used to represent a DNS resource for a Redfish implementation.",
+          "DNSEnable": true,
-        "IPv4Address1": "10.103.62.178",
+          "Description": "This resource is used to represent a DNS resource for a Redfish implementation.",
-        "IPv4Address2": "0.0.0.0",
+          "IPv4Address1": "10.103.62.178",
-        "IPv4Address3": "0.0.0.0",
+          "IPv4Address2": "0.0.0.0",
-        "IPv6Address1": "::",
+          "IPv4Address3": "0.0.0.0",
-        "IPv6Address2": "::",
+          "IPv6Address1": "::",
-        "IPv6Address3": "::",
+          "IPv6Address2": "::",
-        "Id": "LenovoDNS",
+          "IPv6Address3": "::",
-        "PreferredAddresstype": "IPv4"
+          "Id": "LenovoDNS",
-      },
+          "PreferredAddresstype": "IPv4"
-      "ret": true
+        },
+        "ret": true
+      }
     }
-  }'
 """
 
 from ansible.module_utils.basic import AnsibleModule

plugins/modules/xdg_mime.py

@@ -31,16 +31,15 @@ attributes:
 options:
   mime_types:
     description:
-      - One or more MIME types for which a default handler will be set.
+      - One or more MIME types for which a default handler is set.
     type: list
     elements: str
     required: true
   handler:
     description:
       - Sets the default handler for the specified MIME types.
-      - The desktop file must be installed in the system.
+      - The desktop file must be installed in the system. If the desktop file is not installed, the module does not fail,
-        If the desktop file is not installed, the module
+        but the handler is not set either.
-        does not fail, but the handler is not set either.
       - You must pass a handler in the form V(*.desktop), otherwise the module fails.
     type: str
     required: true

plugins/modules/xenserver_guest.py

@@ -394,141 +394,143 @@ instance:
   description: Metadata about the VM.
   returned: always
   type: dict
-  sample: {
+  sample:
-    "cdrom": {
+    {
-      "type": "none"
+      "cdrom": {
-    },
+        "type": "none"
-    "customization_agent": "native",
-    "disks": [
-      {
-        "name": "testvm_11-0",
-        "name_desc": "",
-        "os_device": "xvda",
-        "size": 42949672960,
-        "sr": "Local storage",
-        "sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075",
-        "vbd_userdevice": "0"
       },
-      {
+      "customization_agent": "native",
-        "name": "testvm_11-1",
+      "disks": [
-        "name_desc": "",
+        {
-        "os_device": "xvdb",
+          "name": "testvm_11-0",
-        "size": 42949672960,
+          "name_desc": "",
-        "sr": "Local storage",
+          "os_device": "xvda",
-        "sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075",
+          "size": 42949672960,
-        "vbd_userdevice": "1"
+          "sr": "Local storage",
+          "sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075",
+          "vbd_userdevice": "0"
+        },
+        {
+          "name": "testvm_11-1",
+          "name_desc": "",
+          "os_device": "xvdb",
+          "size": 42949672960,
+          "sr": "Local storage",
+          "sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075",
+          "vbd_userdevice": "1"
+        }
+      ],
+      "domid": "56",
+      "folder": "",
+      "hardware": {
+        "memory_mb": 8192,
+        "num_cpu_cores_per_socket": 2,
+        "num_cpus": 4
+      },
+      "home_server": "",
+      "is_template": false,
+      "name": "testvm_11",
+      "name_desc": "",
+      "networks": [
+        {
+          "gateway": "192.168.0.254",
+          "gateway6": "fc00::fffe",
+          "ip": "192.168.0.200",
+          "ip6": [
+            "fe80:0000:0000:0000:e9cb:625a:32c5:c291",
+            "fc00:0000:0000:0000:0000:0000:0000:0001"
+          ],
+          "mac": "ba:91:3a:48:20:76",
+          "mtu": "1500",
+          "name": "Pool-wide network associated with eth1",
+          "netmask": "255.255.255.128",
+          "prefix": "25",
+          "prefix6": "64",
+          "vif_device": "0"
+        }
+      ],
+      "other_config": {
+        "base_template_name": "Windows Server 2016 (64-bit)",
+        "import_task": "OpaqueRef:e43eb71c-45d6-5351-09ff-96e4fb7d0fa5",
+        "install-methods": "cdrom",
+        "instant": "true",
+        "mac_seed": "f83e8d8a-cfdc-b105-b054-ef5cb416b77e"
+      },
+      "platform": {
+        "acpi": "1",
+        "apic": "true",
+        "cores-per-socket": "2",
+        "device_id": "0002",
+        "hpet": "true",
+        "nx": "true",
+        "pae": "true",
+        "timeoffset": "-25200",
+        "vga": "std",
+        "videoram": "8",
+        "viridian": "true",
+        "viridian_reference_tsc": "true",
+        "viridian_time_ref_count": "true"
+      },
+      "state": "poweredon",
+      "uuid": "e3c0b2d5-5f05-424e-479c-d3df8b3e7cda",
+      "xenstore_data": {
+        "vm-data": ""
       }
-    ],
-    "domid": "56",
-    "folder": "",
-    "hardware": {
-      "memory_mb": 8192,
-      "num_cpu_cores_per_socket": 2,
-      "num_cpus": 4
-    },
-    "home_server": "",
-    "is_template": false,
-    "name": "testvm_11",
-    "name_desc": "",
-    "networks": [
-      {
-        "gateway": "192.168.0.254",
-        "gateway6": "fc00::fffe",
-        "ip": "192.168.0.200",
-        "ip6": [
-          "fe80:0000:0000:0000:e9cb:625a:32c5:c291",
-          "fc00:0000:0000:0000:0000:0000:0000:0001"
-        ],
-        "mac": "ba:91:3a:48:20:76",
-        "mtu": "1500",
-        "name": "Pool-wide network associated with eth1",
-        "netmask": "255.255.255.128",
-        "prefix": "25",
-        "prefix6": "64",
-        "vif_device": "0"
-      }
-    ],
-    "other_config": {
-      "base_template_name": "Windows Server 2016 (64-bit)",
-      "import_task": "OpaqueRef:e43eb71c-45d6-5351-09ff-96e4fb7d0fa5",
-      "install-methods": "cdrom",
-      "instant": "true",
-      "mac_seed": "f83e8d8a-cfdc-b105-b054-ef5cb416b77e"
-    },
-    "platform": {
-      "acpi": "1",
-      "apic": "true",
-      "cores-per-socket": "2",
-      "device_id": "0002",
-      "hpet": "true",
-      "nx": "true",
-      "pae": "true",
-      "timeoffset": "-25200",
-      "vga": "std",
-      "videoram": "8",
-      "viridian": "true",
-      "viridian_reference_tsc": "true",
-      "viridian_time_ref_count": "true"
-    },
-    "state": "poweredon",
-    "uuid": "e3c0b2d5-5f05-424e-479c-d3df8b3e7cda",
-    "xenstore_data": {
-      "vm-data": ""
     }
-  }
 changes:
   description: Detected or made changes to VM.
   returned: always
   type: list
-  sample: [
+  sample:
-    {
+    [
-      "hardware": [
+      {
-        "num_cpus"
+        "hardware": [
-      ]
+          "num_cpus"
-    },
-    {
-      "disks_changed": [
-        [],
-        [
-          "size"
         ]
-      ]
+      },
-    },
+      {
-    {
+        "disks_changed": [
-      "disks_new": [
+          [],
-        {
+          [
-          "name": "new-disk",
+            "size"
-          "name_desc": "",
+          ]
-          "position": 2,
+        ]
-          "size_gb": "4",
+      },
-          "vbd_userdevice": "2"
+      {
-        }
+        "disks_new": [
-      ]
+          {
-    },
+            "name": "new-disk",
-    {
+            "name_desc": "",
-      "cdrom": [
+            "position": 2,
-        "type",
+            "size_gb": "4",
-        "iso_name"
+            "vbd_userdevice": "2"
-      ]
+          }
-    },
+        ]
-    {
+      },
-      "networks_changed": [
+      {
-        [
+        "cdrom": [
-          "mac"
+          "type",
-        ],
+          "iso_name"
-      ]
+        ]
-    },
+      },
-    {
+      {
-      "networks_new": [
+        "networks_changed": [
-        {
+          [
-          "name": "Pool-wide network associated with eth2",
+            "mac"
-          "position": 1,
+          ]
-          "vif_device": "1"
+        ]
-        }
+      },
-      ]
+      {
-    },
+        "networks_new": [
-    "need_poweredoff"
+          {
-  ]
+            "name": "Pool-wide network associated with eth2",
+            "position": 1,
+            "vif_device": "1"
+          }
+        ]
+      },
+      "need_poweredoff"
+    ]
 """
 
 import re

plugins/modules/xml.py

@@ -331,7 +331,15 @@ actions:
   description: A dictionary with the original xpath, namespaces and state.
   type: dict
   returned: success
-  sample: {xpath: xpath, namespaces: [namespace1, namespace2], state: present}
+  sample:
+    {
+      "xpath": "xpath",
+      "namespaces": [
+        "namespace1",
+        "namespace2"
+      ],
+      "state": "present"
+    }
 backup_file:
   description: The name of the backup file that was created.
   type: str