ibm.spectrum_virtualize.ibm_sv_manage_fc_partnership module – This module configures and manages Fibre Channel (FC) partnership 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_fc_partnership
.
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 mkfcpartnership, chpartnership, and rmpartnership commands.
Parameters
Parameter |
Comments |
---|---|
Specifies the maximum percentage of aggregate link bandwidth that can be used for background copy operations. The value must be in the range of 0 - 100. The default value is 50. Valid when state=present. |
|
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 aggregate bandwidth of the remote copy link between two clustered systems (systems) in megabits per second (Mbps). The value must be in the range of 1 - 100000. Valid when state=present. |
|
Path of debug log file. |
|
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 whether policy-based replication will be used on the partnership. Valid when state=present to update a partnership. Choices:
|
|
The hostname or management IP of the remote Spectrum Virtualize storage system. |
|
Domain for the remote Spectrum Virtualize storage system. Valid when hostname is used for the parameter remote_clustername. |
|
REST API password for the remote Spectrum Virtualize storage system. The parameters remote_username and remote_password are required if not using remote_token to authenticate a user. |
|
Specifies the partner system ID or name. |
|
The authentication token to verify a user on the remote Spectrum Virtualize storage system. To generate a token, use the ibm.spectrum_virtualize.ibm_svc_auth module. |
|
REST API username for the remote Spectrum Virtualize storage system. The parameters remote_username and remote_password are required if not using remote_token to authenticate a user. |
|
Validates certification for the remote Spectrum Virtualize storage system. Choices:
|
|
Specifies to start a partnership. Valid when state=present. Choices:
|
|
Creates or updates ( Choices:
|
|
Specifies to stop a partnership. Valid when state=present to update a partnership. 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 for the local Spectrum Virtualize storage system. Choices:
|
Notes
Note
This module supports
check_mode
.
Examples
- name: Create an FC partnership and start the partnership
ibm.spectrum_virtualize.ibm_sv_manage_fc_partnership:
clustername: "{{clustername}}"
username: "{{username}}"
password: "{{password}}"
remote_clustername: "{{remote_clustername}}"
remote_username: "{{remote_username}}"
remote_password: "{{remote_password}}"
remote_system: "{{remote_system}}"
linkbandwidthmbits: 50
backgroundcopyrate: 50
start: True
state: present
- name: Update an FC partnership and stop the partnership
ibm.spectrum_virtualize.ibm_sv_manage_fc_partnership:
clustername: "{{clustername}}"
username: "{{username}}"
password: "{{password}}"
remote_clustername: "{{remote_clustername}}"
remote_username: "{{remote_username}}"
remote_password: "{{remote_password}}"
remote_system: "{{remote_system}}"
linkbandwidthmbits: 40
backgroundcopyrate: 20
stop: True
state: present
- name: Delete the FC partnership
ibm.spectrum_virtualize.ibm_sv_manage_fc_partnership:
clustername: "{{cluster}}"
username: "{{username}}"
password: "{{password}}"
remote_clustername: "{{remote_clustername}}"
remote_username: "{{remote_username}}"
remote_password: "{{remote_password}}"
remote_system: "{{remote_system}}"
state: absent