dellemc.powermax.rdfgroup (3.0.0) — module

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

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

Authors: Arindam Datta (@dattaarindam) <ansible.team@dell.com>, Ananthu S Kuttattu (@kuttattz) <ansible.team@dell.com>, Pavan Mudunuri (@Pavan-Mudunuri) <ansible.team@dell.com>

Install collection

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


Add to requirements.yml

  collections:
    - name: dellemc.powermax
      version: 3.0.0

Description

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

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

Get specific volume details of an RDF Group from a specified PowerMax or VMAX storage system.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get the details of an 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}}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get specific volume details of an RDF Group
  dellemc.powermax.rdfgroup:
    unispherehost: "{{unispherehost}}"
    serial_no: "{{serial_no}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    rdfgroup_number: "1"
    vol_name: "0001"

Inputs

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

timeout:
    default: 120
    description:
    - Time after which the connection will get terminated.
    - It is to be mentioned in seconds.
    type: int

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

vol_name:
    description:
    - Name of the volume.
    required: false
    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
    - 100
    - 101
    description:
    - Unisphere version, currently '91', '92', '100' and '101' versions are supported.
    required: false
    type: int

verifycert:
    description:
    - Specifies system whether to validate SSL certificate or not, Values can be True
      or False or a custom file path for SSL certificate with .pem extension or .cer with
      base 64 encoding.
    required: true
    type: str

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 volumes.
      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 operating environment of the array
        waits after the SRDF link goes down before updating the status of the link.
        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 in seconds that the session configured for.
          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 seconds 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,
            meaning it is the 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 exists.
  sample:
    RDFGroupVolumes:
    - largerRdfSide: Equal
      localRdfGroupNumber: 1
      localSymmetrixId: 0001XXX
      localVolumeName: test_vol
      localVolumeState: Ready
      local_wwn_external: '00000001111'
      rdfMode: Active
      rdfpairState: ActiveBias
      remoteRdfGroupNumber: 63
      remoteSymmetrixId: 0002XXX
      remoteVolumeName: test_vol_1
      remoteVolumeState: Ready
      remote_wwn_external: '11111111'
      volumeConfig: RDFXXXXX
    async: false
    biasConfigured: true
    biasEffective: true
    device_polarity: RDF2
    hardware_compression: false
    label: ansible_test
    link_limbo: 10
    localOnlinePorts: []
    localPorts: []
    metro: true
    modes:
    - Active
    numDevices: 2
    offline: false
    rdfgNumber: 63
    remoteOnlinePorts: []
    remotePorts: []
    remoteRdfgNumber: 63
    remoteSymmetrix: 0001XXXXX
    software_compression: false
    totalDeviceCapacity: 20.0
    type: Metro
    vasa_group: false
    witness: false
    witnessConfigured: false
    witnessDegraded: false
    witnessEffective: false
    witnessProtectedPhysical: false
    witnessProtectedVirtual: false
  type: list
RDFGroupVolumeDetails:
  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: RDF group volume details.
  returned: When the RDF group volume exist.
  sample:
    largerRdfSide: Equal
    localRdfGroupNumber: 1
    localSymmetrixId: 0001XXX
    localVolumeName: test_vol
    localVolumeState: Ready
    local_wwn_external: '00000001111'
    rdfMode: Active
    rdfpairState: ActiveBias
    remoteRdfGroupNumber: 63
    remoteSymmetrixId: 0002XXX
    remoteVolumeName: test_vol_1
    remoteVolumeState: Ready
    remote_wwn_external: '11111111'
    volumeConfig: RDFXXXXX
  type: complex
changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: 'false'
  type: bool