region_networks

Creates, updates, deletes, gets or lists a region_networks resource.

Overview

Name	region_networks
Type	Resource
Id	ovh.cloud_network.region_networks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Network id
name	string	Network name
vlan_id	integer	Network VLAN id (wire: vlanId)
region	string	Network region
status	string	Network status (ACTIVE, BUILDING, DELETING, ERROR)
subnet_ids	array	Network subnet ids (wire: subnetIds)
visibility	string	Network visibility (private, public)

list

Network

Name	Datatype	Description
id	string	Network id
name	string	Network name
vlan_id	integer	Network VLAN id (wire: vlanId)
region	string	Network region
status	string	Network status (ACTIVE, BUILDING, DELETING, ERROR)
subnet_ids	array	Network subnet ids (wire: subnetIds)
visibility	string	Network visibility (private, public)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	network_id, region_name, service_name		Get network
list	select	region_name, service_name		List networks
create	insert	region_name, service_name, name		Create a network with a gateway
delete	delete	network_id, region_name, service_name		Delete network

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
network_id	string	Network ID (wire: networkId)
region_name	string	Region name (wire: regionName)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples

get

Get network

SELECT
id,
name,
vlan_id,
region,
status,
subnet_ids,
visibility
FROM ovh.cloud_network.region_networks
WHERE network_id = '{{ network_id }}' -- required
AND region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List networks

SELECT
id,
name,
vlan_id,
region,
status,
subnet_ids,
visibility
FROM ovh.cloud_network.region_networks
WHERE region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

Create a network with a gateway

INSERT INTO ovh.cloud_network.region_networks (
gateway,
name,
subnet,
vlan_id,
region_name,
service_name
)
SELECT 
'{{ gateway }}',
'{{ name }}' /* required */,
'{{ subnet }}',
{{ vlan_id }},
'{{ region_name }}',
'{{ service_name }}'
RETURNING
id,
resource_id,
action,
completed_at,
created_at,
progress,
regions,
started_at,
status,
sub_operations
;

Manifest

# Description fields are for documentation purposes
- name: region_networks
props:
  - name: region_name
    value: "{{ region_name }}"
    description: Required parameter for the region_networks resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the region_networks resource.
  - name: gateway
    description: |
      Parameters to create a gateway from another resource creation
    value:
      model: "{{ model }}"
      name: "{{ name }}"
  - name: name
    value: "{{ name }}"
    description: |
      Network name
  - name: subnet
    description: |
      Parameters to create a subnet from another resource creation
    value:
      allocationPools:
        - end: "{{ end }}"
          start: "{{ start }}"
      cidr: "{{ cidr }}"
      dnsNameServers:
        - "{{ dnsNameServers }}"
      enableDhcp: {{ enableDhcp }}
      enableGatewayIp: {{ enableGatewayIp }}
      gatewayIp: "{{ gatewayIp }}"
      hostRoutes:
        - destination: "{{ destination }}"
          nextHop: "{{ nextHop }}"
      ipVersion: {{ ipVersion }}
      name: "{{ name }}"
      useDefaultPublicDNSResolver: {{ useDefaultPublicDNSResolver }}
  - name: vlan_id
    value: {{ vlan_id }}
    description: |
      VLAN id, between 1 and 4095

DELETE examples

delete

Delete network

DELETE FROM ovh.cloud_network.region_networks
WHERE network_id = '{{ network_id }}' --required
AND region_name = '{{ region_name }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;