ip_details
Creates, updates, deletes, gets or lists an ip_details resource.
Overview​
| Name | ip_details |
| Type | Resource |
| Id | ovh.dedicated_cloud.ip_details |
Fields​
The following fields are returned by SELECT queries:
- list
Details about an Ip
| Name | Datatype | Description |
|---|---|---|
ip | string (ipv4) | IP address (example: 192.0.2.0) |
reverse | string | IP address reverse record |
usage | string | IP address usage (nsxt, reserved, vm) |
usage_details | string | IP address usage details (wire: usageDetails) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | network, service_name | List IP block addresses. Returns each IP address of the block with its reverse record and its usage: virtual machine, NSX-T or reserved. |
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) |
SELECT examples​
- list
List IP block addresses. Returns each IP address of the block with its reverse record and its usage: virtual machine, NSX-T or reserved.
SELECT
ip,
reverse,
usage,
usage_details
FROM ovh.dedicated_cloud.ip_details
WHERE network = '{{ network }}' -- required
AND service_name = '{{ service_name }}' -- required
;