ibm.storage_virtualize.ibm_svc_mdiskgrp module – This module manages pools on IBM Storage Virtualize family systems

Note

This module is part of the ibm.storage_virtualize collection (version 2.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install ibm.storage_virtualize.

To use it in a playbook, specify: ibm.storage_virtualize.ibm_svc_mdiskgrp.

New in ibm.storage_virtualize 1.0.0

Synopsis

  • Ansible interface to manage ‘mkmdiskgrp’ and ‘rmmdiskgrp’ pool commands.

Parameters

Parameter

Comments

clustername

string / required

The hostname or management IP of the Storage Virtualize system.

datareduction

string

Defines use of data reduction pools (DRPs) on the MDisk group.

Applies when state=present, to create a pool.

Choices:

  • "yes"

  • "no" ← (default)

domain

string

Domain for the Storage Virtualize system.

Valid when hostname is used for the parameter clustername.

easytier

string

Defines use of easytier with the MDisk group.

Applies when state=present, to create a pool.

Choices:

  • "on"

  • "off" ← (default)

  • "auto"

encrypt

string

Defines use of encryption with the MDisk group.

Applies when state=present, to create a pool.

Choices:

  • "yes"

  • "no" ← (default)

etfcmoverallocationmax

string

added in ibm.storage_virtualize 1.12.0

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 state=present.

ext

integer

Specifies the size of the extents for this group in MB.

Applies when state=present, to create a pool.

log_path

string

Path of debug log file.

name

string / required

Specifies the name to assign to the new pool.

noownershipgroup

boolean

added in ibm.storage_virtualize 1.12.0

Specifies to unmap ownershipgroup from the pool.

Applies when state=present to modify an existing pool.

Choices:

  • false

  • true

noprovisioningpolicy

boolean

added in ibm.storage_virtualize 1.10.0

Specify to unmap provisioning policy from the pool.

Applies, when state=present to modify an existing pool.

Choices:

  • false

  • true

noquota

boolean

added in ibm.storage_virtualize 1.8.0

Specify to create a data reduction child pool.

noquota and size parameters are mutually exclusive.

noquota parameter must be used with datareduction set to yes to create a data reduction child pool.

noquota parameter must be used with parentmdiskgrp in a parent data reduction storage pool.

Choices:

  • false

  • true

old_name

string

added in ibm.storage_virtualize 1.12.0

Specifies the old name of an existing pool.

Applies when state=present, to rename the existing pool.

ownershipgroup

string

added in ibm.storage_virtualize 1.12.0

Specifies the name of the ownershipgroup to map it with the pool.

Applies when state=present.

parentmdiskgrp

string

Parentmdiskgrp for subpool.

Applies when state=present, to create a pool.

password

string

REST API password for the Storage Virtualize system.

The parameters username and password are required if not using token to authenticate a user.

provisioningpolicy

string

added in ibm.storage_virtualize 1.10.0

Specify the name of the provisioning policy to map it with the pool.

Applies, when state=present.

replication_partner_clusterid

string

added in ibm.storage_virtualize 1.10.0

Specifies the id or name of the partner cluster which will be used for replication.

Applies, when state=present.

Supported in SV build 8.5.2.1 or later.

replicationpoollinkuid

string

added in ibm.storage_virtualize 1.10.0

Specifies the replication pool unique identifier which should be same as the pool that present in the replication server.

Applies, when state=present.

Supported in SV build 8.5.2.1 or later.

resetreplicationpoollinkuid

boolean

added in ibm.storage_virtualize 1.10.0

If set, any links between this pool on local system and pools on remote systems will be removed.

Applies, when state=present to modify an existing pool.

Supported in SV build 8.5.2.1 or later.

Choices:

  • false

  • true

safeguarded

boolean

added in ibm.storage_virtualize 1.8.0

Specify to create a safeguarded child pool.

Applicable only during child pool creation.

Choices:

  • false

  • true

size

integer

Specifies the child pool capacity. The value must be a numeric value (and an integer multiple of the extent size).

Applies when state=present, to create a pool.

state

string / required

Creates (present) or removes (absent) an MDisk group.

Choices:

  • "absent"

  • "present"

token

string

added in ibm.storage_virtualize 1.5.0

The authentication token to verify a user on the Storage Virtualize system.

To generate a token, use the ibm.storage_virtualize.ibm_svc_auth module.

unit

string

Unit for subpool.

Applies when state=present, to create a pool.

username

string

REST API username for the Storage Virtualize system.

The parameters username and password are required if not using token to authenticate a user.

validate_certs

boolean

Validates certification.

Choices:

  • false ← (default)

  • true

vdiskprotectionenabled

string

added in ibm.storage_virtualize 1.12.0

Specifies whether volume protection is enabled for this storage pool. The default value is ‘yes’.

Applies when state=present.

Choices:

  • "yes"

  • "no"

warning

integer

added in ibm.storage_virtualize 1.12.0

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 state=present while creating the pool.

Notes

Note

  • This module supports check_mode.

Examples

- 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
- 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
- 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
- name: Delete mdisk group
  ibm.storage_virtualize.ibm_svc_mdiskgrp:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    name: pool1
    state: absent
- 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

Authors

  • Peng Wang(@wangpww)

  • Sanjaikumaar M (@sanjaikumaar)

  • Lavanya C R(@lavanya)