ips
Creates, updates, deletes, gets or lists an ips resource.
Overview​
| Name | ips |
| Type | Resource |
| Id | ovh.cloud_network.ips |
Fields​
The following fields are returned by SELECT queries:
- list
CloudIp
| Name | Datatype | Description |
|---|---|---|
id | string | Ip id |
ip | string (ip-block) | Ip (example: 192.0.2.0/24) |
status | string | Ip status (ok, operationPending) |
type | string | Ip type |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | service_name | Get ips |
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 Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set. |
SELECT examples​
- list
Get ips
SELECT
id,
ip,
status,
type
FROM ovh.cloud_network.ips
WHERE service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;