dellemc.unity.info module – Gathering information about Unity
Note
This module is part of the dellemc.unity collection (version 1.6.0).
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.
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.12 or later.
Python 3.9, 3.10 or 3.11.
Storops Python SDK 1.2.11.
Parameters
Parameter |
Comments |
---|---|
List of string variables to specify the Unity storage system entities for which information is required. Choices:
|
|
The password of the Unity management server. |
|
Port number through which communication happens with Unity management server. Default: |
|
IP or FQDN of the Unity management server. |
|
The username of the Unity management server. |
|
Boolean variable to specify whether or not to validate SSL certificate.
Choices:
|
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
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details of the Unity Array. Returned: always Sample: |
|
The current api version of the Unity Array. Returned: success |
|
The earliest api version of the Unity Array. Returned: success |
|
The model of the Unity Array. Returned: success |
|
The name of the Unity Array. Returned: success |
|
The software version of the Unity Array. Returned: success |
|
Details of the CIFS Servers. Returned: When CIFS Servers exist. Sample: |
|
The ID of the CIFS Servers. Returned: success |
|
The name of the CIFS server. Returned: success |
|
Details of the Consistency Groups. Returned: When Consistency Groups exist. Sample: |
|
The ID of the Consistency Group. Returned: success |
|
The name of the Consistency Group. Returned: success |
|
Details of the disk groups. Returned: When disk groups exist. Sample: |
|
The ID of the disk group. Returned: success |
|
The name of the disk group. Returned: success |
|
The tier type of the disk group. Returned: success |
|
Details of the ethernet ports. Returned: When ethernet ports exist. Sample: |
|
The ID of the ethernet port. Returned: success |
|
The name of the ethernet port. Returned: success |
|
Details of the FC initiators. Returned: When FC initiator exist. Sample: |
|
The id of the FC initiator. Returned: success |
|
The WWN of the FC initiator. Returned: success |
|
Details of the file inetrfaces. Returned: When file inetrface exist. Sample: |
|
The ID of the file inetrface. Returned: success |
|
IP address of the file inetrface. Returned: success |
|
The name of the file inetrface. Returned: success |
|
Details of the File Systems. Returned: When File Systems exist. Sample: |
|
The ID of the File System. Returned: success |
|
The name of the File System. Returned: success |
|
Details of the hosts. Returned: When hosts exist. Sample: |
|
The ID of the host. Returned: success |
|
The name of the host. Returned: success |
|
Details of the ISCSI initiators. Returned: When ISCSI initiators exist. Sample: |
|
The id of the ISCSI initiator. Returned: success |
|
The IQN of the ISCSI initiator. Returned: success |
|
Details of the NAS Servers. Returned: When NAS Servers exist. Sample: |
|
The ID of the NAS Server. Returned: success |
|
The name of the NAS Server. Returned: success |
|
Details of the NFS Exports. Returned: When NFS Exports exist. Sample: |
|
The ID of the NFS Export. Returned: success |
|
The name of the NFS Export. Returned: success |
|
Details of the NFS Servers. Returned: When NFS Servers exist. Sample: |
|
The ID of the NFS Servers. Returned: success |
|
Details of the SMB Shares. Returned: When SMB Shares exist. Sample: |
|
The ID of the SMB Share. Returned: success |
|
The name of the SMB Share. Returned: success |
|
Details of the Snapshot Schedules. Returned: When Snapshot Schedules exist. Sample: |
|
The ID of the Snapshot Schedule. Returned: success |
|
The name of the Snapshot Schedule. Returned: success |
|
Details of the Snapshots. Returned: When Snapshots exist. Sample: |
|
The ID of the Snapshot. Returned: success |
|
The name of the Snapshot. Returned: success |
|
Details of the Storage Pools. Returned: When Storage Pools exist. Sample: |
|
The ID of the Storage Pool. Returned: success |
|
The name of the Storage Pool. Returned: success |
|
Details of the quota trees. Returned: When quota trees exist. Sample: |
|
The ID of the quota tree. Returned: success |
|
The path of the quota tree. Returned: success |
|
Details of the user quotas. Returned: When user quotas exist. Sample: |
|
The ID of the user quota. Returned: success |
|
The UID of the user quota. Returned: success |
|
Details of the Volumes. Returned: When Volumes exist. Sample: |
|
The ID of the Volume. Returned: success |
|
The name of the Volume. Returned: success |