Try SpotterGathers information about PowerMax/VMAX Storage entities
| "added in version" 1.0.0 of dellemc.powermax"
Authors: Arindam Datta (@dattaarindam) <ansible.team@dell.com>, Rajshree Khare (@khareRajshree) <ansible.team@dell.com>
preview | supported by community
Install with ansible-galaxy collection install dellemc.powermax:==1.6.1
collections:
- name: dellemc.powermax
version: 1.6.1Gathers the list of specified PowerMax/VMAX storage system entities, such as the list of registered arrays, storage groups, hosts, host groups, storage groups, storage resource pools, port groups, masking views, array health status, alerts and metro DR environments, so on.
- name: Get list of volumes with filter -- all TDEV volumes of size equal
to 5GB
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- vol
filters:
- filter_key: "tdev"
filter_operator: "equal"
filter_value: "True"
- filter_key: "cap_gb"
filter_operator: "equal"
filter_value: "5"
- name: Get list of volumes and storage groups with filter
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- vol
- sg
filters:
- filter_key: "tdev"
filter_operator: "equal"
filter_value: "True"
- filter_key: "cap_gb"
filter_operator: "equal"
filter_value: "5"
- name: Get list of storage groups with capacity between 2GB to 10GB
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- sg
filters:
- filter_key: "cap_gb"
filter_operator: "greater"
filter_value: "2"
- filter_key: "cap_gb"
filter_operator: "lesser"
filter_value: "10"
- name: Get the list of arrays for a given Unisphere host
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
register: array_list
- debug:
var: array_list
- name: Get list of tdev-volumes
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
tdev_volumes: True
gather_subset:
- vol
- name: Get the list of arrays for a given Unisphere host
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
- name: Get array health status
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- health
- name: Get array alerts summary
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- alert
- name: Get the list of metro DR environments for a given Unisphere host
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- metro_dr_env
- name: Get list of Storage groups
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- sg
- name: Get list of Storage Resource Pools
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- srp
- name: Get list of Ports
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- port
- name: Get list of Port Groups
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- pg
- name: Get list of Hosts
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- host
- name: Get list of Host Groups
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- hg
- name: Get list of Masking Views
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- mv
- name: Get list of RDF Groups
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- rdf
- name: Get list of snapshot policies
dellemc_powermax_gatherfacts:
unispherehost: "{{unispherehost}}"
universion: "{{universion}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
serial_no: "{{serial_no}}"
gather_subset:
- snapshot_policies
user:
description:
- The username of the Unisphere host.
required: true
type: str
filters:
description:
- List of filters to support filtered output for storage entities.
- Each filter is a tuple of {filter_key, filter_operator, filter_value}.
- Supports passing of multiple filters.
- The storage entities, 'rdf', 'health', 'snapshot_policies' and 'metro_dr_env', does
not support filters. Filters will be ignored if passed.
elements: dict
required: false
suboptions:
filter_key:
description:
- Name identifier of the filter.
required: true
type: str
filter_operator:
choices:
- equal
- greater
- lesser
- like
description:
- Operation to be performed on filter key.
required: true
type: str
filter_value:
description:
- Value of the filter key.
required: true
type: str
type: list
password:
description:
- The password of the Unisphere host.
required: true
type: str
serial_no:
description:
- The serial number of the PowerMax/VMAX array. It is not required for getting the
list of arrays.
required: false
type: str
universion:
choices:
- 91
- 92
description:
- Unisphere version, currently '91' and '92' versions are supported.
required: false
type: int
verifycert:
choices:
- true
- false
description:
- Boolean variable to specify whether to validate SSL certificate or not.
- True - indicates that the SSL certificate should be verified.
- False - indicates that the SSL certificate should not be verified.
required: true
type: bool
tdev_volumes:
choices:
- true
- false
default: true
description:
- Boolean variable to filter the volume list. This will have a small performance impact.
By default it is set to true, only TDEV volumes will be returned.
- True - Will return only the TDEV volumes.
- False - Will return all the volumes.
required: false
type: bool
gather_subset:
choices:
- alert
- health
- vol
- srp
- sg
- pg
- host
- hg
- port
- mv
- rdf
- metro_dr_env
- snapshot_policies
description:
- List of string variables to specify the PowerMax/VMAX entities for which information
is required.
- Required only if the serial_no is present
- List of all PowerMax/VMAX entities supported by the module
- alert - gets alert summary information
- health - health status of a specific PowerMax array
- vol - volumes
- srp - storage resource pools
- sg - storage groups
- pg - port groups
- host - hosts
- hg - host groups
- port - ports
- mv - masking views
- rdf - rdf groups
- metro_dr_env - metro DR environments
- snapshot_policies - snapshot policies
elements: str
required: false
type: list
unispherehost:
description:
- IP or FQDN of the Unisphere host
required: true
type: str
Alerts:
contains:
acknowledged:
description: Whether or not this alert is acknowledged.
type: str
alertId:
description: Unique ID of alert.
type: str
array:
description: Array serial no.
type: str
created_date:
description: Creation Date.
type: str
created_date_milliseconds:
description: Creation Date in milliseconds.
type: str
description:
description: Description about the alert
type: str
object:
description: Object description
type: str
object_type:
description: Resource class
type: str
severity:
description: Severity of the alert
type: str
state:
description: State of the alert
type: str
type:
description: Type of the alert
type: str
description: Alert summary of the array.
returned: When the alert exists.
type: list
Arrays:
description: List of arrays in the Unisphere.
returned: When the Unisphere exist.
type: list
Health:
contains:
health_score_metric:
contains:
cached_date:
description: Date Time stamp in epoch format when it was cached.
type: int
data_date:
description: Date Time stamp in epoch format when it was collected.
type: int
expired:
description: Flag to indicate the expiry of the score.
type: bool
health_score:
description: Overall health score in numbers.
type: int
instance_metrics:
contains:
health_score_instance_metric:
description: Health score of a specific instance.
type: int
description: Metrics about a specific instance.
type: list
metric:
description: Information about which sub system , such as SYSTEM_UTILIZATION,
CONFIGURATION,CAPACITY, and so on.
type: str
description: Overall health score for the specified Symmetrix.
type: list
num_failed_disks:
description: Numbers of the disk failure in this system.
type: int
description: Health status of the array.
returned: When the array exist.
type: complex
HostGroups:
description: List of host groups present on the array.
returned: When the hostgroups exist.
type: list
Hosts:
description: List of hosts present on the array.
returned: When the hosts exist.
type: list
MaskingViews:
description: List of masking views present on the array.
returned: When the masking views exist.
type: list
MetroDREnvironments:
description: List of metro DR environments on the array.
returned: When environment exists.
type: list
PortGroups:
description: List of port groups on the array.
returned: When the port groups exist.
type: list
Ports:
contains:
directorId:
description: Director ID of the port.
type: str
portId:
description: Port number of the port.
type: str
description: List of ports on the array.
returned: When the ports exist.
type: complex
RDFGroups:
contains:
label:
description: Name of the RDF group.
type: str
rdfgNumber:
description: Unique identifier of the RDF group.
type: int
description: List of RDF groups on the array.
returned: When the RDF groups exist.
type: complex
SnapshotPolicies:
description: List of snapshot policies on the array.
returned: When snapshot policy exists.
type: list
StorageGroups:
description: List of storage groups on the array.
returned: When the storage groups exist.
type: list
StorageResourcePools:
contains:
diskGroupId:
description: ID of the disk group.
type: list
emulation:
description: Type of volume emulation.
type: str
num_of_disk_groups:
description: Number of disk groups.
type: int
rdfa_dse:
description: Flag for RDFA Delta Set Extension.
type: bool
reserved_cap_percent:
description: Reserved capacity percentage.
type: int
srpId:
description: Unique Identifier for SRP.
type: str
srp_capacity:
contains:
effective_used_capacity_percent:
description: Percentage of effectively used capacity.
type: int
snapshot_modified_tb:
description: Snapshot modified in TB.
type: int
snapshot_total_tb:
description: Total snapshot size in TB.
type: int
subscribed_allocated_tb:
description: Subscribed allocated size in TB.
type: int
subscribed_total_tb:
description: Subscribed total size in TB.
type: int
usable_total_tb:
description: Usable total size in TB.
type: int
usable_used_tb:
description: Usable used size in TB.
type: int
description: Different entities to measure SRP capacity.
type: dict
srp_efficiency:
contains:
compression_state:
description: Depicts the compression state of the SRP.
type: str
data_reduction_enabled_percent:
description: Percentage of data reduction enabled in the SRP.
type: int
data_reduction_ratio_to_one:
description: Data reduction ratio of SRP.
type: int
overall_efficiency_ratio_to_one:
description: Overall effectively ratio of SRP.
type: int
snapshot_savings_ratio_to_one:
description: Snapshot savings ratio of SRP.
type: int
virtual_provisioning_savings_ratio_to_one:
description: Virtual provisioning savings ratio of SRP.
type: int
description: Different entities to measure SRP efficiency.
type: dict
total_srdf_dse_allocated_cap_gb:
description: Total srdf dse allocated capacity in GB.
type: int
description: List of storage pools on the array.
returned: When the storage pools exist.
type: complex
Volumes:
description: List of volumes on the array.
returned: When the volumes exist.
type: list