ibm.storage_virtualize.ibm_svc_manage_portset (2.3.1) — module

Install collection

Install with ansible-galaxy collection install ibm.storage_virtualize:==2.3.1

Add to requirements.yml

  collections:
    - name: ibm.storage_virtualize
      version: 2.3.1

Description

Ansible interface to manage IP and Fibre Channel (FC) portsets using 'mkportset', 'chportset', and 'rmportset' commands.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create a portset
  ibm.storage_virtualize.ibm_svc_manage_portset:
   clustername: "{{cluster}}"
   username: "{{username}}"
   password: "{{password}}"
   name: portset1
   portset_type: host
   ownershipgroup: owner1
   state: present

Scanned by Steampunk Spotter

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

- name: Update a portset
  ibm.storage_virtualize.ibm_svc_manage_portset:
   clustername: "{{cluster}}"
   username: "{{username}}"
   password: "{{password}}"
   name: portset1
   noownershipgroup: true
   state: present

Scanned by Steampunk Spotter

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

- name: Create an FC portset
  ibm.storage_virtualize.ibm_svc_manage_portset:
   clustername: "{{cluster}}"
   username: "{{username}}"
   password: "{{password}}"
   name: fcportset1
   porttype: fc
   portset_type: host
   ownershipgroup: owner1
   state: present

Scanned by Steampunk Spotter

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

- name: Rename the portset
  ibm.storage_virtualize.ibm_svc_manage_portset:
   clustername: "{{cluster}}"
   username: "{{username}}"
   password: "{{password}}"
   name: portset2
   old_name: portset1
   state: present

Scanned by Steampunk Spotter

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

- name: Delete a portset
  ibm.storage_virtualize.ibm_svc_manage_portset:
   clustername: "{{cluster}}"
   username: "{{username}}"
   password: "{{password}}"
   name: portset1
   state: absent

Inputs

    
name:
    description:
    - Specifies the name of portset.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Creates (C(present)) or Deletes (C(absent)) the IP portset.
    required: true
    type: str

token:
    description:
    - The authentication token to verify a user on the Storage Virtualize system.
    - To generate a token, use the M(ibm.storage_virtualize.ibm_svc_auth) module.
    type: str

domain:
    description:
    - Domain for the Storage Virtualize system.
    - Valid when hostname is used for the parameter I(clustername).
    type: str

log_path:
    description:
    - Path of debug log file.
    type: str

old_name:
    description:
    - Specifies the old name of the portset while renaming.
    - Valid when I(state=present), to rename an existing host.
    type: str
    version_added: 1.12.0
    version_added_collection: ibm.storage_virtualize

password:
    description:
    - REST API password for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

porttype:
    choices:
    - fc
    - ethernet
    description:
    - Specifies the type of port that can be mapped to the portset.
    - Applies when I(state=present).
    - If not specified, I(porttype=ethernet) will be used to manage IP portset.
    type: str
    version_added: 1.12.0
    version_added_collection: ibm.storage_virtualize

username:
    description:
    - REST API username for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

clustername:
    description:
    - The hostname or management IP of the Storage Virtualize system.
    required: true
    type: str

portset_type:
    choices:
    - host
    - replication
    description:
    - Specifies the type for the portset.
    - Applies only during creation of portset.
    - If not specified, I(portset_type=host) will be used.
    type: str

ownershipgroup:
    description:
    - The name of the ownership group to which the portset object is being mapped.
    - Parameters I(ownershipgroup) and I(noownershipgroup) are mutually exclusive.
    - Applies when I(state=present).
    type: str

validate_certs:
    default: false
    description:
    - Validates certification.
    type: bool

noownershipgroup:
    description:
    - Specify to remove the ownership group from portset.
    - Parameters I(ownershipgroup) and I(noownershipgroup) are mutually exclusive.
    - Applies only during updation of portset.
    type: bool