Managed Object - DrConfigDiagnosticManager

Property of: DrConfigServiceInstanceContent
See also: DrConfigConfigurationTask, DrConfigSystemLogBundleInfo
Since: DrConfig API 1.0

Managed Object Description

Provides an interface to get the SRM system log bundles containing log files, cores and configuration files that are useful for diagnosis problems with SRM

Properties

Name	Type	Description
currentTask* P	ManagedObjectReference to a DrConfigConfigurationTask	Deprecated. The currently active retrieve update task or null.

*May not be presentP Required privilege: System.Read

Methods

Methods defined in this Managed Object
DeleteAllSystemLogBundles, DeleteSystemLogBundle, DrConfigDiagnosticManager_GetRunningTask, GenerateSystemLogBundle, GetSystemLogBundles, RetrieveSystemLogBundle

DeleteAllSystemLogBundles

Deletes all log bundles available on the appliance.

Required Privileges: System.View
Since: DrConfig API 7.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigDiagnosticManager used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
vmodl.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

DeleteSystemLogBundle

Instructs the server that this log bundle is no longer needed by the client that generated it. The server can then safely delete the file. Calling this function after each call to #generateSystemLogBundle() will help the server work more efficiently.

Required Privileges: System.View
Since: DrConfig API 3.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the DrConfigDiagnosticManager used to make the method call.

key P

xsd:string

The DrConfigSystemLogBundleInfo key parameter returned by a call to #generateSystemLogBundle().

Since DrConfig API 3.0

P Required privilege: key

Return Value

Type	Description
None

Faults

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

Events

Type
None

DrConfigDiagnosticManager_GetRunningTask

The currently active retrieve update task or null.

Required Privileges: System.Read
Since: DrConfig API 3.1

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigDiagnosticManager used to make the method call.

Return Value

Type	Description
ManagedObjectReference to a DrConfigConfigurationTask

Faults

Type	Description
vmodl.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

GenerateSystemLogBundle

Instructs the server to generate a system log bundle. A log bundle includes log files and other configuration information that can be used to investigate failures. The bundle can be retrieved with calls to long, long). SRM will maintain five outstanding bundles.

Required Privileges: System.View
Since: DrConfig API 3.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigDiagnosticManager used to make the method call.

Return Value

Type	Description
ManagedObjectReference to a DrConfigConfigurationTask	DrConfigConfigurationTask object that can be used to monitor the operation. ConfigurationTask.info object for the support bundle that has been generated.

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
DrConfigFaultServiceBusy	Thrown if another configuration task is already running.

Events

Type
None

GetSystemLogBundles

Retrieves the log bundles list. The list will have the keys of the log bundles created in the current config session and still available on the appliance.

Required Privileges: System.View
Since: DrConfig API 7.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigDiagnosticManager used to make the method call.

Return Value

Type	Description
DrConfigSystemLogBundleInfo[]	List of support log bundles.

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
vmodl.fault.SystemError	Thrown if something generic fails.

Events

Type
None

RetrieveSystemLogBundle

Retrieves the log bundle using the Binary datatype. The bundle is downloaded in chunks that the client is supposed to assemble into a single file. The MD5 checksum in DrConfigSystemLogBundleInfo can be used to verify that the retrieved file is correctly assembled.

Required Privileges: System.View
Since: DrConfig API 3.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigDiagnosticManager used to make the method call.
key P	xsd:string	The DrConfigSystemLogBundleInfo key parameter returned by a call to #generateSystemLogBundle(). *Since* DrConfig API 3.0
offset P	xsd:long	Byte offset into the bundle file to the start of the chunk that is to be returned. *Since* DrConfig API 3.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* DrConfig API 3.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
xsd:base64Binary	A Binary object containing the requested chunk of the bundle file. Its size may be less than the maxPageSize.

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
DrConfigFaultOutOfBounds	Thrown if offset is greater than the size of the bundle
DrConfigFaultSystemLogBundleNotFound	Thrown if the SystemLogBundleInfo key was not found.

Events

Type
None