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:

Notion of an active diagnostic partition that is selected from a set of available partitions.
Ability to create a diagnostic partition that gets added to the list of available partitions and could be made active.

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostDiagnosticSystem used to make the method call.
spec	HostDiagnosticPartitionCreateSpec

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault	on some internal failure while trying to create the diagnostic partition or to activate the diagnostic partition.
InvalidArgument	Thrown if an invalid storage type is specified or the specified disk is unable to accommodate a new diagnostic partition.
NotFound	Thrown if the specified disk cannot be found.
NotSupported	Thrown if the host is not an ESX Server.
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="CreateDiagnosticPartition" type="vim25:CreateDiagnosticPartitionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateDiagnosticPartitionResponse">
            <complexType/>
         </element>

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

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

Return Value

Type	Description
HostDiagnosticPartition[]

Faults

Type	Description
HostConfigFault	on some internal failure while setting the active partition.
NotSupported	Thrown if the host is not an ESX Server.
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="QueryAvailablePartition" type="vim25:QueryAvailablePartitionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryAvailablePartitionResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:HostDiagnosticPartition" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostDiagnosticSystem used to make the method call.
diskUuid	xsd:string	See HostScsiDisk See uuid
diagnosticType	xsd:string	See HostScsiDisk See uuid

Return Value

Type	Description
HostDiagnosticPartitionCreateDescription

Faults

Type	Description
HostConfigFault	on some internal failure while trying to query information about the disk. See HostScsiDisk See uuid
InvalidArgument	Thrown if an invalid storage type is specified or the specified disk is unable to accommodate a new diagnostic partition. See HostScsiDisk See uuid
NotFound	Thrown if the specified disk cannot be found. See HostScsiDisk See uuid
NotSupported	Thrown if the host is not an ESX Server. See HostScsiDisk See uuid
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="QueryPartitionCreateDesc" type="vim25:QueryPartitionCreateDescRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryPartitionCreateDescResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:HostDiagnosticPartitionCreateDescription"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostDiagnosticSystem used to make the method call.
storageType	xsd:string
diagnosticType	xsd:string

Return Value

Type	Description
HostDiagnosticPartitionCreateOption[]

Faults

Type	Description
HostConfigFault	on some internal failure while querying the create options.
InvalidArgument	Thrown if an invalid storage type is specified.
NotSupported	Thrown if the host is not an ESX Server.
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="QueryPartitionCreateOptions" type="vim25:QueryPartitionCreateOptionsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryPartitionCreateOptionsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:HostDiagnosticPartitionCreateOption" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	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
HostConfigFault	on some internal failure while selecting the active partition.
InvalidArgument	Thrown if the partition is not a diagnostic partition.
NotFound	Thrown if the diagnostic partition does not exist.
NotSupported	Thrown if the host is not an ESX Server.
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="SelectActivePartition" type="vim25:SelectActivePartitionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="SelectActivePartitionResponse">
            <complexType/>
         </element>