routers

Creates, updates, deletes, gets or lists a routers resource.

Overview

Name	routers
Type	Resource
Id	google.compute.routers

Fields

Name	Datatype	Description
id	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	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.
description	string	An optional description of this resource. Provide this property when you create the resource.
bgp	object
bgpPeers	array	BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
encryptedInterconnectRouter	boolean	Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).
interfaces	array	Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface.
kind	string	[Output Only] Type of resource. Always compute#router for routers.
md5AuthenticationKeys	array	Keys used for MD5 authentication.
nats	array	A list of NAT services created in this router.
network	string	URI of the network to which this router belongs.
region	string	[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
selfLink	string	[Output Only] Server-defined URL for the resource.

Methods

Name	Accessible by	Required Params	Description
aggregated_list	SELECT	project	Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
get	SELECT	project, region, router	Returns the specified Router resource.
list	SELECT	project, region	Retrieves a list of Router resources available to the specified project.
insert	INSERT	project, region	Creates a Router resource in the specified project and region using the data included in the request.
delete	DELETE	project, region, router	Deletes the specified Router resource.
patch	UPDATE	project, region, router	Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
update	REPLACE	project, region, router	Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.
preview	EXEC	project, region, router	Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

SELECT examples

Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

SELECT
id,
name,
description,
bgp,
bgpPeers,
creationTimestamp,
encryptedInterconnectRouter,
interfaces,
kind,
md5AuthenticationKeys,
nats,
network,
region,
selfLink
FROM google.compute.routers
WHERE project = '{{ project }}';

INSERT example

Use the following StackQL query and manifest file to create a new routers resource.

All Properties

/*+ create */
INSERT INTO google.compute.routers (
project,
region,
name,
description,
region,
network,
interfaces,
bgpPeers,
bgp,
nats,
encryptedInterconnectRouter,
md5AuthenticationKeys
)
SELECT 
'{{ project }}',
'{{ region }}',
'{{ name }}',
'{{ description }}',
'{{ region }}',
'{{ network }}',
'{{ interfaces }}',
'{{ bgpPeers }}',
'{{ bgp }}',
'{{ nats }}',
{{ encryptedInterconnectRouter }},
'{{ md5AuthenticationKeys }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: region
      value: string
    - name: network
      value: string
    - name: interfaces
      value:
        - - name: name
            value: string
          - name: linkedVpnTunnel
            value: string
          - name: linkedInterconnectAttachment
            value: string
          - name: ipRange
            value: string
          - name: managementType
            value: string
          - name: privateIpAddress
            value: string
          - name: redundantInterface
            value: string
          - name: subnetwork
            value: string
          - name: ipVersion
            value: string
    - name: bgpPeers
      value:
        - - name: name
            value: string
          - name: interfaceName
            value: string
          - name: ipAddress
            value: string
          - name: peerIpAddress
            value: string
          - name: peerAsn
            value: integer
          - name: advertisedRoutePriority
            value: integer
          - name: advertiseMode
            value: string
          - name: advertisedGroups
            value:
              - string
          - name: advertisedIpRanges
            value:
              - - name: range
                  value: string
                - name: description
                  value: string
          - name: managementType
            value: string
          - name: enable
            value: string
          - name: bfd
            value:
              - name: sessionInitializationMode
                value: string
              - name: minTransmitInterval
                value: integer
              - name: minReceiveInterval
                value: integer
              - name: multiplier
                value: integer
          - name: routerApplianceInstance
            value: string
          - name: enableIpv6
            value: boolean
          - name: ipv6NexthopAddress
            value: string
          - name: peerIpv6NexthopAddress
            value: string
          - name: md5AuthenticationKeyName
            value: string
          - name: customLearnedRoutePriority
            value: integer
          - name: customLearnedIpRanges
            value:
              - - name: range
                  value: string
          - name: enableIpv4
            value: boolean
          - name: ipv4NexthopAddress
            value: string
          - name: peerIpv4NexthopAddress
            value: string
          - name: exportPolicies
            value:
              - string
          - name: importPolicies
            value:
              - string
    - name: bgp
      value:
        - name: asn
          value: integer
        - name: advertiseMode
          value: string
        - name: advertisedGroups
          value:
            - string
        - name: advertisedIpRanges
          value:
            - - name: range
                value: string
              - name: description
                value: string
        - name: keepaliveInterval
          value: integer
        - name: identifierRange
          value: string
    - name: selfLink
      value: string
    - name: nats
      value:
        - - name: name
            value: string
          - name: type
            value: string
          - name: autoNetworkTier
            value: string
          - name: endpointTypes
            value:
              - string
          - name: sourceSubnetworkIpRangesToNat
            value: string
          - name: subnetworks
            value:
              - - name: name
                  value: string
                - name: sourceIpRangesToNat
                  value:
                    - string
                - name: secondaryIpRangeNames
                  value:
                    - string
          - name: natIps
            value:
              - string
          - name: drainNatIps
            value:
              - string
          - name: natIpAllocateOption
            value: string
          - name: minPortsPerVm
            value: integer
          - name: maxPortsPerVm
            value: integer
          - name: enableDynamicPortAllocation
            value: boolean
          - name: udpIdleTimeoutSec
            value: integer
          - name: icmpIdleTimeoutSec
            value: integer
          - name: tcpEstablishedIdleTimeoutSec
            value: integer
          - name: tcpTransitoryIdleTimeoutSec
            value: integer
          - name: tcpTimeWaitTimeoutSec
            value: integer
          - name: logConfig
            value:
              - name: enable
                value: boolean
              - name: filter
                value: string
          - name: rules
            value:
              - - name: ruleNumber
                  value: integer
                - name: description
                  value: string
                - name: match
                  value: string
                - name: action
                  value:
                    - name: sourceNatActiveIps
                      value:
                        - string
                    - name: sourceNatDrainIps
                      value:
                        - string
                    - name: sourceNatActiveRanges
                      value:
                        - string
                    - name: sourceNatDrainRanges
                      value:
                        - string
          - name: enableEndpointIndependentMapping
            value: boolean
    - name: encryptedInterconnectRouter
      value: boolean
    - name: md5AuthenticationKeys
      value:
        - - name: name
            value: string
          - name: key
            value: string

UPDATE example

Updates a routers resource.

/*+ update */
UPDATE google.compute.routers
SET 
name = '{{ name }}',
description = '{{ description }}',
region = '{{ region }}',
network = '{{ network }}',
interfaces = '{{ interfaces }}',
bgpPeers = '{{ bgpPeers }}',
bgp = '{{ bgp }}',
nats = '{{ nats }}',
encryptedInterconnectRouter = true|false,
md5AuthenticationKeys = '{{ md5AuthenticationKeys }}'
WHERE 
project = '{{ project }}'
AND region = '{{ region }}'
AND router = '{{ router }}';

REPLACE example

Replaces all fields in the specified routers resource.

/*+ update */
REPLACE google.compute.routers
SET 
name = '{{ name }}',
description = '{{ description }}',
region = '{{ region }}',
network = '{{ network }}',
interfaces = '{{ interfaces }}',
bgpPeers = '{{ bgpPeers }}',
bgp = '{{ bgp }}',
nats = '{{ nats }}',
encryptedInterconnectRouter = true|false,
md5AuthenticationKeys = '{{ md5AuthenticationKeys }}'
WHERE 
project = '{{ project }}'
AND region = '{{ region }}'
AND router = '{{ router }}';

DELETE example

Deletes the specified routers resource.

/*+ delete */
DELETE FROM google.compute.routers
WHERE project = '{{ project }}'
AND region = '{{ region }}'
AND router = '{{ router }}';