ibm.storage_virtualize.ibm_svc_manage_portset module – This module manages portset configuration on IBM Storage Virtualize family systems

Note

This module is part of the ibm.storage_virtualize collection (version 2.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install ibm.storage_virtualize.

To use it in a playbook, specify: ibm.storage_virtualize.ibm_svc_manage_portset.

New in ibm.storage_virtualize 1.8.0

Synopsis

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

Parameters

Parameter

Comments

clustername

string / required

The hostname or management IP of the Storage Virtualize system.

domain

string

Domain for the Storage Virtualize system.

Valid when hostname is used for the parameter clustername.

log_path

string

Path of debug log file.

name

string / required

Specifies the name of portset.

noownershipgroup

boolean

Specify to remove the ownership group from portset.

Parameters ownershipgroup and noownershipgroup are mutually exclusive.

Applies only during updation of portset.

Choices:

  • false

  • true

old_name

string

added in ibm.storage_virtualize 1.12.0

Specifies the old name of the portset while renaming.

Valid when state=present, to rename an existing host.

ownershipgroup

string

The name of the ownership group to which the portset object is being mapped.

Parameters ownershipgroup and noownershipgroup are mutually exclusive.

Applies when state=present.

password

string

REST API password for the Storage Virtualize system.

The parameters username and password are required if not using token to authenticate a user.

portset_type

string

Specifies the type for the portset.

Applies only during creation of portset.

If not specified, portset_type=host will be used.

Choices:

  • "host"

  • "replication"

porttype

string

added in ibm.storage_virtualize 1.12.0

Specifies the type of port that can be mapped to the portset.

Applies when state=present.

If not specified, porttype=ethernet will be used to manage IP portset.

Choices:

  • "fc"

  • "ethernet"

state

string / required

Creates (present) or Deletes (absent) the IP portset.

Choices:

  • "present"

  • "absent"

token

string

The authentication token to verify a user on the Storage Virtualize system.

To generate a token, use the ibm.storage_virtualize.ibm_svc_auth module.

username

string

REST API username for the Storage Virtualize system.

The parameters username and password are required if not using token to authenticate a user.

validate_certs

boolean

Validates certification.

Choices:

  • false ← (default)

  • true

Notes

Note

  • This module supports check_mode.

Examples

- 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
- name: Update a portset
  ibm.storage_virtualize.ibm_svc_manage_portset:
   clustername: "{{cluster}}"
   username: "{{username}}"
   password: "{{password}}"
   name: portset1
   noownershipgroup: true
   state: present
- 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
- name: Rename the portset
  ibm.storage_virtualize.ibm_svc_manage_portset:
   clustername: "{{cluster}}"
   username: "{{username}}"
   password: "{{password}}"
   name: portset2
   old_name: portset1
   state: present
- name: Delete a portset
  ibm.storage_virtualize.ibm_svc_manage_portset:
   clustername: "{{cluster}}"
   username: "{{username}}"
   password: "{{password}}"
   name: portset1
   state: absent

Authors

  • Sanjaikumaar M (@sanjaikumaar)

  • Sudheesh Reddy Satti (@sudheeshreddy)