Getting started with OVHcloud Public Cloud Gateway

Create and manage Public Cloud Gateways using the OVHcloud Console, API, ovhcloud-cli, or Terraform

Objective

An OVHcloud Gateway provides secure outbound connectivity (SNAT) for instances on a private network subnet. It is also required on that subnet to use Floating IPs for public exposure of those private resources.

This guide explains how to create, list, update, and delete a Public Cloud Gateway using the OVHcloud Console, the OVHcloud API, ovhcloud-cli, or Terraform.

Requirements

A Public Cloud project in your OVHcloud account
A private network with at least one subnet in the target region (see Configuring vRack for Public Cloud)
For OVHcloud API: OVHcloud API credentials (First steps with the OVHcloud API)
For ovhcloud-cli: ovhcloud-cli installed and configured with your credentials
For Terraform: Terraform installed and the OVH provider configured (How to use Terraform with OVHcloud)

OVHcloud Console Access

Direct link:
Navigation path: Public Cloud > Select your project > Network > Gateway

Instructions

Gateway models

Before creating a Gateway, choose the model that matches your bandwidth requirements:

Info

Please note that, at this time, size 2XL is not available within the Mumbai, Singapore, and Sydney regions.

Model	Bandwidth
S	up to 200 Mbps
M	up to 500 Mbps
L	up to 2 Gbps
XL	up to 4 Gbps
2XL	up to 8 Gbps

Create a Gateway

OVHcloud Console

OVHcloud API

ovhcloud-cli

Terraform

From your Public Cloud project, click Gateway in the left-hand menu under Network, then click Create a Gateway.

Name the gateway. Enter a Gateway name.
Select a region. In Select a region, choose the region where your private instances are deployed.
Select a size. In Select size, pick the gateway model based on your bandwidth needs (see the table above).
Attach a network. In Attach to a specific private network, select an existing private network, or click Create a private network to create one inline.
Click Create a gateway to confirm. Gateway provisioning takes a few minutes.

Once created, the gateway appears in the Gateway section, and its attached private network is visible under Private Network.

Info

Only single-region private networks are supported by Gateway.

Open the and use the following call to create a gateway together with a new private network and subnet in a single operation:

POST/cloud/project/{serviceName}/region/{regionName}/gateway

Field	Description
`serviceName`	Your Public Cloud project ID
`regionName`	Target region (e.g. `GRA9`)
`model`	Gateway size: `s`, `m`, `l`, `xl`, `2xl`, `3xl`
`name`	Name for your gateway
`network.name`	Name for the new private network
`network.cidr`	Subnet CIDR (e.g. `192.168.1.0/24`)
`network.enableDhcp`	`true` to enable DHCP on the subnet
`network.ipVersion`	`4` (IPv6 not yet supported)
`network.vlanId`	VLAN identifier (2–4000), or leave empty for automatic assignment

The call returns a cloud.Operation object. To attach a gateway to an existing subnet instead, use:

POST/cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet/{subnetId}/gateway

To retrieve your project ID:

GET/cloud/project

Use ovhcloud cloud network gateway create with the target region and the --wait flag to block until provisioning completes.

Create a gateway in an existing private network:

ovhcloud cloud network gateway create <region> \
  --cloud-project <project_id> \
  --name my-gateway \
  --model s \
  --network-id <network_id> \
  --subnet-id <subnet_id> \
  --wait

Create a gateway with a new private network:

ovhcloud cloud network gateway create <region> \
  --cloud-project <project_id> \
  --name my-gateway \
  --model s \
  --network-name my-network \
  --subnet-cidr 192.168.1.0/24 \
  --subnet-enable-dhcp \
  --wait

Available models: s, m, l, xl, 2xl, 3xl.

Create a Terraform configuration file (e.g. gateway.tf) with the following resources:

resource "ovh_cloud_project_network_private" "mypriv" {
  service_name = "<project_id>"
  vlan_id      = "0"
  name         = "my-network"
  regions      = ["GRA9"]
}

resource "ovh_cloud_project_network_private_subnet" "myprivsub" {
  service_name = ovh_cloud_project_network_private.mypriv.service_name
  network_id   = ovh_cloud_project_network_private.mypriv.id
  region       = "GRA9"
  start        = "10.0.0.2"
  end          = "10.0.255.254"
  network      = "10.0.0.0/16"
  dhcp         = true
}

resource "ovh_cloud_project_gateway" "gateway" {
  service_name = ovh_cloud_project_network_private.mypriv.service_name
  name         = "my-gateway"
  model        = "s"
  region       = ovh_cloud_project_network_private_subnet.myprivsub.region
  network_id   = tolist(ovh_cloud_project_network_private.mypriv.regions_attributes[*].openstackid)[0]
  subnet_id    = ovh_cloud_project_network_private_subnet.myprivsub.id
}

Apply the configuration:

terraform init
terraform apply

Info

Replace GRA9 with your target region and <project_id> with your Public Cloud project ID.

List your Gateways

OVHcloud Console

OVHcloud API

ovhcloud-cli

From your Public Cloud project, click Gateway in the left-hand menu under Network.

The page lists all gateways in your project with their region, model, status, and attached network.

GET/cloud/project/{serviceName}/region/{regionName}/gateway

Field	Description
`serviceName`	Your Public Cloud project ID
`regionName`	Target region
`subnetId`	(Optional) Filter by attached subnet ID
`withSubnets`	(Optional) Include subnet details in the response

Update a Gateway

You can update the name or model (size) of an existing gateway.

OVHcloud Console

OVHcloud API

ovhcloud-cli

Terraform

To change the model (size), click the ... menu next to your gateway in the Gateway list, then select Modify size. Select the new size, then click Modify size.

To change the name, click the name of your gateway to open its page, click the Change name icon next to the name, enter the new name, then confirm.

Delete a Gateway

Warning

Deleting a gateway is irreversible. Instances relying on it for outbound connectivity will lose Internet access.

OVHcloud Console

OVHcloud API

ovhcloud-cli

Terraform

From the Gateway list, click the ... menu next to your gateway, then select Delete and confirm.

Go further

For training or technical assistance implementing our solutions, contact your sales representative or visit our Professional Services page to request a quote and have your project analysed by our experts.

Join our community of users.

Was this page helpful?