Enabling Route Propagation

You can enable route propagation to a route table to include the routes associated with a VPN connection.

This action automatically updates the route table with the routes of the VPN connection, and points them to the virtual gateway. Otherwise, you need to manually update the route table with each route. Route propagation is not mandatory, and works for both static and dynamic routing. You can use a default or custom route table. For more information, see About Routing Configuration for VPN Connections.

Enabling Route Propagation Using Cockpit v2

Before you begin:

Create a Net. For more information, see Creating a Net.
Create a virtual gateway. For more information, see Creating a Virtual Gateway.
Link the virtual gateway to the Net. For more information, see Linking a Virtual Gateway.
(optional) Create a custom route table for the Subnet of the Net. For more information, see Creating a Route Table.

In the Route Tables dashboard, check the box of the route table to which you want to enable route propagation.
The route table is selected.
Click Enable Route Propagation.
The ENABLE ROUTE PROPAGATION dialog box appears.
From the Virtual Gateway list, select the virtual gateway from which you want to enable route propagation.
Click Enable.
The route propagation is enabled.

Enabling Route Propagation Using OSC CLI

Before you begin:

Create a Net. For more information, see Creating a Net.
Create a virtual gateway. For more information, see Creating a Virtual Gateway.
Link the virtual gateway to the Net. For more information, see Linking a Virtual Gateway.
(optional) Create a custom route table for the Subnet of the Net. For more information, see Creating a Route Table.

The UpdateRoutePropagation command configures the propagation of routes to a specified route table of a Net by a virtual gateway.

Request sample

$ osc-cli api UpdateRoutePropagation --profile "default" \
    --VirtualGatewayId "vgw-12345678" \
    --RouteTableId "rtb-12345678" \
    --Enable True

This command contains the following attributes that you need to specify:

DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
Enable: If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
RouteTableId: The ID of the route table.
VirtualGatewayId: The ID of the virtual gateway.

The UpdateRoutePropagation command returns the following elements:

ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.
RouteTable: Information about the route table.
- LinkRouteTables: One or more associations between the route table and Subnets.
  - LinkRouteTableId: The ID of the association between the route table and the Net or Subnet.
  - Main: If true, the route table is the main one.
  - NetId: The ID of the Net, if the route table is not explicitly linked to a Subnet.
  - RouteTableId: The ID of the route table.
  - SubnetId: The ID of the Subnet, if the route table is explicitly linked to a Subnet.
- NetId: The ID of the Net for the route table.
- RoutePropagatingVirtualGateways: Information about virtual gateways propagating routes.
  - VirtualGatewayId: The ID of the virtual gateway.
- RouteTableId: The ID of the route table.
- Routes: One or more routes in the route table.
  - CreationMethod: The method used to create the route.
  - DestinationIpRange: The IP range used for the destination match, in CIDR notation (for example, 10.0.0.0/24).
  - DestinationServiceId: The ID of the OUTSCALE service.
  - GatewayId: The ID of the internet service or virtual gateway attached to the Net.
  - NatServiceId: The ID of a NAT service attached to the Net.
  - NetAccessPointId: The ID of the Net access point.
  - NetPeeringId: The ID of the Net peering.
  - NicId: The ID of the NIC.
  - State: The state of a route in the route table (always active).
  - VmAccountId: The account ID of the owner of the VM.
  - VmId: The ID of a VM specified in a route in the table.
- Tags: One or more tags associated with the route table.
  - Key: The key of the tag, with a minimum of 1 character.
  - Value: The value of the tag, between 0 and 255 characters.

Result sample

{
  "RouteTable": {
    "Routes": [
      {
        "DestinationIpRange": "10.0.0.0/16",
        "CreationMethod": "CreateRouteTable",
        "State": "active"
      }
    ],
    "LinkRouteTables": [
      {
        "RouteTableId": "rtb-12345678",
        "Main": true,
        "LinkRouteTableId": "rtbassoc-12345678"
      }
    ],
    "NetId": "vpc-12345678",
    "Tags": [],
    "RoutePropagatingVirtualGateways": [
      {
        "VirtualGatewayId": "vgw-12345678"
      }
    ],
    "RouteTableId": "rtb-12345678"
  },
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Enabling Route Propagation Using oapi-cli

Before you begin:

Create a Net. For more information, see Creating a Net.
Create a virtual gateway. For more information, see Creating a Virtual Gateway.
Link the virtual gateway to the Net. For more information, see Linking a Virtual Gateway.
(optional) Create a custom route table for the Subnet of the Net. For more information, see Creating a Route Table.

The UpdateRoutePropagation command configures the propagation of routes to a specified route table of a Net by a virtual gateway.

Request sample

$ oapi-cli --profile "default" UpdateRoutePropagation \
    --VirtualGatewayId "vgw-12345678" \
    --RouteTableId "rtb-12345678" \
    --Enable True

This command contains the following attributes that you need to specify:

DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
Enable: If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
RouteTableId: The ID of the route table.
VirtualGatewayId: The ID of the virtual gateway.

The UpdateRoutePropagation command returns the following elements:

ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.
RouteTable: Information about the route table.
- LinkRouteTables: One or more associations between the route table and Subnets.
  - LinkRouteTableId: The ID of the association between the route table and the Net or Subnet.
  - Main: If true, the route table is the main one.
  - NetId: The ID of the Net, if the route table is not explicitly linked to a Subnet.
  - RouteTableId: The ID of the route table.
  - SubnetId: The ID of the Subnet, if the route table is explicitly linked to a Subnet.
- NetId: The ID of the Net for the route table.
- RoutePropagatingVirtualGateways: Information about virtual gateways propagating routes.
  - VirtualGatewayId: The ID of the virtual gateway.
- RouteTableId: The ID of the route table.
- Routes: One or more routes in the route table.
  - CreationMethod: The method used to create the route.
  - DestinationIpRange: The IP range used for the destination match, in CIDR notation (for example, 10.0.0.0/24).
  - DestinationServiceId: The ID of the OUTSCALE service.
  - GatewayId: The ID of the internet service or virtual gateway attached to the Net.
  - NatServiceId: The ID of a NAT service attached to the Net.
  - NetAccessPointId: The ID of the Net access point.
  - NetPeeringId: The ID of the Net peering.
  - NicId: The ID of the NIC.
  - State: The state of a route in the route table (always active).
  - VmAccountId: The account ID of the owner of the VM.
  - VmId: The ID of a VM specified in a route in the table.
- Tags: One or more tags associated with the route table.
  - Key: The key of the tag, with a minimum of 1 character.
  - Value: The value of the tag, between 0 and 255 characters.

Result sample

{
  "RouteTable": {
    "Routes": [
      {
        "DestinationIpRange": "10.0.0.0/16",
        "CreationMethod": "CreateRouteTable",
        "State": "active"
      }
    ],
    "LinkRouteTables": [
      {
        "RouteTableId": "rtb-12345678",
        "Main": true,
        "LinkRouteTableId": "rtbassoc-12345678"
      }
    ],
    "NetId": "vpc-12345678",
    "Tags": [],
    "RoutePropagatingVirtualGateways": [
      {
        "VirtualGatewayId": "vgw-12345678"
      }
    ],
    "RouteTableId": "rtb-12345678"
  },
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Enabling Route Propagation Using AWS CLI

Before you begin:

Install and configure AWS CLI. For more information, see Installing and Configuring AWS CLI.
Create a VPC. For more information, see Creating a Net.
Create a virtual private gateway. For more information, see Creating a Virtual Gateway.
Attach the virtual private gateway to the VPC. For more information, see Linking a Virtual Gateway.
(optional) Create a custom route table for the subnet of the VPC. For more information, see Creating a Route Table.

To enable route propagation, use the enable-vgw-route-propagation command following this syntax:

Request sample

$ aws ec2 enable-vgw-route-propagation \
    --profile YOUR_PROFILE \
    --gateway-id vgw-91d73e86 \
    --route-table-id rtb-d1d21759 \
    --endpoint https://fcu.eu-west-2.outscale.com

This command contains the following attributes that you need to specify:

(optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.
gateway-id: The ID of the virtual private gateway from which you want to enable route propagation.
route-table-id: The ID of the route table in which you want to enable route propagation. By default, the main route table in the VPC.
endpoint: The endpoint corresponding to the Region you want to send the request to. For more information, see Installing and Configuring AWS CLI.

Route propagation is enabled from the specified virtual private gateway to the specified route table.

Related Pages

Corresponding API Methods

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.