--- title: "Creating a private network with Gateway" description: "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" url: https://docs.us.ovhcloud.com/en/public-cloud/network-services/create-private-network-gateway lang: en --- > For AI agents: the complete documentation index is available at https://docs.us.ovhcloud.com/en/llms.txt, the full documentation bundle is available at https://docs.us.ovhcloud.com/en/llms-full.txt. # Creating a private network with Gateway A [Gateway](https://us.ovhcloud.com/public-cloud/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 - A [Public Cloud project](https://us.ovhcloud.com/public-cloud/) in your OVHcloud account - **For the OVHcloud API:** API credentials ([First steps with the OVHcloud API](https://docs.us.ovhcloud.com/en/manage-and-operate/api/first-steps.md)) - **For the OVHcloud CLI:** the [OVHcloud CLI ](https://github.com/ovh/ovhcloud-cli)installed and configured with your credentials - **For the OpenStack API:** an OpenStack environment configured ([Preparing an environment](https://docs.us.ovhcloud.com/en/public-cloud/cross-functional/compute-prepare-openstack-api-environment.md)) - **For Terraform:** Terraform installed and the OVHcloud provider configured ([How to use Terraform](https://docs.us.ovhcloud.com/en/public-cloud/cross-functional/how-to-use-terraform.md)) *** ### OVHcloud Control Panel Access - **Direct link:** [Public Cloud Projects](https://manager.us.ovhcloud.com/#/public-cloud/pci/projects) - **Navigation path:** `Public Cloud` > Select your project ***   ## 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 #### OVHcloud Control Panel **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](https://docs.us.ovhcloud.com/en/public-cloud/network-services/configure-vrack.md#step-1-activating-and-managing-a-vrack) of the relevant guide. Next, click `Create a Gateway`. **Step 2 — Select the region and size** Select the region where your private instances are located. Then select your gateway size (see the models table above). **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. **Note:** Only single-region private networks are supported by Gateway. 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`. **Step 4 — Confirm creation** Click `Create a gateway` to start the deployment. The creation may take several minutes. Refresh the page if necessary. Once done, the private network is visible in the `Private Network` section. **Warning:** **NOTE:** You can cancel a Private Network by clicking the _trash_ `🗑️` icon to the right of the network. The Gateway appears in the `Gateway` section. **Warning:** **NOTE:** You can cancel a Gateway by clicking the _more options_ `...` button and selecting `Delete`. #### OVHcloud API **Step 1 — Retrieve the project ID** Log in to the OVHcloud APIv6 interface according to the relevant guide ([First steps with the OVHcloud API](https://docs.us.ovhcloud.com/en/manage-and-operate/api/first-steps.md)). In case the project ID is unknown, the calls below allow you to retrieve it. To retrieve a list of projects: [GET /cloud/project](https://api.us.ovhcloud.com/console/?section=/cloud/project&branch=v1#get-/cloud/project) To identify the project via the "description" field: [GET /cloud/project/{serviceName}](https://api.us.ovhcloud.com/console/?section=/cloud/project&branch=v1#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](https://api.us.ovhcloud.com/console/?section=/cloud/project&branch=v1#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 | **Note:** Repeat for each region where your private instances are present. To verify the details of your Gateway: [GET /cloud/project/{serviceName}/region/{regionName}/gateway](https://api.us.ovhcloud.com/console/?section=/cloud/project&branch=v1#get-/cloud/project/-serviceName-/region/-regionName-/gateway) Leave `subnetId` blank to list all Gateways in the specified region. #### OVHcloud CLI Use the OVHcloud CLI to create a private network with a Gateway. Set your cloud project with `--cloud-project ` or configure it in your profile. **Create a Gateway with a new private network:** ```bash ovhcloud cloud network gateway create \ --cloud-project \ --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:** ```bash ovhcloud cloud network gateway create \ --cloud-project \ --name my-gateway \ --model s \ --network-id \ --subnet-id \ --wait ``` Available models: `s`, `m`, `l`, `xl`, `2xl`, `3xl`. **Note:** Only single-region private networks are supported by Gateway. #### OpenStack API Before proceeding, it is recommended that you consult these guides: - [Preparing an environment to use the OpenStack API](https://docs.us.ovhcloud.com/en/public-cloud/cross-functional/compute-prepare-openstack-api-environment.md) - [Setting OpenStack environment variables](https://docs.us.ovhcloud.com/en/public-cloud/cross-functional/compute-set-openstack-environment-variables.md) **Step 1 — Create a network and subnet** ``` openstack network create my_network openstack subnet create my_subnet --subnet-range --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. #### Terraform Before proceeding, consult our [How to Use Terraform](https://docs.us.ovhcloud.com/en/public-cloud/cross-functional/how-to-use-terraform.md) guide. Create a Terraform file (e.g., `private_network_gateway.tf`) with the following information: ```python # 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 Browse all the [Networking guides](https://docs.us.ovhcloud.com/en/public-cloud/network-services/landing-page-network-services.md). Browse the rest of the [OVHcloud US documentation](https://docs.us.ovhcloud.com/en/index.md) for guides on our other products and services. Learn more about [Public Cloud Network](https://us.ovhcloud.com/public-cloud/network/) on the OVHcloud US website.