ips

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

Overview

Name	ips
Type	Resource
Id	ovh.xdsl.ips

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
dns_list	array	(wire: dnsList)
ip	string (ipv4)	The IP address (example: 192.0.2.0)
range	integer
status	string	status of the IP (active, close, toDelete)
version	string	Ip versions (v4, v6)

list

Informations about an IP address

Name	Datatype	Description
dns_list	array	(wire: dnsList)
ip	string (ipv4)	The IP address (example: 192.0.2.0)
range	integer
status	string	status of the IP (active, close, toDelete)
version	string	Ip versions (v4, v6)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	ip, service_name		Returns an IP address or block of the access with its version, range, status and DNS servers.
list	select	service_name	x_pagination_mode	Returns the IP addresses of the access. Get an IP for its version, range, status and DNS servers.
create	insert	service_name		Orders an extra range of eight IPv4 addresses (/29) for the access. Returns the task that performs the change.
delete	delete	ip, service_name		Stops renewing the extra IPv4 option of the access.

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 (ipv4)	Ip
service_name	string	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 an IP address or block of the access with its version, range, status and DNS servers.

SELECT
dns_list,
ip,
range,
status,
version
FROM ovh.xdsl.ips
WHERE ip = '{{ ip }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the IP addresses of the access. Get an IP for its version, range, status and DNS servers.

SELECT
dns_list,
ip,
range,
status,
version
FROM ovh.xdsl.ips
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Orders an extra range of eight IPv4 addresses (/29) for the access. Returns the task that performs the change.

INSERT INTO ovh.xdsl.ips (
service_name
)
SELECT 
'{{ service_name }}'
RETURNING
id,
done_date,
function,
is_archived,
status,
todo_date,
update_date
;

Manifest

# Description fields are for documentation purposes
- name: ips
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the ips resource.

DELETE examples

delete

Stops renewing the extra IPv4 option of the access.

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