bring_your_own_ip_slices

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

Overview

Name	bring_your_own_ip_slices
Type	Resource
Id	ovh.ip.bring_your_own_ip_slices

Fields

The following fields are returned by SELECT queries:

list

Preview of an IP slicing on BYOIP Additional IPs

Name	Datatype	Description
children_ips	array	Additional IP(s) that will be created (wire: childrenIps)
slicing_size	integer	Slicing size (wire: slicingSize)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	ip		List slicing options. Returns, for each allowed size, the Additional IPs that slicing this one would create. Slicing applies to IPv4 blocks only. (Beta version)
create	insert	ip, slicing_size		Slice an IPv4 block. Splits this BYOIP Additional IP into smaller Additional IPs of the chosen size (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 slicing options. Returns, for each allowed size, the Additional IPs that slicing this one would create. Slicing applies to IPv4 blocks only. (Beta version)

SELECT
children_ips,
slicing_size
FROM ovh.ip.bring_your_own_ip_slices
WHERE ip = '{{ ip }}' -- required
;

INSERT examples

create

Slice an IPv4 block. Splits this BYOIP Additional IP into smaller Additional IPs of the chosen size (async task). (Beta version)

INSERT INTO ovh.ip.bring_your_own_ip_slices (
slicing_size,
ip
)
SELECT 
{{ slicing_size }} /* 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_slices
props:
  - name: ip
    value: "{{ ip }}"
    description: Required parameter for the bring_your_own_ip_slices resource.
  - name: slicing_size
    value: {{ slicing_size }}
    description: |
      Size (ip mask) of the IPs to create inside given IP