ibm.storage_virtualize.ibm_sv_manage_replication_policy module – This module configures and manages replication policies 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_sv_manage_replication_policy.

New in ibm.storage_virtualize 1.10.0

Synopsis

  • Ansible interface to manage mkreplicationpolicy, chreplicationpolicy, and rmreplicationpolicy commands.

  • This module manages policy based replication.

  • This module can be run on all IBM Storage Virtualize systems with version 8.5.2.1 or later.

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.

ha_snapshots

string

added in ibm.storage_virtualize 2.7.0

When specified as yes, snapshots created for volumes and volume groups associated with the policy will be replicated to the remote system.

Applies when state=present and topology=2-site-ha.

Supported from Storage Virtualize family systems 8.7.3.0 or later.

Choices:

  • "yes"

  • "no"

location1iogrp

integer

Specifies the ID of the I/O group of the system in location 1 of the topology.

location1system

string

Specifies the name or ID of the system in location 1 of the topology.

location2iogrp

integer

Specifies the ID of the I/O group of the system in location 2 of the topology.

location2system

string

Specifies the name or ID of the system in location 2 of the topology.

log_path

string

Path of debug log file.

name

string / required

Specifies the name of the replication policy.

partition

string

added in ibm.storage_virtualize 2.6.0

Specifies the name of the storage partition to be assigned to async-dr replication policy.

Applies when state=present.

Supported from Storage Virtualize family systems 8.7.1.0 or later.

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.

rpoalert

integer

Specifies the RPO alert threshold in seconds. The minimum value is 60 (1 minute) and the maximum value is 86400 (1 day).

The value must be a multiple of 60 seconds.

state

string / required

Creates, updates (present), or deletes (absent) a replication policy.

Choices:

  • "present"

  • "absent"

token

string

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

To generate a token, use the ibm.storage_virtualize.ibm_svc_auth module.

topology

string

Specifies the policy topology.

Choices:

  • "2-site-async-dr"

  • "2-site-ha"

  • "async-dr"

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.

  • If both systems support HA snapshots, ha_snapshots will be enabled implicitly while creating replication policy with topology “2-site-ha”.

  • Error Considerations - CMMVC1255E The command failed because the specified topology does not support highly-available snapshots

Examples

- name: Create replication policy
  ibm.storage_virtualize.ibm_sv_manage_replication_policy:
    clustername: "{{ cluster }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: replication_policy0
    topology: 2-site-async-dr
    location1system: x.x.x.x
    location1iogrp: 0
    location2system: x.x.x.x
    location2iogrp: 0
    rpoalert: 60
    state: present
- name: Delete replication policy
  ibm.storage_virtualize.ibm_sv_manage_replication_policy:
    clustername: "{{ cluster }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: replication_policy0
    state: absent
- name: Create DR replication policy
  ibm.storage_virtualize.ibm_sv_manage_replication_policy:
    clustername: "{{ cluster }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: replication_policy0
    topology: async-dr
    partition: partition0
    rpoalert: 60
    state: present
- name: Create replication policy with HA snapshots enabled
  ibm.storage_virtualize.ibm_sv_manage_replication_policy:
    clustername: "{{ cluster }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: replication_policy0
    topology: 2-site-ha
    location1system: x.x.x.x
    location1iogrp: 0
    location2system: x.x.x.x
    location2iogrp: 0
    state: present
    ha_snapshots: "yes"

Authors

  • Sanjaikumaar M (@sanjaikumaar)

  • Sandip Gulab Rajbanshi (@Sandip-Rajbanshi)