netapp.cloudmanager.na_cloudmanager_volume module – NetApp Cloud Manager volume
Note
This module is part of the netapp.cloudmanager collection (version 21.24.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 netapp.cloudmanager
.
To use it in a playbook, specify: netapp.cloudmanager.na_cloudmanager_volume
.
New in netapp.cloudmanager 21.3.0
Synopsis
Create, Modify or Delete volume on Cloud Manager.
Parameters
Parameter |
Comments |
---|---|
The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate. |
|
The volume’s capacity tier for tiering cold data to object storage. The default values for each cloud provider are as follows. Amazon as ‘S3’, Azure as ‘Blob’, GCP as ‘cloudStorage’. If ‘NONE’, the capacity tier will not be set on volume creation. Choices:
|
|
The connector ID of the Cloud Manager Connector. |
|
Enabling cpmpression. Default to true if not specified. Choices:
|
|
Enabling deduplication. Default to true if not specified. Choices:
|
|
Enabling thin provisioning. Default to true if not specified. Choices:
|
|
The environment for NetApp Cloud Manager API operations. Choices:
|
|
Custom export policy list of IPs (NFS protocol parameters). |
|
Export policy protocol (NFS protocol parameters). |
|
The export policy type (NFS protocol parameters). |
|
Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. |
|
List of igroups (iSCSI protocol parameters). |
|
Set of attributes of Initiators (iSCSI protocol parameters). |
|
The alias which associates with the node. |
|
The initiator node name. |
|
Provisioned IOPS. Needed only when provider_volume_type is “io1”. |
|
The name of the volume. |
|
Operating system (iSCSI protocol parameters). |
|
CIFS share permission type (CIFS protocol parameters). |
|
The underlying cloud provider volume type. For AWS is [“gp3”, “gp2”, “io1”, “st1”, “sc1”]. For Azure is [‘Premium_LRS’,’Standard_LRS’,’StandardSSD_LRS’]. For GCP is [‘pd-balanced’,’pd-ssd’,’pd-standard’]. |
|
The refresh token for NetApp Cloud Manager API operations. |
|
The service account secret client ID for NetApp Cloud Manager API operations. |
|
The service account secret key for NetApp Cloud Manager API operations. |
|
Share name (CIFS protocol parameters). |
|
The size of the volume. |
|
The size unit of volume. Choices:
|
|
The snapshot policy name. |
|
Whether the specified volume should exist or not. Choices:
|
|
The name of the SVM. The default SVM name is used, if a name is not provided. |
|
The NetApp account ID that the Connector will be associated with. To be used only when using FSx. |
|
Unit is Mb/s. Valid range 125-1000. Required only when provider_volume_type is ‘gp3’. |
|
The tiering policy. Choices:
|
|
List of users with the permission (CIFS protocol parameters). |
|
The protocol for the volume. This affects the provided parameters. Choices:
|
|
The public ID of the working environment where the volume will be created. |
|
The working environment name where the volume will be created. |
Notes
Note
Support check_mode.
The modules prefixed with na_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds.
If sa_client_id and sa_secret_key are provided, service account will be used in operations. refresh_token will be ignored.
Examples
- name: Create nfs volume with working_environment_name
netapp.cloudmanager.na_cloudmanager_volume:
state: present
name: test_vol
size: 15
size_unit: GB
working_environment_name: working_environment_1
client_id: client_id
refresh_token: refresh_token
svm_name: svm_1
snapshot_policy_name: default
export_policy_type: custom
export_policy_ip: ["10.0.0.1/16"]
export_policy_nfs_version: ["nfs3","nfs4"]
- name: Delete volume
netapp.cloudmanager.na_cloudmanager_volume:
state: absent
name: test_vol
working_environment_name: working_environment_1
client_id: client_id
refresh_token: refresh_token
svm_name: svm_1