dellemc.powermax.initiator (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 initiators on a PowerMax storage system includes retrieving details and renaming alias of an initiator.

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: Get initiator details using initiator id
  dellemc.powermax.initiator:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    initiator_id: 1000000000000001
    state: 'present'

Scanned by Steampunk Spotter

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

- name: Get initiator details using alias
  dellemc.powermax.initiator:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    alias: 'test/host_initiator'
    state: 'present'

Scanned by Steampunk Spotter

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

- name: Rename initiator alias using initiator id
  dellemc.powermax.initiator:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    initiator_id: 1000000000000001
    new_alias:
      new_node_name: 'test_rename'
      new_port_name: 'host_initiator_rename'
    state: 'present'

Scanned by Steampunk Spotter

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

- name: Rename initiator alias using alias
  dellemc.powermax.initiator:
    unispherehost: "{{unispherehost}}"
    universion: "{{universion}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    serial_no: "{{serial_no}}"
    alias: 'test/host_initiator'
    new_alias:
      new_node_name: 'test_rename'
      new_port_name: 'host_initiator_rename'
    state: 'present'

Inputs

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

alias:
    description:
    - Alias of initiator.
    type: str

state:
    choices:
    - absent
    - present
    description:
    - The state of the initiator after the task is performed.
    - absent - indicates that the initiator should not exist in the system.
    - present - indicates that the initiator should exist in the system.
    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

new_alias:
    description:
    - Rename alias for specified initiator.
    suboptions:
      new_node_name:
        description:
        - The new node name to rename the initiator alias.
        type: str
      new_port_name:
        description:
        - The new port name to rename the initiator alias.
        type: str
    type: dict

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

initiator_id:
    description:
    - The initiator WWN or IQN.
    type: str

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
initiator_details:
  contains:
    alias:
      description: Initiator alias.
      type: str
    fabric_name:
      description: Fabric associated with the initiator.
      type: str
    fcid:
      description: FCID associated with the initiator.
      type: str
    host:
      description: Host associated with the initiator.
      type: str
    hostGroup:
      description: Host groups associated with the initiator.
      type: list
    initiatorId:
      description: ID of the initiator.
      type: str
    logged_in:
      description: States whether the initiator is logged in.
      type: bool
  description: Details of the initiator.
  returned: When initiator exists.
  type: complex