netapp.cloudmanager.na_cloudmanager_cvo_aws module – NetApp Cloud Manager CVO for 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_cvo_aws.
New in netapp.cloudmanager 21.3.0
Synopsis
Create, delete, or manage Cloud Manager CVO for AWS.
Parameters
Parameter |
Comments |
|---|---|
Additional tags for the AWS CVO working environment. |
|
The key of the tag. |
|
The tag value. |
|
Automatically enable back up of all volumes to S3. Choices:
|
|
Capacity package name is required when selecting a capacity based license. Essential only available with Bring Your Own License Capacity-Based. Professional available as an annual contract from AWS marketplace or Bring Your Own License Capacity-Based. Choices:
|
|
Whether to enable data tiering for the first data aggregate. Choices:
|
|
The connector ID of the Cloud Manager Connector. You can find the ID from the Connector tab on https://cloudmanager.netapp.com. |
|
The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector. |
|
For HA FloatingIP, the cluster management floating IP address. |
|
SSH authentication key pair name |
|
The type of encryption to use for the working environment. Choices:
|
|
For HA FloatingIP, the data floating IP address. |
|
For HA FloatingIP, the data floating IP address. |
|
EBS 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]. Default: |
|
The unit for ebs volume size. Choices:
|
|
The EBS volume type for the first data aggregate. Choices:
|
|
Enable the Cloud Compliance service on the working environment. Choices:
|
|
Enable the Monitoring service on the working environment. Choices:
|
|
The environment for NetApp Cloud Manager API operations. Choices:
|
|
For HA, the failover mode for the HA pair. ‘PrivateIP’ is for a single availability zone and ‘FloatingIP’ is for multiple availability zones. 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 instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile. |
|
The EC2 instance tenancy. Choices:
|
|
The instance type to use, which depends on the license type. Explore [‘m5.xlarge’]. Standard [‘m5.2xlarge’,’r5.xlarge’]. Premium [‘m5.4xlarge’,’r5.2xlarge’,’c4.8xlarge’]. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. Default: |
|
Provisioned IOPS. Required only when provider_volume_type is ‘io1’ or ‘gp3’. |
|
Indicate whether the working environment is an HA pair or not. Choices:
|
|
AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified. |
|
Aws Encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified. |
|
The type of license to use. For single node by Capacity [‘capacity-paygo’] For single node by Node paygo [‘cot-explore-paygo’, ‘cot-standard-paygo’, ‘cot-premium-paygo’]. For single node by Node boyl [‘cot-premium-byol’]. For HA by Capacity [‘ha-capacity-paygo’] For HA by Node paygo [‘ha-cot-explore-paygo’,’ha-cot-standard-paygo’,’ha-cot-premium-paygo’]. For HA by Node boyl [‘ha-cot-premium-byol’]. Choices:
|
|
Boolean option to assign public IP. Choices:
|
|
For HA, the key pair name for the mediator instance. |
|
For HA, the subnet ID of the mediator. |
|
The name of the Cloud Manager CVO for AWS to manage. |
|
For HA, the subnet ID of the first node. |
|
For HA, the subnet ID of the second node. |
|
The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account is not provided, Cloud Manager tries to use the first existing NSS account. |
|
The required ONTAP version. Ignored if ‘use_latest_version’ is set to true. Default: |
|
Use optimized network utilization. Choices:
|
|
The serial number for the cluster. This is required when using ‘cot-premium-byol’. |
|
For HA BYOL, the serial number for the first node. This is required when using ‘ha-cot-premium-byol’. |
|
For HA BYOL, the serial number for the second node. This is required when using ‘ha-cot-premium-byol’. |
|
Using a NLF license file for BYOL deployment. |
|
The refresh token for NetApp Cloud Manager API operations. |
|
The region where the working environment will be created. |
|
For HA FloatingIP, 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 ID of the security group for the working environment. If not provided, Cloud Manager creates the security group. |
|
Whether the specified Cloud Manager CVO for AWS should exist or not. Choices:
|
|
The subnet id where the working environment will be created. Required when single node only. |
|
For HA FloatingIP, the SVM management floating IP address. |
|
The name of the SVM. |
|
The admin password for Cloud Volumes ONTAP. It will be updated on each run. |
|
Unit is Mb/s. Valid range 125-1000. Required only when provider_volume_type is ‘gp3’. |
|
The tiering level when ‘capacity_tier’ is set to ‘S3’. Choices:
|
|
Indicates whether to update svm_password on the CVO. When set to true, the module is not idempotent, as we cannot read the current password. Choices:
|
|
Indicates whether to upgrade ONTAP image on the CVO. If the current version already matches the desired version, no action is taken. Choices:
|
|
Indicates whether to use the latest available ONTAP version. Choices:
|
|
The VPC ID where the working environment will be created. If this argument is not provided, the VPC will be calculated by using the provided subnet ID. |
|
The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on https://cloudmanager.netapp.com. |
|
The write speed setting for Cloud Volumes ONTAP [‘NORMAL’,’HIGH’]. This argument is not relevant for HA pairs. |
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 Cloud Manager CVO for AWS single
netapp.cloudmanager.na_cloudmanager_cvo_aws:
state: present
refresh_token: "{{ xxxxxxxxxxxxxxx }}"
name: AnsibleCVO
region: us-west-1
subnet_id: subnet-xxxxxxx
vpc_id: vpc-xxxxxxxx
svm_password: P@assword!
client_id: "{{ xxxxxxxxxxxxxxx }}"
writing_speed_state: NORMAL
aws_tag: [
{tag_key: abc,
tag_value: a123}]
- name: Create NetApp Cloud Manager CVO for AWS HA
netapp.cloudmanager.na_cloudmanager_cvo_aws:
state: present
refresh_token: "{{ xxxxxxxxxxxxxxx }}"
name: AnsibleCVO
region: us-west-1
subnet_id: subnet-xxxxxxx
vpc_id: vpc-xxxxxxxx
svm_password: P@assword!
client_id: "{{ xxxxxxxxxxxxxxx }}"
writing_speed_state: NORMAL
aws_tag: [
{tag_key: abc,
tag_value: a123}]
is_ha: true
failover_mode: FloatingIP
node1_subnet_id: subnet-1
node2_subnet_id: subnet-1
mediator_subnet_id: subnet-1
mediator_key_pair_name: key1
cluster_floating_ip: 2.1.1.1
data_floating_ip: 2.1.1.2
data_floating_ip2: 2.1.1.3
svm_floating_ip: 2.1.1.4
route_table_ids: [rt-1,rt-2]
- name: Delete NetApp Cloud Manager cvo for AWS
netapp.cloudmanager.na_cloudmanager_cvo_aws:
state: absent
name: ansible
region: us-west-1
refresh_token: "{{ xxxxxxxxxxxxxxx }}"
subnet_id: subnet-xxxxxxx
vpc_id: vpc-xxxxxxxx
svm_password: P@assword!
client_id: "{{ xxxxxxxxxxxxxxx }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Newly created AWS CVO working_environment_id. Returned: success |