Modifying a VPN Connection

You can modify the attributes of a VPN connection.

Modifying a VPN Connection Using OSC CLI

The UpdateVpnConnection command modifies the specified attributes of a VPN connection.

Request sample
$ osc-cli api UpdateVpnConnection --profile "default" \
    --VpnConnectionId "vpn-12345678" \
    --VpnOptions '{
        "TunnelInsideIpRange": "169.254.254.22/30",
      }'

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

  • ClientGatewayId: (optional) The ID of the client gateway.

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

  • VirtualGatewayId: (optional) The ID of the virtual gateway.

  • VpnConnectionId: The ID of the VPN connection you want to modify.

  • VpnOptions: (optional) Information about the VPN options.

The UpdateVpnConnection command returns the following elements:

  • ResponseContext: Information about the context of the response.

  • VpnConnection: Information about a VPN connection.

Result sample
{
  "VpnConnection": {
    "VpnOptions": {
      "TunnelInsideIpRange": "169.254.254.22/30"
    },
    "Routes": [],
    "Tags": [],
    "ClientGatewayConfiguration": "...",
    "StaticRoutesOnly": true,
    "VirtualGatewayId": "vgw-12345678",
    "ConnectionType": "ipsec.1",
    "ClientGatewayId": "cgw-12345678",
    "State": "pending",
    "VgwTelemetries": [
      {
        "StateDescription": "IPSEC IS DOWN",
        "AcceptedRouteCount": 0,
        "LastStateChangeDate": "2017-05-10T12:34:56.789Z",
        "OutsideIpAddress": "192.0.2.0"
      }
    ],
    "VpnConnectionId": "vpn-12345678"
  },
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Related Pages

Corresponding API Method

Export to PDF