Convert to reduced list of known types (#50010)

2025-07-25 14:20:22 -07:00 · 2018-12-18 22:25:30 +01:00 · 2018-12-18 22:25:30 +01:00 · 05c6ff79f9
commit 05c6ff79f9
parent fcd1486b51
908 changed files with 4822 additions and 4821 deletions
--- a/lib/ansible/modules/storage/ibm/ibm_sa_domain.py
+++ b/lib/ansible/modules/storage/ibm/ibm_sa_domain.py
@ -104,7 +104,7 @@ RETURN = '''
 msg:
    description: module return status.
    returned: as needed
-    type: string
+    type: str
    sample: "domain 'domain_name' created successfully."
 '''

--- a/lib/ansible/modules/storage/netapp/_sf_snapshot_schedule_manager.py
+++ b/lib/ansible/modules/storage/netapp/_sf_snapshot_schedule_manager.py
@ -132,7 +132,7 @@ RETURN = """
 schedule_id:
    description: Schedule ID of the newly created schedule
    returned: success
-    type: string
+    type: str
 """
 import traceback

--- a/lib/ansible/modules/storage/netapp/_sf_volume_manager.py
+++ b/lib/ansible/modules/storage/netapp/_sf_volume_manager.py
@ -125,7 +125,7 @@ RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str

 """

--- a/lib/ansible/modules/storage/netapp/na_elementsw_access_group.py
+++ b/lib/ansible/modules/storage/netapp/na_elementsw_access_group.py
@ -104,7 +104,7 @@ RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str

 """
 import traceback
--- a/lib/ansible/modules/storage/netapp/na_elementsw_cluster.py
+++ b/lib/ansible/modules/storage/netapp/na_elementsw_cluster.py
@ -94,7 +94,7 @@ RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str

 """
 import traceback
--- a/lib/ansible/modules/storage/netapp/na_elementsw_drive.py
+++ b/lib/ansible/modules/storage/netapp/na_elementsw_drive.py
@ -115,7 +115,7 @@ RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str

 """
 import traceback
--- a/lib/ansible/modules/storage/netapp/na_elementsw_network_interfaces.py
+++ b/lib/ansible/modules/storage/netapp/na_elementsw_network_interfaces.py
@ -151,7 +151,7 @@ RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str

 """
 import traceback
--- a/lib/ansible/modules/storage/netapp/na_elementsw_node.py
+++ b/lib/ansible/modules/storage/netapp/na_elementsw_node.py
@ -81,7 +81,7 @@ RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str

 """
 import traceback
--- a/lib/ansible/modules/storage/netapp/na_elementsw_snapshot.py
+++ b/lib/ansible/modules/storage/netapp/na_elementsw_snapshot.py
@ -135,7 +135,7 @@ RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str

 """
 import traceback
--- a/lib/ansible/modules/storage/netapp/na_elementsw_snapshot_restore.py
+++ b/lib/ansible/modules/storage/netapp/na_elementsw_snapshot_restore.py
@ -74,7 +74,7 @@ RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str

 """
 import traceback
--- a/lib/ansible/modules/storage/netapp/na_elementsw_snapshot_schedule.py
+++ b/lib/ansible/modules/storage/netapp/na_elementsw_snapshot_schedule.py
@ -175,7 +175,7 @@ RETURN = """
 schedule_id:
    description: Schedule ID of the newly created schedule
    returned: success
-    type: string
+    type: str
 """
 import traceback
 from ansible.module_utils.basic import AnsibleModule
--- a/lib/ansible/modules/storage/netapp/na_elementsw_volume.py
+++ b/lib/ansible/modules/storage/netapp/na_elementsw_volume.py
@ -135,7 +135,7 @@ RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str

 """

--- a/lib/ansible/modules/storage/netapp/na_elementsw_volume_clone.py
+++ b/lib/ansible/modules/storage/netapp/na_elementsw_volume_clone.py
@ -95,7 +95,7 @@ RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str

 """

--- a/lib/ansible/modules/storage/netapp/na_ontap_lun_map.py
+++ b/lib/ansible/modules/storage/netapp/na_ontap_lun_map.py
@ -84,27 +84,27 @@ RETURN = """
 lun_node:
    description: NetApp controller that is hosting the LUN.
    returned: success
-    type: string
+    type: str
    sample: node01
 lun_ostype:
    description: Specifies the OS of the host accessing the LUN.
    returned: success
-    type: string
+    type: str
    sample: vmware
 lun_serial:
    description: A unique, 12-byte, ASCII string used to identify the LUN.
    returned: success
-    type: string
+    type: str
    sample: 80E7/]LZp1Tt
 lun_naa_id:
    description: The Network Address Authority (NAA) identifier for the LUN.
    returned: success
-    type: string
+    type: str
    sample: 600a0980383045372f5d4c5a70315474
 lun_state:
    description: Online or offline status of the LUN.
    returned: success
-    type: string
+    type: str
    sample: online
 lun_size:
    description: Size of the LUN in bytes.
--- a/lib/ansible/modules/storage/netapp/na_ontap_nfs.py
+++ b/lib/ansible/modules/storage/netapp/na_ontap_nfs.py
@ -254,7 +254,7 @@ class NetAppONTAPNFS(object):
        :param:
            name : Name of the vserver
        :return: status of nfs. None if not found.
-        :rtype: boolean
+        :rtype: bool
        """
        nfs_status = netapp_utils.zapi.NaElement('nfs-status')
        result = self.server.invoke_successfully(nfs_status, True)
--- a/lib/ansible/modules/storage/netapp/netapp_e_alerts.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_alerts.py
@ -98,7 +98,7 @@ RETURN = """
 msg:
    description: Success message
    returned: on success
-    type: string
+    type: str
    sample: The settings have been updated.
 """

--- a/lib/ansible/modules/storage/netapp/netapp_e_amg.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_amg.py
@ -96,7 +96,7 @@ RETURN = """
 msg:
    description: Successful creation
    returned: success
-    type: string
+    type: str
    sample: '{"changed": true, "connectionType": "fc", "groupRef": "3700000060080E5000299C24000006E857AC7EEC", "groupState": "optimal", "id": "3700000060080E5000299C24000006E857AC7EEC", "label": "amg_made_by_ansible", "localRole": "primary", "mirrorChannelRemoteTarget": "9000000060080E5000299C24005B06E557AC7EEC", "orphanGroup": false, "recoveryPointAgeAlertThresholdMinutes": 20, "remoteRole": "secondary", "remoteTarget": {"nodeName": {"ioInterfaceType": "fc", "iscsiNodeName": null, "remoteNodeWWN": "20040080E5299F1C"}, "remoteRef": "9000000060080E5000299C24005B06E557AC7EEC", "scsiinitiatorTargetBaseProperties": {"ioInterfaceType": "fc", "iscsiinitiatorTargetBaseParameters": null}}, "remoteTargetId": "ansible2", "remoteTargetName": "Ansible2", "remoteTargetWwn": "60080E5000299F880000000056A25D56", "repositoryUtilizationWarnThreshold": 80, "roleChangeProgress": "none", "syncActivity": "idle", "syncCompletionTimeAlertThresholdMinutes": 10, "syncIntervalMinutes": 10, "worldWideName": "60080E5000299C24000006E857AC7EEC"}'
 """  # NOQA

--- a/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py
@ -78,7 +78,7 @@ RETURN = """
 msg:
    description: Failure message
    returned: failure
-    type: string
+    type: str
    sample: "No Async Mirror Group with the name."
 """
 import json
--- a/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py
@ -81,7 +81,7 @@ RETURN = """
 json:
    description: The object attributes of the AMG.
    returned: success
-    type: string
+    type: str
    example:
        {
            "changed": false,
--- a/lib/ansible/modules/storage/netapp/netapp_e_asup.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_asup.py
@ -117,7 +117,7 @@ RETURN = """
 msg:
    description: Success message
    returned: on success
-    type: string
+    type: str
    sample: The settings have been updated.
 asup:
    description:
--- a/lib/ansible/modules/storage/netapp/netapp_e_auditlog.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_auditlog.py
@ -96,7 +96,7 @@ RETURN = """
 msg:
    description: Success message
    returned: on success
-    type: string
+    type: str
    sample: The settings have been updated.
 """

--- a/lib/ansible/modules/storage/netapp/netapp_e_auth.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_auth.py
@ -83,7 +83,7 @@ RETURN = '''
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str
    sample: "Password Updated Successfully"
 '''
 import json
--- a/lib/ansible/modules/storage/netapp/netapp_e_facts.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_facts.py
@ -61,7 +61,7 @@ RETURN = """
 msg:
    description: Gathered facts for <StorageArrayId>.
    returned: always
-    type: string
+    type: str
 """
 import json

--- a/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py
@ -85,7 +85,7 @@ RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str
    sample: json for newly created flash cache
 """
 import json
--- a/lib/ansible/modules/storage/netapp/netapp_e_global.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_global.py
@ -51,7 +51,7 @@ RETURN = """
 msg:
    description: Success message
    returned: on success
-    type: string
+    type: str
    sample: The settings have been updated.
 name:
    description:
--- a/lib/ansible/modules/storage/netapp/netapp_e_host.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_host.py
@ -128,13 +128,13 @@ msg:
    description:
        - A user-readable description of the actions performed.
    returned: on success
-    type: string
+    type: str
    sample: The host has been created.
 id:
    description:
        - the unique identifier of the host on the E-Series storage-system
    returned: on success when state=present
-    type: string
+    type: str
    sample: 00000000600A098000AAC0C3003004700AD86A52
    version_added: "2.6"

@ -142,7 +142,7 @@ ssid:
    description:
        - the unique identifer of the E-Series storage-system with the current api
    returned: on success
-    type: string
+    type: str
    sample: 1
    version_added: "2.6"

@ -150,7 +150,7 @@ api_url:
    description:
        - the url of the API that this request was proccessed by
    returned: on success
-    type: string
+    type: str
    sample: https://webservices.example.com:8443
    version_added: "2.6"

--- a/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py
@ -79,13 +79,13 @@ RETURN = '''
 clusterRef:
    description: The unique identification value for this object. Other objects may use this reference value to refer to the cluster.
    returned: always except when state is absent
-    type: string
+    type: str
    sample: "3233343536373839303132333100000000000000"
 confirmLUNMappingCreation:
    description: If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping
                 will alter the volume access rights of other clusters, in addition to this one.
    returned: always
-    type: boolean
+    type: bool
    sample: false
 hosts:
    description: A list of the hosts that are part of the host group after all operations.
@ -95,28 +95,28 @@ hosts:
 id:
    description: The id number of the hostgroup
    returned: always except when state is absent
-    type: string
+    type: str
    sample: "3233343536373839303132333100000000000000"
 isSAControlled:
    description: If true, indicates that I/O accesses from this cluster are subject to the storage array's default LUN-to-volume mappings. If false,
                 indicates that I/O accesses from the cluster are subject to cluster-specific LUN-to-volume mappings.
    returned: always except when state is absent
-    type: boolean
+    type: bool
    sample: false
 label:
    description: The user-assigned, descriptive label string for the cluster.
    returned: always
-    type: string
+    type: str
    sample: "MyHostGroup"
 name:
    description: same as label
    returned: always except when state is absent
-    type: string
+    type: str
    sample: "MyHostGroup"
 protectionInformationCapableAccessMethod:
    description: This field is true if the host has a PI capable access method.
    returned: always except when state is absent
-    type: boolean
+    type: bool
    sample: true
 '''

--- a/lib/ansible/modules/storage/netapp/netapp_e_iscsi_interface.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_iscsi_interface.py
@ -143,7 +143,7 @@ RETURN = """
 msg:
    description: Success message
    returned: on success
-    type: string
+    type: str
    sample: The interface settings have been updated.
 enabled:
    description:
--- a/lib/ansible/modules/storage/netapp/netapp_e_iscsi_target.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_iscsi_target.py
@ -87,20 +87,20 @@ RETURN = """
 msg:
    description: Success message
    returned: on success
-    type: string
+    type: str
    sample: The iSCSI target settings have been updated.
 alias:
    description:
        - The alias assigned to the iSCSI target.
    returned: on success
    sample: myArray
-    type: string
+    type: str
 iqn:
    description:
        - The iqn (iSCSI Qualified Name), assigned to the iSCSI target.
    returned: on success
    sample: iqn.1992-08.com.netapp:2800.000a132000b006d2000000005a0e8f45
-    type: string
+    type: str
 """
 import json
 import logging
--- a/lib/ansible/modules/storage/netapp/netapp_e_ldap.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_ldap.py
@ -142,7 +142,7 @@ RETURN = """
 msg:
    description: Success message
    returned: on success
-    type: string
+    type: str
    sample: The ldap settings have been updated.
 """

--- a/lib/ansible/modules/storage/netapp/netapp_e_lun_mapping.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_lun_mapping.py
@ -86,7 +86,7 @@ RETURN = '''
 msg:
    description: success of the module
    returned: always
-    type: string
+    type: str
    sample: Lun mapping is complete
 '''
 import json
--- a/lib/ansible/modules/storage/netapp/netapp_e_mgmt_interface.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_mgmt_interface.py
@ -213,7 +213,7 @@ RETURN = """
 msg:
    description: Success message
    returned: on success
-    type: string
+    type: str
    sample: The interface settings have been updated.
 enabled:
    description:
--- a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py
@ -125,7 +125,7 @@ RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str
    sample: json facts for newly created snapshot group.
 """
 HEADERS = {
--- a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py
@ -65,12 +65,12 @@ RETURN = """
 ---
    msg:
        description: State of operation
-        type: string
+        type: str
        returned: always
        sample: "Created snapshot image"
    image_id:
        description: ID of snaphot image
-        type: string
+        type: str
        returned: state == created
        sample: "3400000060080E5000299B640063074057BC5C5E "
 """
--- a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py
@ -100,7 +100,7 @@ RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str
    sample: Json facts for the volume that was created.
 """
 HEADERS = {
--- a/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py
@ -87,7 +87,7 @@ EXAMPLES = '''
 RETURN = '''
 msg:
    description: State of request
-    type: string
+    type: str
    returned: always
    sample: 'Storage system removed.'
 '''
--- a/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py
@ -101,7 +101,7 @@ RETURN = '''
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str
    sample: Json facts for the pool that was created.
 '''

--- a/lib/ansible/modules/storage/netapp/netapp_e_syslog.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_syslog.py
@ -89,7 +89,7 @@ RETURN = """
 msg:
    description: Success message
    returned: on success
-    type: string
+    type: str
    sample: The settings have been updated.
 syslog:
    description:
--- a/lib/ansible/modules/storage/netapp/netapp_e_volume.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_volume.py
@ -106,7 +106,7 @@ RETURN = '''
 ---
 msg:
    description: State of volume
-    type: string
+    type: str
    returned: always
    sample: "Standard volume [workload_vol_1] has been created."
 '''
--- a/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py
+++ b/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py
@ -84,14 +84,14 @@ EXAMPLES = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str
    sample: Json facts for the volume copy that was created.
 """
 RETURN = """
 msg:
    description: Success message
    returned: success
-    type: string
+    type: str
    sample: Created Volume Copy Pair with ID
 """

--- a/lib/ansible/modules/storage/zfs/zfs_facts.py
+++ b/lib/ansible/modules/storage/zfs/zfs_facts.py
@ -76,22 +76,22 @@ RETURN = '''
 name:
    description: ZFS dataset name
    returned: always
-    type: string
+    type: str
    sample: rpool/var/spool
 parsable:
    description: if parsable output should be provided in machine friendly format.
    returned: if 'parsable' is set to True
-    type: boolean
+    type: bool
    sample: True
 recurse:
    description: if we should recurse over ZFS dataset
    returned: if 'recurse' is set to True
-    type: boolean
+    type: bool
    sample: True
 zfs_datasets:
    description: ZFS dataset facts
    returned: always
-    type: string
+    type: str
    sample:
            {
                "aclinherit": "restricted",
--- a/lib/ansible/modules/storage/zfs/zpool_facts.py
+++ b/lib/ansible/modules/storage/zfs/zpool_facts.py
@ -63,7 +63,7 @@ ansible_facts:
        ansible_zfs_pools:
            description: ZFS pool facts
            returned: always
-            type: string
+            type: str
            sample:
                {
                    "allocated": "3.46G",
@ -109,12 +109,12 @@ ansible_facts:
 name:
    description: ZFS pool name
    returned: always
-    type: string
+    type: str
    sample: rpool
 parsable:
    description: if parsable output should be provided in machine friendly format.
    returned: if 'parsable' is set to True
-    type: boolean
+    type: bool
    sample: True
 '''