resiliation_follow_ups
Creates, updates, deletes, gets or lists a resiliation_follow_ups resource.
Overview​
| Name | resiliation_follow_ups |
| Type | Resource |
| Id | ovh.pack_xdsl.resiliation_follow_ups |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
date_todo | string (date-time) | Date when the resiliation will take effect (wire: dateTodo) |
need_modem_return | boolean | If the customer needs to return his modem (wire: needModemReturn) |
registration_date | string (date-time) | Date when the resiliation was asked (wire: registrationDate) |
status | string | Status of the resiliation |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | pack_name | Get the resiliation follow-up of an xDSL pack. Returns the status of the ongoing resiliation of the pack, its effective date and whether the modem must be returned. |
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"}}) |
pack_name | string | The internal name of your pack (wire: packName) |
SELECT examples​
- get
Get the resiliation follow-up of an xDSL pack. Returns the status of the ongoing resiliation of the pack, its effective date and whether the modem must be returned.
SELECT
date_todo,
need_modem_return,
registration_date,
status
FROM ovh.pack_xdsl.resiliation_follow_ups
WHERE pack_name = '{{ pack_name }}' -- required
;