GET /nodes/{uuid}/tasks/{task-id}
Use this method to return information about a task that is running on a specific ThinkSystem or ThinkAgile server.
Note
This REST API requires Lenovo XClarity Administrator v4.2.0 or later.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/nodes/{uuid}/tasks/{task-id}
where
{uuid is the UUID of the server
{task-id} is the ID of the task to be returned
Query parameters
| Parameter | Required / Optional | Description |
|---|---|---|
| IncludeDetail={Boolean} | Optional | Indicates whether to return job details. This can be one of the following values.
|
The following example returns information only about the job.
GET https://192.0.2.0/nodes/b7d353d9a8019a434aa8948a6d16f3/tasks/7
The following example returns information about the job, steps, and members.
GET https://192.0.2.0/nodes/b7d353d9a8019a434aa8948a6d16f3/tasks/7?IncludeDetail=true
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||||
|---|---|---|---|---|---|---|
| Id | String | Task ID | ||||
| Description | String | Task description | ||||
| EndTime | String | Timestamp, in ISO-8601 format, when the job completed | ||||
| HidePayload | Boolean | |||||
| Jobs | Array of objects | List of jobs that are associated with this task | ||||
| Id | String | Job ID | ||||
| Description | String | Job description | ||||
| EndTime | String | Timestamp, in ISO-8601 format, when the job completed | ||||
| JobState | String | Job state | ||||
| JobStatus | String | Job status | ||||
| Messages | Array of objects | Information about each message for the overall job | ||||
| Message | String | Message text | ||||
| MessageArgs | String | List of message arguments | ||||
| MessageId | String | Message ID | ||||
| MessageSeverity | String | Message severity | ||||
| Resolution | String | Message resolution | ||||
| @odata.type | String | |||||
| Name | String | Job name | ||||
| StepOrder | Array of strings | |||||
| Steps | Array of objects | Information about each subtask in the job | ||||
| Description | String | Subtask description | ||||
| Members | Array of objects | |||||
| Id | String | Subtask ID | ||||
| Description | String | |||||
| EndTime | String | |||||
| JobState | String | Subtask state | ||||
| JobStatus | String | Subtask status | ||||
| Messages | Array of objects | Information about each message for the substep | ||||
| Message | String | Message text | ||||
| MessageArgs | Array of strings | List of message arguments | ||||
| MessageId | String | Message ID | ||||
| MessageSeverity | String | Message severity | ||||
| Resolution | String | Message resolution | ||||
| Name | String | Subtask name | ||||
| PercentComplete | String | Percentage complete of the subtask. This can be an integer from 0 - 100. | ||||
| StartTime | String | Timestamp, in ISO-8601 format, when the subtask completed | ||||
| @odata.type | String | |||||
| Name | String | Task name | ||||
| @odata.id | String | |||||
| Messages | Array of objects | Information about each message for the task | ||||
| Message | String | Message text | ||||
| MessageArgs | String | List of message arguments | ||||
| MessageId | String | Message ID | ||||
| MessageSeverity | String | Message severity | ||||
| Resolution | String | Message resolution | ||||
| Name | String | Task name | ||||
| PercentComplete | String | Percentage complete of the task. This can be an integer from 0 - 100. | ||||
| StartTime | String | Timestamp, in ISO-8601 format, when the task started | ||||
| TaskState | String | Task state | ||||
| TaskStatus | String | Task status | ||||
The following example is returned if the request is successful and includeDetails is false.
{
"Id": "0",
"Description": "This resource represents a task for a Redfish implementation.",
"EndTime": "2024-08-08T19:09:21+00:00",
"HidePayload": true,
"Jobs": [{
"Id": "FW_Update_6",
"Description": null,
"EndTime": null,
"JobState": null,
"JobStatus": null,
"Messages": [],
"Name": null,
"PercentComplete": null,
"StartTime": null,
"StepOrder": [],
"Steps": null,
"@odata.id": null
}],
"Messages": [{
"Message": "The update operation has transitioned to the job at URI '/redfish/v1/JobService/Jobs/FW_Update_6'.",
"MessageArgs": ["/redfish/v1/JobService/Jobs/FW_Update_6"],
"MessageId": "Update.1.0.1.OperationTransitionedToJob",
"MessageSeverity": "OK"
"Resolution": "Follow the referenced job and monitor the job for further updates.",
}],
"Name": "Task 0",
"PercentComplete": 100,
"StartTime": "2024-08-08T19:09:12+00:00",
"TaskState": "Completed",
"TaskStatus": "OK"
}TaskStatus": "OK"
}
The following example is returned if the request is successful and includeDetails is true.
{
"Id": "0",
"Description": "This resource represents a task for a Redfish implementation.",
"EndTime": "2024-08-08T19:09:21+00:00",
"HidePayload": true,
"Jobs": [{
"Id": "FW_Update_6",
"Description": "This resource is used to represent a job for a Redfish implementation.",
"EndTime": "2024-08-08T19:30:01+00:00",
"JobState": "Exception",
"JobStatus": "Critical",
"Messages": [{
"Message": "The target device '/redfish/v1/UpdateService/FirmwareInventory/PCIeDevice_slot8_0xae0000.Bundle' will be updated with image '37f353d9-8019-434a-8948-6d16f3beaba0'.",
"MessageArgs": [
"/redfish/v1/UpdateService/FirmwareInventory/PCIeDevice_slot8_0xae0000.Bundle",
"37f353d9-8019-434a-8948-6d16f3beaba0"
],
"MessageId": "Update.1.0.1.TargetDetermined",
"MessageSeverity": "OK"
"Resolution": "None.",
}],
"Name": "FW_Update_6",
"StepOrder": [
"brcm-lnvgy_fw_nic_nx1.14e4.1657.17aa.4104-230.0.3.1-040_anyos_comp.lvt"
],
"Steps": {
"Description": "A collection of Job resource instances.",
"Members": [{
"Id": "brcm-lnvgy_fw_nic_nx1.14e4.1657.17aa.4104-230.0.3.1-040_anyos_comp.lvt",
"Description": null,
"EndTime": null,
"JobState": "Exception",
"JobStatus": "OK",
"Messages": [{
"Message": "Awaiting for an action to proceed with installing image '37f353d9-8019-434a-8948-6d16f3beaba0' on '/redfish/v1/UpdateService/FirmwareInventory/PCIeDevice_slot8_0xae0000.Bundle'.",
"MessageArgs": [
"37f353d9-8019-434a-8948-6d16f3beaba0",
"/redfish/v1/UpdateService/FirmwareInventory/PCIeDevice_slot8_0xae0000.Bundle"
],
"MessageId": "Update.1.0.1.AwaitToUpdate",
"MessageSeverity": "OK"
"Resolution": "Perform the requested action to advance the update operation.",
}],
"Name": "brcm-lnvgy_fw_nic_nx1.14e4.1657.17aa.4104-230.0.3.1-040_anyos_comp.lvt",
"PercentComplete": 0,
"StartTime": "2024-08-08T19:09:22+00:00",
"@odata.id": "/redfish/v1/JobService/Jobs/FW_Update_6/Steps/brcm-lnvgy_fw_nic_nx1.14e4.1657.17aa.4104-230.0.3.1-040_anyos_comp.lvt"
}],
"Name": "FW_Update_6 Job Steps",
"@odata.id": "/redfish/v1/JobService/Jobs/FW_Update_6/Steps"
},
"PercentComplete": 0,
"StartTime": "2024-08-08T19:09:21+00:00",
"@odata.id": "/redfish/v1/JobService/Jobs/FW_Update_6"
}],
"Messages": [{
"Message": "The update operation has transitioned to the job at URI '/redfish/v1/JobService/Jobs/FW_Update_6'.",
"MessageArgs": ["/redfish/v1/JobService/Jobs/FW_Update_6" ],
"MessageId": "Update.1.0.1.OperationTransitionedToJob",
"MessageSeverity": "OK"
"Resolution": "Follow the referenced job and monitor the job for further updates.",
}],
"Name": "Task 0",
"PercentComplete": 100,
"StartTime": "2024-08-08T19:09:12+00:00",
"TaskState": "Completed",
"TaskStatus": "OK"
}
Give documentation feedback