ibm.spectrum_virtualize.ibm_svc_manage_portset module – This module manages portset configuration on IBM Spectrum Virtualize family storage systems
Note
This module is part of the ibm.spectrum_virtualize collection (version 2.0.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.spectrum_virtualize
.
To use it in a playbook, specify: ibm.spectrum_virtualize.ibm_svc_manage_portset
.
Note
The ibm.spectrum_virtualize collection has been renamed to ibm.storage_virtualize and will be removed from Ansible 12. The content of ibm.spectrum_virtualize will be replaced by redirects to ibm.storage_virtualize in Ansible 10. If you use content from ibm.spectrum_virtualize, please update FQCNs in your playbooks and roles! When creating new playbooks or roles, directly use content from ibm.storage_virtualize instead.
New in ibm.spectrum_virtualize 1.8.0
Synopsis
Ansible interface to manage IP and Fibre Channel (FC) portsets using ‘mkportset’, ‘chportset’, and ‘rmportset’ commands.
Parameters
Parameter |
Comments |
---|---|
The hostname or management IP of the Spectrum Virtualize storage system. |
|
Domain for the Spectrum Virtualize storage system. Valid when hostname is used for the parameter clustername. |
|
Path of debug log file. |
|
Specifies the name of portset. |
|
Specify to remove the ownership group from portset. Parameters ownershipgroup and noownershipgroup are mutually exclusive. Applies only during updation of portset. Choices:
|
|
Specifies the old name of the portset while renaming. Valid when state=present, to rename an existing host. |
|
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. |
|
REST API password for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Specifies the type for the portset. Applies only during creation of portset. If not specified, portset_type=host will be used. Choices:
|
|
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:
|
|
Creates ( Choices:
|
|
The authentication token to verify a user on the Spectrum Virtualize storage system. To generate a token, use the ibm.spectrum_virtualize.ibm_svc_auth module. |
|
REST API username for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Validates certification. Choices:
|
Notes
Note
This module supports
check_mode
.
Examples
- name: Create a portset
ibm.spectrum_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.spectrum_virtualize.ibm_svc_manage_portset:
clustername: "{{cluster}}"
username: "{{username}}"
password: "{{password}}"
name: portset1
noownershipgroup: true
state: present
- name: Create an FC portset
ibm.spectrum_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.spectrum_virtualize.ibm_svc_manage_portset:
clustername: "{{cluster}}"
username: "{{username}}"
password: "{{password}}"
name: portset2
old_name: portset1
state: present
- name: Delete a portset
ibm.spectrum_virtualize.ibm_svc_manage_portset:
clustername: "{{cluster}}"
username: "{{username}}"
password: "{{password}}"
name: portset1
state: absent