veeam_restore_points

Creates, updates, deletes, gets or lists a veeam_restore_points resource.

Overview

Name	veeam_restore_points
Type	Resource
Id	ovh.vps.veeam_restore_points

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	The restore point's id
creation_time	string (date-time)	The restore point's creation time (wire: creationTime)

list

Informations about a VPS Veeam restore points

Name	Datatype	Description
id	integer	The restore point's id
creation_time	string (date-time)	The restore point's creation time (wire: creationTime)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Returns the ID and the creation time of a Veeam restore point of the VPS. (Deprecated, will be removed)
list	select	service_name	creation_time, x_pagination_mode	Returns the IDs of the Veeam restore points available for the VPS. (Deprecated, will be removed)
restore	exec	id, serviceName, full		Restores the VPS from a Veeam restore point 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"}})
id	integer	Id
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)
creation_time	string (date-time)	Filter the value of creationTime property (like) (wire: creationTime)
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

Returns the ID and the creation time of a Veeam restore point of the VPS. (Deprecated, will be removed)

SELECT
id,
creation_time
FROM ovh.vps.veeam_restore_points
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the IDs of the Veeam restore points available for the VPS. (Deprecated, will be removed)

SELECT
id,
creation_time
FROM ovh.vps.veeam_restore_points
WHERE service_name = '{{ service_name }}' -- required
AND creation_time = '{{ creation_time }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

restore

Restores the VPS from a Veeam restore point and returns the task that performs it. (Deprecated, will be removed)

EXEC ovh.vps.veeam_restore_points.restore 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"changePassword": {{ changePassword }}, 
"export": "{{ export }}", 
"full": {{ full }}
}'
;