dellemc.unity.info module – Gathering information about Unity

Note

This module is part of the dellemc.unity collection (version 1.7.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install dellemc.unity. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: dellemc.unity.info.

New in dellemc.unity 1.1.0

Synopsis

  • Gathering information about Unity storage system includes Get the details of Unity array, Get list of Hosts in Unity array, Get list of FC initiators in Unity array, Get list of iSCSI initiators in Unity array, Get list of Consistency groups in Unity array, Get list of Storage pools in Unity array, Get list of Volumes in Unity array, Get list of Snapshot schedules in Unity array, Get list of NAS servers in Unity array, Get list of File systems in Unity array, Get list of Snapshots in Unity array, Get list of SMB shares in Unity array, Get list of NFS exports in Unity array, Get list of User quotas in Unity array, Get list of Quota tree in Unity array, Get list of NFS Servers in Unity array, Get list of CIFS Servers in Unity array. Get list of Ethernet ports in Unity array. Get list of File interfaces used in Unity array. Get list of Replication sessions in Unity array.

Aliases: dellemc_unity_gatherfacts, dellemc_unity_info

Requirements

The below requirements are needed on the host that executes this module.

  • A Dell Unity Storage device version 5.1 or later.

  • Ansible-core 2.13 or later.

  • Python 3.9, 3.10 or 3.11.

  • Storops Python SDK 1.2.11.

Parameters

Parameter

Comments

gather_subset

list / elements=string

List of string variables to specify the Unity storage system entities for which information is required.

Choices:

  • "host"

  • "fc_initiator"

  • "iscsi_initiator"

  • "cg"

  • "storage_pool"

  • "vol"

  • "snapshot_schedule"

  • "nas_server"

  • "file_system"

  • "snapshot"

  • "nfs_export"

  • "smb_share"

  • "user_quota"

  • "tree_quota"

  • "disk_group"

  • "nfs_server"

  • "cifs_server"

  • "ethernet_port"

  • "file_interface"

  • "replication_session"

password

string / required

The password of the Unity management server.

port

integer

Port number through which communication happens with Unity management server.

Default: 443

unispherehost

string / required

IP or FQDN of the Unity management server.

username

string / required

The username of the Unity management server.

validate_certs

aliases: verifycert

boolean

Boolean variable to specify whether or not to validate SSL certificate.

true - Indicates that the SSL certificate should be verified.

false - Indicates that the SSL certificate should not be verified.

Choices:

  • false

  • true ← (default)

Notes

Note

  • The check_mode is supported.

  • The modules present in this collection named as ‘dellemc.unity’ are built to support the Dell Unity storage platform.

Examples

- name: Get detailed list of Unity entities
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - host
      - fc_initiator
      - iscsi_initiator
      - cg
      - storage_pool
      - vol
      - snapshot_schedule
      - nas_server
      - file_system
      - snapshot
      - nfs_export
      - smb_share
      - user_quota
      - tree_quota
      - disk_group
      - nfs_server
      - cifs_server
      - ethernet_port
      - file_interface
      - replication_session

- name: Get information of Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"

- name: Get list of hosts on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - host

- name: Get list of FC initiators on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - fc_initiator

- name: Get list of ISCSI initiators on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - iscsi_initiator

- name: Get list of consistency groups on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - cg

- name: Get list of storage pools on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - storage_pool

- name: Get list of volumes on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - vol

- name: Get list of snapshot schedules on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - snapshot_schedule

- name: Get list of NAS Servers on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - nas_server

- name: Get list of File Systems on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - file_system

- name: Get list of Snapshots on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - snapshot

- name: Get list of NFS exports on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - nfs_export

- name: Get list of SMB shares on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - smb_share

- name: Get list of user quotas on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - user_quota

- name: Get list of quota trees on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - tree_quota

- name: Get list of disk groups on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - disk_group

- name: Get list of NFS Servers on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - nfs_server

- name: Get list of CIFS Servers on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - cifs_server

- name: Get list of ethernet ports on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - ethernet_port

- name: Get list of file interfaces on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - file_interface

- name: Get list of replication sessions on Unity array
  dellemc.unity.info:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    gather_subset:
      - replication_session

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

Array_Details

dictionary

Details of the Unity Array.

Returned: always

Sample: {"api_version": "12.0", "earliest_api_version": "4.0", "existed": true, "hash": 8766644083532, "id": "0", "model": "Unity 480", "name": "APM00213404195", "software_version": "5.2.1"}

api_version

string

The current api version of the Unity Array.

Returned: success

earliest_api_version

string

The earliest api version of the Unity Array.

Returned: success

model

string

The model of the Unity Array.

Returned: success

name

string

The name of the Unity Array.

Returned: success

software_version

string

The software version of the Unity Array.

Returned: success

CIFS_Servers

list / elements=string

Details of the CIFS Servers.

Returned: When CIFS Servers exist.

Sample: [{"id": "cifs_3", "name": "test_cifs_1"}, {"id": "cifs_4", "name": "test_cifs_2"}, {"id": "cifs_9", "name": "test_cifs_3"}]

id

string

The ID of the CIFS Servers.

Returned: success

name

string

The name of the CIFS server.

Returned: success

Consistency_Groups

list / elements=string

Details of the Consistency Groups.

Returned: When Consistency Groups exist.

Sample: [{"advanced_dedup_status": "DedupStatusEnum.DISABLED", "block_host_access": {"UnityBlockHostAccessList": [{"UnityBlockHostAccess": {"hash": 8745385821206}}, {"UnityBlockHostAccess": {"hash": 8745386530115}}, {"UnityBlockHostAccess": {"hash": 8745386530124}}]}, "data_reduction_percent": 0, "data_reduction_ratio": 1.0, "data_reduction_size_saved": 0, "data_reduction_status": "DataReductionStatusEnum.DISABLED", "datastores": null, "dedup_status": null, "description": "CG has created with all parametres.", "esx_filesystem_block_size": null, "esx_filesystem_major_version": null, "existed": true, "filesystem": null, "hash": 8745385801328, "health": {"UnityHealth": {"hash": 8745386647098}}, "host_v_vol_datastore": null, "id": "res_93", "is_replication_destination": false, "is_snap_schedule_paused": false, "luns": {"UnityLunList": [{"UnityLun": {"hash": 8745389830024, "id": "sv_64"}}, {"UnityLun": {"hash": 8745386526751, "id": "sv_63"}}]}, "metadata_size": 8858370048, "metadata_size_allocated": 7516192768, "name": "CG1_Ansible_Test_SS", "per_tier_size_used": [11811160064, 0, 0], "pools": {"UnityPoolList": [{"UnityPool": {"hash": 8745386552375, "id": "pool_3"}}]}, "relocation_policy": "TieringPolicyEnum.AUTOTIER", "replication_type": "ReplicationTypeEnum.NONE", "size_allocated": 99418112, "size_total": 268435456000, "size_used": null, "snap_count": 1, "snap_schedule": {"UnitySnapSchedule": {"hash": 8745386550224, "id": "snapSch_66"}}, "snaps_size_allocated": 8888320, "snaps_size_total": 108675072, "thin_status": "ThinStatusEnum.TRUE", "type": "StorageResourceTypeEnum.CONSISTENCY_GROUP", "virtual_volumes": null, "vmware_uuid": null}]

id

string

The ID of the Consistency Group.

Returned: success

name

string

The name of the Consistency Group.

Returned: success

Disk_Groups

list / elements=string

Details of the disk groups.

Returned: When disk groups exist.

Sample: [{"id": "dg_3", "name": "400 GB SAS Flash 2", "tier_type": "EXTREME_PERFORMANCE"}, {"id": "dg_16", "name": "600 GB SAS 10K", "tier_type": "PERFORMANCE"}]

id

string

The ID of the disk group.

Returned: success

name

string

The name of the disk group.

Returned: success

tier_type

string

The tier type of the disk group.

Returned: success

Ethernet_ports

list / elements=string

Details of the ethernet ports.

Returned: When ethernet ports exist.

Sample: [{"id": "spa_mgmt", "name": "SP A Management Port"}, {"id": "spa_ocp_0_eth0", "name": "SP A 4-Port Card Ethernet Port 0"}, {"id": "spa_ocp_0_eth1", "name": "SP A 4-Port Card Ethernet Port 1"}]

id

string

The ID of the ethernet port.

Returned: success

name

string

The name of the ethernet port.

Returned: success

FC_initiators

list / elements=string

Details of the FC initiators.

Returned: When FC initiator exist.

Sample: [{"WWN": "20:00:00:0E:1E:E9:B8:FC:21:00:00:0E:1E:E9:B8:FC", "id": "HostInitiator_3"}, {"WWN": "20:00:00:0E:1E:E9:B8:F7:21:00:00:0E:1E:E9:B8:F7", "id": "HostInitiator_4"}]

id

string

The id of the FC initiator.

Returned: success

WWN

string

The WWN of the FC initiator.

Returned: success

File_interfaces

list / elements=string

Details of the file inetrfaces.

Returned: When file inetrface exist.

Sample: [{"id": "if_3", "ip_address": "xx.xx.xx.xx", "name": "1_APMXXXXXXXXXX"}, {"id": "if_3", "ip_address": "xx.xx.xx.xx", "name": "2_APMXXXXXXXXXX"}, {"id": "if_3", "ip_address": "xx.xx.xx.xx", "name": "3_APMXXXXXXXXXX"}]

id

string

The ID of the file inetrface.

Returned: success

ip_address

string

IP address of the file inetrface.

Returned: success

name

string

The name of the file inetrface.

Returned: success

File_Systems

list / elements=string

Details of the File Systems.

Returned: When File Systems exist.

Sample: [{"access_policy": "AccessPolicyEnum.UNIX", "cifs_notify_on_change_dir_depth": 512, "cifs_share": null, "data_reduction_percent": 0, "data_reduction_ratio": 1.0, "data_reduction_size_saved": 0, "description": "", "existed": true, "folder_rename_policy": "FSRenamePolicyEnum.SMB_RENAME_FORBIDDEN", "format": "FSFormatEnum.UFS64", "hash": 8786518053735, "health": {"UnityHealth": {"hash": 8786518049091}}, "host_io_size": "HostIOSizeEnum.GENERAL_8K", "id": "fs_12", "is_advanced_dedup_enabled": false, "is_cifs_notify_on_access_enabled": false, "is_cifs_notify_on_write_enabled": false, "is_cifs_op_locks_enabled": true, "is_cifs_sync_writes_enabled": false, "is_data_reduction_enabled": false, "is_read_only": false, "is_smbca": false, "is_thin_enabled": true, "locking_policy": "FSLockingPolicyEnum.MANDATORY", "metadata_size": 4294967296, "metadata_size_allocated": 3758096384, "min_size_allocated": 0, "name": "vro-daniel-test", "nas_server": {"UnityNasServer": {"hash": 8786517296113, "id": "nas_1"}}, "nfs_share": null, "per_tier_size_used": [6442450944, 0, 0], "pool": {"UnityPool": {"hash": 8786518259493, "id": "pool_3"}}, "pool_full_policy": "ResourcePoolFullPolicyEnum.FAIL_WRITES", "size_allocated": 283148288, "size_allocated_total": 4041244672, "size_preallocated": 2401206272, "size_total": 107374182400, "size_used": 1620312064, "snap_count": 0, "snaps_size": 0, "snaps_size_allocated": 0, "storage_resource": {"UnityStorageResource": {"hash": 8786518044167, "id": "res_20"}}, "supported_protocols": "FSSupportedProtocolEnum.NFS", "tiering_policy": "TieringPolicyEnum.AUTOTIER_HIGH", "type": "FilesystemTypeEnum.FILESYSTEM"}]

id

string

The ID of the File System.

Returned: success

name

string

The name of the File System.

Returned: success

Hosts

list / elements=string

Details of the hosts.

Returned: When hosts exist.

Sample: [{"auto_manage_type": "HostManageEnum.UNKNOWN", "datastores": null, "description": "", "existed": true, "fc_host_initiators": null, "hash": 8762200072289, "health": {"UnityHealth": {"hash": 8762200072352}}, "host_container": null, "host_ip_ports": {"UnityHostIpPortList": [{"UnityHostIpPort": {"hash": 8762200072361}}]}, "host_luns": null, "host_polled_uuid": null, "host_pushed_uuid": null, "host_uuid": null, "host_v_vol_datastore": null, "id": "Host_2191", "iscsi_host_initiators": null, "last_poll_time": null, "name": "10.225.2.153", "os_type": "Linux", "registration_type": null, "storage_resources": null, "tenant": null, "type": "HostTypeEnum.HOST_MANUAL", "vms": null}]

id

string

The ID of the host.

Returned: success

name

string

The name of the host.

Returned: success

ISCSI_initiators

list / elements=string

Details of the ISCSI initiators.

Returned: When ISCSI initiators exist.

Sample: [{"IQN": "iqn.1994-05.com.redhat:634d768090f", "id": "HostInitiator_1"}, {"IQN": "iqn.1994-05.com.redhat:2835ba62cc6d", "id": "HostInitiator_2"}]

id

string

The id of the ISCSI initiator.

Returned: success

IQN

string

The IQN of the ISCSI initiator.

Returned: success

NAS_Servers

list / elements=string

Details of the NAS Servers.

Returned: When NAS Servers exist.

Sample: [{"allow_unmapped_user": null, "cifs_server": null, "current_sp": {"UnityStorageProcessor": {"hash": 8747629920422, "id": "spb"}}, "current_unix_directory_service": "NasServerUnixDirectoryServiceEnum.NONE", "default_unix_user": null, "default_windows_user": null, "existed": true, "file_dns_server": null, "file_interface": {"UnityFileInterfaceList": [{"UnityFileInterface": {"hash": 8747626606870, "id": "if_6"}}]}, "filesystems": {"UnityFileSystemList": [{"UnityFileSystem": {"hash": 8747625901355, "id": "fs_6892"}}]}, "hash": 8747625900370, "health": {"UnityHealth": {"hash": 8747625900493}}, "home_sp": {"UnityStorageProcessor": {"hash": 8747625877420, "id": "spb"}}, "id": "nas_1", "is_backup_only": false, "is_multi_protocol_enabled": false, "is_packet_reflect_enabled": false, "is_replication_destination": false, "is_replication_enabled": false, "is_windows_to_unix_username_mapping_enabled": null, "name": "lglad072", "pool": {"UnityPool": {"hash": 8747629920479, "id": "pool_3"}}, "preferred_interface_settings": {"UnityPreferredInterfaceSettings": {"hash": 8747626625166, "id": "preferred_if_1"}}, "replication_type": "ReplicationTypeEnum.NONE", "size_allocated": 2952790016, "tenant": null, "virus_checker": {"UnityVirusChecker": {"hash": 8747626604144, "id": "cava_1"}}}]

id

string

The ID of the NAS Server.

Returned: success

name

string

The name of the NAS Server.

Returned: success

NFS_Exports

list / elements=string

Details of the NFS Exports.

Returned: When NFS Exports exist.

Sample: [{"anonymous_gid": 4294967294, "anonymous_uid": 4294967294, "creation_time": "2021-12-01 06:21:48.381000+00:00", "default_access": "NFSShareDefaultAccessEnum.NO_ACCESS", "description": "", "existed": true, "export_option": 1, "export_paths": ["10.230.24.20:/zack_nfs_01"], "filesystem": {"UnityFileSystem": {"hash": 8747298565566, "id": "fs_67"}}, "hash": 8747298565548, "host_accesses": null, "id": "NFSShare_29", "is_read_only": null, "min_security": "NFSShareSecurityEnum.SYS", "modification_time": "2022-04-01 11:44:17.553000+00:00", "name": "zack_nfs_01", "nfs_owner_username": null, "no_access_hosts": null, "no_access_hosts_string": "10.226.198.207,10.226.198.25,10.226.198.44,10.226.198.85,Host1, Host2,Host4,Host5,Host6,10.10.0.0/255.255.240.0", "path": "/", "read_only_hosts": null, "read_only_hosts_string": "", "read_only_root_access_hosts": null, "read_only_root_hosts_string": "", "read_write_hosts": null, "read_write_hosts_string": "", "read_write_root_hosts_string": "", "role": "NFSShareRoleEnum.PRODUCTION", "root_access_hosts": null, "snap": null, "type": "NFSTypeEnum.NFS_SHARE"}]

id

string

The ID of the NFS Export.

Returned: success

name

string

The name of the NFS Export.

Returned: success

NFS_Servers

list / elements=string

Details of the NFS Servers.

Returned: When NFS Servers exist.

Sample: [{"id": "nfs_3"}, {"id": "nfs_4"}, {"id": "nfs_9"}]

id

string

The ID of the NFS Servers.

Returned: success

Replication_sessions

list / elements=string

Details of the Replication sessions.

Returned: When Replication sessions exist.

Sample: [{"current_transfer_est_remain_time": 0, "daily_snap_replication_policy": null, "dst_resource_id": "nas_8", "dst_spa_interface": {"UnityRemoteInterface": {"hash": 8771253398547, "id": "APM00213404195:if_181"}}, "dst_spb_interface": {"UnityRemoteInterface": {"hash": 8771253424144, "id": "APM00213404195:if_180"}}, "dst_status": "ReplicationSessionStatusEnum.OK", "existed": true, "hash": 8771259012271, "health": {"UnityHealth": {"hash": 8771253424168}}, "hourly_snap_replication_policy": null, "id": "103079215114_APM00213404195_0000_103079215274_APM00213404194_0000", "last_sync_time": "2023-04-18 10:35:25+00:00", "local_role": "ReplicationSessionReplicationRoleEnum.DESTINATION", "max_time_out_of_sync": 0, "members": null, "name": "rep_sess_nas", "network_status": "ReplicationSessionNetworkStatusEnum.OK", "remote_system": {"UnityRemoteSystem": {"hash": 8771253380142}}, "replication_resource_type": "ReplicationEndpointResourceTypeEnum.NASSERVER", "src_resource_id": "nas_213", "src_spa_interface": {"UnityRemoteInterface": {"hash": 8771253475010, "id": "APM00213404194:if_195"}}, "src_spb_interface": {"UnityRemoteInterface": {"hash": 8771253374169, "id": "APM00213404194:if_194"}}, "src_status": "ReplicationSessionStatusEnum.OK", "status": "ReplicationOpStatusEnum.ACTIVE", "sync_progress": 0, "sync_state": "ReplicationSessionSyncStateEnum.IN_SYNC"}]

id

string

The ID of the Replication session.

Returned: success

name

string

The name of the Replication session.

Returned: success

SMB_Shares

list / elements=string

Details of the SMB Shares.

Returned: When SMB Shares exist.

Sample: [{"creation_time": "2022-03-17 11:56:54.867000+00:00", "description": "", "existed": true, "export_paths": ["\\\\multi-prot-pie.extreme1.com\\multi-prot-hui", "\\\\10.230.24.26\\multi-prot-hui"], "filesystem": {"UnityFileSystem": {"hash": 8741295638110, "id": "fs_140"}}, "hash": 8741295638227, "id": "SMBShare_20", "is_abe_enabled": false, "is_ace_enabled": false, "is_branch_cache_enabled": false, "is_continuous_availability_enabled": false, "is_dfs_enabled": false, "is_encryption_enabled": false, "is_read_only": null, "modified_time": "2022-03-17 11:56:54.867000+00:00", "name": "multi-prot-hui", "offline_availability": "CifsShareOfflineAvailabilityEnum.NONE", "path": "/", "snap": null, "type": "CIFSTypeEnum.CIFS_SHARE", "umask": "022"}]

id

string

The ID of the SMB Share.

Returned: success

name

string

The name of the SMB Share.

Returned: success

Snapshot_Schedules

list / elements=string

Details of the Snapshot Schedules.

Returned: When Snapshot Schedules exist.

Sample: [{"existed": true, "hash": 8775599492651, "id": "snapSch_1", "is_default": true, "is_modified": null, "is_sync_replicated": false, "luns": null, "modification_time": "2021-08-18 19:10:33.774000+00:00", "name": "CEM_DEFAULT_SCHEDULE_DEFAULT_PROTECTION", "rules": {"UnitySnapScheduleRuleList": [{"UnitySnapScheduleRule": {"hash": 8775599498593}}]}, "storage_resources": {"UnityStorageResourceList": [{"UnityStorageResource": {"hash": 8775599711597, "id": "res_88"}}, {"UnityStorageResource": {"hash": 8775599711528, "id": "res_3099"}}]}, "version": "ScheduleVersionEnum.LEGACY"}]

id

string

The ID of the Snapshot Schedule.

Returned: success

name

string

The name of the Snapshot Schedule.

Returned: success

Snapshots

list / elements=string

Details of the Snapshots.

Returned: When Snapshots exist.

Sample: [{"access_type": "FilesystemSnapAccessTypeEnum.CHECKPOINT", "attached_wwn": null, "creation_time": "2022-04-06 11:19:26.818000+00:00", "creator_schedule": null, "creator_type": "SnapCreatorTypeEnum.REP_V2", "creator_user": null, "description": "", "existed": true, "expiration_time": null, "hash": 8739100256648, "host_access": null, "id": "38654716464", "io_limit_policy": null, "is_auto_delete": false, "is_modifiable": false, "is_modified": false, "is_read_only": true, "is_system_snap": true, "last_writable_time": null, "lun": {"UnityLun": {"hash": 8739100148962, "id": "sv_301"}}, "name": "42949677504_APM00213404195_0000.ckpt000_9508038064690266.2_238", "parent_snap": null, "size": 3221225472, "snap_group": null, "state": "SnapStateEnum.READY", "storage_resource": {"UnityStorageResource": {"hash": 8739100173002, "id": "sv_301"}}}]

id

string

The ID of the Snapshot.

Returned: success

name

string

The name of the Snapshot.

Returned: success

Storage_Pools

list / elements=string

Details of the Storage Pools.

Returned: When Storage Pools exist.

Sample: [{"alert_threshold": 70, "creation_time": "2021-10-18 12:45:12+00:00", "description": "", "existed": true, "harvest_state": "UsageHarvestStateEnum.PAUSED_COULD_NOT_REACH_HWM", "hash": 8741501012399, "health": {"UnityHealth": {"hash": 8741501012363}}, "id": "pool_2", "is_all_flash": false, "is_empty": false, "is_fast_cache_enabled": false, "is_harvest_enabled": true, "is_snap_harvest_enabled": false, "metadata_size_subscribed": 312458870784, "metadata_size_used": 244544700416, "name": "fastVP_pool", "object_id": 12884901891, "pool_fast_vp": {"UnityPoolFastVp": {"hash": 8741501228023}}, "pool_space_harvest_high_threshold": 95.0, "pool_space_harvest_low_threshold": 85.0, "pool_type": "StoragePoolTypeEnum.TRADITIONAL", "raid_type": "RaidTypeEnum.RAID5", "rebalance_progress": null, "size_free": 2709855928320, "size_subscribed": 2499805044736, "size_total": 3291018690560, "size_used": 455513956352, "snap_size_subscribed": 139720515584, "snap_size_used": 66002944, "snap_space_harvest_high_threshold": 25.0, "snap_space_harvest_low_threshold": 20.0, "tiers": {"UnityPoolTierList": [{"UnityPoolTier": {"hash": 8741500996410}}, {"UnityPoolTier": {"hash": 8741501009430}}, {"UnityPoolTier": {"hash": 8741501009508}}]}}]

id

string

The ID of the Storage Pool.

Returned: success

name

string

The name of the Storage Pool.

Returned: success

Tree_Quotas

list / elements=string

Details of the quota trees.

Returned: When quota trees exist.

Sample: [{"id": "treequota_171798709589_1", "path": "/vro-ui-fs-rkKfimmN"}, {"id": "treequota_171798709590_1", "path": "/vro-ui-fs-mGYXAMqk"}]

id

string

The ID of the quota tree.

Returned: success

path

string

The path of the quota tree.

Returned: success

User_Quotas

list / elements=string

Details of the user quotas.

Returned: When user quotas exist.

Sample: [{"id": "userquota_171798694698_0_60000", "uid": 60000}, {"id": "userquota_171798694939_0_5001", "uid": 5001}]

id

string

The ID of the user quota.

Returned: success

uid

string

The UID of the user quota.

Returned: success

Volumes

list / elements=string

Details of the Volumes.

Returned: When Volumes exist.

Sample: [{"current_node": "NodeEnum.SPB", "data_reduction_percent": 0, "data_reduction_ratio": 1.0, "data_reduction_size_saved": 0, "default_node": "NodeEnum.SPB", "description": null, "effective_io_limit_max_iops": null, "effective_io_limit_max_kbps": null, "existed": true, "family_base_lun": {"UnityLun": {"hash": 8774260820794, "id": "sv_27"}}, "family_clone_count": 0, "hash": 8774260854260, "health": {"UnityHealth": {"hash": 8774260812499}}, "host_access": {"UnityBlockHostAccessList": [{"UnityBlockHostAccess": {"hash": 8774260826387}}]}, "id": "sv_27", "io_limit_policy": null, "is_advanced_dedup_enabled": false, "is_compression_enabled": null, "is_data_reduction_enabled": false, "is_replication_destination": false, "is_snap_schedule_paused": false, "is_thin_clone": false, "is_thin_enabled": false, "metadata_size": 4294967296, "metadata_size_allocated": 4026531840, "name": "VSI-UNITY-test-task", "per_tier_size_used": [111400714240, 0, 0], "pool": {"UnityPool": {"hash": 8774260811427}}, "size_allocated": 107374182400, "size_total": 107374182400, "size_used": null, "snap_count": 0, "snap_schedule": null, "snap_wwn": "60:06:01:60:5C:F0:50:00:94:3E:91:4D:51:5A:4F:97", "snaps_size": 0, "snaps_size_allocated": 0, "storage_resource": {"UnityStorageResource": {"hash": 8774267822228}}, "tiering_policy": "TieringPolicyEnum.AUTOTIER_HIGH", "type": "LUNTypeEnum.VMWARE_ISCSI", "wwn": "60:06:01:60:5C:F0:50:00:00:B5:95:61:2E:34:DB:B2"}]

id

string

The ID of the Volume.

Returned: success

name

string

The name of the Volume.

Returned: success

Authors

  • Rajshree Khare (@kharer5)

  • Akash Shendge (@shenda1)

  • Meenakshi Dembi (@dembim)