ibm.storage_virtualize.ibm_svc_manage_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 'mkfcmap', 'rmfcmap', and 'chfcmap' volume commands. This module configures "clone", "snapshot" or "backup" type FlashCopy mappings.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create FlashCopy mapping for snapshot
  ibm.storage_virtualize.ibm_svc_manage_flashcopy:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    state: present
    name: snapshot-name
    copytype: snapshot
    source: source-volume-name
    target: target-volume-name
    mdiskgrp: Pool0
    consistgrp: consistencygroup-name
    copyrate: 50
    grainsize: 64

Scanned by Steampunk Spotter

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

- name: Create FlashCopy mapping for clone
  ibm.storage_virtualize.ibm_svc_manage_flashcopy:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    state: present
    name: snapshot-name
    copytype: clone
    source: source-volume-name
    target: target-volume-name
    mdiskgrp: Pool0
    consistgrp: consistencygroup-name
    copyrate: 50
    grainsize: 64

Scanned by Steampunk Spotter

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

- name: Create FlashCopy mapping for backup
  ibm.storage_virtualize.ibm_svc_manage_flashcopy:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    state: present
    name: snapshot-name
    copytype: backup
    source: source-volume-name
    target: target-volume-name
    mdiskgrp: Pool0
    copyrate: 50
    grainsize: 64

Scanned by Steampunk Spotter

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

- name: Delete FlashCopy mapping for snapshot
  ibm.storage_virtualize.ibm_svc_manage_flashcopy:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: snapshot-name
    state: absent
    force: true

Scanned by Steampunk Spotter

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

- name: Delete FlashCopy mapping for clone
  ibm.storage_virtualize.ibm_svc_manage_flashcopy:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: clone-name
    state: absent
    force: true

Inputs

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

force:
    description:
    - Brings the target volume online. This parameter is required if the FlashCopy mapping
      is in the stopped state.
    - Valid when I(state=absent), to delete a FlashCopy mapping.
    type: bool

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

source:
    description:
    - Specifies the name of the source volume.
    - Required when I(state=present), to create a FlashCopy mapping.
    type: str

target:
    description:
    - Specifies the name of the target volume.
    - Required when I(state=present), to create a FlashCopy mapping.
    type: str

copyrate:
    description:
    - Specifies the copy rate. The rate varies between 0-150.
    - If unspecified, the default copy rate of 50 for clone and 0 for snapshot is used.
    - Valid when I(state=present), to create or modify a FlashCopy mapping.
    type: str

copytype:
    choices:
    - snapshot
    - clone
    - backup
    description:
    - Specifies the copy type when creating the FlashCopy mapping.
    - Required when I(state=present), to create a FlashCopy mapping.
    type: str

log_path:
    description:
    - Path of debug log file.
    type: str

mdiskgrp:
    description:
    - Specifies the name of the storage pool to use when creating the target volume.
    - If unspecified, the pool associated with the source volume is used.
    - Valid when I(state=present), to create a FlashCopy mapping.
    type: str

old_name:
    description:
    - Specifies the old name of an mdiskgrp.
    - Applies when I(state=present), to rename the existing mdiskgrp.
    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

grainsize:
    description:
    - Specifies the grain size for the FlashCopy mapping.
    - The grainsize can be set to 64 or 256. The default value is 256.
    - Valid when I(state=present), to create a FlashCopy mapping.
    type: str

consistgrp:
    description:
    - Specifies the name of the consistency group to which the FlashCopy mapping is to
      be added.
    - Parameters I(consistgrp) and I(noconsistgrp) are mutually exclusive.
    - Valid when I(state=present), to create or modify a FlashCopy mapping.
    type: str

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

noconsistgrp:
    description:
    - If specified True, FlashCopy mapping is removed from the consistency group.
    - Parameters I(noconsistgrp) and I(consistgrp) are mutually exclusive.
    - Valid when I(state=present), to modify a FlashCopy mapping.
    type: bool

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