netapp.cloudmanager.na_cloudmanager_connector_gcp – NetApp Cloud Manager connector for GCP.
Note
This plugin is part of the netapp.cloudmanager collection (version 21.12.1).
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_gcp
.
New in version 21.4.0: of netapp.cloudmanager
Parameters
Parameter |
Comments |
---|---|
The NetApp account ID that the Connector will be associated with. If not provided, Cloud Manager uses the first account. If no account exists, Cloud Manager creates a new account. You can find the account ID in the account tab of Cloud Manager at [https://cloudmanager.netapp.com](https://cloudmanager.netapp.com). |
|
Indicates whether to associate a public IP address to the virtual machine. Choices:
|
|
The client ID of the Cloud Manager Connector. If state is absent, the client id is used to identify the agent and delete it. If state is absent and this parameter is not set, all agents associated with Ignored when state is present. |
|
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. |
|
Indicates whether to add firewall_tags to the connector VM (HTTP and HTTP). Choices:
|
|
The email of the service_account for the connector instance. This service account is used to allow the Connector to create Cloud Volume ONTAP. |
|
The local path of the service_account JSON file for GCP authorization purposes. This service account is used to create the Connector in GCP. |
|
The machine_type for the Connector VM. Default: “n1-standard-4” |
|
The name of the Cloud Manager connector 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. |
|
The GCP project_id where the connector will be created. |
|
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 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 GCP should exist or not. Choices:
|
|
The name of the subnet for the virtual machine. Default: “default” |
|
The GCP zone where the Connector will be created. |
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 GCP
netapp.cloudmanager.na_cloudmanager_connector_gcp:
state: present
name: ansible-occm-gcp
project_id: xxxxxxx-support
zone: us-east4-b
company: NetApp
gcp_service_account_email: [email protected]
gcp_service_account_path: gcp_creds.json
proxy_user_name: test
proxy_password: test
proxy_url: http://abcdefg.com
proxy_certificates: ["D-TRUST_Root_Class_3_CA_2_2009.crt", "DigiCertGlobalRootCA.crt", "DigiCertGlobalRootG2.crt"]
account_id: account-xxxxXXXX
refresh_token: "{{ xxxxxxxxxxxxxxx }}"
- name: Delete NetApp Cloud Manager connector for GCP
netapp.cloudmanager.na_cloudmanager_connector_gcp:
state: absent
name: ansible-occm-gcp
refresh_token: "{{ xxxxxxxxxxxxxxx }}"
client_id: "{{ wwwwwwwwww }}"
project_id: xxxxxxx-support
zone: us-east4-b
company: NetApp
gcp_service_account_email: [email protected]
gcp_service_account_path: gcp_creds.json
account_id: account-xxxxXXXX
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Newly created GCP connector id on cloud manager. Returned: success Sample: “FDQE8SwrbjVS6mqUgZoOHQmu2DvBNRRW” |
|
a list of client ids matching the name and provider if the connector already exists. ideally the list should be empty, or contain a single element matching client_id. Returned: success Sample: [“FDQE8SwrbjVS6mqUgZoOHQmu2DvBNRRW”] |
Authors
NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>