google.cloud.gcp_compute_instance_group_info module – Gather info for GCP InstanceGroup

Note

This module is part of the google.cloud collection (version 1.0.2).

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 google.cloud.

To use it in a playbook, specify: google.cloud.gcp_compute_instance_group_info.

Synopsis

  • Gather info for GCP InstanceGroup

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

Parameters

Parameter

Comments

auth_kind

string / required

The type of credential used.

Choices:

  • application

  • machineaccount

  • serviceaccount

env_type

string

Specifies which Ansible environment you’re running this module within.

This should not be set unless you know what you’re doing.

This only alters the User Agent string for any API requests.

filters

list / elements=string

A list of filter value pairs. Available filters are listed here https://cloud.google.com/sdk/gcloud/reference/topic/filters.

Each additional filter in the list will act be added as an AND condition (filter1 and filter2) .

project

string

The Google Cloud Platform project to use.

scopes

list / elements=string

Array of scopes to be used

service_account_contents

jsonarg

The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.

service_account_email

string

An optional service account email address if machineaccount is selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount is selected as type.

zone

string / required

A reference to the zone where the instance group resides.

Notes

Note

  • for authentication, you can set service_account_file using the gcp_service_account_file env variable.

  • for authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.

  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.

  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.

  • For authentication, you can set scopes using the GCP_SCOPES env variable.

  • Environment variables values will only be used if the playbook values are not set.

  • The service_account_email and service_account_file options are mutually exclusive.

Examples

- name: get info on an instance group
  gcp_compute_instance_group_info:
    zone: us-central1-a
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

resources

complex

List of resources

Returned: always

creationTimestamp

string

Creation timestamp in RFC3339 text format.

Returned: success

description

string

An optional description of this resource. Provide this property when you create the resource.

Returned: success

id

integer

A unique identifier for this instance group.

Returned: success

instances

list / elements=string

The list of instances associated with this InstanceGroup.

All instances must be created before being added to an InstanceGroup.

All instances not in this list will be removed from the InstanceGroup and will not be deleted.

Only the full identifier of the instance will be returned.

Returned: success

name

string

The name of the instance group.

The name must be 1-63 characters long, and comply with RFC1035.

Returned: success

namedPorts

complex

Assigns a name to a port number.

For example: {name: “http”, port: 80}.

This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports.

For example: [{name: “http”, port: 80},{name: “http”, port: 8080}] Named ports apply to all instances in this instance group.

Returned: success

name

string

The name for this named port.

The name must be 1-63 characters long, and comply with RFC1035.

Returned: success

port

integer

The port number, which can be a value between 1 and 65535.

Returned: success

network

dictionary

The network to which all instances in the instance group belong.

Returned: success

region

string

The region where the instance group is located (for regional resources).

Returned: success

subnetwork

dictionary

The subnetwork to which all instances in the instance group belong.

Returned: success

zone

string

A reference to the zone where the instance group resides.

Returned: success

Authors

  • Google Inc. (@googlecloudplatform)