ibm.spectrum_virtualize.ibm_svc_manage_ip module – This module manages IP provisioning 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_ip
.
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 ‘mkip’ and ‘rmip’ commands.
This module can run on all IBM Spectrum Virtualize storage running on 8.4.2.0 or later.
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. |
|
Specifies the gateway address. Applies when state=present. |
|
Specifies a valid ipv4/ipv6 address. |
|
Path of debug log file. |
|
Specifies the name of the node. |
|
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 a port ranging from 1 - 16 to which IP shall be assigned. |
|
Specifies the name of the portset object. |
|
Specifies the flag when IP is shared between multiple portsets. Applies when state=present. Choices:
|
|
Creates ( Choices:
|
|
Specifies the prefix of subnet mask. Applies when state=present. |
|
The authentication token to verify a user on the Spectrum Virtualize storage system. To generate a token, use the 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:
|
|
Specifies a vlan id ranging from 1 - 4096. Applies when state=present. |
Notes
Note
This module supports
check_mode
.
Examples
- name: Create IP provisioning
ibm.spectrum_virtualize.ibm_svc_manage_ip:
clustername: "{{cluster}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/playbook.debug
node: node1
port: 1
portset: portset0
ip_address: x.x.x.x
subnet_prefix: 20
gateway: x.x.x.x
vlan: 1
shareip: true
state: present
- name: Remove IP provisioning
ibm.spectrum_virtualize.ibm_svc_manage_ip:
clustername: "{{cluster}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/playbook.debug
node: node1
port: 1
portset: portset0
ip_address: x.x.x.x
state: absent