View API


Data Object - LogCollectorTaskInfo

Class
VMware.Hv.LogCollectorTaskInfo
Returned by
LogCollector_Collect, LogCollector_GetTaskInfo, LogCollector_GetTaskInfoById, LogCollector_List, LogCollector_Purge
See also
LogCollectorComponentIdentifier, LogCollectorTaskId, UserOrGroupId
Since
Horizon 7.10

Data Object Description

Task information for a log collector component.

Data Object Properties

Properties

Name Type Description
logCollectorComponentIdLogCollectorComponentIdentifier

Log component identifier.
  • This property need not be set.
idLogCollectorTaskId

Unique identifier of a log collector task.
  • This property need not be set.
startTimexsd:dateTime

Start time of the log collection.
  • This property need not be set.
endTimexsd:dateTime

End time of the log collection.
  • This property need not be set.
initiatedByUserOrGroupId

User identity information.
logCollectorTaskStatexsd:string

Log collector task state.
  • This property will be one of:
    Value Description
    "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.
    "NON_RESPONSIVE"In rare occasions, the log collection process becomes non-responsive. A connection server restart is required to remediate it.