Skip to main content

network_publics

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

Overview​

Namenetwork_publics
TypeResource
Idovh.cloud_network.network_publics

Fields​

The following fields are returned by SELECT queries:

Network

NameDatatypeDescription
idstringNetwork id
namestringNetwork name
vlan_idintegerNetwork VLAN id (wire: vlanId)
regionsarrayDetails about private network in region
statusstringNetwork status (ACTIVE, BUILDING, DELETING, ERROR)
typestringNetwork type (private, public)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectservice_nameGet public networks

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.

NameDatatypeDescription
api_hoststringThe 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"}})
service_namestringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples​

Get public networks

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