ibm.storage_virtualize.ibm_svc_start_stop_flashcopy (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 'startfcmap', 'stopfcmap', 'startfcconsistgrp', and 'stopfcconsistgrp' commands.

Usage examples

Scanned by Steampunk Spotter

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

- name: Start a FlashCopy mapping
  ibm.storage_virtualize.ibm_svc_start_stop_flashcopy:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: mapping-name
    state: started

Scanned by Steampunk Spotter

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

- name: Stop a FlashCopy mapping
  ibm.storage_virtualize.ibm_svc_start_stop_flashcopy:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: mapping-name
    state: stopped

Scanned by Steampunk Spotter

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

- name: Start a FlashCopy consistency group
  ibm.storage_virtualize.ibm_svc_start_stop_flashcopy:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: fcconsistgrp-name
    isgroup: true
    state: started

Scanned by Steampunk Spotter

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

- name: Stop a FlashCopy consistency group
  ibm.storage_virtualize.ibm_svc_start_stop_flashcopy:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: fcconsistgrp-name
    isgroup: true
    state: stopped

Inputs

    
name:
    description:
    - Specifies the name of the FlashCopy mapping or FlashCopy consistency group.
    required: true
    type: str

force:
    description:
    - Specifies that all processing associated with the FlashCopy mapping or FlashCopy
      consistency group be immediately stopped.
    - Valid when I(state=stopped), to stop a FlashCopy mapping or FlashCopy consistency
      group.
    required: false
    type: bool

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

isgroup:
    description:
    - If specified True, the associated I(name) parameter is set as name of the FlashCopy
      consistency group.
    - If specified False, or unspecified, the associated I(name) parameter is set as name
      of the FlashCopy mapping.
    required: false
    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

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