Skip to main content

global_tasks

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

Overview​

Nameglobal_tasks
TypeResource
Idovh.dedicated_cloud.global_tasks

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
valueinteger

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectservice_namedatacenter_id, end_date.from, end_date.to, execution_date.from, execution_date.to, filer_id, host_id, last_modification_date.from, last_modification_date.to, name, network_access_id, order_id, parent_task_id, state, user_id, vlan_idList all tasks. Returns the IDs of the tasks of the service and its resources. Filter by datacenter, host, datastore, user, VLAN, state, name or date.

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.

NameDatatypeDescription
api_hoststringThe 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_namestringDomain of the service (wire: serviceName)
datacenter_idintegerFilter the tasks by datacenter Id (wire: datacenterId)
end_date.fromstring (date)Filter the tasks by end date (>=) (wire: endDate.from)
end_date.tostring (date)Filter the tasks by end date (<=) (wire: endDate.to)
execution_date.fromstring (date-time)Filter the tasks by execution date (>=) (wire: executionDate.from)
execution_date.tostring (date-time)Filter the tasks by execution date (<=) (wire: executionDate.to)
filer_idintegerFilter the tasks by filer Id (wire: filerId)
host_idintegerFilter the tasks by host Id (wire: hostId)
last_modification_date.fromstring (date-time)Filter the tasks by last modification date (>=) (wire: lastModificationDate.from)
last_modification_date.tostring (date-time)Filter the tasks by last modification date (<=) (wire: lastModificationDate.to)
namestringFilter the tasks by name
network_access_idintegerFilter the tasks by network access Id (wire: networkAccessId)
order_idintegerFilter the tasks by order Id (wire: orderId)
parent_task_idintegerFilter the tasks by parent task Id (wire: parentTaskId)
statearrayFilter the tasks by state
user_idintegerFilter the tasks by user Id (wire: userId)
vlan_idintegerFilter the tasks by vlan Id (wire: vlanId)

SELECT examples​

List all tasks. Returns the IDs of the tasks of the service and its resources. Filter by datacenter, host, datastore, user, VLAN, state, name or date.

SELECT
value
FROM ovh.dedicated_cloud.global_tasks
WHERE service_name = '{{ service_name }}' -- required
AND datacenter_id = '{{ datacenter_id }}'
AND end_date.from = '{{ end_date.from }}'
AND end_date.to = '{{ end_date.to }}'
AND execution_date.from = '{{ execution_date.from }}'
AND execution_date.to = '{{ execution_date.to }}'
AND filer_id = '{{ filer_id }}'
AND host_id = '{{ host_id }}'
AND last_modification_date.from = '{{ last_modification_date.from }}'
AND last_modification_date.to = '{{ last_modification_date.to }}'
AND name = '{{ name }}'
AND network_access_id = '{{ network_access_id }}'
AND order_id = '{{ order_id }}'
AND parent_task_id = '{{ parent_task_id }}'
AND state = '{{ state }}'
AND user_id = '{{ user_id }}'
AND vlan_id = '{{ vlan_id }}'
;