dellemc.powermax.maskingview (3.0.0) — module

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 masking views on PowerMax storage system includes, creating masking view with port group, storage group and host or host group, renaming masking view and deleting masking view.

For creating a masking view -

(i) portgroup_name,

(ii) sg_name and

(iii) any one of host_name or hostgroup_name is required.

All three entities must be present on the array.

For renaming a masking view, the 'new_mv_name' is required. After a masking view is created, only its name can be changed. No underlying entity (portgroup, storagegroup, host or hostgroup) can be changed on the masking view.

Requirements

• A Dell PowerMax storage system.
• Ansible-core 2.14 or later.
• Python 3.9, 3.10 or 3.11.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create MV with hostgroup
  dellemc.powermax.maskingview:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    mv_name: "{{mv_name}}"
    portgroup_name: "Ansible_Testing_portgroup"
    hostgroup_name: "Ansible_Testing_hostgroup"
    sg_name: "Ansible_Testing_SG"
    state: "present"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create MV with host
  dellemc.powermax.maskingview:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    mv_name: "{{mv_name}}"
    portgroup_name: "Ansible_Testing_portgroup"
    host_name: "Ansible_Testing_host"
    sg_name: "Ansible_Testing_SG"
    state: "present"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Rename host masking view
  dellemc.powermax.maskingview:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    mv_name: "{{mv_name}}"
    new_mv_name: "Ansible_Testing_mv_renamed"
    state: "present"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete host masking view
  dellemc.powermax.maskingview:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    mv_name: "Ansible_Testing_mv_renamed"
    state: "absent"

Inputs

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

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

mv_name:
    description:
    - The name of the masking view. No Special Character support except for _. Case sensitive
      for REST Calls.
    required: true
    type: str

sg_name:
    description:
    - The name of the existing 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

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

host_name:
    description:
    - The name of the existing host. This parameter is to create an exclusive or host
      export.
    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_mv_name:
    description:
    - The new name for the renaming function. No Special Character support except for
      _. Case sensitive for REST Calls.
    type: str

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

hostgroup_name:
    description:
    - The name of the existing host group. This parameter is used to create cluster export.
    type: str

portgroup_name:
    description:
    - The name of the existing port group.
    type: str

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  type: bool
create_mv:
  description: Flag sets to true when a new masking view is created.
  returned: When masking view is created.
  type: bool
delete_mv:
  description: Flag sets to true when a masking view is deleted.
  returned: When masking view is deleted.
  type: bool
modify_mv:
  description: Flag sets to true when a masking view is modified.
  returned: When masking view is modified.
  type: bool
mv_details:
  contains:
    hostId:
      description: Host group present in the masking view.
      type: str
    maskingViewId:
      description: Masking view ID.
      type: str
    portGroupId:
      description: Port group present in the masking view.
      type: str
    storageGroupId:
      description: Storage group present in the masking view.
      type: str
  description: Details of masking view.
  returned: When masking view exist.
  type: list