Skip to content
This repository has been archived by the owner on Feb 24, 2022. It is now read-only.

na_cloudmanager_volume

Chris Archibald edited this page Apr 8, 2021 · 2 revisions
orphan:

netapp.cloudmanager.na_cloudmanager_volume -- NetApp Cloud Manager volume

Note

This plugin is part of the netapp.cloudmanager collection (version 21.4.0).

To install it use: ansible-galaxy collection install netapp.cloudmanager.

To use it in a playbook, specify: netapp.cloudmanager.na_cloudmanager_volume.

.. versionadded:: 21.3.0 of netapp.cloudmanager

  • Create, Modify or Delete volume on Cloud Manager.
Parameter Choices/Defaults Comments
capacity_tier
string
    Choices:
  • NONE
  • S3
  • Blob
  • cloudStorage
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.
client_id
string / required
The client ID of the Cloud Manager Connector.
enable_compression
boolean
    Choices:
  • no
  • yes
Enabling cpmpression.
Default to true if not specified.
enable_deduplication
boolean
    Choices:
  • no
  • yes
Enabling deduplication.
Default to true if not specified.
enable_thin_provisioning
boolean
    Choices:
  • no
  • yes
Enabling thin provisioning.
Default to true if not specified.
export_policy_ip
list / elements=string
Custom export policy list of IPs (NFS protocol parameters).
export_policy_nfs_version
list / elements=string
Export policy protocol (NFS protocol parameters).
export_policy_type
string
The export policy type (NFS protocol parameters).
igroups
list / elements=string
List of igroups (iSCSI protocol parameters).
initiators
list / elements=dictionary
Set of attributes of Initiators (iSCSI protocol parameters).
alias
string / required
The alias which associates with the node.
iqn
string / required
The initiator node name.
iops
integer
Provisioned IOPS. Needed only when provider_volume_type is "io1".
name
string / required
The name of the volume.
os_name
string
Operating system (iSCSI protocol parameters).
permission
string
CIFS share permission type (CIFS protocol parameters).
provider_volume_type
string
The underlying cloud provider volume type.
For AWS is ["gp2", "io1", "st1", "sc1"].
For Azure is ['Premium_LRS','Standard_LRS','StandardSSD_LRS'].
For GCP is ['pd-ssd','pd-standard'].
refresh_token
string / required
The refresh token for NetApp Cloud Manager API operations.
share_name
string
Share name (CIFS protocol parameters).
size
float
The size of the volume.
size_unit
string
    Choices:
  • GB ←
The size unit of volume.
snapshot_policy_name
string
The snapshot policy name.
state
string
    Choices:
  • present ←
  • absent
Whether the specified volume should exist or not.
svm_name
string
The name of the SVM. The default SVM name is used, if a name is not provided.
tiering_policy
string
    Choices:
  • none
  • snapshot_only
  • auto
  • all
The tiering policy.
users
list / elements=string
List of users with the permission (CIFS protocol parameters).
volume_protocol
string
    Choices:
  • nfs ←
  • cifs
  • iscsi
The protocol for the volume. This affects the provided parameters.
working_environment_id
string
The public ID of the working environment where the volume will be created.
working_environment_name
string
The working environment name where the volume will be created.

Note

  • Support check_mode.
  • The modules prefixed with cloudmanager_netapp are built to Manage AWS/GCP/Azure CLOUDMANAGER.
- 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

Authors