ibm.storage_virtualize.ibm_svc_manage_replication module – This module manages remote copies (or rcrelationship) on IBM Storage Virtualize family systems

Note

This module is part of the ibm.storage_virtualize collection (version 2.7.4).

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_replication.

New in ibm.storage_virtualize 1.3.0

Synopsis

  • Ansible interface to manage remote copy replication.

Parameters

Parameter

Comments

aux

string

Specifies the auxiliary volume name when creating a remote copy.

clustername

string / required

The hostname or management IP of the Storage Virtualize system.

consistgrp

string

Specifies a consistency group that this relationship will join. If not specified by user, the relationship is created as a stand-alone relationship.

Applies when state=present.

copytype

string

Specifies the mirror type of the remote copy. ‘metro’ means MetroMirror, ‘global’ means GlobalMirror, and ‘GMCV’ means GlobalMirror with change volume.

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

Choices:

  • "metro"

  • "global"

  • "GMCV"

cyclingperiod

integer

Specifies the cycle period in seconds. The default cycle is of 300 seconds.

domain

string

Domain for the Storage Virtualize system.

Valid when hostname is used for the parameter clustername.

force

boolean

Specifies that the relationship must be deleted even if it results in the secondary volume containing inconsistent data.

Choices:

  • false

  • true

log_path

string

Path of debug log file.

master

string

Specifies the master volume name when creating a remote copy.

name

string

Specifies the name to assign to the new remote copy relationship or to operate on the existing remote copy.

noconsistgrp

boolean

Specifies whether to remove the specified relationship from a consistency group, making the relationship a stand-alone relationship.

Applies when state=present.

Choices:

  • false ← (default)

  • true

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 remote cluster when creating a remote copy.

state

string / required

Creates or updates (present), removes (absent) a remote copy relationship.

Choices:

  • "absent"

  • "present"

sync

boolean

Specifies whether to create a synchronized relationship.

Choices:

  • false ← (default)

  • true

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

  • The parameters primary and aux are mandatory only when a remote copy relationship does not exist.

  • This module supports check_mode.

  • Parameters copytype, cyclingperiod are not supported for update operation when the relationship is a part of consistency group. In case these parameters are specified, Ansible will return the following error, “CMMVC5951E Individual relationship cannot be updated while it is part of a consistency group.”

  • Only one update operation is supported in a single task for remote copy relationships, if multiple are detected, Ansible will return the following error, “CMMVC5713E Only 1 update operation supported in one task”

Examples

- name: Create remote copy
  ibm.storage_virtualize.ibm_svc_manage_replication:
    name: sample_rcopy
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: /tmp/ansible.log
    state: present
    remotecluster: "{{ remotecluster }}"
    master: SourceVolume0
    aux: TargetVolume0
    copytype: global
    sync: true
    consistgrp: sample_rccg
  register: result
- name: Exclude the remote copy from consistency group
  ibm.storage_virtualize.ibm_svc_manage_replication:
    name: sample_rcopy2
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: /tmp/ansible.log
    state: present
    noconsistgrp: true
- name: Delete remote copy
  ibm.storage_virtualize.ibm_svc_manage_replication:
    name: sample_rcopy3
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: /tmp/ansible.log
    state: absent
- name: Create GlobalMirror remote copy relationship with change volume
  ibm.storage_virtualize.ibm_svc_manage_replication:
    name: sample_rcopy4
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: /tmp/ansible.log
    state: present
    remotecluster: "{{ remotecluster }}"
    master: SourceVolume1
    aux: TargetVolume1
    copytype: GMCV
    sync: true
  register: result

Authors

  • rohit(@rohitk-github)

  • Shilpi Jain (@Shilpi-Jain1)