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.
|
auto_create_subnetworks
boolean
|
|
When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
|
description
-
|
An optional description of this resource. Provide this property when you create the resource.
|
|
gateway_ipv4
-
|
A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
|
|
ipv4_range
-
|
The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
|
|
name
-
|
Name of the resource. Provided by the client when the resource is created. 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.
|
|
project
-
|
Default: None
|
The Google Cloud Platform project to use.
|
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
|
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: "test_object"
auto_create_subnetworks: true
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 |
---|---|---|
auto_create_subnetworks
boolean
|
success |
When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
|
creation_timestamp
string
|
success |
Creation timestamp in RFC3339 text format.
|
description
string
|
success |
An optional description of this resource. Provide this property when you create the resource.
|
gateway_ipv4
string
|
success |
A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
|
id
integer
|
success |
The unique identifier for the resource.
|
ipv4_range
string
|
success |
The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
|
name
string
|
success |
Name of the resource. Provided by the client when the resource is created. 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.
|
subnetworks
list
|
success |
Server-defined fully-qualified URLs for all subnetworks in this network.
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.