ibm.spectrum_virtualize.ibm_svc_start_stop_flashcopy module – This module starts or stops FlashCopy mapping and consistency groups 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_flashcopy
.
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.4.0
Synopsis
Ansible interface to manage ‘startfcmap’, ‘stopfcmap’, ‘startfcconsistgrp’, and ‘stopfcconsistgrp’ commands.
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 that all processing associated with the FlashCopy mapping or FlashCopy consistency group be immediately stopped. Valid when state=stopped, to stop a FlashCopy mapping or FlashCopy consistency group. Choices:
|
|
If specified True, the associated name parameter is set as name of the FlashCopy consistency group. If specified False, or unspecified, the associated name parameter is set as name of the FlashCopy mapping. Choices:
|
|
Path of debug log file. |
|
Specifies the name of the FlashCopy mapping or FlashCopy consistency group. |
|
REST API password for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
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 a FlashCopy mapping
ibm.spectrum_virtualize.ibm_svc_start_stop_flashcopy:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/playbook.debug
name: mapping-name
state: started
- name: Stop a FlashCopy mapping
ibm.spectrum_virtualize.ibm_svc_start_stop_flashcopy:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/playbook.debug
name: mapping-name
state: stopped
- name: Start a FlashCopy consistency group
ibm.spectrum_virtualize.ibm_svc_start_stop_flashcopy:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/playbook.debug
name: fcconsistgrp-name
isgroup: true
state: started
- name: Stop a FlashCopy consistency group
ibm.spectrum_virtualize.ibm_svc_start_stop_flashcopy:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/playbook.debug
name: fcconsistgrp-name
isgroup: true
state: stopped