ibm.spectrum_virtualize.ibm_svc_manage_flashcopy module – This module manages FlashCopy mappings 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_flashcopy
.
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.4.0
Synopsis
Ansible interface to manage ‘mkfcmap’, ‘rmfcmap’, and ‘chfcmap’ volume commands.
Parameters
Parameter |
Comments |
---|---|
The hostname or management IP of the Spectrum Virtualize storage system. |
|
Specifies the name of the consistency group to which the FlashCopy mapping is to be added. Parameters consistgrp and noconsistgrp are mutually exclusive. Valid when state=present, to create or modify a FlashCopy mapping. |
|
Specifies the copy rate. The rate varies between 0-150. If unspecified, the default copy rate of 50 for clone and 0 for snapshot is used. Valid when state=present, to create or modify a FlashCopy mapping. |
|
Specifies the copy type when creating the FlashCopy mapping. Required when state=present, to create a FlashCopy mapping. Choices:
|
|
Domain for the Spectrum Virtualize storage system. Valid when hostname is used for the parameter clustername. |
|
Brings the target volume online. This parameter is required if the FlashCopy mapping is in the stopped state. Valid when state=absent, to delete a FlashCopy mapping. Choices:
|
|
Specifies the grain size for the FlashCopy mapping. The grainsize can be set to 64 or 256. The default value is 256. Valid when state=present, to create a FlashCopy mapping. |
|
Path of debug log file. |
|
Specifies the name of the storage pool to use when creating the target volume. If unspecified, the pool associated with the source volume is used. Valid when state=present, to create a FlashCopy mapping. |
|
Specifies the name of the FlashCopy mapping. |
|
If specified True, FlashCopy mapping is removed from the consistency group. Parameters noconsistgrp and consistgrp are mutually exclusive. Valid when state=present, to modify a FlashCopy mapping. Choices:
|
|
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 name of the source volume. Required when state=present, to create a FlashCopy mapping. |
|
Creates or updates ( Choices:
|
|
Specifies the name of the target volume. Required when state=present, to create a FlashCopy mapping. |
|
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: Create FlashCopy mapping for snapshot
ibm.spectrum_virtualize.ibm_svc_manage_flashcopy:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/playbook.debug
state: present
name: snapshot-name
copytype: snapshot
source: source-volume-name
target: target-volume-name
mdiskgrp: Pool0
consistgrp: consistencygroup-name
copyrate: 50
grainsize: 64
- name: Create FlashCopy mapping for clone
ibm.spectrum_virtualize.ibm_svc_manage_flashcopy:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/playbook.debug
state: present
name: snapshot-name
copytype: clone
source: source-volume-name
target: target-volume-name
mdiskgrp: Pool0
consistgrp: consistencygroup-name
copyrate: 50
grainsize: 64
- name: Delete FlashCopy mapping for snapshot
ibm.spectrum_virtualize.ibm_svc_manage_flashcopy:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/playbook.debug
name: snapshot-name
state: absent
force: true
- name: Delete FlashCopy mapping for clone
ibm.spectrum_virtualize.ibm_svc_manage_flashcopy:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/playbook.debug
name: clone-name
state: absent
force: true