ibm.storage_virtualize.ibm_svc_mdiskgrp (2.3.1) — module

This module manages pools on IBM Storage Virtualize family systems

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

Authors: Peng Wang(@wangpww), Sanjaikumaar M (@sanjaikumaar), Lavanya C R(@lavanya)

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 'mkmdiskgrp' and 'rmmdiskgrp' pool commands.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create mdisk group
  ibm.storage_virtualize.ibm_svc_mdiskgrp:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    name: pool1
    provisioningpolicy: pp0
    replicationpoollinkuid: 000000000000000
    replication_partner_clusterid: 000000000032432342
    etfcmoverallocationmax: 120
    state: present
    datareduction: no
    easytier: auto
    encrypt: no
    ext: 1024
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create childpool with ownershipgroup
  ibm.storage_virtualize.ibm_svc_mdiskgrp:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    name: childpool0
    ownershipgroup: owner0
    parentmdiskgrp: pool1
    state: present
    datareduction: no
    easytier: auto
    encrypt: no
    ext: 1024
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a safeguarded backup location
  ibm.storage_virtualize.ibm_svc_mdiskgrp:
    clustername: "{{clustername}}"
    token: "{{results.token}}"
    log_path: "{{log_path}}"
    parentmdiskgrp: Pool1
    name: Pool1child1
    datareduction: 'yes'
    safeguarded: True
    ext: 1024
    noquota: True
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete mdisk group
  ibm.storage_virtualize.ibm_svc_mdiskgrp:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    name: pool1
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete a safeguarded backup location
  ibm.storage_virtualize.ibm_svc_mdiskgrp:
    clustername: "{{clustername}}"
    token: "{{results.token}}"
    log_path: "{{log_path}}"
    parentmdiskgrp: Pool1
    name: Pool1child1
    state: absent

Inputs

    
ext:
    description:
    - Specifies the size of the extents for this group in MB.
    - Applies when I(state=present), to create a pool.
    type: int

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

size:
    description:
    - Specifies the child pool capacity. The value must be a numeric value (and an integer
      multiple of the extent size).
    - Applies when I(state=present), to create a pool.
    type: int

unit:
    description:
    - Unit for subpool.
    - Applies when I(state=present), to create a pool.
    type: str

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

encrypt:
    choices:
    - 'yes'
    - 'no'
    default: 'no'
    description:
    - Defines use of encryption with the MDisk group.
    - Applies when I(state=present), to create a pool.
    type: str

noquota:
    description:
    - Specify to create a data reduction child pool.
    - I(noquota) and I(size) parameters are mutually exclusive.
    - I(noquota) parameter must be used with I(datareduction) set to yes to create a data
      reduction child pool.
    - I(noquota) parameter must be used with I(parentmdiskgrp) in a parent data reduction
      storage pool.
    type: bool
    version_added: 1.8.0
    version_added_collection: ibm.storage_virtualize

warning:
    description:
    - If specified, generates a warning when the used disk capacity in the storage pool
      first exceeds the specified threshold.
    - The default value is 80. To disable it, specify the value as 0.
    - Applies when I(state=present) while creating the pool.
    type: int
    version_added: 1.12.0
    version_added_collection: ibm.storage_virtualize

easytier:
    choices:
    - 'on'
    - 'off'
    - auto
    default: 'off'
    description:
    - Defines use of easytier with the MDisk group.
    - Applies when I(state=present), to create a pool.
    type: str

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

old_name:
    description:
    - Specifies the old name of an existing pool.
    - Applies when I(state=present), to rename the existing pool.
    type: str
    version_added: 1.12.0
    version_added_collection: ibm.storage_virtualize

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

safeguarded:
    description:
    - Specify to create a safeguarded child pool.
    - Applicable only during child pool creation.
    type: bool
    version_added: 1.8.0
    version_added_collection: ibm.storage_virtualize

datareduction:
    choices:
    - 'yes'
    - 'no'
    default: 'no'
    description:
    - Defines use of data reduction pools (DRPs) on the MDisk group.
    - Applies when I(state=present), to create a pool.
    type: str

ownershipgroup:
    description:
    - Specifies the name of the ownershipgroup to map it with the pool.
    - Applies when I(state=present).
    type: str
    version_added: 1.12.0
    version_added_collection: ibm.storage_virtualize

parentmdiskgrp:
    description:
    - Parentmdiskgrp for subpool.
    - Applies when I(state=present), to create a pool.
    type: str

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

noownershipgroup:
    description:
    - Specifies to unmap ownershipgroup from the pool.
    - Applies when I(state=present) to modify an existing pool.
    type: bool
    version_added: 1.12.0
    version_added_collection: ibm.storage_virtualize

provisioningpolicy:
    description:
    - Specify the name of the provisioning policy to map it with the pool.
    - Applies, when I(state=present).
    type: str
    version_added: 1.10.0
    version_added_collection: ibm.storage_virtualize

noprovisioningpolicy:
    description:
    - Specify to unmap provisioning policy from the pool.
    - Applies, when I(state=present) to modify an existing pool.
    type: bool
    version_added: 1.10.0
    version_added_collection: ibm.storage_virtualize

etfcmoverallocationmax:
    description:
    - Specifies the maximum over allocation which Easy Tier can migrate onto FlashCore
      Module arrays, when the array is used as the top tier in a multitier pool. The value
      acts as a multiplier of the physically available space.
    - The allowed values are a percentage in the range of 100% (default) to 400% or off.
      Setting the value to off disables this feature.
    - Applies when I(state=present).
    type: str
    version_added: 1.12.0
    version_added_collection: ibm.storage_virtualize

replicationpoollinkuid:
    description:
    - Specifies the replication pool unique identifier which should be same as the pool
      that present in the replication server.
    - Applies, when I(state=present).
    - Supported in SV build 8.5.2.1 or later.
    type: str
    version_added: 1.10.0
    version_added_collection: ibm.storage_virtualize

vdiskprotectionenabled:
    choices:
    - 'yes'
    - 'no'
    description:
    - Specifies whether volume protection is enabled for this storage pool. The default
      value is 'yes'.
    - Applies when I(state=present).
    type: str
    version_added: 1.12.0
    version_added_collection: ibm.storage_virtualize

resetreplicationpoollinkuid:
    description:
    - If set, any links between this pool on local system and pools on remote systems
      will be removed.
    - Applies, when I(state=present) to modify an existing pool.
    - Supported in SV build 8.5.2.1 or later.
    type: bool
    version_added: 1.10.0
    version_added_collection: ibm.storage_virtualize

replication_partner_clusterid:
    description:
    - Specifies the id or name of the partner cluster which will be used for replication.
    - Applies, when I(state=present).
    - Supported in SV build 8.5.2.1 or later.
    type: str
    version_added: 1.10.0
    version_added_collection: ibm.storage_virtualize