service_bring_your_own_ip_sub_ranges

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

Overview

Name	service_bring_your_own_ip_sub_ranges
Type	Resource
Id	ovh.ip.service_bring_your_own_ip_sub_ranges

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
description	string	Custom description on your ip
ip	string (ip-block)	IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24) (example: 192.0.2.0/24)

list

Imported IP range's sub range

Name	Datatype	Description
description	string	Custom description on your ip
ip	string (ip-block)	IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24) (example: 192.0.2.0/24)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	ip, service_name		Get a sub-range. Returns the IPv4 or IPv6 sub-range, as an IP block, and the custom description set when it was created. (Beta version)
list	select	service_name	x_pagination_mode	List sub-ranges. Returns the IPv4 and IPv6 sub-ranges of the imported range, as IP blocks in CIDR notation. (Beta version)
create	insert	service_name, ip		Create an IPv6 sub-range. Creates an IPv6 /56 sub-range of the imported range, with an optional description. (Beta version)
delete	delete	ip, service_name		Delete an IPv6 sub-range. Deletes the IPv6 sub-range from the imported range. The call returns no content. (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)
service_name	string	The internal name of your IP services (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 sub-range. Returns the IPv4 or IPv6 sub-range, as an IP block, and the custom description set when it was created. (Beta version)

SELECT
description,
ip
FROM ovh.ip.service_bring_your_own_ip_sub_ranges
WHERE ip = '{{ ip }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List sub-ranges. Returns the IPv4 and IPv6 sub-ranges of the imported range, as IP blocks in CIDR notation. (Beta version)

SELECT
description,
ip
FROM ovh.ip.service_bring_your_own_ip_sub_ranges
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create an IPv6 sub-range. Creates an IPv6 /56 sub-range of the imported range, with an optional description. (Beta version)

INSERT INTO ovh.ip.service_bring_your_own_ip_sub_ranges (
description,
ip,
service_name
)
SELECT 
'{{ description }}',
'{{ ip }}' /* required */,
'{{ service_name }}'
RETURNING
description,
ip
;

Manifest

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

DELETE examples

delete

Delete an IPv6 sub-range. Deletes the IPv6 sub-range from the imported range. The call returns no content. (Beta version)

DELETE FROM ovh.ip.service_bring_your_own_ip_sub_ranges
WHERE ip = '{{ ip }}' --required
AND service_name = '{{ service_name }}' --required
;