dellemc.unity.dellemc_unity_gatherfacts (1.2.1) — module

Gathering information about DellEMC Unity

| "added in version" 1.1.0 of dellemc.unity"

Authors: Rajshree Khare (@kharer5) <ansible.team@dell.com>, Akash Shendge (@shenda1) <ansible.team@dell.com>

preview | supported by community

Install collection

Install with ansible-galaxy collection install dellemc.unity:==1.2.1


Add to requirements.yml

  collections:
    - name: dellemc.unity
      version: 1.2.1

Description

Gathering information about DellEMC 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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get detailed list of Unity entities
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get information of Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of hosts on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - host
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of FC initiators on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - fc_initiator
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of ISCSI initiators on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - iscsi_initiator
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of consistency groups on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - cg
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of storage pools on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - storage_pool
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of volumes on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - vol
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of snapshot schedules on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - snapshot_schedule
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of NAS Servers on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - nas_server
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of File Systems on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - file_system
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of Snapshots on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - snapshot
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of NFS exports on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - nfs_export
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of SMB shares on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - smb_share
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of user quotas on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - user_quota
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - name: Get list of quota trees on Unity array
   dellemc.unity.dellemc_unity_gatherfacts:
     unispherehost: "{{unispherehost}}"
     username: "{{username}}"
     password: "{{password}}"
     verifycert: "{{verifycert}}"
     gather_subset:
       - tree_quota

Inputs

    
port:
    default: 443
    description:
    - Port number through which communication happens with Unity management server.
    required: false
    type: int

password:
    description:
    - The password of the Unity management server.
    required: true
    type: str

username:
    description:
    - The username of the Unity management server.
    required: true
    type: str

verifycert:
    choices:
    - true
    - false
    default: true
    description:
    - 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.
    required: false
    type: bool

gather_subset:
    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
    description:
    - List of string variables to specify the Unity storage system entities for which
      information is required.
    - host
    - fc_initiator
    - iscsi_initiator
    - cg
    - storage_pool
    - vol
    - snapshot_schedule
    - nas_server
    - file_system
    - snapshot
    - nfs_export
    - smb_share
    - user_quota
    - tree_quota
    elements: str
    type: list

unispherehost:
    description:
    - IP or FQDN of the Unity management server.
    required: true
    type: str

Outputs

Array_Details:
  contains:
    api_version:
      description: The current api version of the Unity Array.
      type: str
    earliest_api_version:
      description: The earliest api version of the Unity Array.
      type: str
    model:
      description: The model of the Unity Array.
      type: str
    name:
      description: The name of the Unity Array.
      type: str
    software_version:
      description: The software version of the Unity Array.
      type: str
  description: Details of the Unity Array.
  returned: always
  type: complex
Consistency_Groups:
  contains:
    id:
      description: The ID of the Consistency Group.
      type: str
    name:
      description: The name of the Consistency Group.
      type: str
  description: Details of the Consistency Groups.
  returned: When Consistency Groups exist.
  type: complex
FC_initiators:
  contains:
    WWN:
      description: The WWN of the FC initiator.
      type: str
    id:
      description: The id of the FC initiator.
      type: str
  description: Details of the FC initiators.
  returned: When FC initiator exist.
  type: complex
File_Systems:
  contains:
    id:
      description: The ID of the File System.
      type: str
    name:
      description: The name of the File System.
      type: str
  description: Details of the File Systems.
  returned: When File Systems exist.
  type: complex
Hosts:
  contains:
    id:
      description: The ID of the host.
      type: str
    name:
      description: The name of the host.
      type: str
  description: Details of the hosts.
  returned: When hosts exist.
  type: complex
ISCSI_initiators:
  contains:
    IQN:
      description: The IQN of the ISCSI initiator.
      type: str
    id:
      description: The id of the ISCSI initiator.
      type: str
  description: Details of the ISCSI initiators.
  returned: When ISCSI initiators exist.
  type: complex
NAS_Servers:
  contains:
    id:
      description: The ID of the NAS Server.
      type: str
    name:
      description: The name of the NAS Server.
      type: str
  description: Details of the NAS Servers.
  returned: When NAS Servers exist.
  type: complex
NFS_Exports:
  contains:
    id:
      description: The ID of the NFS Export.
      type: str
    name:
      description: The name of the NFS Export.
      type: str
  description: Details of the NFS Exports.
  returned: When NFS Exports exist.
  type: complex
SMB_Shares:
  contains:
    id:
      description: The ID of the SMB Share.
      type: str
    name:
      description: The name of the SMB Share.
      type: str
  description: Details of the SMB Shares.
  returned: When SMB Shares exist.
  type: complex
Snapshot_Schedules:
  contains:
    id:
      description: The ID of the Snapshot Schedule.
      type: str
    name:
      description: The name of the Snapshot Schedule.
      type: str
  description: Details of the Snapshot Schedules.
  returned: When Snapshot Schedules exist.
  type: complex
Snapshots:
  contains:
    id:
      description: The ID of the Snapshot.
      type: str
    name:
      description: The name of the Snapshot.
      type: str
  description: Details of the Snapshots.
  returned: When Snapshots exist.
  type: complex
Storage_Pools:
  contains:
    id:
      description: The ID of the Storage Pool.
      type: str
    name:
      description: The name of the Storage Pool.
      type: str
  description: Details of the Storage Pools.
  returned: When Storage Pools exist.
  type: complex
Tree_Quotas:
  contains:
    id:
      description: The ID of the quota tree.
      type: str
    path:
      description: The path of the quota tree.
      type: str
  description: Details of the quota trees.
  returned: When quota trees exist.
  type: complex
User_Quotas:
  contains:
    id:
      description: The ID of the user quota.
      type: str
    uid:
      description: The UID of the user quota.
      type: str
  description: Details of the user quotas.
  returned: When user quotas exist.
  type: complex
Volumes:
  contains:
    id:
      description: The ID of the Volume.
      type: str
    name:
      description: The name of the Volume.
      type: str
  description: Details of the Volumes.
  returned: When Volumes exist.
  type: complex