Managed Object - HostDiagnosticSystem

Property of
HostConfigManager
See also
HostDiagnosticPartition, HostDiagnosticPartitionCreateDescription, HostDiagnosticPartitionCreateOption, HostDiagnosticPartitionCreateSpec, HostScsiDiskPartition

Managed Object Description

The DiagnosticSystem managed object is used to configure the diagnostic mechanisms specific to the host. The DiagnosticSystem interface supports the following concepts:

Properties

Name Type Description
activePartition*HostDiagnosticPartition The currently active diagnostic partition.
*May not be present

Methods

Methods defined in this Managed Object
CreateDiagnosticPartition, QueryAvailablePartition, QueryPartitionCreateDesc, QueryPartitionCreateOptions, SelectActivePartition

CreateDiagnosticPartition

Creates a diagnostic partition according to the provided create specification. On success, this method will create the partition and make the partition the active diagnostic partition if specified. On failure, the diagnostic partition may exist but may not be active if the partition was supposed to be made active.
Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDiagnosticSystem used to make the method call.
specHostDiagnosticPartitionCreateSpec

Return Value

Type Description
None

Faults

Type Description
HostConfigFaulton some internal failure while trying to create the diagnostic partition or to activate the diagnostic partition.
InvalidArgumentThrown if an invalid storage type is specified or the specified disk is unable to accommodate a new diagnostic partition.
NotFoundThrown if the specified disk cannot be found.
NotSupportedThrown if the host is not an ESX Server.
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



QueryAvailablePartition

Retrieves a list of available diagnostic partitions. The server will provide the list in order of preference. In general, local diagnostic partitions are better than shared diagnostic partitions because of the impossibility of multiple servers sharing the same partition. The most preferred diagnostic partition will be first in the array.
Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDiagnosticSystem used to make the method call.

Return Value

Type Description
HostDiagnosticPartition[]

Faults

Type Description
HostConfigFaulton some internal failure while setting the active partition.
NotSupportedThrown if the host is not an ESX Server.
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



QueryPartitionCreateDesc

For a disk, query for the diagnostic partition creation description. The description details how the diagnostic partition will be created on the disk and provides a creation specification that is needed to invoke the create operation.
See HostScsiDisk
See uuid
Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDiagnosticSystem used to make the method call.
diskUuidxsd:string
See HostScsiDisk
See uuid
diagnosticTypexsd:string
See HostScsiDisk
See uuid

Return Value

Type Description
HostDiagnosticPartitionCreateDescription

Faults

Type Description
HostConfigFaulton some internal failure while trying to query information about the disk.
See HostScsiDisk
See uuid
InvalidArgumentThrown if an invalid storage type is specified or the specified disk is unable to accommodate a new diagnostic partition.
See HostScsiDisk
See uuid
NotFoundThrown if the specified disk cannot be found.
See HostScsiDisk
See uuid
NotSupportedThrown if the host is not an ESX Server.
See HostScsiDisk
See uuid
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



QueryPartitionCreateOptions

Retrieves a list of disks that can be used to contain a diagnostic partition. This list will contain disks that have sufficient space to contain a diagnostic partition of the specific type.

The choices will be returned in the order that is most preferable as determined by the system.

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDiagnosticSystem used to make the method call.
storageTypexsd:string
diagnosticTypexsd:string

Return Value

Type Description
HostDiagnosticPartitionCreateOption[]

Faults

Type Description
HostConfigFaulton some internal failure while querying the create options.
InvalidArgumentThrown if an invalid storage type is specified.
NotSupportedThrown if the host is not an ESX Server.
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



SelectActivePartition

Changes the active diagnostic partition to a different partition. Setting a NULL partition will result in unsetting the diagnostic partition.
Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDiagnosticSystem used to make the method call.
partition*HostScsiDiskPartition
*Need not be set

Return Value

Type Description
None

Faults

Type Description
HostConfigFaulton some internal failure while selecting the active partition.
InvalidArgumentThrown if the partition is not a diagnostic partition.
NotFoundThrown if the diagnostic partition does not exist.
NotSupportedThrown if the host is not an ESX Server.
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