Managed Object - DiagnosticManager(vim.DiagnosticManager)

Property of: ServiceContent
See also: DiagnosticManagerAuditRecordResult, DiagnosticManagerBundleInfo, DiagnosticManagerLogDescriptor, DiagnosticManagerLogHeader, HostSystem
Since: 2.0

Managed Object Description

Provides an interface for obtaining diagnostic information on a host (e.g. generating and retrieving support logs on the host, reading audit records). 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, EmitSyslogMark, FetchAuditRecords, GenerateLogBundles_Task, QueryDescriptions

BrowseDiagnosticLog(browse)

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

Required Privileges: Global.Diagnostics

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DiagnosticManager used to make the method call.
host* P	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. *Since* 2.0
key P	xsd:string	A string key specifying the key for the log file to browse. Keys can be obtained using the queryDescriptions method. *Since* 2.0
start* P	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. *Since* 2.0
lines* P	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. *Since* 2.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
DiagnosticManagerLogHeader	A 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
CannotAccessFile	Thrown if the key refers to a file that cannot be accessed at the present 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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="BrowseDiagnosticLog" type="vim25:BrowseDiagnosticLogRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="BrowseDiagnosticLogResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:DiagnosticManagerLogHeader"/>
                     </sequence>
                  </complexType>
               </element>

EmitSyslogMark

Issue a "mark" to syslog and the audit trail. The specified message string will be written to syslog and the audit trail. The "mark" audit record will contain the message string in its comment parameter.

Required Privileges: Global.Diagnostics
Since: 8.0.0.2

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

message P

xsd:string

The string to be used.

Since 8.0.0.2

P Required privilege: message

Return Value

Type	Description
None

Faults

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="EmitSyslogMark" type="vim25:EmitSyslogMarkRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="EmitSyslogMarkResponse">
                  <complexType/>
               </element>

FetchAuditRecords

Retrieve audit records from their storage on the specified host. Audit records are stored on the host in a (large) FIFO. The FIFO is continuously being written to due to system activities. It is the responsibility of the caller to issue reads fast enough to keep ahead of the write traffic.

Required Privileges: Global.Diagnostics
Since: vSphere API 7.0.3.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

token* P

xsd:string

The token to be used for the operation. The first call must be made without a token. All subsequent calls use the token returned in AuditRecordStatus.

Since vSphere API 7.0.3.0

*Need not be set P Required privilege: token

Return Value

Type	Description
DiagnosticManagerAuditRecordResult

Faults

Type	Description
InvalidState	The reader has failed to keep up with the write data rate. Data has been lost. It is up to the caller to decide how to react to this. One possibility is to "start again from the beginning" with a call with no token.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
SystemError	One more more errors (on the host) have occurred. One or more error strings are available to detail the issues.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="FetchAuditRecords" type="vim25:FetchAuditRecordsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="FetchAuditRecordsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:DiagnosticManagerAuditRecordResult"/>
                     </sequence>
                  </complexType>
               </element>

GenerateLogBundles_Task(generateLogBundles)

Deprecated. since version 5.0 M/N it is recommended to use the CGI interface for the host bundles, use the address instead: {@code https://<>/cgi-bin/vm-support.cgi} for the VC bundles, use {@code https://<>/appliance/support-bundle}

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.

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

Name

Type

Description

_this

ManagedObjectReference

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

includeDefault P

xsd: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.

Since 2.0

host* P

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.

Since 2.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

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

Faults

Type	Description
LogBundlingFailed	Thrown if generation of support bundle failed.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if there is a pending request to generate a support bundle.

Events

Type
None

QueryDescriptions(queryDescriptions)

Returns a list of diagnostic files for a given system.

Required Privileges: Global.Diagnostics

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

host* P

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.

Since 2.0

*Need not be set P Required privilege: host

Return Value

Type	Description
DiagnosticManagerLogDescriptor[]

Faults

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryDescriptions" type="vim25:QueryDescriptionsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryDescriptionsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:DiagnosticManagerLogDescriptor" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>