ipv6_routed_subranges

Creates, updates, deletes, gets or lists an ipv6_routed_subranges resource.

Overview

Name	ipv6_routed_subranges
Type	Resource
Id	ovh.vrack.ipv6_routed_subranges

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
nexthop	string (ipv6)	nexthop used as a gateway for your routed subrange (example: 2001:41d0:1:1994::1)
routed_subrange	string (ipv6-block)	subrange routed into your vrack (example: 2001:41d0::/128) (wire: routedSubrange)

list

Routed subranges within your IP v6 block

Name	Datatype	Description
nexthop	string (ipv6)	nexthop used as a gateway for your routed subrange (example: 2001:41d0:1:1994::1)
routed_subrange	string (ipv6-block)	subrange routed into your vrack (example: 2001:41d0::/128) (wire: routedSubrange)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	ipv_6, routed_subrange, service_name		Get a routed subrange. Returns the subrange and its next hop.
list	select	ipv_6, service_name	x_pagination_mode	List routed subranges. Returns the subranges of the block routed in the vRack.
create	insert	ipv_6, service_name, nexthop, routed_subrange		Route a subrange. Routes a subrange of the block to a next hop. The next hop must belong to a bridged subrange. Returns the task that performs it.
delete	delete	ipv_6, routed_subrange, service_name		Unroute a subrange. Removes the route of the subrange. Returns the task that performs it.

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"}})
ipv_6	string (ipv6-block)	Your IP v6 block (wire: ipv6)
routed_subrange	string (ipv6-block)	subrange routed into your vrack (wire: routedSubrange)
service_name	string	The internal name of your vrack (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

Get a routed subrange. Returns the subrange and its next hop.

SELECT
nexthop,
routed_subrange
FROM ovh.vrack.ipv6_routed_subranges
WHERE ipv_6 = '{{ ipv_6 }}' -- required
AND routed_subrange = '{{ routed_subrange }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List routed subranges. Returns the subranges of the block routed in the vRack.

SELECT
nexthop,
routed_subrange
FROM ovh.vrack.ipv6_routed_subranges
WHERE ipv_6 = '{{ ipv_6 }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Route a subrange. Routes a subrange of the block to a next hop. The next hop must belong to a bridged subrange. Returns the task that performs it.

INSERT INTO ovh.vrack.ipv6_routed_subranges (
nexthop,
routed_subrange,
ipv_6,
service_name
)
SELECT 
'{{ nexthop }}' /* required */,
'{{ routed_subrange }}' /* required */,
'{{ ipv_6 }}',
'{{ service_name }}'
RETURNING
id,
order_id,
service_name,
function,
last_update,
status,
target_domain,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: ipv6_routed_subranges
props:
  - name: ipv_6
    value: "{{ ipv_6 }}"
    description: Required parameter for the ipv6_routed_subranges resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the ipv6_routed_subranges resource.
  - name: nexthop
    value: "{{ nexthop }}"
    description: |
      nexthop to configure for your routed subrange (must be part of bridged subrange)
  - name: routed_subrange
    value: "{{ routed_subrange }}"
    description: |
      IPv6 CIDR notation (e.g., 2001:41d0::/128)

DELETE examples

delete

Unroute a subrange. Removes the route of the subrange. Returns the task that performs it.

DELETE FROM ovh.vrack.ipv6_routed_subranges
WHERE ipv_6 = '{{ ipv_6 }}' --required
AND routed_subrange = '{{ routed_subrange }}' --required
AND service_name = '{{ service_name }}' --required
;