network_privates

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

Overview

Name	network_privates
Type	Resource
Id	ovh.cloud_network.network_privates

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)
regions	array	Details about private network in region
status	string	Network status (ACTIVE, BUILDING, DELETING, ERROR)
type	string	Network type (private, public)

list

Network

Name	Datatype	Description
id	string	Network id
name	string	Network name
vlan_id	integer	Network VLAN id (wire: vlanId)
regions	array	Details about private network in region
status	string	Network status (ACTIVE, BUILDING, DELETING, ERROR)
type	string	Network type (private, public)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	network_id, service_name		Get private network
list	select	service_name		Get private networks
create	insert	service_name, name		Create a new network
update	update	network_id, service_name, name		Rename private network
delete	delete	network_id, service_name		Delete private network
region	exec	networkId, service_name, region		Activate private network in a new region

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)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples

get

Get private network

SELECT
id,
name,
vlan_id,
regions,
status,
type
FROM ovh.cloud_network.network_privates
WHERE network_id = '{{ network_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Get private networks

SELECT
id,
name,
vlan_id,
regions,
status,
type
FROM ovh.cloud_network.network_privates
WHERE service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

Create a new network

INSERT INTO ovh.cloud_network.network_privates (
name,
regions,
vlan_id,
service_name
)
SELECT 
'{{ name }}' /* required */,
'{{ regions }}',
{{ vlan_id }},
'{{ service_name }}'
RETURNING
id,
name,
vlan_id,
regions,
status,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_privates
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the network_privates resource.
  - name: name
    value: "{{ name }}"
    description: |
      Network name
  - name: regions
    value:
      - "{{ regions }}"
    description: |
      Region where to activate private network. No parameters means all region
  - name: vlan_id
    value: {{ vlan_id }}
    description: |
      Vland id, between 0 and 4095. 0 value means no vlan.

UPDATE examples

update

Rename private network

UPDATE ovh.cloud_network.network_privates
SET 
name = '{{ name }}'
WHERE 
network_id = '{{ network_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
AND name = '{{ name }}' --required;

DELETE examples

delete

Delete private network

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

Lifecycle Methods

EXEC variables use wire (API) names.

region

Activate private network in a new region

EXEC ovh.cloud_network.network_privates.region 
@networkId='{{ networkId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set 
@@json=
'{
"region": "{{ region }}"
}'
;