ibm.storage_virtualize.ibm_svc_start_stop_flashcopy module – This module starts or stops FlashCopy mapping and consistency groups on IBM Storage Virtualize family systems

Note

This module is part of the ibm.storage_virtualize collection (version 2.2.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.storage_virtualize.

To use it in a playbook, specify: ibm.storage_virtualize.ibm_svc_start_stop_flashcopy.

New in ibm.storage_virtualize 1.4.0

Synopsis

  • Ansible interface to manage ‘startfcmap’, ‘stopfcmap’, ‘startfcconsistgrp’, and ‘stopfcconsistgrp’ commands.

Parameters

Parameter

Comments

clustername

string / required

The hostname or management IP of the Storage Virtualize system.

domain

string

Domain for the Storage Virtualize system.

Valid when hostname is used for the parameter clustername.

force

boolean

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:

  • false

  • true

isgroup

boolean

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:

  • false

  • true

log_path

string

Path of debug log file.

name

string / required

Specifies the name of the FlashCopy mapping or FlashCopy consistency group.

password

string

REST API password for the Storage Virtualize system.

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

state

string / required

Starts (started) or stops (stopped) a FlashCopy mapping or FlashCopy consistency group.

Choices:

  • "started"

  • "stopped"

token

string

added in ibm.storage_virtualize 1.5.0

The authentication token to verify a user on the Storage Virtualize system.

To generate a token, use the ibm_svc_auth module.

username

string

REST API username for the Storage Virtualize 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: Start a FlashCopy mapping
  ibm.storage_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.storage_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.storage_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.storage_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

Authors

  • Sreshtant Bohidar(@Sreshtant-Bohidar)