region_network_subnets

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

Overview

Name	region_network_subnets
Type	Resource
Id	ovh.cloud_network.region_network_subnets

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Subnet id
name	string	Subnet name
allocation_pools	array	List of ip pools allocated in subnet (wire: allocationPools)
cidr	string (ip-block)	Subnet CIDR (example: 192.0.2.0/24)
dhcp_enabled	boolean	If DHCP is enabled on subnet (wire: dhcpEnabled)
dns_name_servers	array	DNS nameservers (wire: dnsNameServers)
gateway_ip	string (ipv4)	Gateway IP (example: 192.0.2.0) (wire: gatewayIp)
host_routes	array	Subnet host routes (wire: hostRoutes)
ip_version	integer	IP Version (4 or 6) (wire: ipVersion)

list

Subnet

Name	Datatype	Description
id	string	Subnet id
name	string	Subnet name
allocation_pools	array	List of ip pools allocated in subnet (wire: allocationPools)
cidr	string (ip-block)	Subnet CIDR (example: 192.0.2.0/24)
dhcp_enabled	boolean	If DHCP is enabled on subnet (wire: dhcpEnabled)
dns_name_servers	array	DNS nameservers (wire: dnsNameServers)
gateway_ip	string (ipv4)	Gateway IP (example: 192.0.2.0) (wire: gatewayIp)
host_routes	array	Subnet host routes (wire: hostRoutes)
ip_version	integer	IP Version (4 or 6) (wire: ipVersion)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	network_id, region_name, subnet_id, service_name		Get subnet
list	select	network_id, region_name, service_name		List subnets
create	insert	network_id, region_name, service_name, cidr, enable_dhcp, enable_gateway_ip, ip_version, name		Create subnet
delete	delete	network_id, region_name, subnet_id, service_name		Delete subnet
gateway	exec	networkId, regionName, subnetId, service_name, model, name		Create Gateway for existing subnet

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"}})
networkId	string	Network ID
network_id	string	Network ID (wire: networkId)
regionName	string	Region name
region_name	string	Region name (wire: regionName)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
subnetId	string	Subnet ID
subnet_id	string	Subnet ID (wire: subnetId)

SELECT examples

get

Get subnet

SELECT
id,
name,
allocation_pools,
cidr,
dhcp_enabled,
dns_name_servers,
gateway_ip,
host_routes,
ip_version
FROM ovh.cloud_network.region_network_subnets
WHERE network_id = '{{ network_id }}' -- required
AND region_name = '{{ region_name }}' -- required
AND subnet_id = '{{ subnet_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List subnets

SELECT
id,
name,
allocation_pools,
cidr,
dhcp_enabled,
dns_name_servers,
gateway_ip,
host_routes,
ip_version
FROM ovh.cloud_network.region_network_subnets
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
;

INSERT examples

create

Create subnet

INSERT INTO ovh.cloud_network.region_network_subnets (
allocation_pools,
cidr,
dns_name_servers,
enable_dhcp,
enable_gateway_ip,
gateway_ip,
host_routes,
ip_version,
name,
use_default_public_dns_resolver,
network_id,
region_name,
service_name
)
SELECT 
'{{ allocation_pools }}',
'{{ cidr }}' /* required */,
'{{ dns_name_servers }}',
{{ enable_dhcp }} /* required */,
{{ enable_gateway_ip }} /* required */,
'{{ gateway_ip }}',
'{{ host_routes }}',
{{ ip_version }} /* required */,
'{{ name }}' /* required */,
{{ use_default_public_dns_resolver }},
'{{ network_id }}',
'{{ region_name }}',
'{{ service_name }}'
RETURNING
id,
name,
allocation_pools,
cidr,
dhcp_enabled,
dns_name_servers,
gateway_ip,
host_routes,
ip_version
;

Manifest

# Description fields are for documentation purposes
- name: region_network_subnets
props:
  - name: network_id
    value: "{{ network_id }}"
    description: Required parameter for the region_network_subnets resource.
  - name: region_name
    value: "{{ region_name }}"
    description: Required parameter for the region_network_subnets resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the region_network_subnets resource.
  - name: allocation_pools
    description: |
      List of ip pools allocated in subnet
    value:
      - end: "{{ end }}"
        start: "{{ start }}"
  - name: cidr
    value: "{{ cidr }}"
    description: |
      Subnet range in CIDR notation
  - name: dns_name_servers
    value:
      - "{{ dns_name_servers }}"
    description: |
      DNS nameservers
  - name: enable_dhcp
    value: {{ enable_dhcp }}
    description: |
      Enable DHCP for the subnet
  - name: enable_gateway_ip
    value: {{ enable_gateway_ip }}
    description: |
      Set a gateway IP for the subnet
  - name: gateway_ip
    value: "{{ gateway_ip }}"
    description: |
      Gateway IP
  - name: host_routes
    description: |
      Host routes
    value:
      - destination: "{{ destination }}"
        nextHop: "{{ nextHop }}"
  - name: ip_version
    value: {{ ip_version }}
    description: |
      IP version
  - name: name
    value: "{{ name }}"
    description: |
      Subnet name
  - name: use_default_public_dns_resolver
    value: {{ use_default_public_dns_resolver }}
    description: |
      Use default DNS

DELETE examples

delete

Delete subnet

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

Lifecycle Methods

EXEC variables use wire (API) names.

gateway

Create Gateway for existing subnet

EXEC ovh.cloud_network.region_network_subnets.gateway 
@networkId='{{ networkId }}' --required, 
@regionName='{{ regionName }}' --required, 
@subnetId='{{ subnetId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set 
@@json=
'{
"model": "{{ model }}", 
"name": "{{ name }}"
}'
;