config_pop_datacenter_extras

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

Overview

Name	config_pop_datacenter_extras
Type	Resource
Id	ovh.ovh_cloud_connect.config_pop_datacenter_extras

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	ID of the extra configuration
bgp_neighbor_area	integer	BGP AS number (wire: bgpNeighborArea)
bgp_neighbor_ip	string (ipv4)	Router IP for BGP (example: 192.0.2.0) (wire: bgpNeighborIp)
next_hop	string (ipv4)	Static route next hop (example: 192.0.2.0) (wire: nextHop)
status	string	Status of the pop configuration (active, init, toDelete)
subnet	string (ipv4-block)	Static route ip (example: 192.0.2.0/24)
type	string	Type of the configuration (bgp, network)

list

OVHcloud Connect Service Datacenter Extra Configuration

Name	Datatype	Description
id	integer	ID of the extra configuration
bgp_neighbor_area	integer	BGP AS number (wire: bgpNeighborArea)
bgp_neighbor_ip	string (ipv4)	Router IP for BGP (example: 192.0.2.0) (wire: bgpNeighborIp)
next_hop	string (ipv4)	Static route next hop (example: 192.0.2.0) (wire: nextHop)
status	string	Status of the pop configuration (active, init, toDelete)
subnet	string (ipv4-block)	Static route ip (example: 192.0.2.0/24)
type	string	Type of the configuration (bgp, network)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	datacenter_id, extra_id, pop_id, service_name		Returns the route type, its BGP peer or static subnet and next hop, and its status.
list	select	datacenter_id, pop_id, service_name	x_pagination_mode	Returns the IDs of the BGP peers and static routes of this availability zone configuration.
create	insert	datacenter_id, pop_id, service_name, type		Adds a BGP peer (bgp) or a static route (network) to this availability zone configuration (async task).
delete	delete	datacenter_id, extra_id, pop_id, service_name		Removes the BGP peer or static route (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"}})
datacenter_id	integer	Datacenter ID (wire: datacenterId)
extra_id	integer	Extra ID (wire: extraId)
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 route type, its BGP peer or static subnet and next hop, and its status.

SELECT
id,
bgp_neighbor_area,
bgp_neighbor_ip,
next_hop,
status,
subnet,
type
FROM ovh.ovh_cloud_connect.config_pop_datacenter_extras
WHERE datacenter_id = '{{ datacenter_id }}' -- required
AND extra_id = '{{ extra_id }}' -- required
AND pop_id = '{{ pop_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the IDs of the BGP peers and static routes of this availability zone configuration.

SELECT
id,
bgp_neighbor_area,
bgp_neighbor_ip,
next_hop,
status,
subnet,
type
FROM ovh.ovh_cloud_connect.config_pop_datacenter_extras
WHERE datacenter_id = '{{ datacenter_id }}' -- required
AND pop_id = '{{ pop_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Adds a BGP peer (bgp) or a static route (network) to this availability zone configuration (async task).

INSERT INTO ovh.ovh_cloud_connect.config_pop_datacenter_extras (
bgp_neighbor_area,
bgp_neighbor_ip,
next_hop,
subnet,
type,
datacenter_id,
pop_id,
service_name
)
SELECT 
{{ bgp_neighbor_area }},
'{{ bgp_neighbor_ip }}',
'{{ next_hop }}',
'{{ subnet }}',
'{{ type }}' /* required */,
'{{ datacenter_id }}',
'{{ pop_id }}',
'{{ service_name }}'
RETURNING
id,
resource_id,
function,
status
;

Manifest

# Description fields are for documentation purposes
- name: config_pop_datacenter_extras
props:
  - name: datacenter_id
    value: {{ datacenter_id }}
    description: Required parameter for the config_pop_datacenter_extras resource.
  - name: pop_id
    value: {{ pop_id }}
    description: Required parameter for the config_pop_datacenter_extras resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the config_pop_datacenter_extras resource.
  - name: bgp_neighbor_area
    value: {{ bgp_neighbor_area }}
    description: |
      BGP AS number
  - name: bgp_neighbor_ip
    value: "{{ bgp_neighbor_ip }}"
    description: |
      Router IP for BGP
  - name: next_hop
    value: "{{ next_hop }}"
    description: |
      Static route next hop
  - name: subnet
    value: "{{ subnet }}"
    description: |
      Static route ip
  - name: type
    value: "{{ type }}"
    description: |
      Type of the configuration
    valid_values: ['bgp', 'network']

DELETE examples

delete

Removes the BGP peer or static route (async task).

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