task
Description
This resource contains a task for a Redfish implementation.
Fields
| Field | Type | Description |
|---|---|---|
Description | Description | |
EndTime | string | This property shall indicate the date and time when the task was completed. This property shall not appear if the task is running or otherwise has not been completed. This property shall appear only if the `TaskState` is `Completed`, `Killed`, `Cancelled`, or `Exception`. |
EstimatedDuration | string | This property shall indicate the estimated total time needed to complete the task. The value is not expected to change while the task is in progress, but the service may update the value if it obtains new information that significantly changes the expected duration. Services should be conservative in the reported estimate and clients should treat this value as an estimate. |
HidePayload | boolean | This property shall indicate whether the contents of the payload should be hidden from view after the task has been created. If `true`, responses shall not return the `Payload` property. If `false`, responses shall return the `Payload` property. If this property is not present when the task is created, the default is `false`. This property shall be supported if the `Payload` property is supported. |
Id | Id | |
Links | Links | The `Links` property, as described by the Redfish Specification, shall contain references to resources that are related to but are not contained by, or subordinate to, this resource. |
Messages | array | This property shall contain an array of messages associated with the task. |
Name | Name | |
Oem | Oem | This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements. |
Payload | Payload | This object shall contain information detailing the HTTP and JSON request payload information for executing this task. This property shall not be included in the response if the `HidePayload` property is `true`. |
PercentComplete | integer | This property shall indicate the completion progress of the task, reported in percent of completion, `0` to `100`. If the task has not been started, the value shall be zero. |
StartTime | string | This property shall indicate the date and time when the task was started. |
SubTasks | TaskCollection | This property shall contain a link to a resource collection of type `TaskCollection`. This property shall not be present if this resource represents a sub-task for a task. |
TaskMonitor | string | This property shall contain a URI to task monitor as defined in the Redfish Specification. |
TaskState | TaskState | This property shall indicate the state of the task. |
TaskStatus | Health | This property shall contain the completion status of the task and shall not be set until the task completes. This property should contain `Critical` if one or more messages in the `Messages` array contains the severity `Critical`. This property should contain `Warning` if one or more messages in the `Messages` array contains the severity `Warning` and if no messages contain the severity `Critical`. This property should contain `OK` if all messages in the `Messages` array contain the severity `OK` or if the array is empty. |