Updating a route in the console

To update a route in the console, 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 appears.
3. Locate the routing table with the routes that you want to update, and click its name in the table.
4. In the Routes section, locate the route that you want to update in the table. Then, click the Actions menu to edit or delete the route. You can change the name, priority, advertise, and route type information.
5. Click Save to save your updates.

Updating a route from the CLI

Before you begin, set up your CLI environment.

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

ibmcloud is vpc-routing-table-route-update VPC ROUTING_TABLE ROUTE --name NEW_NAME [--priority PRIORITY] [--next-hop NEXT_HOP [--vpngw VPNGW]] [--advertise true | false] [--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.

ROUTE

Is the ID or name of the VPC route.

--name

Is the new name of the route.

--priority

Is the route's priority. 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, this value is the IP address or VPN connection ID or name of the next hop to which to route packets.

--advertise

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

--output

Formats the output in JSON.

--q, quiet

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

Updating a route with the API

To update 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. To update a route:

   curl -X PATCH "$vpc_api_endpoint/v1/vpcs/$vpc_id/routing_tables/$routing_table_id/routes/$id?version=2023-11-28&generation=2" \
   -H "Authorization: Bearer $iam_token" \
   -d '{
      "name": "my-vpc-route-updated"
    }'
   

Updating a route with Terraform

To update a route with Terraform, follow these steps:

1. Set up your Terraform environment.

2. Update priority in the existing route resource:

   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"
     priority      = 4
     next_hop      = ibm_is_vpn_gateway_connection.example.gateway_connection // Example value "10.0.0.4"
   }
   

For documentation about the ibm_is_vpc_routing_table_route resource, see the Terraform Registry.