ibm.spectrum_virtualize.ibm_svc_start_stop_replication module – This module starts or stops remote copies 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_start_stop_replication
.
Note
The ibm.spectrum_virtualize collection has been renamed to ibm.storage_virtualize and will eventually be removed from Ansible. 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.3.0
Synopsis
Ansible interface to manage remote copy related commands.
Parameters
Parameter |
Comments |
---|---|
Instructs the system to allow write access to a consistent secondary volume. Applies when state=stopped. Choices:
|
|
Specifies that the volume that is to become a secondary is clean. Applies when state=started. Choices:
|
|
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 that the system must process the copy operation even if it causes a temporary loss of consistency during synchronization. Applies when state=started. Choices:
|
|
Specifies that a consistency group has to be started or stopped. Choices:
|
|
Path of debug log file. |
|
Specifies a name to assign to the new remote copy relationship or group, or to operate on the existing remote copy. |
|
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 copy direction by defining which disk becomes the primary (source). Applies when state=started. Choices:
|
|
Starts ( Choices:
|
|
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:
|
Notes
Note
This module supports
check_mode
.
Examples
- name: Start remote copy
ibm.spectrum_virtualize.ibm_svc_start_stop_replication:
name: sample_rcopy
clustername: "{{clustername}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/ansible.log
state: started
clean: true
- name: Stop remote copy
ibm.spectrum_virtualize.ibm_svc_start_stop_replication:
name: sample_rcopy
clustername: "{{clustername}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/ansible.log
state: stopped