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. This field can be set only at resource creation time.
|
|
gateway_address |
The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time.
|
|
ip_cidr_range |
The range of internal addresses that are owned by this subnetwork.
Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported.
|
|
name |
The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
|
|
network |
A reference to Network resource.
|
|
private_ip_google_access |
|
Whether the VMs in this subnet can access Google services without assigned external IP addresses.
|
project |
The Google Cloud Platform project to use.
|
|
region
required |
A reference to Region resource.
|
|
scopes
required |
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
required |
|
Whether the given object should exist in GCP
|
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-subnetwork'
auto_create_subnetworks: true
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
scopes:
- https://www.googleapis.com/auth/compute
state: present
register: network
- name: create a subnetwork
gcp_compute_subnetwork:
name: 'ansiblenet'
region: 'us-west1'
network: "{{ network }}"
ip_cidr_range: '172.16.0.0/16'
project: testProject
auth_kind: service_account
service_account_file: /tmp/auth.pem
scopes:
- https://www.googleapis.com/auth/compute
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. This field can be set only at resource creation time.
|
gateway_address
str
|
success |
The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time.
|
id
int
|
success |
The unique identifier for the resource.
|
ip_cidr_range
str
|
success |
The range of internal addresses that are owned by this subnetwork.
Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported.
|
name
str
|
success |
The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
|
network
dict
|
success |
A reference to Network resource.
|
private_ip_google_access
bool
|
success |
Whether the VMs in this subnet can access Google services without assigned external IP addresses.
|
region
str
|
success |
A reference to Region resource.
|
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.