Skip to main content

iDRAC9 Redfish API Guide Firmware version: 4.20.20.20

PDF

Task

Description

The Task schema contains information about a task that the Redfish Task Service schedules or executes. Tasks represent operations that take more time than a client typically wants to wait.

URL

/redfish/v1/TaskService/Tasks/<Task-Id>

Supported HTTP Method and Privileges


HTTP Method	Required Privilege
GET	Login

Supported Properties


Property	Type	Read-only	Description
EndTime	String	Yes	The date and time when the task was completed. This property will only appear when the task is complete.
HidePayload	Boolean	Yes	An indication of whether the contents of the payload should be hidden from view after the task has been created. If `true`, responses do not return the payload. If `false`, responses return the payload. If this property is not present when the task is created, the default is `false`.
Messages	String	Yes	An array of messages associated with the task.
Payload	Object	Yes	The HTTP and JSON payload details for this task.
PercentComplete	Integer	Yes	The completion percentage of this task.
StartTime	String	Yes	The date and time when the task was started.
TaskMonitor	String	Yes	The URI of the Task Monitor for this task.
TaskState	String	Yes	The state of the task.
TaskStatus	String	Yes	The completion status of the task.

Supported Status Codes


HTTP Status Code	Extended Information	Error Code
200
401	Base.1.2.AccessDenied
404	Base.1.2.ResourceMissingAtURI	SYS403
405		SYS402
500	Base.1.2.InternalError	SWC0058
503