Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages

Manual Reference Pages  -  GCLOUD_COMPUTE_ROUTES_CREATE (1)


gcloud compute routes create - create a new route



gcloud compute routes create NAME --destination-range DESTINATION_RANGE [--description DESCRIPTION] [--network NETWORK; default="default"] [--next-hop-address NEXT_HOP_ADDRESS | --next-hop-gateway NEXT_HOP_GATEWAY | --next-hop-instance NEXT_HOP_INSTANCE | --next-hop-vpn-tunnel NEXT_HOP_VPN_TUNNEL] [--next-hop-instance-zone NEXT_HOP_INSTANCE_ZONE] [--next-hop-vpn-tunnel-region NEXT_HOP_VPN_TUNNEL_REGION] [--priority PRIORITY; default="1000"] [--tags TAG,[TAG,...]] [GLOBAL-FLAG ...]


gcloud compute routes create is used to create routes. A route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with virtual machine instances by tag, and the set of routes for a particular VM is called its routing table. For each packet leaving a virtual machine, the system searches that machine’s routing table for a single best matching route.

Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones (see --destination-range). If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by --next-hop-address, --next-hop-instance, --next-hop-vpn-tunnel, or --next-hop-gateway of the winning route. Packets that do not match any route in the sending virtual machine routing table will be dropped.

Exactly one of --next-hop-address, --next-hop-gateway, --next-hop-vpn-tunnel, or --next-hop-instance must be provided with this command.



The name to assign to the route.


--destination-range DESTINATION_RANGE

The destination range of outgoing packets that the route will apply to. To match all traffic, use ‘‘’’.


--description DESCRIPTION

An optional, textual description for the route.

--network NETWORK; default="default"
Specifies the network to which the route will be applied.

--next-hop-address NEXT_HOP_ADDRESS
Specifies the IP address of an instance that should handle matching packets. The instance must have IP forwarding enabled (i.e., include --can-ip-forward when creating the instance using ’gcloud compute instances create’)

--next-hop-gateway NEXT_HOP_GATEWAY
Specifies the gateway that should handle matching packets. Currently, the only acceptable value is default-internet-gateway which is a gateway operated by Google Compute Engine.

--next-hop-instance NEXT_HOP_INSTANCE
Specifies the name of an instance that should handle traffic matching this route. When this flag is specified, the zone of the instance must be specified using --next-hop-instance-zone.

--next-hop-instance-zone NEXT_HOP_INSTANCE_ZONE
The zone of the next hop instance. If not specified, you will be prompted to select a zone.

To avoid prompting when this flag is omitted, you can set the compute/zone property:

$ gcloud config set compute/zone ZONE

A list of zones can be fetched by running:

$ gcloud compute zones list

To unset the property, run:

$ gcloud config unset compute/zone

Alternatively, the zone can be stored in the environment variable CLOUDSDK_COMPUTE_ZONE.

--next-hop-vpn-tunnel NEXT_HOP_VPN_TUNNEL
The target VPN tunnel that will receive forwarded traffic.

--next-hop-vpn-tunnel-region NEXT_HOP_VPN_TUNNEL_REGION
The region of the next hop vpn tunnel. If not specified, you will be prompted to select a region.

To avoid prompting when this flag is omitted, you can set the compute/region property:

$ gcloud config set compute/region REGION

A list of regions can be fetched by running:

$ gcloud compute regions list

To unset the property, run:

$ gcloud config unset compute/region

Alternatively, the region can be stored in the environment variable CLOUDSDK_COMPUTE_REGION.

--priority PRIORITY; default="1000"
Specifies the priority of this route relative to other routes with the same specifity. The lower the value, the higher the priority.

--tags TAG,[TAG,...]
Identifies the set of instances that this route will apply to. If no tags are provided, the route will apply to all instances in the network.


Run $ gcloud help for a description of flags available to all commands.

Search for    or go to Top of page |  Section 1 |  Main Index


Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.