Routers

For a list of methods for this resource, see the end of this page.

Resource representations

Router resource.

{
  "kind": "compute#router",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "region": string,
  "network": string,
  "interfaces": [
    {
      "name": string,
      "linkedVpnTunnel": string,
      "linkedInterconnectAttachment": string,
      "ipRange": string
    }
  ],
  "bgpPeers": [
    {
      "name": string,
      "interfaceName": string,
      "ipAddress": string,
      "peerIpAddress": string,
      "peerAsn": unsigned integer,
      "advertisedRoutePriority": unsigned integer
    }
  ],
  "bgp": {
    "asn": unsigned integer
  },
  "selfLink": string
}
Property name Value Description Notes
bgp nested object BGP information specific to this router.
bgp.asn unsigned integer 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.
bgpPeers[] list BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
bgpPeers[].advertisedRoutePriority unsigned integer The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
bgpPeers[].interfaceName string Name of the interface the BGP peer is associated with.
bgpPeers[].ipAddress string IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
bgpPeers[].name string Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
bgpPeers[].peerAsn unsigned integer Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
bgpPeers[].peerIpAddress string IP address of the BGP interface outside Google cloud. Only IPv4 is supported.
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
description string An optional description of this resource. Provide this property when you create the resource.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
interfaces[] list Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
interfaces[].ipRange string IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
interfaces[].linkedInterconnectAttachment string URI of the linked interconnect attachment. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment.
interfaces[].linkedVpnTunnel string URI of the linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment.
interfaces[].name string Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
kind string [Output Only] Type of resource. Always compute#router for routers.
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.
network string URI of the network to which this router belongs.
region string [Output Only] URI of the region where the router resides.

Methods

aggregatedList
Retrieves an aggregated list of routers.
delete
Deletes the specified Router resource.
get
Returns the specified Router resource. Get a list of available routers by making a list() request.
getRouterStatus
Retrieves runtime information of the specified router.
insert
Creates a Router resource in the specified project and region using the data included in the request.
list
Retrieves a list of Router resources available to the specified project.
patch
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.
preview
Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.
update
Updates the specified Router resource with the data included in the request.

Send feedback about...

Compute Engine