dellemc.powermax.dellemc_powermax_rdfgroup (1.6.1) — module

Gets the detail information about RDF Groups of a PowerMax/VMAX storage system

| "added in version" 1.3.0 of dellemc.powermax"

Authors: Arindam Datta (@dattaarindam) <ansible.team@dell.com>

preview | supported by community

Install collection

Install with ansible-galaxy collection install dellemc.powermax:==1.6.1


Add to requirements.yml

  collections:
    - name: dellemc.powermax
      version: 1.6.1

Description

Gets details of an RDF Group from a specified PowerMax/VMAX storage system.

Lists the volumes of an RDF Group from a specified PowerMax/VMAX storage system


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get the details of rdf group and volumes
  dellemc_powermax_rdfgroup:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    rdfgroup_number: "{{rdfgroup_id}}"

Inputs

    
user:
    description:
    - The username of the Unisphere host.
    required: true
    type: str

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 a required parameter for all
      array-specific operations except for getting a list of arrays in the Gatherfacts
      module.
    required: true
    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

unispherehost:
    description:
    - IP or FQDN of the Unisphere host
    required: true
    type: str

rdfgroup_number:
    description:
    - Identifier of an RDF Group of type string
    required: true
    type: str

Outputs

RDFGroupDetails:
  contains:
    RDFGroupVolumes:
      contains:
        largerRdfSide:
          description: Larger RDF side among the devices.
          type: str
        localRdfGroupNumber:
          description: RDF group number at primary device.
          type: int
        localSymmetrixId:
          description: Primary device ID.
          type: int
        localVolumeName:
          description: Volume name at primary device.
          type: str
        localVolumeState:
          description: Volume state at primary device
          type: str
        local_wwn_external:
          description: External WWN of volume at primary device.
          type: int
        rdfMode:
          description: SRDF mode of pairing.
          type: str
        rdfpairState:
          description: SRDF state of pairing.
          type: str
        remoteRdfGroupNumber:
          description: RDF group number at remote device.
          type: int
        remoteSymmetrixId:
          description: Remote device ID.
          type: int
        remoteVolumeName:
          description: Volume name at remote device.
          type: str
        remoteVolumeState:
          description: Volume state at remote device.
          type: str
        remote_wwn_external:
          description: External WWN of volume at remote device.
          type: int
        volumeConfig:
          description: Type of volume.
          type: str
      description: List of various properties of RDF group volume(s).
      type: list
    async:
      description: Flag sets to true when an SRDF pair is in async mode.
      type: bool
    biasConfigured:
      description: Flag for configured bias.
      type: bool
    biasEffective:
      description: Flag for effective bias.
      type: bool
    device_polarity:
      description: Type of device polarity.
      type: str
    hardware_compression:
      description: Flag for hardware compression.
      type: bool
    label:
      description: RDF group label.
      type: str
    link_limbo:
      description: The amount of time that the array's operating environment waits
        after the SRDF link goes down before updating the link's status. The link
        limbo value can be set from 0 to 120 seconds. The default value is 10 seconds.
      type: int
    localOnlinePorts:
      description: List of local online ports.
      type: list
    localPorts:
      description: List of local ports.
      type: list
    metro:
      description: Flag for metro configuration.
      type: list
    modes:
      description: Mode of the SRDF link.
      type: str
    numDevices:
      description: Number of devices involved in the pairing.
      type: int
    offline:
      description: Offline flag.
      type: bool
    rdfa_properties:
      contains:
        average_cycle_time:
          description: Average cycle time (seconds) configured for this session in
            seconds.
          type: int
        consistency_exempt_volumes:
          description: Flag that indicates if consistency is exempt.
          type: bool
        cycle_number:
          description: Number of cycles in seconds.
          type: int
        dse_active:
          description: Flag for active Delta Set Extension.
          type: bool
        dse_autostart:
          description: Indicates DSE autostart state.
          type: str
        dse_threshold:
          description: Flag for DSE threshold.
          type: int
        duration_of_last_cycle:
          description: The cycle time (in secs) of the most recently completed cycle.
          type: int
        duration_of_last_transmit_cycle:
          description: Duration of last transmitted cycle in seconds.
          type: int
        r1_to_r2_lag_time:
          description: Time that R2 is behind R1 in seconds.
          type: int
        session_priority:
          description: Priority used to determine which RDFA sessions to drop if cache
            becomes full. Values range from 1 to 64, with 1 being the highest priority
            (last to be dropped).
          type: int
        session_uncommitted_tracks:
          description: Number of uncommitted session tracks.
          type: int
        transmit_idle_state:
          description: Indicates RDFA transmit idle state.
          type: str
        transmit_idle_time:
          description: Time the transmit cycle has been idle.
          type: int
        transmit_queue_depth:
          description: The transmitted queue depth of disks.
          type: int
      description: Properties associated with the RDF group.
      type: list
    rdfgNumber:
      description: RDF group number on primary device.
      type: int
    remoteOnlinePorts:
      description: List of remote online ports.
      type: list
    remotePorts:
      description: List of remote ports.
      type: list
    remoteRdfgNumber:
      description: RDF group number at remote device.
      type: int
    remoteSymmetrix:
      description: Remote device ID.
      type: int
    software_compression:
      description: Flag for software compression.
      type: bool
    totalDeviceCapacity:
      description: Total capacity of RDF group in GB.
      type: int
    type:
      description: Type of RDF group.
      type: str
    vasa_group:
      description: Flag for VASA group member.
      type: bool
    witness:
      description: Flag for witness.
      type: bool
    witnessConfigured:
      description: Flag for configured witness.
      type: bool
    witnessDegraded:
      description: Flag for degraded witness.
      type: bool
    witnessEffective:
      description: Flag for effective witness.
      type: bool
    witnessProtectedPhysical:
      description: Flag for physically protected witness.
      type: bool
    witnessProtectedVirtual:
      description: Flag for virtually protected witness.
      type: bool
  description: Details of the RDF group.
  returned: When the RDF group exist.
  type: list
changed:
  description: Whether or not the resource has changed.
  returned: always
  type: bool