Service - LogCollector
Java Class
com.omnissa.vdi.vlsi.binding.vdi.utils.logcollector.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
Methods defined in this Service: LogCollector_Clean, LogCollector_Collect, LogCollector_GetDownloadURL, LogCollector_GetTaskInfo, LogCollector_GetTaskInfoById, LogCollector_List, LogCollector_Purge
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the LogCollector used to make the method call. |
| logCollectorTaskIdList | LogCollectorTaskId[] |
Return Value
| Type | Description |
|---|---|
| None |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| PartialFailureFault | 2 3 |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the LogCollector used to make the method call. |
| logCollectorSpecList | LogCollectorSpec[] |
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
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| PartialFailureFault | 4 3 |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
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
Retrieves Download URL for each of specified LogCollectorTaskId
Privileges
| Privilege | Description |
|---|---|
| LOG_COLLECTION | 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. |
| logCollectorTaskIdList | LogCollectorTaskId[] |
Return Value
| Type | Description |
|---|---|
| LogCollectorDownloadURLInfo[] | Array of LogCollectorDownloadURLInfo |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| PartialFailureFault | 4 3 |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the LogCollector used to make the method call. |
Return Value
| Type | Description |
|---|---|
| LogCollectorTaskInfo[] | Array of LogCollectorTaskInfo - Log collector task information for current user is returned. |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| PartialFailureFault | 4 3 |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the LogCollector used to make the method call. |
| logCollectorTaskIdList | LogCollectorTaskId[] | - A unique task identifier generated from log collect request for monitoring the status. |
Return Value
| Type | Description |
|---|---|
| LogCollectorTaskInfo[] | Array of LogCollectorTaskInfo |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| PartialFailureFault | 4 3 |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
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. 1 |
Return Value
| Type | Description |
|---|---|
| LogCollectorTaskInfo[] | Array of LogCollectorTaskInfo 5 6 |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| LogCollectorFault | |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the LogCollector used to make the method call. |
| componentIdentifiers | LogCollectorComponentIdentifier[] |
Return Value
| Type | Description |
|---|---|
| LogCollectorTaskInfo[] | Array of LogCollectorTaskInfo |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| PartialFailureFault | 4 3 |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
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
-
This parameter need not be set. ↩
-
Contains null for which the request is processed successfully. ↩
-
Contains array of LogCollectorTaskInfo for which the request is processed successfully. ↩↩↩↩↩
-
All available log collector task information is returned if no parameter used. ↩
-
Log collector task information for specified user returned if parameter used. ↩