Skip to content
This repository has been archived by the owner on Feb 24, 2022. It is now read-only.

na_cloudmanager_connector_gcp

Chris Archibald edited this page Apr 8, 2021 · 1 revision
orphan:

netapp.cloudmanager.na_cloudmanager_connector_gcp -- NetApp Cloud Manager connector for GCP.

Note

This plugin is part of the netapp.cloudmanager collection (version 21.4.0).

To install it use: ansible-galaxy collection install netapp.cloudmanager.

To use it in a playbook, specify: netapp.cloudmanager.na_cloudmanager_connector_gcp.

.. versionadded:: 21.4.0 of netapp.cloudmanager

  • Create or delete Cloud Manager connector for GCP.
Parameter Choices/Defaults Comments
account_id
string
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).
associate_public_ip
boolean
    Choices:
  • no
  • yes ←
Indicates whether to associate a public IP address to the virtual machine.
client_id
string / required
The client ID of the Cloud Manager Connector.
company
string / required
The name of the company of the user.
firewall_tags
boolean
    Choices:
  • no
  • yes ←
Indicates whether to add firewall_tags to the connector VM (HTTP and HTTP).
machine_type
string
Default:
"n1-standard-4"
The machine_type for the Connector VM.
name
string / required
The name of the Cloud Manager connector for GCP to manage.
network_project_id
string
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.
project_id
string / required
The GCP project_id where the connector will be created.
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 / required
The refresh token for NetApp Cloud Manager API operations.
service_account_email
string / required
The email of the service_account for the connector instance. This service account is used to allow the Connector to create Cloud Volume ONTAP.
service_account_path
string / required
The local path of the service_account JSON file for GCP authorization purposes. This service account is used to create the Connector in GCP.
state
string
    Choices:
  • present ←
  • absent
Whether the specified Cloud Manager connector for GCP should exist or not.
subnet_id
string
Default:
"default"
The name of the subnet for the virtual machine.
zone
string / required
The GCP zone where the Connector will be created.

Note

  • The modules prefixed with cloudmanager_netapp are built to Manage AWS/GCP/Azure CLOUDMANAGER.
- name: Create NetApp Cloud Manager connector for GCP
  na_cloudmanager_connector_gcp:
    state: present
    name: ansible-occm-gcp
    project_id: xxxxxxx-support
    zone: us-east4-b
    company: NetApp
    service_account_email: [email protected]
    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 }}"
    client_id: "{{ wwwwwwwwww }}"

- name: Delete NetApp Cloud Manager connector for GCP
  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
    service_account_email: [email protected]
    service_account_path: gcp_creds.json
    account_id: account-xxxxXXXX

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

Key Returned Description
client_id
string
success
Newly created GCP connector id on cloud manager.

Sample:
FDQE8SwrbjVS6mqUgZoOHQmu2DvBNRRW


Authors