ibm.storage_virtualize.ibm_svc_manage_replicationgroup (2.3.1) — module

Install collection

Install with ansible-galaxy collection install ibm.storage_virtualize:==2.3.1

Add to requirements.yml

  collections:
    - name: ibm.storage_virtualize
      version: 2.3.1

Description

Ansible interface to manage 'mkrcconsistgrp', 'chrcconsistgrp', and 'rmrcconsistgrp' remote copy consistency group commands.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
name:
    description:
    - Specifies the name for the new consistency group.
    required: true
    type: str

force:
    description:
    - 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.
    type: bool

state:
    choices:
    - absent
    - present
    description:
    - Creates or updates (C(present)) removes (C(absent)) a consistency group.
    required: true
    type: str

token:
    description:
    - The authentication token to verify a user on the Storage Virtualize system.
    - To generate a token, use the ibm_svc_auth module.
    type: str
    version_added: 1.5.0
    version_added_collection: ibm.storage_virtualize

domain:
    description:
    - Domain for the Storage Virtualize system.
    - Valid when hostname is used for the parameter I(clustername).
    type: str

copytype:
    choices:
    - metro
    - global
    description:
    - 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 I(state=present).
    type: str

log_path:
    description:
    - Path of debug log file.
    type: str

password:
    description:
    - REST API password for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

username:
    description:
    - REST API username for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

clustername:
    description:
    - The hostname or management IP of the Storage Virtualize system.
    required: true
    type: str

cyclingmode:
    choices:
    - multi
    - none
    description:
    - 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 I(state=present) and I(copytype=global).
    type: str

cyclingperiod:
    description:
    - Specifies the cycle period in seconds.
    type: int

remotecluster:
    description:
    - Specifies the name of the remote system. Only used while creating a consistency
      group.
    type: str

validate_certs:
    default: false
    description:
    - Validates certification.
    type: bool