Creating a route

Creating a route in the UI

To create a route in the UI, follow these steps:

1. Make sure to review Limitations and guidelines.

2. From the IBM Cloud console, select the Navigation Menu , then click Infrastructure > Network > Routing tables. The Routing tables for VPC page appear.

3. Select the VPC associated with the routing table that you want to view. Then, click the name of the routing table to show its details.

4. Scroll to the Routes section and click Create.

5. In the Create route side panel, enter the following information:

   • Zone - Select an availability zone for your route.

   • Name - Type a name for the new route.

   • Destination CIDR - The destination CIDR of the route (for example, 10.0.0.0/16).

   • Priority - Enter a priority from 0 to 4. The default value is 2. For more information, see Determining route preference.

   • Action - The action to perform with a packet that matches the route. Values are:

     • Delegate - Routes the packet by using the system routing table.
     • Delegate-VPC - Delegates to the system's built-in routes, ignoring internet-bound routes. Required if the VPC uses non-RFC-1918 addresses and also has public connectivity. See Routing considerations for IANA-registered IP assignments for details.
     • Deliver - Routes the packet to the next hop target. You can add multiple routes with the same address prefix. The virtual router performs equal-cost, multi-path routing (ECMP) by using the different next hop IP addresses.
     • Drop - Drops the packet.

   Traffic egressing a subnet uses the custom routing table that is associated with the subnet. If no matching route is found in a custom routing table, routing continues by using the VPC system routing table. You can avoid this behavior with a custom routing table default route with an action of Drop.

   • Type - Select either IP address or VPN connection.

   • Next hop (IP address) - Enter the next hop.

     You can modify the next hop IP address for existing routes.

   • Advertise - Advertise to an ingress source. Currently, Direct Link and Transit Gateway are supported. Optional.

6. Click Save to save the new route. The route appears on the Routing table details page.

Creating a route from the CLI

Before you begin, set up your CLI environment.

To create a VPC route from the CLI, run the following command:

ibmcloud is vpc-routing-table-route-create VPC ROUTING_TABLE --zone ZONE_NAME --destination DESTINATION_CIDR [--action delegate_vpc | delegate | deliver | drop] [--priority PRIORITY] [--next-hop NEXT_HOP [--vpngw VPNGW]][--advertise true | false] [--name NAME] [--output JSON] [-q, --quiet]

Where:

VPC

Is the ID or name of the VPC.

ROUTING_TABLE

Is the ID or name of the VPC routing table.

--zone

Is the name of the zone.

--destination

Is the destination CIDR of the route. At most, two routes per zone in a table can have the same destination, and only if both routes have an action of deliver.

--action

Is the action to perform with a packet that matches the route. Actions are delegate_vpc, delegate, deliver, and drop.

--priority

Is the route's priority. Values are 0, 1, 2, 3, and 4. The default value is 2. Lesser values have higher priority. If a custom routing table contains routes with the same destination, the route with the highest priority (smallest value) is selected.

--next-hop

If the action is deliver, enter the IP address or VPN connection ID of the next hop to which to route packets.

--vpngw

Is the name of the VPN gateway.

--advertise

Advertise to a direct link, transit gateway, or both ingress sources. One of true, false.

--name

Is the name of the VPC routing table.

--output

Formats the output in JSON.

--q, quiet

Causes the command to run silently and does not generate any output.

Creating a route with the API

To create a destination route with the API, follow these steps:

1. Set up your API environment.

2. Store values for the following variables to be used in the API command:

   export VpcId=<your_vpc_id>
   export RoutingTableId=<your_routing_table_id>
   

3. Create a route:

   curl -X POST "$vpc_api_endpoint/v1/vpcs/$VpcId/routing_tables/$RoutingTableId/routes?version=$api_version&generation=2" \
   -H "Authorization: $iam_token" \
   -d '{
        "name": "my-new-route",
        "zone": {"name": "us-south-2"},
        "action": "deliver",
        "destination": "10.10.10.0/24",
        "next_hop": {"address": "10.0.0.3"}
      }'
   

Creating a route with Terraform

To create a route with Terraform, follow these steps:

1. Set up your Terraform environment.

2. Create a route:

   resource "ibm_is_vpc_routing_table_route" "example" {
     vpc           = ibm_is_vpc.example.id
     routing_table = ibm_is_vpc_routing_table.example.routing_table
     zone          = "us-south-1"
     name          = "custom-route-2"
     destination   = "192.168.4.0/24"
     action        = "deliver"
     next_hop      = ibm_is_vpn_gateway_connection.example.gateway_connection // Example value "10.0.0.4"
   }
   

   For more information about the ibm_is_vpc_routing_table_route resource, see the Terraform Registry.