New in version 2.6.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
auth_kind
required |
|
The type of credential used.
|
|
description |
An optional description of this resource. Provide this property when you create the resource.
|
||
name |
The name of the instance group.
The name must be 1-63 characters long, and comply with RFC1035.
|
||
named_ports |
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.
|
||
name |
The name for this named port.
The name must be 1-63 characters long, and comply with RFC1035.
|
||
port |
The port number, which can be a value between 1 and 65535.
|
||
network |
The network to which all instances in the instance group belong.
|
||
project |
Default: None
|
The Google Cloud Platform project to use.
|
|
region |
The region where the instance group is located (for regional resources).
|
||
scopes |
Array of scopes to be used.
|
||
service_account_email |
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
|
||
service_account_file |
The path of a Service Account JSON file if serviceaccount is selected as type.
|
||
state |
|
Whether the given object should exist in GCP
|
|
subnetwork |
The subnetwork to which all instances in the instance group belong.
|
||
zone
required |
A reference to the zone where the instance group resides.
|
Note
GCP_SERVICE_ACCOUNT_FILE
env variable.GCP_SERVICE_ACCOUNT_EMAIL
env variable.GCP_AUTH_KIND
env variable.GCP_SCOPES
env variable.- name: create a network
gcp_compute_network:
name: "network-instancegroup"
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: network
- name: create a instance group
gcp_compute_instance_group:
name: "test_object"
named_ports:
- name: ansible
port: 1234
network: "{{ network }}"
zone: us-central1-a
project: "test_project"
auth_kind: "service_account"
service_account_file: "/tmp/auth.pem"
state: present
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
creation_timestamp
str
|
success |
Creation timestamp in RFC3339 text format.
|
|
description
str
|
success |
An optional description of this resource. Provide this property when you create the resource.
|
|
id
int
|
success |
A unique identifier for this instance group.
|
|
name
str
|
success |
The name of the instance group.
The name must be 1-63 characters long, and comply with RFC1035.
|
|
named_ports
complex
|
success |
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.
|
|
name
str
|
success |
The name for this named port.
The name must be 1-63 characters long, and comply with RFC1035.
|
|
port
int
|
success |
The port number, which can be a value between 1 and 65535.
|
|
network
dict
|
success |
The network to which all instances in the instance group belong.
|
|
region
str
|
success |
The region where the instance group is located (for regional resources).
|
|
subnetwork
dict
|
success |
The subnetwork to which all instances in the instance group belong.
|
|
zone
str
|
success |
A reference to the zone where the instance group resides.
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.