bring_your_own_ip_aggregates

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

Overview

Name	bring_your_own_ip_aggregates
Type	Resource
Id	ovh.ip.bring_your_own_ip_aggregates

Fields

The following fields are returned by SELECT queries:

list

Preview of an IP aggregation on BYOIP Additional IPs

Name	Datatype	Description
aggregation_ip	string (ip-block)	Aggregation Additional IP that will be created (example: 192.0.2.0/24) (wire: aggregationIp)
children_ips	array	Existing Additional IP(s) that will be aggregated (wire: childrenIps)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	ip		List aggregation options. Returns the larger Additional IPs this one can merge into, with the neighbors each would absorb. Aggregation applies to IPv4 blocks only. (Beta version)
create	insert	ip, aggregation_ip		Aggregate IPv4 blocks. Merges this BYOIP Additional IP and its neighbors into the chosen larger block (async task). (Beta version)

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"}})
ip	string (ip-block)

SELECT examples

list

List aggregation options. Returns the larger Additional IPs this one can merge into, with the neighbors each would absorb. Aggregation applies to IPv4 blocks only. (Beta version)

SELECT
aggregation_ip,
children_ips
FROM ovh.ip.bring_your_own_ip_aggregates
WHERE ip = '{{ ip }}' -- required
;

INSERT examples

create

Aggregate IPv4 blocks. Merges this BYOIP Additional IP and its neighbors into the chosen larger block (async task). (Beta version)

INSERT INTO ovh.ip.bring_your_own_ip_aggregates (
aggregation_ip,
ip
)
SELECT 
'{{ aggregation_ip }}' /* required */,
'{{ ip }}'
RETURNING
task_id,
comment,
destination,
done_date,
function,
last_update,
start_date,
status
;

Manifest

# Description fields are for documentation purposes
- name: bring_your_own_ip_aggregates
props:
  - name: ip
    value: "{{ ip }}"
    description: Required parameter for the bring_your_own_ip_aggregates resource.
  - name: aggregation_ip
    value: "{{ aggregation_ip }}"
    description: |
      IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)