|
| Local Methods | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
| Name | Type | Description |
|---|---|---|
| None | ||
Methods
| Methods defined in this Managed Object |
|---|
| BrowseDiagnosticLog, GenerateLogBundles_Task, QueryDescriptions |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | 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.
|
| key | xsd: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.
|
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. |
| InvalidArgument | Thrown if the key refers to a nonexistent log file or the log file is not of type "plain". |
| 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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the DiagnosticManager used to make the method call. |
| includeDefault | 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.
|
| 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.
|
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 |
|---|---|
| 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. 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. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | 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.
|
Return Value
| Type | Description |
|---|---|
| DiagnosticManagerLogDescriptor[] |
Faults
| Type | Description |
|---|---|
| InvalidArgument | Thrown if the host does not exist or is specified on a host. |
| 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 | |
| Top of page | Local Methods | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |