ibm.spectrum_virtualize.ibm_sv_manage_fcportsetmember module – This module manages addition or removal of ports to or from the Fibre Channel(FC) portsets 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_sv_manage_fcportsetmember.

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.12.0

Synopsis

  • Ansible interface to manage ‘addfcportsetmember’ and ‘rmfcportsetmember’ commands.

Parameters

Parameter

Comments

clustername

string / required

The hostname or management IP of the Spectrum Virtualize storage system.

domain

string

Domain for the Spectrum Virtualize storage system.

Valid when hostname is used for the parameter clustername.

fcportid

string / required

Specifies the Fibre Channel I/O port ID of the port.

The value can be a decimal number 1 to the maximum number of FC I/O ports.

log_path

string

Path of debug log file.

name

string / required

Specifies the name of the FC portset.

password

string

REST API password for the Spectrum Virtualize storage system.

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

state

string / required

Add (present) or Remove (absent) the FC port ID to or from the FC portset

Choices:

  • "present"

  • "absent"

token

string

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.

username

string

REST API username for the Spectrum Virtualize storage 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: Add port ID to the portset
  ibm.spectrum_virtualize.ibm_sv_manage_fcportsetmember:
   clustername: "{{cluster}}"
   username: "{{username}}"
   password: "{{password}}"
   name: portset1
   fcportid: 3
   state: present
- name: Remove port ID from portset
  ibm.spectrum_virtualize.ibm_sv_manage_fcportsetmember:
   clustername: "{{cluster}}"
   username: "{{username}}"
   password: "{{password}}"
   name: portset1
   fcportid: 3
   state: absent

Authors

  • Sudheesh S (@sudheesh-reddy)