gcp_compute_route_info – Gather info for GCP Route

New in version 2.7.

Synopsis

  • Gather info for GCP Route

  • This module was called gcp_compute_route_facts before Ansible 2.9. The usage has not changed.

Aliases: gcp_compute_route_facts

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
string / required
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
env_type
string
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
filters
list
A list of filter value pairs. Available filters are listed here https://cloud.google.com/sdk/gcloud/reference/topic/filters.
Each additional filter in the list will act be added as an AND condition (filter1 and filter2) .
project
string
The Google Cloud Platform project to use.
scopes
list
Array of scopes to be used.
service_account_contents
jsonarg
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
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.

Notes

Note

  • for authentication, you can set service_account_file using the c(gcp_service_account_file) env variable.

  • for authentication, you can set service_account_contents using the c(GCP_SERVICE_ACCOUNT_CONTENTS) 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: get info on a route
  gcp_compute_route_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Return Values

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

Key Returned Description
resources
complex
always
List of resources
 
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.


Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

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