ibm.storage_virtualize.ibm_svc_manage_consistgrp_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 'mkfcconsistgrp' and 'rmfcconsistgrp' volume commands.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create a FlashCopy consistency group
  ibm.storage_virtualize.ibm_svc_manage_consistgrp_flashcopy:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: consistgroup-name
    state: present
    ownershipgroup: ownershipgroup-name

Scanned by Steampunk Spotter

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

- name: Delete a FlashCopy consistency group
  ibm.storage_virtualize.ibm_svc_manage_consistgrp_flashcopy:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: consistgroup-name
    state: absent
    force: true

Inputs

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

force:
    description:
    - If specified True, removes all the associated FlashCopy mappings while deleting
      the FlashCopy consistency group.
    - Valid when I(state=absent), to delete a FlashCopy consistency group.
    required: false
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - Creates (C(present)) or removes (C(absent)) a 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 M(ibm.storage_virtualize.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

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

ownershipgroup:
    description:
    - Specifies the name of the ownership group.
    - Parameters I(ownershipgroup) and I(noownershipgroup) are mutually exclusive.
    - Valid when I(state=present), to create or modify a FlashCopy consistency group.
    required: false
    type: str

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

noownershipgroup:
    description:
    - If specified True, the consistency group is removed from all associated ownership
      groups.
    - Parameters I(noownershipgroup) and I(ownershipgroup) are mutually exclusive.
    - Valid when I(state=present), to modify a FlashCopy consistency group.
    required: false
    type: bool