netapp.cloudmanager.na_cloudmanager_cvo_aws – NetApp Cloud Manager CVO for AWS

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_cvo_aws.

New in version 21.3.0: of netapp.cloudmanager

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Create, delete, or manage Cloud Manager CVO for AWS.

Parameters

Parameter		Choices/Defaults	Comments
aws_tag list / elements=dictionary			Additional tags for the AWS CVO working environment.
	tag_key string		The key of the tag.
	tag_value string		The tag value.
backup_volumes_to_cbs boolean		Choices: no ← yes	Automatically enable back up of all volumes to S3.
capacity_package_name string added in 21.12.0 of netapp.cloudmanager		Choices: Professional Essential Freemium	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.
capacity_tier string		Choices: S3 ← NONE	Whether to enable data tiering for the first data aggregate.
client_id string / required			The client ID of the Cloud Manager Connector. You can find the ID from the Connector tab on https://cloudmanager.netapp.com.
cloud_provider_account string			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.
cluster_floating_ip string			For HA FloatingIP, the cluster management floating IP address.
data_encryption_type string		Choices: AWS ← NONE	The type of encryption to use for the working environment.
data_floating_ip string			For HA FloatingIP, the data floating IP address.
data_floating_ip2 string			For HA FloatingIP, the data floating IP address.
ebs_volume_size integer		Default: 1	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].
ebs_volume_size_unit string		Choices: GB TB ←	The unit for ebs volume size.
ebs_volume_type string		Choices: gp3 gp2 ← io1 sc1 st1	The EBS volume type for the first data aggregate.
enable_compliance boolean		Choices: no ← yes	Enable the Cloud Compliance service on the working environment.
enable_monitoring boolean		Choices: no ← yes	Enable the Monitoring service on the working environment.
environment string added in 21.8.0 of netapp.cloudmanager		Choices: prod ← stage	The environment for NetApp Cloud Manager API operations.
failover_mode string		Choices: PrivateIP FloatingIP	For HA, the failover mode for the HA pair. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones.
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.
instance_profile_name string			The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile.
instance_tenancy string		Choices: default ← dedicated	The EC2 instance tenancy.
instance_type string		Default: "m5.2xlarge"	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.
iops integer			Provisioned IOPS. Required only when provider_volume_type is 'io1' or 'gp3'.
is_ha boolean		Choices: no ← yes	Indicate whether the working environment is an HA pair or not.
kms_key_arn string added in 21.10.0 of netapp.cloudmanager			AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
kms_key_id string			Aws Encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified.
license_type string		Choices: cot-standard-paygo ← cot-premium-paygo cot-explore-paygo cot-premium-byol ha-cot-standard-paygo ha-cot-premium-paygo ha-cot-premium-byol ha-cot-explore-paygo capacity-paygo ha-capacity-paygo	The type of license to use. For single node ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo', 'cot-premium-byol', 'capacity-paygo']. For HA ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo','ha-cot-premium-byol', 'ha-capacity-paygo']. Use capacity-paygo or ha-capacity-paygo for HA on selecting Bring Your Own License type Capacity-Based or Freemium. Use cot-premium-boyl or ha-cot-permium-boyl for HA on selecting Bring Your Own License type Node-Based.
mediator_assign_public_ip boolean		Choices: no yes ←	Boolean option to assign public IP.
mediator_key_pair_name string			For HA, the key pair name for the mediator instance.
mediator_subnet_id string			For HA, the subnet ID of the mediator.
name string / required			The name of the Cloud Manager CVO for AWS to manage.
node1_subnet_id string			For HA, the subnet ID of the first node.
node2_subnet_id string			For HA, the subnet ID of the second node.
nss_account string			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.
ontap_version string		Default: "latest"	The required ONTAP version. Ignored if 'use_latest_version' is set to true.
optimized_network_utilization boolean		Choices: no yes ←	Use optimized network utilization.
platform_serial_number string			The serial number for the cluster. This is required when using 'cot-premium-byol'.
platform_serial_number_node1 string			For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'.
platform_serial_number_node2 string			For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'.
provided_license string			Using a NLF license file for BYOL deployment.
refresh_token string			The refresh token for NetApp Cloud Manager API operations.
region string / required			The region where the working environment will be created.
route_table_ids list / elements=string			For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs.
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.
security_group_id string			The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
state string		Choices: present ← absent	Whether the specified Cloud Manager CVO for AWS should exist or not.
subnet_id string			The subnet id where the working environment will be created. Required when single node only.
svm_floating_ip string			For HA FloatingIP, the SVM management floating IP address.
svm_password string / required			The admin password for Cloud Volumes ONTAP. It will be updated on each run.
throughput integer			Unit is Mb/s. Valid range 125-1000. Required only when provider_volume_type is 'gp3'.
tier_level string		Choices: normal ← ia ia-single intelligent	The tiering level when 'capacity_tier' is set to 'S3'.
use_latest_version boolean		Choices: no yes ←	Indicates whether to use the latest available ONTAP version.
vpc_id string			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.
workspace_id string			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.
writing_speed_state string			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	Returned	Description
working_environment_id string	success	Newly created AWS CVO working_environment_id.

Authors

NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>

© 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_cvo_aws_module.html