netapp.cloudmanager.na_cloudmanager_connector_azure – NetApp Cloud Manager connector for Azure.

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

New in version 21.4.0: of netapp.cloudmanager

Synopsis

  • Create or delete Cloud Manager connector for Azure.

Parameters

Parameter Choices/Defaults Comments
account_id
string / required
The NetApp tenancy account ID.
admin_password
string / required
The password for the Connector.
admin_username
string / required
The user name for the Connector.
associate_public_ip_address
boolean
    Choices:
  • no
  • yes ←
Indicates whether to associate the public IP address to the virtual machine.
client_id
string
The unique client ID of the Connector.
company
string / required
The name of the company of the user.
environment
string
added in 21.8.0 of netapp.cloudmanager
    Choices:
  • prod ←
  • stage
The environment for NetApp Cloud Manager API operations.
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.
location
string / required
The location where the Cloud Manager Connector will be created.
name
string / required
The name of the Cloud Manager connector for Azure to manage.
network_security_group_name
string / required
The name of the security group for the deployment.
network_security_resource_group
string
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.
proxy_certificates
list / elements=string
The proxy certificates, a list of certificate file names.
proxy_password
string
The proxy password, if using a proxy to connect to the internet.
proxy_url
string
The proxy URL, if using a proxy to connect to the internet.
proxy_user_name
string
The proxy user name, if using a proxy to connect to the internet.
refresh_token
string
The refresh token for NetApp Cloud Manager API operations.
resource_group
string / required
The resource group in Azure where the resources will be created.
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.
state
string
    Choices:
  • present ←
  • absent
Whether the specified Cloud Manager connector for Azure should exist or not.
subnet_name
string / required
added in 21.7.0 of netapp.cloudmanager
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.

aliases: subnet_id
subscription_id
string / required
The ID of the Azure subscription.
virtual_machine_size
string
Default:
"Standard_DS3_v2"
The virtual machine type. (for example, Standard_DS3_v2).
At least 4 CPU and 16 GB of memory are required.
vnet_name
string / required
added in 21.7.0 of netapp.cloudmanager
The name of the virtual network.
for example, in /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Network/virtualNetworks/default, only default is needed.

aliases: vnet_id
vnet_resource_group
string
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 Returned Description
msg
string
success
Newly created Azure connector id in cloud manager.

Sample:
xxxxxxxxxxxxxxxx


Authors

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