Docs4dev
Docs
ansible / latest / collections / netapp / cloudmanager / na_cloudmanager_cvo_azure_module.html

netapp.cloudmanager.na_cloudmanager_cvo_azure – NetApp Cloud Manager CVO/working environment in single or HA mode 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_cvo_azure.

New in version 21.4.0: of netapp.cloudmanager

Synopsis

  • Create, delete, or manage Cloud Manager CVO/working environment in single or HA mode for Azure.

Parameters

Parameter Choices/Defaults Comments
allow_deploy_in_existing_rg
boolean
    Choices:
  • no ←
  • yes
Indicates if to allow creation in existing resource group
azure_encryption_parameters
string
added in 21.10.0 of netapp.cloudmanager
AZURE encryption parameters. It is required if using AZURE encryption.
azure_tag
list / elements=dictionary
Additional tags for the AZURE 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 a cloud provider or Bring Your Own License Capacity-Based.
capacity_tier
string
    Choices:
  • Blob ←
  • NONE
Whether to enable data tiering for the first data aggregate
cidr
string / required
The CIDR of the VNET.
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.
data_encryption_type
string
    Choices:
  • AZURE ←
  • NONE
The type of encryption to use for the working environment.
disk_size
integer
Default:
1
Azure volume size for the first data aggregate.
For GB, the value can be [100, 500].
For TB, the value can be [1,2,4,8,16].
disk_size_unit
string
    Choices:
  • GB
  • TB ←
The unit for disk size.
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.
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.
ha_enable_https
boolean
added in 21.10.0 of netapp.cloudmanager
    Choices:
  • no
  • yes
For HA, enable the HTTPS connection from CVO to storage accounts. This can impact write performance. The default is false.
instance_type
string
Default:
"Standard_DS4_v2"
The type of instance to use, which depends on the license type you chose.
Explore ['Standard_DS3_v2']
Standard ['Standard_DS4_v2, Standard_DS13_v2,Standard_L8s_v2']
Premium ['Standard_DS5_v2', 'Standard_DS14_v2']
For more supported instance types, refer to Cloud Volumes ONTAP Release Notes.
is_ha
boolean
    Choices:
  • no ←
  • yes
Indicate whether the working environment is an HA pair or not.
license_type
string
    Choices:
  • azure-cot-standard-paygo ←
  • azure-cot-premium-paygo
  • azure-cot-premium-byol
  • azure-cot-explore-paygo
  • azure-ha-cot-standard-paygo
  • azure-ha-cot-premium-paygo
  • azure-ha-cot-premium-byol
  • capacity-paygo
  • ha-capacity-paygo
The type of license to use.
For single node ['azure-cot-explore-paygo', 'azure-cot-standard-paygo', 'azure-cot-premium-paygo', 'azure-cot-premium-byol', 'capacity-paygo']
For HA ['azure-ha-cot-standard-paygo', 'azure-ha-cot-premium-paygo', 'azure-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 azure-cot-premium-boyl or azure-ha-cot-permium-boyl for HA on selecting Bring Your Own License type Node-Based.
location
string / required
The location where the working environment will be created.
name
string / required
The name of the Cloud Manager CVO for AZURE to manage.
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 isn't 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
platform_serial_number_node1
string
For HA BYOL, the serial number for the first node.
platform_serial_number_node2
string
For HA BYOL, the serial number for the second node.
provided_license
string
Using a NLF license file for BYOL deployment.
refresh_token
string
The refresh token for NetApp Cloud Manager API operations.
resource_group
string
The resource_group where Cloud Volumes ONTAP will be created.
If not provided, Cloud Manager generates the resource group name (name of the working environment/CVO with suffix '-rg').
If the resource group does not exist, it is 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.
security_group_id
string
The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group.
serial_number
string
The serial number for the cluster
Required when using one of these, 'azure-cot-premium-byol' or 'azure-ha-cot-premium-byol'
state
string
    Choices:
  • present ←
  • absent
Whether the specified Cloud Manager CVO for AZURE should exist or not.
storage_type
string
    Choices:
  • Premium_LRS ←
  • Standard_LRS
  • StandardSSD_LRS
The type of storage for the first data aggregate.
subnet_id
string / required
The name of the subnet for the Cloud Volumes ONTAP system.
subscription_id
string / required
The ID of the Azure subscription.
svm_password
string / required
The admin password for Cloud Volumes ONTAP.
It will be updated on each run.
tier_level
string
    Choices:
  • normal ←
  • cool
If capacity_tier is Blob, this argument indicates the tiering level.
use_latest_version
boolean
    Choices:
  • no
  • yes ←
Indicates whether to use the latest available ONTAP version.
vnet_id
string / required
The name of the virtual network.
vnet_resource_group
string
The resource group in Azure associated to the virtual network.
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

  • 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 Azure single
  netapp.cloudmanager.na_cloudmanager_cvo_azure:
    state: present
    refresh_token: "{{ xxxxxxxxxxxxxxx }}"
    name: AnsibleCVO
    location: westus
    subnet_id: subnet-xxxxxxx
    vnet_id: vnetxxxxxxxx
    svm_password: P@assword!
    client_id: "{{ xxxxxxxxxxxxxxx }}"
    writing_speed_state: NORMAL
    azure_tag: [
        {tag_key: abc,
        tag_value: a123}]

- name: create NetApp Cloud Manager CVO for Azure HA
  netapp.cloudmanager.na_cloudmanager_cvo_azure:
    state: present
    refresh_token: "{{ xxxxxxxxxxxxxxx }}"
    name: AnsibleCVO
    location: westus
    subnet_id: subnet-xxxxxxx
    vnet_id: vnetxxxxxxxx
    svm_password: P@assword!
    client_id: "{{ xxxxxxxxxxxxxxx }}"
    writing_speed_state: NORMAL
    azure_tag: [
        {tag_key: abc,
        tag_value: a123}]
    is_ha: true

- name: delete NetApp Cloud Manager cvo for Azure
  netapp.cloudmanager.na_cloudmanager_cvo_azure:
    state: absent
    name: ansible
    refresh_token: "{{ xxxxxxxxxxxxxxx }}"
    location: westus
    subnet_id: subnet-xxxxxxx
    vnet_id: vnetxxxxxxxx
    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 AZURE CVO working_environment_id.



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_cvo_azure_module.html