Configuration

Before enabling Gate, ensure that you have completed the following:

Then, enable Gate for your VPG:

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

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

  3. Click the Advanced settings tab.

  4. Enable Gate by switching the option to ON.

    Missing

  5. Click the Save button at the bottom of the panel.

Programmatic Usage

Soracom API

Enable Gate by using the openGate API method:

curl -X POST \
>  https://g.api.soracom.io/v1/virtual_private_gateways/<VPG-ID>/gate/open

Once enabled, the API will return a response indicating the status of the VPG:

{
  "operatorId": "OP0012345678",
  "vpgId": "abcdef00-0000-0000-0000-000012345678",
  "type": 12,
  "status": "running",
  "useInternetGateway": true,
  "tags": {
    "name": "my-vpg"
  },
  "createdTime": 1467007824685,
  "lastModifiedTime": 1467012076035,
  "primaryServiceName": "Gate",
  "vpcPeeringConnections": null,
  "virtualInterfaces": null,
  "gateOpened": true
}

You can disable gate similarly by using the closeGate API.

Soracom CLI

Enable Gate by using the open-gate command:

soracom vpg open-gate --vpg-id "<VPG-ID>" --coverage-type g

The CLI will return a similar response indicating the VPG status.

You can disable Gate using the close-gate command.