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 2.0.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.
Note
The ibm.spectrum_virtualize collection has been renamed to ibm.storage_virtualize and will be removed from Ansible 12. If you use content from ibm.spectrum_virtualize, please update FQCNs in your playbooks and roles! When creating new playbooks or roles, directly use content from ibm.storage_virtualize instead.
New in ibm.spectrum_virtualize 1.0.0
Synopsis
Ansible interface to manage ‘mkmdiskgrp’ and ‘rmmdiskgrp’ pool commands.
Parameters
Parameter |
Comments |
|---|---|
The hostname or management IP of the Spectrum Virtualize storage system. |
|
Defines use of data reduction pools (DRPs) on the MDisk group. Applies when state=present, to create a pool. Choices:
|
|
Domain for the Spectrum Virtualize storage system. Valid when hostname is used for the parameter clustername. |
|
Defines use of easytier with the MDisk group. Applies when state=present, to create a pool. Choices:
|
|
Defines use of encryption with the MDisk group. Applies when state=present, to create a pool. Choices:
|
|
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. |
|
Specifies the size of the extents for this group in MB. Applies when state=present, to create a pool. |
|
Path of debug log file. |
|
Specifies the name to assign to the new pool. |
|
Specifies to unmap ownershipgroup from the pool. Applies when state=present to modify an existing pool. Choices:
|
|
Specify to unmap provisioning policy from the pool. Applies, when state=present to modify an existing pool. Choices:
|
|
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:
|
|
Specifies the old name of an existing pool. Applies when state=present, to rename the existing pool. |
|
Specifies the name of the ownershipgroup to map it with the pool. Applies when state=present. |
|
Parentmdiskgrp for subpool. Applies when state=present, to create a pool. |
|
REST API password for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Specify the name of the provisioning policy to map it with the pool. Applies, when state=present. |
|
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. |
|
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. |
|
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:
|
|
Specify to create a safeguarded child pool. Applicable only during child pool creation. Choices:
|
|
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. |
|
Creates ( Choices:
|
|
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 for subpool. Applies when state=present, to create a pool. |
|
REST API username for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Validates certification. Choices:
|
|
Specifies whether volume protection is enabled for this storage pool. The default value is ‘yes’. Applies when state=present. Choices:
|
|
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.spectrum_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.spectrum_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.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