ibm.storage_virtualize.ibm_svc_start_stop_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 related commands.

Usage examples

Scanned by Steampunk Spotter

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

- name: Start remote copy
  ibm.storage_virtualize.ibm_svc_start_stop_replication:
    name: sample_rcopy
    clustername: "{{clustername}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/ansible.log
    state: started
    clean: true

Scanned by Steampunk Spotter

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

- name: Stop remote copy
  ibm.storage_virtualize.ibm_svc_start_stop_replication:
    name: sample_rcopy
    clustername: "{{clustername}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/ansible.log
    state: stopped

Inputs

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

clean:
    default: false
    description:
    - Specifies that the volume that is to become a secondary is clean.
    - Applies when I(state=started).
    type: bool

force:
    description:
    - Specifies that the system must process the copy operation even if it causes a temporary
      loss of consistency during synchronization.
    - Applies when I(state=started).
    type: bool

state:
    choices:
    - started
    - stopped
    description:
    - Starts (C(started)) or stops (C(stopped)) 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

access:
    default: false
    description:
    - Instructs the system to allow write access to a consistent secondary volume.
    - Applies when I(state=stopped).
    type: bool

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

isgroup:
    default: false
    description:
    - Specifies that a consistency group has to be started or stopped.
    type: bool

primary:
    choices:
    - master
    - aux
    description:
    - Specifies the copy direction by defining which disk becomes the primary (source).
    - Applies when I(state=started).
    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

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