netapp.cloudmanager.na_cloudmanager_aggregate module – NetApp Cloud Manager Aggregate
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_aggregate
.
New in netapp.cloudmanager 21.3.0
Synopsis
Create, Modify or Delete Aggregate on Cloud Manager.
Parameters
Parameter |
Comments |
---|---|
The aggregate’s capacity tier for tiering cold data to object storage. If the value is NONE, the capacity_tier will not be set on aggregate creation. Choices:
|
|
The connector ID of the Cloud Manager Connector. |
|
The required size of the disks. |
|
The disk size unit [‘GB’ or ‘TB’]. The default is ‘TB’. Choices:
|
|
The environment for NetApp Cloud Manager API operations. Choices:
|
|
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. |
|
The home node that the new aggregate should belong to. |
|
Provisioned IOPS. Needed only when providerVolumeType is “io1”. |
|
The name of the new aggregate. |
|
The required number of disks in the new aggregate. |
|
The cloud provider volume type. |
|
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. |
|
Whether the specified aggregate should exist or not. Choices:
|
|
Unit is Mb/s. Valid range 125-1000. Required only when provider_volume_type is ‘gp3’. |
|
The public ID of the working environment where the aggregate will be created. |
|
The working environment name where the aggregate 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 Aggregate
netapp.cloudmanager.na_cloudmanager_aggregate:
state: present
name: AnsibleAggregate
working_environment_name: testAWS
client_id: "{{ client_id }}"
number_of_disks: 2
refresh_token: xxx
- name: Delete Volume
netapp.cloudmanager.na_cloudmanager_aggregate:
state: absent
name: AnsibleAggregate
working_environment_name: testAWS
client_id: "{{ client_id }}"
refresh_token: xxx
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Success message. Returned: success Sample: |