netapp.cloudmanager.na_cloudmanager_cvo_gcp module – NetApp Cloud Manager CVO for GCP
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_cvo_gcp.
New in netapp.cloudmanager 21.4.0
Synopsis
Create, delete, or manage Cloud Manager CVO for GCP.
Parameters
Parameter |
Comments |
|---|---|
Automatically backup all volumes to cloud. Choices:
|
|
Capacity package name is required when selecting a capacity based license. Choices:
|
|
Whether to enable data tiering for the first data aggregate. Choices:
|
|
The connector ID of the Cloud Manager Connector. You can find the ID from the Connector tab on https://cloudmanager.netapp.com. |
|
Type of encryption to use for this working environment. Choices:
|
|
Enable the Cloud Compliance service on the working environment. 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. |
|
Firewall name for a single node cluster. |
|
The GCP encryption parameters. |
|
Optionally provide up to four key-value pairs with which to all GCP entities created by Cloud Manager. |
|
The key of the label. |
|
The label value. |
|
The gcp_service_account email in order to enable tiering of cold data to Google Cloud Storage. |
|
GCP volume size. |
|
GCP volume size unit. Choices:
|
|
GCP volume type. Choices:
|
|
The type of instance to use, which depends on the license type you choose. Explore [‘custom-4-16384’]. Standard [‘n1-standard-8’]. Premium [‘n1-standard-32’]. BYOL all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. Default: |
|
Indicate whether the working environment is an HA pair or not. Choices:
|
|
The type of license to use. For single node by Capacity [‘capacity-paygo’]. For single node by Node paygo [‘gcp-cot-explore-paygo’, ‘gcp-cot-standard-paygo’, ‘gcp-cot-premium-paygo’]. For single node by Node byol [‘gcp-cot-premium-byol’]. For HA by Capacity [‘ha-capacity-paygo’]. For HA by Node paygo [‘gcp-ha-cot-explore-paygo’, ‘gcp-ha-cot-standard-paygo’, ‘gcp-ha-cot-premium-paygo’]. For HA by Node byol [‘gcp-cot-premium-byol’]. Choices:
|
|
The zone for mediator. Option for HA pair only. |
|
The name of the Cloud Manager CVO for GCP to manage. |
|
The project id in GCP associated with the Subnet. If not provided, it is assumed that the Subnet is within the previously specified project id. |
|
Zone for node 1. Option for HA pair only. |
|
Zone for node 2. Option for HA pair only. |
|
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. |
|
The required ONTAP version. Ignored if ‘use_latest_version’ is set to true. Default: |
|
The serial number for the system. Required when using ‘gcp-cot-premium-byol’. |
|
For HA BYOL, the serial number for the first node. Option for HA pair only. |
|
For HA BYOL, the serial number for the second node. Option for HA pair only. |
|
The ID of the GCP project. |
|
Using a NLF license file for BYOL deployment |
|
The refresh token for NetApp Cloud Manager API operations. |
|
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 CVO for GCP should exist or not. Choices:
|
|
Subnet path for nic1, required for node and data connectivity. If using shared VPC, network_project_id must be provided. Option for HA pair only. |
|
Subnet path for nic2, required for cluster connectivity. Option for HA pair only. |
|
Subnet path for nic3, required for HA connectivity. Option for HA pair only. |
|
Subnet path for nic4, required for HA connectivity. Option for HA pair only. |
|
The name of the subnet for Cloud Volumes ONTAP. |
|
Subnet path for a single node cluster. |
|
The name of the SVM. |
|
The admin password for Cloud Volumes ONTAP. It will be updated on each run. |
|
The tiering level when ‘capacity_tier’ is set to ‘cloudStorage’. Choices:
|
|
Indicates whether to update svm_password on the CVO. When set to true, the module is not idempotent, as we cannot read the current password. Choices:
|
|
Indicates whether to upgrade ONTAP image on the CVO. If the current version already matches the desired version, no action is taken. Choices:
|
|
Indicates whether to use the latest available ONTAP version. Choices:
|
|
Firewall rule name for vpc1. Option for HA pair only. |
|
VPC path for nic1, required for node and data connectivity. If using shared VPC, network_project_id must be provided. Option for HA pair only. |
|
VPC path for nic2, required for cluster connectivity. Option for HA pair only. |
|
Firewall rule name for vpc2. Option for HA pair only. |
|
Firewall rule name for vpc3. Option for HA pair only. |
|
VPC path for nic3, required for HA connectivity. Option for HA pair only. |
|
VPC path for nic4, required for data replication. Option for HA pair only. |
|
Firewall rule name for vpc4. Option for HA pair only. |
|
The name of the VPC. |
|
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]. |
|
The write speed setting for Cloud Volumes ONTAP [‘NORMAL’,’HIGH’]. Default value is ‘NORMAL’ for non-HA GCP CVO This argument is not relevant for HA pairs. |
|
The zone of the region where the working environment will be created. |
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 GCP
netapp.cloudmanager.na_cloudmanager_cvo_gcp:
state: present
name: ansiblecvogcp
project_id: default-project
zone: us-east4-b
subnet_path: projects/<project>/regions/<region>/subnetworks/<subnetwork>
subnet_id: projects/<project>/regions/<region>/subnetworks/<subnetwork>
gcp_volume_type: pd-ssd
gcp_volume_size: 500
gcp_volume_size_unit: GB
gcp_service_account: "{{ xxxxxxxxxxxxxxx }}"
data_encryption_type: GCP
svm_password: "{{ xxxxxxxxxxxxxxx }}"
ontap_version: latest
use_latest_version: true
license_type: capacity-paygo
instance_type: n1-standard-8
client_id: "{{ xxxxxxxxxxxxxxx }}"
workspace_id: "{{ xxxxxxxxxxxxxxx }}"
capacity_tier: cloudStorage
writing_speed_state: NORMAL
refresh_token: "{{ xxxxxxxxxxxxxxx }}"
vpc_id: default
gcp_labels:
- label_key: key1
label_value: value1
- label_key: key2
label_value: value2
- name: Create NetApp Cloud Manager cvo ha for GCP
netapp.cloudmanager.na_cloudmanager_cvo_gcp:
state: present
name: ansiblecvogcpha
project_id: "default-project"
zone: us-east1-b
gcp_volume_type: pd-ssd
gcp_volume_size: 500
gcp_volume_size_unit: GB
gcp_service_account: "{{ xxxxxxxxxxxxxxx }}"
data_encryption_type: GCP
svm_password: "{{ xxxxxxxxxxxxxxx }}"
ontap_version: ONTAP-9.9.0.T1.gcpha
use_latest_version: false
license_type: ha-capacity-paygo
instance_type: custom-4-16384
client_id: "{{ xxxxxxxxxxxxxxx }}"
workspace_id: "{{ xxxxxxxxxxxxxxx }}"
capacity_tier: cloudStorage
writing_speed_state: NORMAL
refresh_token: "{{ xxxxxxxxxxxxxxx }}"
is_ha: true
mediator_zone: us-east1-b
node1_zone: us-east1-b
node2_zone: us-east1-b
subnet0_node_and_data_connectivity: default
subnet1_cluster_connectivity: subnet2
subnet2_ha_connectivity: subnet3
subnet3_data_replication: subnet1
vpc0_node_and_data_connectivity: default
vpc1_cluster_connectivity: vpc2
vpc2_ha_connectivity: vpc3
vpc3_data_replication: vpc1
vpc_id: default
subnet_id: default
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Newly created GCP CVO working_environment_id. Returned: success |