dellemc.powermax.volume (3.0.0) — module

Manage volumes on PowerMax Storage System

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

Authors: Vasudevu Lakhinana (@unknown) <ansible.team@dell.com>, Akash Shendge (@shenda1) <ansible.team@dell.com>, Ambuj Dubey (@AmbujDube) <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

Managing volumes on PowerMax storage system includes creating a volume, renaming a volume, expanding a volume, and deleting a volume.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create volume
  dellemc.powermax.volume:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    vol_name: "{{vol_name}}"
    sg_name: "{{sg_name}}"
    size: 1
    cap_unit: "{{cap_unit}}"
    append_vol_id: true
    state: 'present'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Expanding volume size
  dellemc.powermax.volume:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    size: 3
    cap_unit: "{{cap_unit}}"
    vol_id: "0059B"
    state: 'present'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Renaming volume
  dellemc.powermax.volume:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    new_name: "Test_GOLD_vol_Renamed"
    vol_id: "0059B"
    state: 'present'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete volume using volume ID
  dellemc.powermax.volume:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    vol_id: "0059B"
    state: 'absent'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete volume using volume WWN
  dellemc.powermax.volume:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    vol_wwn: "60000970000197900237533030303246"
    state: 'absent'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Move volume between storage group
  dellemc.powermax.volume:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    vol_name: "{{vol_name}}"
    sg_name: "{{sg_name}}"
    new_sg_name: "{{new_sg_name}}"
    state: 'present'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create volume with capacity unit as cylinder
  dellemc.powermax.volume:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    vol_name: "{{vol_name}}"
    sg_name: "{{sg_name}}"
    size: 1
    cap_unit: "CYL"
    state: 'present'

Inputs

    
size:
    description:
    - The new size of existing volume.
    - Required for create and expand volume operations.
    type: float

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

state:
    choices:
    - absent
    - present
    description:
    - Defines whether the volume should exist or not.
    required: true
    type: str

vol_id:
    description:
    - The native id of the volume.
    - Required for rename and delete volume operations.
    type: str

sg_name:
    description:
    - The name of the storage group.
    type: str

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

vol_wwn:
    description:
    - The WWN of the volume.
    type: str

cap_unit:
    choices:
    - MB
    - GB
    - TB
    - CYL
    description:
    - volume capacity units.
    - If not specified, default value is GB.
    type: str

new_name:
    description:
    - The new volume identifier for the volume.
    type: str

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

vol_name:
    description:
    - The name of the volume.
    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

new_sg_name:
    description:
    - The name of the target storage group.
    type: str

append_vol_id:
    description:
    - Appends volume id to the volume name, Applicable from V4 (Juniper).
    type: bool

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

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  type: bool
volume_details:
  contains:
    allocated_percent:
      description: Allocated percentage the volume.
      type: int
    cap_cyl:
      description: Number of cylinders.
      type: int
    cap_gb:
      description: Volume capacity in GB.
      type: int
    cap_mb:
      description: Volume capacity in MB.
      type: int
    effective_wwn:
      description: Effective WWN of the volume.
      type: str
    emulation:
      description: Volume emulation type.
      type: str
    encapsulated:
      description: Flag for encapsulation.
      type: bool
    has_effective_wwn:
      description: Flag for effective WWN presence.
      type: str
    mobility_id_enabled:
      description: Flag for enabling mobility.
      type: bool
    num_of_front_end_paths:
      description: Number of front end paths in the volume.
      type: int
    num_of_storage_groups:
      description: Number of storage groups in which volume is present.
      type: int
    pinned:
      description: Pinned flag.
      type: bool
    rdfGroupId:
      description: RDFG number for volume.
      type: int
    reserved:
      description: Reserved flag.
      type: bool
    snapvx_source:
      description: Source SnapVX flag.
      type: bool
    snapvx_target:
      description: Target SnapVX flag.
      type: bool
    ssid:
      description: SSID of the volume.
      type: str
    status:
      description: Volume status.
      type: str
    storageGroupId:
      description: Storage group ID of the volume.
      type: str
    storage_groups:
      description: List of storage groups for the volume.
      type: list
    type:
      description: Type of the volume.
      type: str
    volumeId:
      description: Unique ID of the volume.
      type: str
    volume_identifier:
      description: Name identifier for the volume.
      type: str
    wwn:
      description: WWN of the volume.
      type: str
  description: Details of the volume.
  returned: When volume exists.
  type: complex