ips
Creates, updates, deletes, gets or lists an ips resource.
Overview​
| Name | ips |
| Type | Resource |
| Id | ovh.over_the_box.ips |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
geolocation | string | IP geolocation (fr) |
ip | string (ipv4) | IP address (example: 192.0.2.0) |
range | integer | IP cidr prefix |
status | string | IP status (active, free, pendingRelease, released, reserved) |
version | string | IP version (v4, v6) |
Service IP details
| Name | Datatype | Description |
|---|---|---|
geolocation | string | IP geolocation (fr) |
ip | string (ipv4) | IP address (example: 192.0.2.0) |
range | integer | IP cidr prefix |
status | string | IP status (active, free, pendingRelease, released, reserved) |
version | string | IP version (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 of the OverTheBox service with its version (v4 or v6), CIDR prefix, status and geolocation. (Beta version) | |
list | select | service_name | x_pagination_mode | Returns the IP addresses attached to the OverTheBox service. Get an IP for its version, prefix, status and geolocation. (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 (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
- list
Returns an IP address of the OverTheBox service with its version (v4 or v6), CIDR prefix, status and geolocation. (Beta version)
SELECT
geolocation,
ip,
range,
status,
version
FROM ovh.over_the_box.ips
WHERE ip = '{{ ip }}' -- required
AND service_name = '{{ service_name }}' -- required
;
Returns the IP addresses attached to the OverTheBox service. Get an IP for its version, prefix, status and geolocation. (Beta version)
SELECT
geolocation,
ip,
range,
status,
version
FROM ovh.over_the_box.ips
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;