tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.veeam_enterprise.tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Task name
task_id	integer	Task id (wire: taskId)
end_date	string (date-time)	Task completion date (wire: endDate)
progress	integer	Current progress
start_date	string (date-time)	Task creation date (wire: startDate)
state	string	Current Task state (canceled, doing, done, error, toCreate, todo, unfixed, waiting, waitingForChilds)

list

Operation with the Enterprise Account

Name	Datatype	Description
name	string	Task name
task_id	integer	Task id (wire: taskId)
end_date	string (date-time)	Task completion date (wire: endDate)
progress	integer	Current progress
start_date	string (date-time)	Task creation date (wire: startDate)
state	string	Current Task state (canceled, doing, done, error, toCreate, todo, unfixed, waiting, waitingForChilds)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name, task_id		Get operation
list	select	service_name	name, state, x_pagination_mode	List operations

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	Domain of the service (wire: serviceName)
task_id	integer	Task id (wire: taskId)
name	string	Filter the value of name property (like)
state	string	Filter the value of state property (=)
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

Get operation

SELECT
name,
task_id,
end_date,
progress,
start_date,
state
FROM ovh.veeam_enterprise.tasks
WHERE service_name = '{{ service_name }}' -- required
AND task_id = '{{ task_id }}' -- required
;

list

List operations

SELECT
name,
task_id,
end_date,
progress,
start_date,
state
FROM ovh.veeam_enterprise.tasks
WHERE service_name = '{{ service_name }}' -- required
AND name = '{{ name }}'
AND state = '{{ state }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;