ips
Creates, updates, deletes, gets or lists an ips resource.
Overview​
| Name | ips |
| Type | Resource |
| Id | ovh.dedicated_cloud.ips |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
network_name | string | Network name (wire: networkName) |
country | string | |
description | string | |
gateway | string (ipv4) | Gateway value (example: 192.0.2.0) |
netmask | string (ipv4) | Netmask value (example: 192.0.2.0) |
network | string (ipv4-block) | IP ex: 213.186.33.34/24 (example: 192.0.2.0/24) |
register | string | The Regional Internet Registry of this Ip Block (arin, ripe) |
vlan_number | integer | Vlan where this network is routed (wire: vlanNumber) |
IP block
| Name | Datatype | Description |
|---|---|---|
network_name | string | Network name (wire: networkName) |
country | string | |
description | string | |
gateway | string (ipv4) | Gateway value (example: 192.0.2.0) |
netmask | string (ipv4) | Netmask value (example: 192.0.2.0) |
network | string (ipv4-block) | IP ex: 213.186.33.34/24 (example: 192.0.2.0/24) |
register | string | The Regional Internet Registry of this Ip Block (arin, ripe) |
vlan_number | integer | Vlan where this network is routed (wire: vlanNumber) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | network, service_name | Get an IP block | |
list | select | service_name | x_pagination_mode | List IP blocks |
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"}}) |
network | string (ipv4-block) | IP ex: 213.186.33.34/24 |
service_name | string | Domain of the service (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
Get an IP block
SELECT
network_name,
country,
description,
gateway,
netmask,
network,
register,
vlan_number
FROM ovh.dedicated_cloud.ips
WHERE network = '{{ network }}' -- required
AND service_name = '{{ service_name }}' -- required
;
List IP blocks
SELECT
network_name,
country,
description,
gateway,
netmask,
network,
register,
vlan_number
FROM ovh.dedicated_cloud.ips
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;