config_pops

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

Overview

Name	config_pops
Type	Resource
Id	ovh.ovh_cloud_connect.config_pops

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	ID of the Pop Configuration
interface_id	integer	ID of the interface (wire: interfaceId)
customer_bgp_area	integer	Customer Private AS (wire: customerBgpArea)
ovh_bgp_area	integer	OVH Private AS (wire: ovhBgpArea)
status	string	Status of the pop configuration (active, init, toDelete)
subnet	string (ipv4-block)	Subnet should be a /30, first IP for OVH, second IP for customer (example: 192.0.2.0/24)
type	string	Type of the pop configuration (l2, l3)

list

OVHcloud Connect Service Pop Configuration

Name	Datatype	Description
id	integer	ID of the Pop Configuration
interface_id	integer	ID of the interface (wire: interfaceId)
customer_bgp_area	integer	Customer Private AS (wire: customerBgpArea)
ovh_bgp_area	integer	OVH Private AS (wire: ovhBgpArea)
status	string	Status of the pop configuration (active, init, toDelete)
subnet	string (ipv4-block)	Subnet should be a /30, first IP for OVH, second IP for customer (example: 192.0.2.0/24)
type	string	Type of the pop configuration (l2, l3)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	pop_id, service_name		Returns the configuration's type, interface, subnet, AS numbers and status.
list	select	service_name	x_pagination_mode	Returns the IDs of the PoP configurations.
create	insert	service_name, interface_id, type		Sets configuration for an interface from interfaceList; Provided settings depends on type L2 or L3 (async task).
delete	delete	pop_id, service_name		Removes the PoP configuration from its interface (async task).

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"}})
pop_id	integer	Pop ID (wire: popId)
service_name	string (uuid)	Service name (wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Returns the configuration's type, interface, subnet, AS numbers and status.

SELECT
id,
interface_id,
customer_bgp_area,
ovh_bgp_area,
status,
subnet,
type
FROM ovh.ovh_cloud_connect.config_pops
WHERE pop_id = '{{ pop_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the IDs of the PoP configurations.

SELECT
id,
interface_id,
customer_bgp_area,
ovh_bgp_area,
status,
subnet,
type
FROM ovh.ovh_cloud_connect.config_pops
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Sets configuration for an interface from interfaceList; Provided settings depends on type L2 or L3 (async task).

INSERT INTO ovh.ovh_cloud_connect.config_pops (
customer_bgp_area,
interface_id,
ovh_bgp_area,
subnet,
type,
service_name
)
SELECT 
{{ customer_bgp_area }},
{{ interface_id }} /* required */,
{{ ovh_bgp_area }},
'{{ subnet }}',
'{{ type }}' /* required */,
'{{ service_name }}'
RETURNING
id,
resource_id,
function,
status
;

Manifest

# Description fields are for documentation purposes
- name: config_pops
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the config_pops resource.
  - name: customer_bgp_area
    value: {{ customer_bgp_area }}
    description: |
      Customer Private AS
  - name: interface_id
    value: {{ interface_id }}
    description: |
      ID of the interface
  - name: ovh_bgp_area
    value: {{ ovh_bgp_area }}
    description: |
      OVH Private AS
  - name: subnet
    value: "{{ subnet }}"
    description: |
      Subnet should be a /30, first IP for OVH, second IP for customer
  - name: type
    value: "{{ type }}"
    description: |
      Type of the pop configuration
    valid_values: ['l2', 'l3']

DELETE examples

delete

Removes the PoP configuration from its interface (async task).

DELETE FROM ovh.ovh_cloud_connect.config_pops
WHERE pop_id = '{{ pop_id }}' --required
AND service_name = '{{ service_name }}' --required
;