Virtual Private Gateway

Configuration

Creating a VPG

1. Login to the User Console. From the Menu, open the VPG screen.

2. Click the Create VPG button.

   https://console.soracom.io

   

3. Enter a name and configuration settings for the VPG.

   

   • Name (required) - Any name used to identify this VPG.
   • Type (required) - The VPG type to create.
   • Use internet gateway (required) - Enables or disables internet access for Air devices connected to this VPG.
   • Rendezvous Point (required) - The region where the VPG will be located in. This option is only available for Type-F and Type-G VPGs. For Type-C VPGs, the Rendezvous Point will be set to Frankfurt (Germany) and cannot be changed.
   • CIDR Range for device subnet (optional) - The CIDR block of IP addresses assigned to Air devices connected to this VPG. If left blank, a default block of 10.128.0.0/9 will be used. Note: The following CIDR blocks cannot be used: 100.64.0.0/10 or 198.18.0.0/15. For VPGs within Japan coverage, 10.0.0.0/8 also cannot be used.

   Then click Create.

   Once created, the Primary Service, Internet Gateway, and CIDR Range settings cannot be changed.

Once you click the Create button, the VPG will appear in the list of VPGs. Its status will show Creating while it is being configured, a process that will typically take 3–5 minutes. Once the VPG is ready, its status will change to Running.

Configuring VPG Settings

Once a VPG has been set up, it can be configured for use with Soracom Canal, Direct, Door, Gate, and Junction.

VPG Overview Table

The main screen you are presented with when accessing your VPG shows a table of the basic information relating to your VPG follow by the individual settings tabs beneath it.

Basic Settings Tab

VPC Peering Connections

When configuring Soracom Canal with a VPG, this panel is used to add and manage the AWS Peering Connections that bridge the Soracom VPG with your AWS VPC. This panel is only visible for Type-C, Type-F, and Type-G VPGs.

For more information, refer to the Soracom Canal documentation.

Groups

You can view and manage the Soracom Air for Cellular groups that are attached to the VPG from this panel.

Packet Capture Sessions Tab

You can create, view, and download Soracom Peek packet capture sessions from this tab. This tab is only visible for Type-E, Type-F, and Type-G VPGs.

For more information, refer to the Soracom Peek documentation.

Junction Settings Tab

SORACOM Junction: Inspection

This panel is used to configure the destination of Soracom Junction Inspection mode.

For more information, refer to the Soracom Junction: Inspection documentation.

SORACOM Junction: Mirroring

This panel is used to configure the destination of Soracom Junction Mirroring mode.

For more information, refer to the Soracom Junction: Mirroring documentation.

SORACOM Junction: Redirection

This panel is used to configure the destination of Soracom Junction Redirection mode.

For more information, refer to the Soracom Junction: Redirection documentation.

Tag Settings Tab

You can add tags to a VPG in this tab.

Advanced Settings Tab

Enable Gate

Enable and configure Soracom Gate for the VPG. When configuring Gate for remote device access, additional setup procedure is required. This panel is only visible for Type-C, Type-F, and Type-G VPGs.

For more information, refer to the Soracom Gate documentation.

Gate Peers in your network

When configuring Soracom Gate for remote device access, this panel is used to manage Gate Peers in your private network. This panel is only visible for Type-C, Type-F, and Type-G VPGs.

For more information, refer to the Soracom Gate: Gate Peer Configuration documentation.

Gate Peers in VPG

When a VPG is created, two Gate Peers are automatically configured within the VPG. Their networking configuration is required to configure Soracom Gate for remote device access. This panel is only visible for Type-C, Type-F, and Type-G VPGs.

For more information, refer to the Soracom Gate: Gate Peer Configuration documentation.

IP address map

By default, a VPG will randomly assign IP addresses to Air for Cellular subscribers from the CIDR block of IP addresses. Although the VPG will attempt to maintain the same IP address for each known subscriber whenever possible, you can also manually assign IP addresses to individual subscribers based on the subscriber IMSI number. This panel is used to manage IP address reservations.

Outbound Filter

You can define custom routing rules in order to allow access to certain IP address while blocking access to others.

For more information, refer to the Outbound Filter documentation.

Terminating a VPG

1. Login to the User Console. From the Menu, open the VPG screen.

2. From the list of VPGs, click the VPG you want to terminate to open its settings page.

   https://console.soracom.io

   

3. From the VPG settings page, click the Terminate button.

   https://console.soracom.io

   

Programmatic Usage

You can also use the Soracom API and Soracom CLI to create and manage VPGs.

curl -X POST \
>  -H 'X-Soracom-API-Key: <MY-API-KEY>' \
>  -H 'X-Soracom-Token: <MY-TOKEN>' \
>  -H 'Content-Type: application/json' \
>  -d '{
>        "type": 15,
>        "placement": {
>          "region": "us-west-2"
>        },
>        "deviceSubnetCidrRange": "10.128.0.0/9",
>        "useInternetGateway": true
>      }' \
>  https://g.api.soracom.io/v1/virtual_private_gateways

curl -X POST \
>  -H 'X-Soracom-API-Key: <MY-API-KEY>' \
>  -H 'X-Soracom-Token: <MY-TOKEN>' \
>  -H 'Content-Type: application/json' \
>  -d '{
>        "type": 15,
>        "deviceSubnetCidrRange": "10.128.0.0/9",
>        "useInternetGateway": true
>      }' \
>  https://jp.api.soracom.io/v1/virtual_private_gateways

soracom vpg create --use-internet-gateway 'true' --device-subnet-cidr-range string '10.128.0.0/9' --coverage-type g

soracom vpg create --use-internet-gateway 'true' --device-subnet-cidr-range string '10.128.0.0/9' --coverage-type jp