Set the dynamic routing mode

Cloud Router dynamically advertises subnets and propagates learned routes in the region where the router is configured or throughout the entire Virtual Private Cloud (VPC) network.

Whether Cloud Routers in a VPC network are regional or global depends on the VPC network's dynamic routing mode. When creating or editing a VPC network, you can set the dynamic routing mode to be regional or global.

For Cloud Routers to advertise routes to other Cloud Routers and instances in other regions, the VPC network must be set to global dynamic routing mode.

View a VPC network's dynamic routing mode

To view the current dynamic routing mode of a VPC network, follow these steps.

Console

  1. In the Google Cloud console, go to the VPC networks page.

    Go to VPC networks

  2. To view a network's details page, click the network's name.

  3. In the Dynamic routing mode section, the value indicates the type of dynamic routing mode, either Regional or Global.

gcloud

Run the describe command:

gcloud compute networks describe NETWORK_NAME

Replace NETWORK_NAME with the name of the VPC network.

In the output, the routingMode field indicates the dynamic routing mode of the VPC network, either REGIONAL or GLOBAL.

API

Use the networks.get method:

GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/global/networks/NETWORK

Replace the following:

  • PROJECT_ID: the ID of the project that contains the VPC network
  • NETWORK: the name of the VPC network

In the output, the routingMode field indicates the dynamic routing mode of the VPC network, either REGIONAL or GLOBAL.

Change a VPC network's dynamic routing mode

To change the dynamic routing mode of a VPC network, follow these steps.

Console

  1. In the Google Cloud console, go to the VPC networks page.

    Go to VPC networks

  2. To view a network's details page, click the network's name.

  3. To modify the network, click Edit.

  4. In the Dynamic routing mode section, select Regional or Global.

  5. To confirm, click Save.

gcloud

Run the update command:

gcloud compute networks update NETWORK_NAME \
    --bgp-routing-mode=ROUTING_MODE

Replace the following:

  • NETWORK_NAME: the name of the VPC network to modify
  • ROUTING_MODE: the BGP routing mode of your network—specify REGIONAL or GLOBAL; the default is REGIONAL

API

Use the networks.patch method:

PATCH https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/global/networks/NETWORK
{
  "routingConfig": {
    "routingMode": "ROUTING_MODE"
  }
}

Replace the following:

  • PROJECT_ID: the ID of the project that contains the VPC network to modify
  • NETWORK: the name of the VPC network to modify
  • ROUTING_MODE: either REGIONAL or GLOBAL

What's next?

  • To view examples of regional dynamic routing and global dynamic routing, see Dynamic routing mode.
  • To specify the dynamic routing mode when creating a VPC network, see Use VPC networks.