Service -
LogCollector
- Class
- VMware.Hv.LogCollector
- See also
-
LogCollectorComponentIdentifier, LogCollectorDownloadURLInfo, LogCollectorSpec, LogCollectorTaskId, LogCollectorTaskInfo, UserOrGroupId
- Since
- Horizon 7.10
Service Description
Service Interface for collecting DCT bundle from Connector Server.
Methods
LogCollector_Clean
A finish acknowledgement to notify the connection server for cleanup of
collect complete log bundles or to terminate the collect operation if is
in progress of collecting logs bundle.
Privileges
Privilege
|
Description
|
LOG_COLLECTION |
Log collection privilege is required to perform
log collection operations.
|
Parameters
Return Value
Faults
Events
Event
|
Description
|
VLSI_LOG_COLLECTION_PURGE_TASK_SUCCESS |
- Generated for each of the
log component type when the log purge request is successfully
submitted
|
VLSI_LOG_COLLECTION_ABORT_TASK_SUCCESS |
- Generated for each of the
log component type when the log abort request is successfully
submitted
|
Show WSDL type definition
LogCollector_Collect
Sends the log collection request for the set of targets
Privileges
Privilege
|
Description
|
LOG_COLLECTION |
Log collection privilege is required to perform
log collection operations.
|
Parameters
Return Value
Type
|
Description
|
LogCollectorTaskInfo[] | Array of LogCollectorTaskInfo - A unique task id is returned as part of each LogCollectorTaskInfo. It is responsibility of the caller to keep track of it for using it later for fetching the status of it. |
Faults
Events
Event
|
Description
|
VLSI_LOG_COLLECTION_INITIATE_TASK_SUCCESS |
- Generated for each of
the log component type when the log collect request is
successfully submitted
|
Show WSDL type definition
LogCollector_GetDownloadURL
Retrieves Download URL for each of specified LogCollectorTaskId
Privileges
Privilege
|
Description
|
LOG_COLLECTION |
Log collection privilege is required to perform
log collection operations.
|
Parameters
Return Value
Faults
Events
Event
|
Description
|
VLSI_LOG_COLLECTION_DOWNLOAD_TASK_SUCCESS |
- Generated for each of
the log component type when log download URL is retrieved
successfully
|
Show WSDL type definition
LogCollector_GetTaskInfo
Retrieves log collection task information for current logged-in user.
Privileges
Privilege
|
Description
|
LOG_COLLECTION |
Log collection privilege is required to perform
log collection operations.
|
Parameters
Return Value
Faults
Show WSDL type definition
LogCollector_GetTaskInfoById
Retrieves log collection task information for specified task identifiers.
Only the task identifiers owned by the current user are returned.
Privileges
Privilege
|
Description
|
LOG_COLLECTION |
Log collection privilege is required to perform
log collection operations.
|
Parameters
Return Value
Faults
Show WSDL type definition
LogCollector_List
Retrieves all the log collector task information.
Privileges
Privilege
|
Description
|
ADMINISTRATOR |
Log collection privilege is required to perform
log collection operations.
|
Parameters
Name | Type | Description |
_this | ManagedObjectReference |
A reference to the
LogCollector
used to make the method call.
|
userOrGroupId | UserOrGroupId |
- Optional field to filter the task information based on the
user or group.
- Optional parameter. If not specifing any value, this should be set to null.
|
Return Value
Type
|
Description
|
LogCollectorTaskInfo[] | Array of LogCollectorTaskInfo - All available log collector task information is returned if no parameter used.
- Log collector task information for specified user returned if parameter used.
|
Faults
Show WSDL type definition
LogCollector_Purge
Purges the log collection bundle for the provided list of targets.
Privileges
Privilege
|
Description
|
ADMINISTRATOR |
Log collection privilege is required to perform
log collection purge operations.
|
Parameters
Return Value
Faults
Events
Event
|
Description
|
VLSI_LOG_COLLECTION_PURGE_TASK_SUCCESS |
- Generated for each of the
log component type when the log purge request is successfully
submitted
|
Show WSDL type definition
© 2020 VMware, Inc. All rights reserved.
Revision Mar-2020 Version 7.12.0