ibm.spectrum_virtualize.ibm_svc_manage_consistgrp_flashcopy module – This module manages FlashCopy 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_manage_consistgrp_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 ‘mkfcconsistgrp’ and ‘rmfcconsistgrp’ volume commands.

Parameters

Parameter

Comments

clustername

string / required

The hostname or management IP of the Spectrum Virtualize storage system.

domain

string

Domain for the Spectrum Virtualize storage system.

Valid when hostname is used for the parameter clustername.

force

boolean

If specified True, removes all the associated FlashCopy mappings while deleting the FlashCopy consistency group.

Valid when state=absent, to delete a FlashCopy consistency group.

Choices:

  • false

  • true

log_path

string

Path of debug log file.

name

string / required

Specifies the name of the FlashCopy consistency group.

noownershipgroup

boolean

If specified True, the consistency group is removed from all associated ownership groups.

Parameters noownershipgroup and ownershipgroup are mutually exclusive.

Valid when state=present, to modify a FlashCopy consistency group.

Choices:

  • false

  • true

ownershipgroup

string

Specifies the name of the ownership group.

Parameters ownershipgroup and noownershipgroup are mutually exclusive.

Valid when state=present, to create or modify a FlashCopy consistency group.

password

string

REST API password for the Spectrum Virtualize storage system.

The parameters username and password are required if not using token to authenticate a user.

state

string / required

Creates (present) or removes (absent) a FlashCopy consistency group.

Choices:

  • "present"

  • "absent"

token

string

added in ibm.spectrum_virtualize 1.5.0

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.

username

string

REST API username for the Spectrum Virtualize storage system.

The parameters username and password are required if not using token to authenticate a user.

validate_certs

boolean

Validates certification.

Choices:

  • false ← (default)

  • true

Notes

Note

  • This module supports check_mode.

Examples

- name: Create a FlashCopy consistency group
  ibm.spectrum_virtualize.ibm_svc_manage_consistgrp_flashcopy:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: consistgroup-name
    state: present
    ownershipgroup: ownershipgroup-name
- name: Delete a FlashCopy consistency group
  ibm.spectrum_virtualize.ibm_svc_manage_consistgrp_flashcopy:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: consistgroup-name
    state: absent
    force: true

Authors

  • Sreshtant Bohidar(@Sreshtant-Bohidar)