ibm.storage_virtualize.ibm_svc_manage_mirrored_volume (2.3.1) — module

This module manages mirrored volumes on IBM Storage Virtualize family systems

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

Authors: Rohit Kumar(@rohitk-github)

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 'mkvolume', 'addvolumecopy', 'rmvolumecopy', and 'rmvolume' volume commands.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a HyperSwap volume
  ibm.storage_virtualize.ibm_svc_manage_mirrored_volume:
    clustername: "{{clustername}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    type: "local hyperswap"
    name: "vol1"
    state: present
    poolA: "pool1"
    poolB: "pool2"
    size: "1024"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a thin-provisioned HyperSwap volume
  ibm.storage_virtualize.ibm_svc_manage_mirrored_volume:
    clustername: "{{clustername}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    type: "local hyperswap"
    name: "vol2"
    state: present
    poolA: "pool1"
    poolB: "pool2"
    size: "1024"
    thin: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete a mirrored volume
  ibm.storage_virtualize.ibm_svc_manage_mirrored_volume:
    clustername: "{{clustername}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    name: "vol2"
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a standard mirror volume
  block:
    - name: Create Volume
      ibm.storage_virtualize.ibm_svc_manage_mirrored_volume:
        clustername: "{{clustername}}"
        username: "{{username}}"
        password: "{{password}}"
        log_path: /tmp/playbook.debug
        name: "vol4"
        state: present
        type: "standard"
        poolA: "pool1"
        poolB: "pool3"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Resize an existing mirrored volume
  block:
    - name: Resize an existing mirrored volume
      ibm.storage_virtualize.ibm_svc_manage_mirrored_volume:
        clustername: "{{clustername}}"
        username: "{{username}}"
        password: "{{password}}"
        log_path: /tmp/playbook.debug
        name: "vol1"
        state: present
        size: "{{new_size}}"

Inputs

    
name:
    description:
    - Specifies the name to assign to the new volume.
    required: true
    type: str

size:
    description:
    - Specifies the size of mirrored volume in MB. This can also be used to resize a mirrored
      volume. When resizing, only mandatory parameters can be passed.
    type: str

thin:
    description:
    - Specifies if the volume to be created is thin-provisioned.
    type: bool

type:
    choices:
    - local hyperswap
    - standard
    description:
    - Specifies the desired volume type.
    - When the type is C(local hyperswap), a HyperSwap volume gets created.
    - When the type is C(standard) and values for I(PoolA) and I(PoolB) arguments are
      also specified, a "standard mirror" volume gets created.
    - If a "standard" mirrored volume exists and either I(PoolA) or I(PoolB) is specified,
      the mirrored volume gets converted to a standard volume.
    type: str

poolA:
    description:
    - Specifies the name of first storage pool to be used when creating a mirrored volume.
    type: str

poolB:
    description:
    - Specifies the name of second storage pool to be used when creating a mirrored volume.
    type: str

rsize:
    description:
    - Specifies the rsize (buffersize) in %. Defines how much physical space is initially
      allocated to the thin-provisioned or compressed volume.
    type: str

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

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

grainsize:
    description:
    - Specifies the grain size (in KB) to use when creating the HyperSwap volume.
    type: str

compressed:
    description:
    - Specifies if the volume to be created is compressed.
    type: bool

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

deduplicated:
    description:
    - Specifies if the volume to be created is deduplicated.
    type: bool

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