dellemc.powermax.dellemc_powermax_portgroup (1.6.1) — module

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

Managing port groups on a PowerMax storage system includes creating a port group with a set of ports, adding or removing single or multiple ports to or from the port group, renaming the port group and deleting the port group.

Requirements

• A DellEMC PowerMax storage system.
• Ansible 2.9 or later.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create port group without ports
  dellemc_powermax_portgroup:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{array_id}}"
    portgroup_name: "{{portgroup_name}}"
    state: "present"

Scanned by Steampunk Spotter

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

- name: Create port group with ports
  dellemc_powermax_portgroup:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{array_id}}"
    portgroup_name: "{{portgroup_name}}"
    state: "present"
    ports:
    - director_id: "FA-1D"
      port_id: "5"
    - director_id: "FA-2D"
      port_id: "5"
    port_state: "present-in-group"

Scanned by Steampunk Spotter

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

- name: Add ports to port group
  dellemc_powermax_portgroup:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{array_id}}"
    portgroup_name: "{{portgroup_name}}"
    state: "present"
    ports:
    - director_id: "FA-2D"
      port_id: "8"
    - director_id: "FA-2D"
      port_id: "9"
    port_state: "present-in-group"

Scanned by Steampunk Spotter

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

- name: Remove ports from port group
  dellemc_powermax_portgroup:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{array_id}}"
    portgroup_name: "{{portgroup_name}}"
    state: "present"
    ports:
    - director_id: "FA-2D"
      port_id: "8"
    - director_id: "FA-2D"
      port_id: "9"
    port_state: "absent-in-group"

Scanned by Steampunk Spotter

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

- name: Modify port group
  dellemc_powermax_portgroup:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{array_id}}"
    portgroup_name: "{{portgroup_name}}"
    state: "present"
    new_name: "{{new_name}}"

Scanned by Steampunk Spotter

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

- name: Delete port group
  dellemc_powermax_portgroup:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{array_id}}"
    portgroup_name: "{{portgroup_name}}"
    state: "absent"

Inputs

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

ports:
    description:
    - List of directors and ports to be added or removed to or from the port group
    elements: dict
    required: false
    type: list

state:
    choices:
    - absent
    - present
    description:
    - Define whether the port group should exist or not.
    - present - indicates that the port group should be present on the system
    - absent - indicates that the port group should not be present on the system
    required: true
    type: str

new_name:
    description:
    - New name of the port group while renaming. No Special Character support except for
      _. Case sensitive for REST Calls.
    required: false
    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

port_state:
    choices:
    - present-in-group
    - absent-in-group
    description:
    - Define whether the port should be present or absent in the port group.
    - present-in-group - indicates that the ports should be present on a port group object
    - absent-in-group - indicates that the ports should not be present on a port group
      object
    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

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

portgroup_name:
    description:
    - The name of the port group. No Special Character support except for _. Case sensitive
      for REST Calls.
    required: true
    type: str

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  type: bool
portgroup_details:
  contains:
    num_of_masking_views:
      description: Number of masking views in where port group is associated.
      type: int
    num_of_ports:
      description: Number of ports in the port group.
      type: int
    portGroupId:
      description: Port group ID.
      type: str
    symmetrixPortKey:
      contains:
        directorId:
          description: Director ID of the port.
          type: str
        portId:
          description: Port number of the port.
          type: str
      description: Symmetrix system director and port in the port group.
      type: list
    type:
      description: Type of ports in port group.
      type: str
  description: Details of the port group.
  returned: When the port group exist.
  type: list