netapp.cloudmanager.na_cloudmanager_aws_fsx module – Cloud ONTAP file system(FSx) in AWS
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_aws_fsx.
New in netapp.cloudmanager 21.13.0
Synopsis
Create or delete CVO/Working Environment for AWS FSx.
Parameters
Parameter |
Comments |
|---|---|
The name of the AWS Credentials account name. |
|
The endpoint IP address range. |
|
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 AWS file system ID to import to CloudManager. Required when import_file_system is ‘True’ |
|
The admin password for Cloud Volumes ONTAP fsxadmin user. |
|
bool option to existing import AWS file system to CloudManager. Choices:
|
|
AWS encryption parameters. It is required if using aws encryption. |
|
Provisioned SSD IOPS. |
|
The name of the CVO/Working Environment for AWS FSx to manage. |
|
The subnet ID of the first node. |
|
The refresh token for NetApp Cloud Manager API operations. |
|
The region where the working environment will be created. |
|
The list of route table IDs that will be updated with the floating IPs. |
|
The service account secret client ID for NetApp Cloud Manager API operations. |
|
The service account secret key for NetApp Cloud Manager API operations. |
|
The subnet ID of the second node. |
|
The IDs of the security groups for the working environment, multiple security groups can be provided separated by ‘,’. |
|
Whether the specified FSx in AWS should exist or not. Choices:
|
|
volume size for the first data aggregate. For GB, the value can be [100 or 500]. For TB, the value can be [1,2,4,8,16]. |
|
The unit for volume size. Choices:
|
|
Additional tags for the FSx AWS working environment. |
|
The key of the tag. |
|
The tag value. |
|
The NetApp account ID that the File System will be associated with. |
|
The capacity of the throughput. Choices:
|
|
The ID of the AWS FSx working environment used for delete. |
|
The ID of the Cloud Manager workspace of working environment. |
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 NetApp AWS FSx
netapp.cloudmanager.na_cloudmanager_aws_fsx:
state: present
refresh_token: "{{ xxxxxxxxxxxxxxx }}"
name: fsxAnsible
region: us-east-2
workspace_id: workspace-xxxxx
tenant_id: account-xxxxx
storage_capacity_size: 1024
storage_capacity_size_unit: TiB
aws_credentials_name: xxxxxxx
primary_subnet_id: subnet-xxxxxx
secondary_subnet_id: subnet-xxxxx
throughput_capacity: 512
fsx_admin_password: xxxxxxx
tags: [
{tag_key: abcd,
tag_value: ABCD}]
- name: Import AWS FSX
na_cloudmanager_aws_fsx:
state: present
refresh_token: "{{ xxxxxxxxxxxxxxx }}"
name: fsxAnsible
region: us-west-2
workspace_id: workspace-xxxxx
import_file_system: True
file_system_id: "{{ xxxxxxxxxxxxxxx }}"
tenant_id: account-xxxxx
aws_credentials_name: xxxxxxx
- name: Delete NetApp AWS FSx
netapp.cloudmanager.na_cloudmanager_aws_fsx:
state: absent
refresh_token: "{{ xxxxxxxxxxxxxxx }}"
working_environment_id: fs-xxxxxx
name: fsxAnsible
tenant_id: account-xxxxx
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Newly created AWS FSx working_environment_id. Returned: success |