ibm.storage_virtualize.ibm_svc_manage_cv (2.3.1) — module

This module manages the change volume for a given volume on IBM Storage Virtualize family systems

| "added in version" 1.3.0 of ibm.storage_virtualize"

Authors: Shilpi Jain(@Shilpi-Jain1)

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 the change volume in remote copy replication on IBM Storage Virtualize family systems.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create master change volume and associate with rcopy
  ibm.storage_virtualize.ibm_svc_manage_cv:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    state: present
    rname: sample_rcopy
    cvname: vol1_cv
    basevolume: vol1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create auxiliary change volume and associate with rcopy
  ibm.storage_virtualize.ibm_svc_manage_cv:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    state: present
    rname: sample_rcopy
    cvname: vol2_aux_cv
    basevolume: vol2
    ismaster: false
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete master change volume and disassociate from rcopy
  ibm.storage_virtualize.ibm_svc_manage_cv:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    state: absent
    rname: sample_rcopy
    cvname: vol1_cv
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete auxiliary change volume and disassociate from rcopy
  ibm.storage_virtualize.ibm_svc_manage_cv:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    state: absent
    rname: sample_rcopy
    cvname: vol2_aux_cv
    ismaster: false

Inputs

    
rname:
    description:
    - Specifies the name of the remote copy relationship.
    required: true
    type: str

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

cvname:
    description:
    - Specifies the name to assign to the master or auxiliary change volume.
    required: true
    type: str

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

ismaster:
    default: true
    description:
    - Specifies whether the change volume is being (dis)associated with master cluster.
    - Required when the change volume is being associated or disassociated from the master
      cluster.
    type: bool

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

basevolume:
    description:
    - Specifies the base volume name (master or auxiliary).
    - Required when I(state=present), to create the change volume.
    type: str

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

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