netapp.cloudmanager.na_cloudmanager_connector_aws module – NetApp Cloud Manager connector 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_connector_aws
.
New in netapp.cloudmanager 21.3.0
Synopsis
Create or delete Cloud Manager connector for AWS.
This module requires to be authenticated with AWS. This can be done with
aws configure
.
Parameters
Parameter |
Comments |
---|---|
The NetApp tenancy account ID. |
|
The image ID. |
|
Indicates whether to associate a public IP address to the instance. If not provided, the association will be done based on the subnet’s configuration. Choices:
|
|
Additional tags for the AWS EC2 instance. |
|
The key of the tag. |
|
The tag value. |
|
The unique client ID of the Connector. The connector ID. |
|
The name of the company of the user. |
|
Indicates whether to enable termination protection on the instance. 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 name of the instance profile for the Connector. |
|
The ID of the EC2 instance used for delete. |
|
The type of instance (for example, t3.xlarge). At least 4 CPU and 16 GB of memory are required. Default: |
|
The name of the key pair to use for the Connector instance. |
|
The name of the Cloud Manager connector for AWS to manage. |
|
The proxy certificates, a list of certificate file names. |
|
The proxy password, if using a proxy to connect to the internet. |
|
The proxy URL, if using a proxy to connect to the internet. |
|
The proxy user name, if using a proxy to connect to the internet. |
|
The refresh token for NetApp Cloud Manager API operations. |
|
The region where the Cloud Manager Connector will be created. |
|
The service account secret client ID for NetApp Cloud Manager API operations. |
|
The service account secret key for NetApp Cloud Manager API operations. |
|
The IDs of the security groups for the instance, multiple security groups can be provided separated by ‘,’. |
|
Whether the specified Cloud Manager connector for AWS should exist or not. Choices:
|
|
The ID of the subnet for the instance. |
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 connector for AWS
netapp.cloudmanager.na_cloudmanager_connector_aws:
state: present
refresh_token: "{{ xxxxxxxxxxxxxxx }}"
name: bsuhas_ansible_occm
region: us-west-1
key_name: dev_automation
subnet_id: subnet-xxxxx
security_group_ids: [sg-xxxxxxxxxxx]
iam_instance_profile_name: OCCM_AUTOMATION
account_id: "{{ account-xxxxxxx }}"
company: NetApp
proxy_url: abc.com
proxy_user_name: xyz
proxy_password: abcxyz
proxy_certificates: [abc.crt.txt, xyz.crt.txt]
aws_tag: [
{tag_key: abc,
tag_value: a123}]
- name: Delete NetApp Cloud Manager connector for AWS
netapp.cloudmanager.na_cloudmanager_connector_aws:
state: absent
name: ansible
region: us-west-1
account_id: "{{ account-xxxxxxx }}"
instance_id: i-xxxxxxxxxxxxx
client_id: xxxxxxxxxxxxxxxxxxx
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Newly created AWS client ID in cloud manager, instance ID and account ID. Returned: success |