Managed Object - DiagnosticManager

Property of
ServiceContent
See also
DiagnosticManagerBundleInfo, DiagnosticManagerLogDescriptor, DiagnosticManagerLogHeader, HostSystem

Managed Object Description

Provides an interface to get low-level debugging logs or diagnostic bundles for a server. For VirtualCenter, this includes the log files for the server daemon. For an ESX Server host, this includes detailed log files for the VMkernel.

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
BrowseDiagnosticLog, GenerateLogBundles_Task, QueryDescriptions

BrowseDiagnosticLog

Returns part of a log file. Log entries are always returned chronologically, typically with the newest event last.
Required Privileges
Global.Diagnostics

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DiagnosticManager used to make the method call.
host*ManagedObjectReference
to a HostSystem
Specifies the host. If not specified, then it defaults to the default server. For example, if called on VirtualCenter, then the value defaults to VirtualCenter logs.
keyxsd:string A string key specifying the key for the log file to browse. Keys can be obtained using the queryDescriptions method.
start*xsd:int The line number for the first entry to be returned. If the parameter is not specified, then the operation returns with lines starting from the top of the log.
lines*xsd:int The number of lines to return. If not specified, then all lines are returned from the start value to the end of the file.
*Need not be set

Return Value

Type Description
DiagnosticManagerLogHeaderA LogHeader that includes the log lines. Sometimes fewer log lines are returned than were requested. For example, fewer lines are returned than expected if the client requests lines that do not exist or if the server limits the number of lines that it returns. If zero lines are returned, then the end of the log file may have been reached.

Faults

Type Description
CannotAccessFileThrown if the key refers to a file that cannot be accessed at the present time.
InvalidArgumentThrown if the key refers to a nonexistent log file or the log file is not of type "plain".
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



GenerateLogBundles_Task

Instructs the server to generate diagnostic bundles. A diagnostic bundle includes log files and other configuration information that can be used to investigate potential server issues. Virtual machine and guest operation system state is excluded from diagnostic bundles.

Required Privileges
Global.Diagnostics

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DiagnosticManager used to make the method call.
includeDefaultxsd:boolean Specifies if the bundle should include the default server. If called on a VirtualCenter server, then this means the VirtualCenter diagnostic files. If called directly on a host, then includeDefault must be set to true.
host*ManagedObjectReference[]
to a HostSystem[]
Lists hosts that are included. This is only used when called on VirtualCenter. If called directly on a host, then this parameter must be empty.
*Need not be set

Return Value

Type Description
ManagedObjectReference
to a Task
This method returns a Task object with which to monitor the operation. Upon success, the info.result property in the Task contains a list of DiagnosticManagerBundleInfo objects for each diagnostic bundle that has been generated.

Faults

Type Description
LogBundlingFailedThrown if generation of support bundle failed.

The caller can download the bundles using an HTTP GET operation for each 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.

RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



QueryDescriptions

Returns a list of diagnostic files for a given system.
Required Privileges
Global.Diagnostics

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DiagnosticManager used to make the method call.
host*ManagedObjectReference
to a HostSystem
Specifies the host. If not specified, then it defaults to the server itself. For example, if called on VirtualCenter, then the value defaults to VirtualCenter logs. When called on an ESX server host, the host should not be specified.
*Need not be set

Return Value

Type Description
DiagnosticManagerLogDescriptor[]

Faults

Type Description
InvalidArgumentThrown if the host does not exist or is specified on a host.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition