New in version 2.6.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_kind
string
/ required
|
|
The type of credential used.
|
description
-
added in 2.7 |
An optional description of this resource. Provide this property when you create the resource.
|
|
dest_range
-
/ required
|
The destination range of outgoing packets that this route applies to.
Only IPv4 is supported.
|
|
name
-
/ required
|
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.
|
|
network
-
/ required
|
The network that this route applies to.
This field represents a link to a Network resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_network task and then set this network field to "{{ name-of-resource }}"
|
|
next_hop_gateway
-
|
URL to a gateway that should handle matching packets.
Currently, you can only specify the internet gateway, using a full or partial valid URL: * https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway .
|
|
next_hop_instance
-
|
URL to an instance that should handle matching packets.
You can specify this as a full or partial URL. For example: * https://www.googleapis.com/compute/v1/projects/project/zones/zone/ instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance .
This field represents a link to a Instance resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_instance task and then set this next_hop_instance field to "{{ name-of-resource }}"
|
|
next_hop_ip
-
|
Network IP address of an instance that should handle matching packets.
|
|
next_hop_vpn_tunnel
-
|
URL to a VpnTunnel that should handle matching packets.
This field represents a link to a VpnTunnel resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_vpn_tunnel task and then set this next_hop_vpn_tunnel field to "{{ name-of-resource }}"
|
|
priority
-
|
The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length.
In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins.
Default value is 1000. Valid range is 0 through 65535.
|
|
project
string
|
The Google Cloud Platform project to use.
|
|
scopes
list
|
Array of scopes to be used.
|
|
service_account_contents
string
|
A string representing the contents of a Service Account JSON file.
This should not be passed in as a dictionary, but a string that has the exact contents of a service account json file (valid JSON)
|
|
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.
|
|
state
-
|
|
Whether the given object should exist in GCP
|
tags
-
|
A list of instance tags to which this route applies.
|
Note
GCP_SERVICE_ACCOUNT_FILE
env variable.GCP_SERVICE_ACCOUNT_EMAIL
env variable.GCP_SERVICE_ACCOUNT_CONTENTS
env variable.GCP_AUTH_KIND
env variable.GCP_SCOPES
env variable.- name: create a network
gcp_compute_network:
name: network-route
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: network
- name: create a route
gcp_compute_route:
name: test_object
dest_range: 192.168.6.0/24
next_hop_gateway: global/gateways/default-internet-gateway
network: "{{ network }}"
tags:
- backends
- databases
project: test_project
auth_kind: serviceaccount
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 |
---|---|---|
description
string
|
success |
An optional description of this resource. Provide this property when you create the resource.
|
destRange
string
|
success |
The destination range of outgoing packets that this route applies to.
Only IPv4 is supported.
|
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.
|
network
dictionary
|
success |
The network that this route applies to.
|
nextHopGateway
string
|
success |
URL to a gateway that should handle matching packets.
Currently, you can only specify the internet gateway, using a full or partial valid URL: * https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway .
|
nextHopInstance
dictionary
|
success |
URL to an instance that should handle matching packets.
You can specify this as a full or partial URL. For example: * https://www.googleapis.com/compute/v1/projects/project/zones/zone/ instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance .
|
nextHopIp
string
|
success |
Network IP address of an instance that should handle matching packets.
|
nextHopNetwork
string
|
success |
URL to a Network that should handle matching packets.
|
nextHopVpnTunnel
dictionary
|
success |
URL to a VpnTunnel that should handle matching packets.
|
priority
integer
|
success |
The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length.
In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins.
Default value is 1000. Valid range is 0 through 65535.
|
tags
list
|
success |
A list of instance tags to which this route applies.
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.