Docs4dev
Docs
ansible / latest / collections / netapp / cloudmanager / na_cloudmanager_aggregate_module.html

netapp.cloudmanager.na_cloudmanager_aggregate – NetApp Cloud Manager Aggregate

Note

This plugin is part of the netapp.cloudmanager collection (version 21.11.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 version 21.3.0: of netapp.cloudmanager

Synopsis

  • Create, Modify or Delete Aggregate on Cloud Manager.

Parameters

Parameter Choices/Defaults Comments
capacity_tier
string
    Choices:
  • NONE
  • S3
  • Blob
  • cloudStorage
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.
client_id
string / required
The client ID of the Cloud Manager Connector.
disk_size_size
integer
The required size of the disks.
disk_size_unit
string
    Choices:
  • GB
  • TB ←
The disk size unit ['GB' or 'TB']. The default is 'TB'.
environment
string
added in 21.8.0 of netapp.cloudmanager
    Choices:
  • prod ←
  • stage
The environment for NetApp Cloud Manager API operations.
feature_flags
dictionary
added in 21.11.0 of netapp.cloudmanager
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.
home_node
string
The home node that the new aggregate should belong to.
iops
integer
Provisioned IOPS. Needed only when providerVolumeType is "io1".
name
string / required
The name of the new aggregate.
number_of_disks
integer
The required number of disks in the new aggregate.
provider_volume_type
string
The cloud provider volume type.
refresh_token
string
The refresh token for NetApp Cloud Manager API operations.
sa_client_id
string
The service account secret client ID for NetApp Cloud Manager API operations.
sa_secret_key
string
The service account secret key for NetApp Cloud Manager API operations.
state
string / required
    Choices:
  • present
  • absent
Whether the specified aggregate should exist or not.
throughput
integer
Unit is Mb/s. Valid range 125-1000.
Required only when provider_volume_type is 'gp3'.
working_environment_id
string
The public ID of the working environment where the aggregate will be created.
working_environment_name
string
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 Returned Description
msg
string
success
Success message.

Sample:
Aggregate Created


Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/cloudmanager/na_cloudmanager_aggregate_module.html