google.cloud.gcp_compute_instance_group_manager_info module – Gather info for GCP InstanceGroupManager
Note
This module is part of the google.cloud collection (version 1.4.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 google.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: google.cloud.gcp_compute_instance_group_manager_info
.
Synopsis
Gather info for GCP InstanceGroupManager
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 |
---|---|
An OAuth2 access token if credential type is accesstoken. |
|
The type of credential used. Choices:
|
|
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. |
|
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) . |
|
The Google Cloud Platform project to use. |
|
Array of scopes to be used |
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. |
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email. |
|
The path of a Service Account JSON file if serviceaccount is selected as type. |
|
The zone the managed 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 access_token using the
GCP_ACCESS_TOKEN
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 manager
gcp_compute_instance_group_manager_info:
zone: us-west1-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 |
---|---|
List of resources Returned: always |
|
The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. Returned: success |
|
The creation timestamp for this managed instance group in RFC3339 text format. Returned: success |
|
The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. Returned: success |
|
The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. Returned: success |
|
The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. Returned: success |
|
The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group’s targetSize value accordingly. Returned: success |
|
The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. Returned: success |
|
The number of instances in the managed instance group that are running and have no scheduled actions. Returned: success |
|
The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. Returned: success |
|
The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. Returned: success |
|
The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. Returned: success |
|
An optional description of this resource. Provide this property when you create the resource. Returned: success |
|
A unique identifier for this resource. Returned: success |
|
The instance group being managed. Returned: success |
|
The instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. Returned: success |
|
The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. Returned: success |
|
Named ports configured for the Instance Groups complementary to this Instance Group Manager. Returned: success |
|
The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. Returned: success |
|
The port number, which can be a value between 1 and 65535. Returned: success |
|
The region this managed instance group resides (for regional resources). Returned: success |
|
TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. Returned: success |
|
The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. Returned: success |
|
The zone the managed instance group resides. Returned: success |