Skip to main content

Creating a private network with Gateway

Stephanie R.
Updated

Learn how to create a private network with a Gateway via the OVHcloud Control Panel, OVHcloud API, OVHcloud CLI, OpenStack API, or Terraform.

A Gateway offers a secure outbound connection method from your private network instances or the ability to use Floating IPs with your instance or Load Balancer for service exposition.

 

Requirements

OVHcloud Control Panel Access

 

Instructions

Gateway models

Before creating a Gateway, choose the model suited to your bandwidth needs:

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 private network with a Gateway

Step 1 — Access the creation page

Click on Gateway in the left-hand menu under Network.

You must have an active vRack before proceeding. If you do not have a vRack, please consult this section of the relevant guide.

Next, click Create a Gateway.

PCI_createGateway.png

Step 2 — Select the region and size

Select the region where your private instances are located.

PCI_createGateway_selectLocation.png

Then select your gateway size (see the models table above).

PCI_createGateway_selectSize.png

Step 3 — Name the Gateway and attach a private network

Edit the default name of your Gateway and select an existing private network from the drop-down list.

Only single-region private networks are supported by Gateway.

PCI_createGateway_attachExistingNetwork.png

You can also click Add a private network to create a new private network inline.

In the pop-up window, enter a name for your private network, select a subnet, and click Add.

PCI_createGateway_attachNewNetwork.png

Step 4 — Confirm creation

Click Create a gateway to start the deployment.

PCI_createGateway_attachExistingNetwork.png

The creation may take several minutes. Refresh the page if necessary.

Once done, the private network is visible in the Private Network section.

NOTE: You can cancel a Private Network by clicking the trash 🗑️ icon to the right of the network.

PCI_listPrivateNetworks.png

The Gateway appears in the Gateway section.

NOTE: You can cancel a Gateway by clicking the more options ... button and selecting Delete.

PCI_listGateways.png

Step 1 — Retrieve the project ID

Log in to the OVHcloud APIv6 interface according to the relevant guide (First steps with the OVHcloud API).

In case the project ID is unknown, the calls below allow you to retrieve it.

To retrieve a list of projects:

GET /cloud/project

To identify the project via the "description" field:

GET /cloud/project/{serviceName}

Step 2 — Create the private network with a Gateway

Create your private network and gateway:

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

Fill in the fields according to the following table.

Field Description
serviceName 'The ID of your project'
regionName Example: US-VA-EAST-1
model size of your gateway (s, m, l, xl, 2xl) depending on your needs
name set a name for your gateway, you can click on the dropdown arrow and select "null" for a default one
network.name set a name for your private network, you can click on the dropdown arrow and select "null" for a default one
cidr IP block for your subnet
enableDhcp check the box for yes
ipVersion 4
vlanId Value between 2 and 4000, or empty for automatic assignment

Repeat for each region where your private instances are present.

To verify the details of your Gateway:

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

Leave subnetId blank to list all Gateways in the specified region.

Use the OVHcloud CLI to create a private network with a Gateway. Set your cloud project with --cloud-project <project_id> or configure it in your profile.

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

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

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

Only single-region private networks are supported by Gateway.

Before proceeding, it is recommended that you consult these guides:

Step 1 — Create a network and subnet

openstack network create my_network
 
openstack subnet create my_subnet --subnet-range <my_private_ip_range/mask> --network my_network --no-dhcp

Step 2 — List quality of service policies

openstack network qos policy list
+--------------------------------------+---------------+--------+---------+----------------------------------+
| ID                                   | Name          | Shared | Default | Project                          |
+--------------------------------------+---------------+--------+---------+----------------------------------+
| a5524eb5-944e-4106-b209-9478bbdcedab | large_router  | True   | False   | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| c210f5b2-db59-4973-a25f-9131195b6bcf | medium_router | True   | False   | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| ec0ee74d-a1f3-43f6-87aa-b0e69ef8ce45 | small_router  | True   | False   | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
+--------------------------------------+---------------+--------+---------+----------------------------------+

Step 3 — Create the router and configure the Gateway

openstack router create my_router 
 
openstack router add subnet my_router my_subnet
 
openstack router set --external-gateway Ext-Net --qos-policy QOS_ID_OF_YOUR_CHOICE my_router

If you omit the --qos-policy parameter the "small" quality of service will be applied.

Before proceeding, consult our How to Use Terraform guide.

Create a Terraform file (e.g., private_network_gateway.tf) with the following information:

# Create a Private Network
resource "ovh_cloud_project_network_private" "mypriv" {
  service_name  = "my_service_name"  # Replace with your OVHcloud project ID
  vlan_id       = "0"             # VLAN ID (usually 0)
  name          = "mypriv"
  regions       = ["US-EAST-VA-1"]
}
# Create a private subnet
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        = "US-EAST-VA-1"
  start         = "10.0.0.2"
  end           = "10.0.255.254"
  network       = "10.0.0.0/16"
  dhcp          = true
}
# Create a custom gateway
resource "ovh_cloud_project_gateway" "gateway" {
  service_name = ovh_cloud_project_network_private.mypriv.service_name
  name         = "my-gateway"
  model        = "s"  # Gateway model ("s" for small, "m" for medium, etc.)
  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
}

You can create your resources by entering the following command:

terraform apply

 

Go further

For more information and tutorials, please see our other Public Cloud support guides or explore the guides for other OVHcloud products and services.

Related articles