veeam_restored_backups
Creates, updates, deletes, gets or lists a veeam_restored_backups resource.
Overview​
| Name | veeam_restored_backups |
| Type | Resource |
| Id | ovh.vps.veeam_restored_backups |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
restore_point_id | integer | The restore point id (wire: restorePointId) |
access_infos | object | Backup access informations (wire: accessInfos) |
state | string | The restored backup state (mounted, restoring, unmounted, unmounting) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Returns the restore point, the state and the access information of the Veeam backup currently restored on the VPS. (Deprecated, will be removed) | |
delete | delete | service_name | Unmounts the restored Veeam backup from the VPS and returns the task that performs it. (Deprecated, will be removed) |
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 | Service name (wire: serviceName) |
SELECT examples​
- get
Returns the restore point, the state and the access information of the Veeam backup currently restored on the VPS. (Deprecated, will be removed)
SELECT
restore_point_id,
access_infos,
state
FROM ovh.vps.veeam_restored_backups
WHERE service_name = '{{ service_name }}' -- required
;
DELETE examples​
- delete
Unmounts the restored Veeam backup from the VPS and returns the task that performs it. (Deprecated, will be removed)
DELETE FROM ovh.vps.veeam_restored_backups
WHERE service_name = '{{ service_name }}' --required
;