tasks

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

Overview

Name	tasks
Type	Resource
Id	ovh.vps.tasks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
date	string (date-time)
progress	integer
state	string	All states a VPS task can be in (blocked, cancelled, doing, done, error, paused, todo, waitingAck)
type	string	All type a VPS task can be (addVeeamBackupJob, changeRootPassword, createSnapshot, deleteSnapshot, deliverVm, getConsoleUrl, internalTask, migrate, openConsoleAccess, provisioningAdditionalIp, reOpenVm, rebootVm, reinstallVm, removeVeeamBackup, rescheduleAutoBackup, restoreFullVeeamBackup, restoreVeeamBackup, restoreVm, revertSnapshot, setMonitoring, setNetboot, startVm, stopVm, upgradeVm)

list

Operation on a VPS Virtual Machine

Name	Datatype	Description
id	integer
date	string (date-time)
progress	integer
state	string	All states a VPS task can be in (blocked, cancelled, doing, done, error, paused, todo, waitingAck)
type	string	All type a VPS task can be (addVeeamBackupJob, changeRootPassword, createSnapshot, deleteSnapshot, deliverVm, getConsoleUrl, internalTask, migrate, openConsoleAccess, provisioningAdditionalIp, reOpenVm, rebootVm, reinstallVm, removeVeeamBackup, rescheduleAutoBackup, restoreFullVeeamBackup, restoreVeeamBackup, restoreVm, revertSnapshot, setMonitoring, setNetboot, startVm, stopVm, upgradeVm)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Returns the type, state, progress and date of a task of the VPS.
list	select	service_name	state, type, x_pagination_mode	Returns the IDs of the tasks of the VPS.

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
service_name	string	Service name (wire: serviceName)
state	string	Filter the value of state property (=)
type	string	Filter the value of type 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

Returns the type, state, progress and date of a task of the VPS.

SELECT
id,
date,
progress,
state,
type
FROM ovh.vps.tasks
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the IDs of the tasks of the VPS.

SELECT
id,
date,
progress,
state,
type
FROM ovh.vps.tasks
WHERE service_name = '{{ service_name }}' -- required
AND state = '{{ state }}'
AND type = '{{ type }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;