LogCollectorTaskInfo

LogCollectorTaskInfo
LogCollectorTaskInfo

Information about Log collector Task.

JSON Example 
{
    "component_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
    "component_type": "AGENT",
    "end_time": 1652079610000,
    "id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
    "initiated_by": "S-1-5-21-1111111111-2222222222-3333333333-500",
    "start_time": 1656527400000,
    "task_state": "IDLE"
}
string
component_id
Optional

Represents the ID of the log collector component type for which logs are to be collected.

Represents CS id if CS logs are collected, Machine id if Agent logs are collected and

RDS server id if Agent RDS logs are collected.

string
component_type
Optional

Represents the type of the log collector component. Supported Filters : 'Equals'. This property can be used for sorting.

  • CONNECTION_SERVER: Log component type is Connection Server.
  • AGENT: Log component type is agent machine from desktop pool.
  • AGENT_RDS: Log component type is agent RDSH server from farm.
Possible values are : CONNECTION_SERVER, AGENT, AGENT_RDS,
integer As int64 As int64
end_time
Optional

End time of the log collection. Supported Filters : 'Between', 'Equals. This property can be used for sorting.

string
id
Optional

Unique identifier of a log collector task. Supported Filters : 'Equals'. This property can be used for sorting.

string
initiated_by
Optional

User identity information. Supported Filters : 'Equals. This property can be used for sorting.

integer As int64 As int64
start_time
Optional

Start time of the log collection. Supported Filters : 'Between', 'Equals. This property can be used for sorting.

string
task_state
Optional

Log collector task state. Supported Filters : 'Equals'. This property can be used for sorting.

  • IDLE: Log Collection task is in IDLE state.
  • COLLECT: Log Collection task has started collecting logs bundle.
  • COLLECT_COMPLETE: Log collection task has completed collection of logs bundle.
  • PURGE_COMPLETE: Log collection task has completed purge operation.
  • PURGE: Log collection task is in purge operation.
  • COLLECT_TIMED_OUT: Log collection task has timed out and the process has been interrupted.
  • ERROR: Log collection task has ended in error.
  • ABORT_COMPLETE: Log collection task has been aborted.
  • NON_RESPONSIVE: In rare occasions, the log collection process becomes non-responsive. A connection server restart is required to remediate it.
Possible values are : IDLE, COLLECT, COLLECT_COMPLETE, PURGE_COMPLETE, PURGE, COLLECT_TIMED_OUT, ERROR, ABORT_COMPLETE, NON_RESPONSIVE,