Scripting Object - VcHostDiagnosticSystem

Scripting-object corresponding to
HostDiagnosticSystem
Attribute of
VcHostConfigManager

Scripting Object Description

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

Attributes

Name Type Description
activePartitionVcHostDiagnosticPartition

@since VI API 2.5
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createDiagnosticPartition, createTrigger, queryAvailablePartition, queryPartitionCreateDesc, queryPartitionCreateOptions, selectActivePartition

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

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. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcHostDiagnosticPartition []

selectActivePartition

Changes the active diagnostic partition to a different partition. Setting a NULL partition will result in unsetting the diagnostic partition. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostScsiDiskPartition


Return Value

Type Description
None

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
VcHostDiagnosticPartitionCreateOption []

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostDiagnosticPartitionCreateSpec


Return Value

Type Description
None

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
VcHostDiagnosticPartitionCreateDescription