ibm.storage_virtualize.ibm_svc_manage_replication (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 remote copy replication.

Usage examples

Scanned by Steampunk Spotter

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

- 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

Scanned by Steampunk Spotter

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

- 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

Scanned by Steampunk Spotter

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

- 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

Scanned by Steampunk Spotter

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

- 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

Inputs

    
aux:
    description:
    - Specifies the auxiliary volume name when creating a remote copy.
    type: str

name:
    description:
    - Specifies the name to assign to the new remote copy relationship or to operate on
      the existing remote copy.
    type: str

sync:
    default: false
    description:
    - Specifies whether to create a synchronized relationship.
    type: bool

force:
    description:
    - Specifies that the relationship must be deleted even if it results in the secondary
      volume containing inconsistent data.
    type: bool

state:
    choices:
    - absent
    - present
    description:
    - Creates or updates (C(present)), removes (C(absent)) a remote copy relationship.
    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

master:
    description:
    - Specifies the master volume name when creating a remote copy.
    type: str

copytype:
    choices:
    - metro
    - global
    - GMCV
    description:
    - 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 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

consistgrp:
    description:
    - 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 I(state=present).
    type: str

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

noconsistgrp:
    default: false
    description:
    - Specifies whether to remove the specified relationship from a consistency group,
      making the relationship a stand-alone relationship.
    - Applies when I(state=present).
    type: bool

cyclingperiod:
    description:
    - Specifies the cycle period in seconds. The default cycle is of 300 seconds.
    type: int

remotecluster:
    description:
    - Specifies the name of remote cluster when creating a remote copy.
    type: str

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