# Managed Object - ConverterDiagnosticManager

Property of
  ConverterHelperServiceContent, ConverterServiceContent
Extended by
  ConverterServerDiagnosticManager
See also
  ConverterComputerSpec, ConverterDiagnosticManagerTaskLogBundleInfo, ConverterTask
Since
  Converter API 1.0

## Managed Object Description

Provides an interface to get server and task related diagnostic bundles containing low-level debugging logs. For conversion tasks this includes the converter Agent logs as well as the related server logs.

Properties

Name | Type | Description
--- | --- | ---
None

Methods

Methods defined in this Managed Object
ConverterDeleteTaskLogBundle, ConverterGenerateLogBundle, ConverterGenerateTaskLogBundle, ConverterRetrieveTaskLogBundle, ConverterRetrieveTaskLogBundleUrl

# ConverterDeleteTaskLogBundle

Instructs the server that this diagnostic bundle is no longer needed by the client that generated it. The server can then safely delete the file either immediately or after a delay. Calling this function after each call to generateTaskLogBundle will help the server work more efficiently.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterDiagnosticManager used to make the method call.
key P | xsd:string | The TaskLogBundleInfo key parameter returned by a call to generateTaskLogBundle. Since Converter API 1.0

P Required privilege: key

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
CannotDeleteFile |
NotFound | Thrown if the TaskLogBundleInfo key was not found.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# ConverterGenerateLogBundle

Instructs the server to generate diagnostic bundle not associated with a particular task. A diagnostic bundle includes log files and other configuration information that can be used to investigate failures.

Required Privileges
  None
Since
  Converter API 2.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterDiagnosticManager used to make the method call.
source* P | ConverterComputerSpec | Specifies ComputerSpec object of the source for which to generate the diagnostic bundle. Since Converter API 2.0

*Need not be set P Required privilege: source

Return Value

Type | Description
--- | ---
ConverterDiagnosticManagerTaskLogBundleInfo | A TaskLogBundleInfo object for the diagnostic bundle that has been generated.

Faults

Type | Description
--- | ---
LogBundlingFailed | Thrown if generation of support bundle failed. The caller can download the bundle using an HTTP GET operation for the URL returned by retrieveTaskLogBundleUrl or alternatively the bundle can be retrieved with calls to retrieveTaskLogBundle. Bundles are usually available for at least 24 hours, but the caller should not assume that the returned URLs are valid indefinitely. Servers often automatically delete generated diagnostic bundles after some given period of time.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# ConverterGenerateTaskLogBundle

Instructs the server to generate diagnostic bundle for the specified task. A diagnostic bundle includes log files and other configuration information that can be used to investigate failures.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterDiagnosticManager used to make the method call.
task* P | ManagedObjectReference to a ConverterTask | Specifies the Task object for which to generate the diagnostic bundle. If this parameter is not specified then only the server diagnostic logs are added to the bundle. Since Converter API 1.0

*Need not be set P Required privilege: task

Return Value

Type | Description
--- | ---
ConverterDiagnosticManagerTaskLogBundleInfo | A TaskLogBundleInfo object for the diagnostic bundle that has been generated.

Faults

Type | Description
--- | ---
InvalidState | Thrown if the Task is still running.
LogBundlingFailed | Thrown if generation of support bundle failed. The caller can download the bundle using an HTTP GET operation for the URL returned by retrieveTaskLogBundleUrl or alternatively the bundle can be retrieved with calls to retrieveTaskLogBundle. Bundles are usually available for at least 24 hours, but the caller should not assume that the returned URLs are valid indefinitely. Servers often automatically delete generated diagnostic bundles after some given period of time.
NoPermission | Thrown if the user has no permission to access the diagnostic logs for this task.
NotFound | Thrown if the Task was not found on the server.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# ConverterRetrieveTaskLogBundle

Retrieves the diagnostic bundle using Base64 encoding. This method is useful when the server does not support HTTP GET requests. The bundle is downloaded in chunks that the client is supposed to assemble into a single file. The CRC checksum in TaskLogBundleInfo can be used to verify that the retrieved file is correctly assembled.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterDiagnosticManager used to make the method call.
key P | xsd:string | The TaskLogBundleInfo key parameter returned by a call to generateTaskLogBundle. Since Converter API 1.0
offset P | xsd:long | Byte offset into the bundle file to the start of the chunk that is to be returned. Since Converter API 1.0
maxPageSize P | xsd:long | Maximum size in bytes of the chunk to be returned. This parameter can be used to control the size and number of chunks with which to retrieve a bundle. The maximum page size can also be limited internally by the server so the size of the returned chunk may be smaller than maxPageSize even if the bundle file contains more bytes. Since Converter API 1.0

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
xsd:string | A Base64 encoded string containing the requested chunk of the bundle file. Its length may be less than the maxPageSize.

Faults

Type | Description
--- | ---
NotFound | Thrown if the TaskLogBundleInfo key was not found.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# ConverterRetrieveTaskLogBundleUrl

Returns the location from which the diagnostic bundle can be downloaded. The host part of the URL is returned as '*' if the host name to be used is the name of the server to which the call was made. For example, if the call is made to vcsrv1.domain1.com, and the bundle is available for download from http://vcsrv1.domain1.com/diagnostics/bundle.zip, the URL returned may be http:// * /diagnostics/bundle.zip (without spaces). The client replaces the asterisk with the server name on which it invoked the call.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterDiagnosticManager used to make the method call.
key P | xsd:string | The TaskLogBundleInfo key parameter returned by a call to generateTaskLogBundle. Since Converter API 1.0

P Required privilege: key

Return Value

Type | Description
--- | ---
xsd:string | A URL for the location of the diagnostic bundle.

Faults

Type | Description
--- | ---
InvalidState | Thrown if the server does not support HTTP GET. The caller can download the bundle using an HTTP GET operation for the returned URL. Bundles are usually available for at least 24 hours, but the caller should not assume that the returned URLs are valid indefinitely. Servers often automatically delete generated diagnostic bundles after some given period of time.
NotFound | Thrown if the TaskLogBundleInfo key was not found.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None