netapp.cloudmanager.na_cloudmanager_connector_azure module – NetApp Cloud Manager connector for Azure.
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_azure
.
New in netapp.cloudmanager 21.4.0
Synopsis
Create or delete Cloud Manager connector for Azure.
Parameters
Parameter |
Comments |
---|---|
The NetApp tenancy account ID. |
|
The password for the Connector. |
|
The user name for the Connector. |
|
Indicates whether to associate the public IP address to the virtual machine. Choices:
|
|
The unique client ID of the Connector. The connector ID. |
|
The name of the company of the user. |
|
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 location where the Cloud Manager Connector will be created. |
|
The name of the Cloud Manager connector for Azure to manage. |
|
The name of the security group for the deployment. |
|
The resource group in Azure associated with the security group. If not provided, its assumed that the security group is within the previously specified resource group. |
|
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 resource group in Azure where the resources 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. |
|
Whether the specified Cloud Manager connector for Azure should exist or not. Choices:
|
|
The storage account can be created automatically. When Storage account name must be between 3 and 24 characters in length and use numbers and lower-case letters only. |
|
The name of the subnet for the virtual machine. For example, in /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Network/virtualNetworks/xxx/subnets/default, only default is needed. |
|
The ID of the Azure subscription. |
|
The virtual machine type. (for example, Standard_DS3_v2). At least 4 CPU and 16 GB of memory are required. Default: |
|
The name of the virtual network. for example, in /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Network/virtualNetworks/default, only default is needed. |
|
The resource group in Azure associated with the virtual network. If not provided, its assumed that the VNet is within the previously specified resource group. |
Notes
Note
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 Azure.
netapp.cloudmanager.na_cloudmanager_connector_azure:
state: present
refresh_token: "{{ xxxxxxxxxxxxxxx }}"
name: bsuhas_ansible_occm
location: westus
resource_group: occm_group_westus
subnet_name: subnetxxxxx
vnet_name: Vnetxxxxx
subscription_id: "{{ xxxxxxxxxxxxxxxxx }}"
account_id: "{{ account-xxxxxxx }}"
company: NetApp
admin_password: Netapp123456
admin_username: bsuhas
network_security_group_name: OCCM_SG
proxy_url: abc.com
proxy_user_name: xyz
proxy_password: abcxyz
proxy_certificates: [abc.crt.txt, xyz.crt.txt]
- name: Delete NetApp Cloud Manager connector for Azure.
netapp.cloudmanager.na_cloudmanager_connector_azure:
state: absent
name: ansible
location: westus
resource_group: occm_group_westus
network_security_group_name: OCCM_SG
subnet_name: subnetxxxxx
company: NetApp
admin_password: Netapp123456
admin_username: bsuhas
vnet_name: Vnetxxxxx
subscription_id: "{{ xxxxxxxxxxxxxxxxx }}"
account_id: "{{ account-xxxxxxx }}"
refresh_token: "{{ xxxxxxxxxxxxxxx }}"
client_id: xxxxxxxxxxxxxxxxxxx
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Newly created Azure connector id in cloud manager. Returned: success Sample: |