gcp_compute_route - Creates a GCP Route

New in version 2.6.

Synopsis

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 Choices/Defaults Comments
auth_kind
required
    Choices:
  • machineaccount
  • serviceaccount
  • application
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.
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 .
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.
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 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
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP
tags
A list of instance tags to which this route applies.

Notes

Note

  • API Reference: https://cloud.google.com/compute/docs/reference/rest/v1/routes
  • Using Routes: https://cloud.google.com/vpc/docs/using-routes
  • For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.
  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL 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: 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: "service_account"
      service_account_file: "/tmp/auth.pem"
      state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
description
str
success
An optional description of this resource. Provide this property when you create the resource.

dest_range
str
success
The destination range of outgoing packets that this route applies to.
Only IPv4 is supported.

name
str
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
dict
success
The network that this route applies to.

next_hop_gateway
str
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 .

next_hop_instance
str
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 .

next_hop_ip
str
success
Network IP address of an instance that should handle matching packets.

next_hop_network
str
success
URL to a Network that should handle matching packets.

next_hop_vpn_tunnel
str
success
URL to a VpnTunnel that should handle matching packets.

priority
int
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.



Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.