ibm.spectrum_virtualize.ibm_sv_manage_ip_partnership module – This module manages IP partnerships 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_ip_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.9.0
Synopsis
Ansible interface to manage ‘mkippartnership’, ‘rmpartnership’, and ‘chpartnership’ commands on local and remote systems.
Parameters
Parameter |
Comments |
---|---|
Specifies the maximum percentage of aggregate link bandwidth that can be used for background copy operations. This is a numeric value from 0 through 100. The default value is 50. Valid when state=present. |
|
The hostname or management IP of the Spectrum Virtualize storage system. |
|
Specifies whether compression is enabled for this partnership. Valid when state=present. Choices:
|
|
Domain for the Spectrum Virtualize storage system. Valid when hostname is used for the parameter clustername. |
|
Specifies the portset name to be used for WAN link 1 of the Spectrum Virtualize storage system. Valid when state=present, to create an IP partnership. |
|
Specifies the portset name to be used for WAN link 2 of the Spectrum Virtualize storage system. Valid when state=present, to create an IP partnership. |
|
Specifies the aggregate bandwidth of the RC link between two clustered systems (systems) in megabits per second (Mbps). This is a numeric value from 1 through 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 the partnership ID of the partner system. Required when state=present, to modify an existing IP partnership. Required when state=absent, to remove an existing IP partnership. |
|
Specifies the partner system IP address, either IPv4 or IPv6. Required when state=present, to create an IP partnership. |
|
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. |
|
Specifies the portset name to be used for WAN link 1 of the remote Spectrum Virtualize storage system. Valid when state=present, to create an IP partnership. |
|
Specifies the portset name to be used for WAN link 2 of the remote Spectrum Virtualize storage system. Valid when state=present, to create an IP partnership. |
|
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. |
|
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:
|
|
Creates or updates ( 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. |
|
Specifies the Internet Protocol (IP) address format for the partnership. Valid when state=present. Choices:
|
|
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 IP partnership
ibm.spectrum_virtualize.ibm_sv_manage_ip_partnership:
clustername: "{{ clustername }}"
domain: "{{ domain }}"
username: "{{ username }}"
password: "{{ password }}"
remote_clustername: "{{ remote_clustername }}"
remote_domain: "{{ remote_domain }}"
remote_username: "{{ remote_username }}"
remote_password: "{{ remote_password }}"
log_path: "/tmp/debug.log"
remote_clusterip: "{{ partner_ip }}"
type: "ipv4"
linkbandwidthmbits: 100
backgroundcopyrate: 50
compressed: yes
link1: "{{ portsetname }}"
remote_link1: "{{ remote_portsetname}}"
state: "present"
- name: Update an IP partnership
ibm.spectrum_virtualize.ibm_sv_manage_ip_partnership:
clustername: "{{ clustername }}"
domain: "{{ domain }}"
username: "{{ username }}"
password: "{{ password }}"
remote_clustername: "{{ remote_clustername }}"
remote_domain: "{{ remote_domain }}"
remote_username: "{{ remote_username }}"
remote_password: "{{ remote_password }}"
log_path: "/tmp/debug.log"
remote_cluster_id: "{{ cluster_id }}"
linkbandwidthmbits: 110
backgroundcopyrate: 60
compressed: no
state: "present"
- name: Remove an IP partnership
ibm.spectrum_virtualize.ibm_sv_manage_ip_partnership:
clustername: "{{ clustername }}"
username: "{{ username }}"
password: "{{ password }}"
remote_clustername: "{{ remote_clustername }}"
remote_username: "{{ remote_username }}"
remote_password: "{{ remote_password }}"
log_path: "/tmp/debug.log"
remote_cluster_id: "{{ cluster_id }}"
state: "absent"