ibm.spectrum_virtualize.ibm_svc_mdiskgrp module – This module manages pools on IBM Spectrum Virtualize family storage systems

Note

This module is part of the ibm.spectrum_virtualize collection (version 1.10.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.spectrum_virtualize.

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

New in ibm.spectrum_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 Spectrum Virtualize storage 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 Spectrum Virtualize storage 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)

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.

noprovisioningpolicy

boolean

added in ibm.spectrum_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.spectrum_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

parentmdiskgrp

string

Parentmdiskgrp for subpool.

Applies when state=present, to create a pool.

password

string

REST API password for the Spectrum Virtualize storage system.

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

provisioningpolicy

string

added in ibm.spectrum_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.spectrum_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.spectrum_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.spectrum_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.spectrum_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.spectrum_virtualize 1.5.0

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

To generate a token, use the ibm.spectrum_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 Spectrum Virtualize storage 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

Notes

Note

  • This module supports check_mode.

Examples

- name: Create mdisk group
  ibm.spectrum_virtualize.ibm_svc_mdiskgrp:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    name: pool1
    provisioningpolicy: pp0
    replicationpoollinkuid: 000000000000000
    replication_partner_clusterid: 000000000032432342
    state: present
    datareduction: no
    easytier: auto
    encrypt: no
    ext: 1024
- name: Create a safeguarded backup location
  ibm.spectrum_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.spectrum_virtualize.ibm_svc_mdiskgrp:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    name: pool1
    state: absent
- name: Delete a safeguarded backup location
  ibm.spectrum_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)