google.cloud.gcp_compute_router – Creates a GCP Router¶

Note

This plugin is part of the google.cloud collection (version 1.0.2).

To install it use: ansible-galaxy collection install google.cloud.

To use it in a playbook, specify: google.cloud.gcp_compute_router.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Represents a Router resource.

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.
bgp dictionary				BGP information specific to this router.
	advertise_mode string		Default: "DEFAULT"	User-specified flag to indicate which mode to use for advertisement. Some valid choices include: "DEFAULT", "CUSTOM"
	advertised_groups list / elements=string			User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. This enum field has the one valid value: ALL_SUBNETS .
	advertised_ip_ranges list / elements=dictionary			User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.
		description string		User-specified description for the IP range.
		range string / required		The IP range to advertise. The value must be a CIDR-formatted string.
	asn integer / required			Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
description string				An optional description of this resource.
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.
name string / required				Name of 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 dictionary / required				A reference to the network to which this router belongs. 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 }}"
project string				The Google Cloud Platform project to use.
region string / required				Region where the router resides.
scopes list / elements=string				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.
state string			Choices: present ← absent	Whether the given object should exist in GCP

Notes ¶

Note

API Reference: https://cloud.google.com/compute/docs/reference/rest/v1/routers
Google Cloud Router: https://cloud.google.com/router/docs/
for authentication, you can set service_account_file using the gcp_service_account_file env variable.
for authentication, you can set service_account_contents using the 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: create a network
  google.cloud.gcp_compute_network:
    name: network-router
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network

- name: create a router
  google.cloud.gcp_compute_router:
    name: test_object
    network: "{{ network }}"
    bgp:
      asn: 64514
      advertise_mode: CUSTOM
      advertised_groups:
      - ALL_SUBNETS
      advertised_ip_ranges:
      - range: 1.2.3.4
      - range: 6.7.0.0/16
    region: us-central1
    project: test_project
    auth_kind: serviceaccount
    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
bgp complex			success	BGP information specific to this router.
	advertisedGroups list / elements=string		success	User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. This enum field has the one valid value: ALL_SUBNETS .
	advertisedIpRanges complex		success	User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.
		description string	success	User-specified description for the IP range.
		range string	success	The IP range to advertise. The value must be a CIDR-formatted string.
	advertiseMode string		success	User-specified flag to indicate which mode to use for advertisement.
	asn integer		success	Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
creationTimestamp string			success	Creation timestamp in RFC3339 text format.
description string			success	An optional description of this resource.
id integer			success	The unique identifier for the resource.
name string			success	Name of 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 dictionary			success	A reference to the network to which this router belongs.
region string			success	Region where the router resides.

Authors¶

Google Inc. (@googlecloudplatform)

google.cloud.gcp_compute_router – Creates a GCP Router¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶