ibm.storage_virtualize.ibm_svc_manage_replicationgroup module – This module manages remote copy consistency group 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_manage_replicationgroup.

New in ibm.storage_virtualize 1.3.0

Synopsis

  • Ansible interface to manage ‘mkrcconsistgrp’, ‘chrcconsistgrp’, and ‘rmrcconsistgrp’ remote copy consistency group commands.

Parameters

Parameter

Comments

clustername

string / required

The hostname or management IP of the Storage Virtualize system.

copytype

string

Specifies the mirror type of the remote copy. ‘metro’ means MetroMirror, ‘global’ means GlobalMirror.

If not specified, a MetroMirror remote copy will be created when creating a remote copy state=present.

Choices:

  • "metro"

  • "global"

cyclingmode

string

Specifies the behavior of Global Mirror for the relationship.

Active-active relationships and relationships with cycling modes set to Multiple must always be configured with change volumes.

Applies when state=present and copytype=global.

Choices:

  • "multi"

  • "none"

cyclingperiod

integer

Specifies the cycle period in seconds.

domain

string

Domain for the Storage Virtualize system.

Valid when hostname is used for the parameter clustername.

force

boolean

If used to delete a consistency group, it specifies that you want the system to remove any relationship that belongs to the consistency group before the group is deleted.

If used to start a consistency group, it specifies that you want the system to process the copy operation even if it causes a temporary loss of consistency during synchronization.

It is required if the consistency group is in the ConsistentStopped state, but is not synchronized or is in the idling state - except if consistency protection is configured.

Choices:

  • false

  • true

log_path

string

Path of debug log file.

name

string / required

Specifies the name for the new 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.

remotecluster

string

Specifies the name of the remote system. Only used while creating a consistency group.

state

string / required

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

Choices:

  • "absent"

  • "present"

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: Define a new rc consistency group
  ibm.storage_virtualize.ibm_svc_manage_replicationgroup:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: rccg4test
    remotecluster: remotecluster
    state: present
- name: Delete rc consistency group
  ibm.storage_virtualize.ibm_svc_manage_replicationgroup:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: rccg4test
    force: true
    state: absent
- name: Update rc consistency group
  ibm.storage_virtualize.ibm_svc_manage_replicationgroup:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: rccg4test
    cyclingperiod: 60
    state: present

Authors

  • rohit(@rohitk-github)