orderable_ips
Creates, updates, deletes, gets or lists an orderable_ips resource.
Overview​
| Name | orderable_ips |
| Type | Resource |
| Id | ovh.dedicated_server.orderable_ips |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
ipv_4 | array | Orderable IP v4 details (wire: ipv4) |
ipv_6 | array | Orderable IP v6 details (wire: ipv6) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get orderable IP addresses. Returns the IPv4 and IPv6 types that can be ordered for the server, with their block sizes, the number of prefixes and IPs that can be routed to it, and whether they are included in the offer. When a type needs an option first, optionRequired names it. |
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"}}) |
service_name | string | The internal name of your dedicated server (wire: serviceName) |
SELECT examples​
- get
Get orderable IP addresses. Returns the IPv4 and IPv6 types that can be ordered for the server, with their block sizes, the number of prefixes and IPs that can be routed to it, and whether they are included in the offer. When a type needs an option first, optionRequired names it.
SELECT
ipv_4,
ipv_6
FROM ovh.dedicated_server.orderable_ips
WHERE service_name = '{{ service_name }}' -- required
;