deb-python-pyvmomi/docs/vim/host/DiagnosticSystem.rst

vim.host.DiagnosticSystem

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.

Attributes

activePartition (vim.host.DiagnosticPartition):

The currently active diagnostic partition.

Methods

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.

Privilege:

Host.Config.Storage

Args:

Returns:

[vim.host.DiagnosticPartition]:

Raises:

vim.fault.HostConfigFault:

on some internal failure while setting the active partition.

vmodl.fault.NotSupported:

if the host is not an ESX Server.

SelectActivePartition(partition):

Changes the active diagnostic partition to a different partition. Setting a NULL partition will result in unsetting the diagnostic partition.

Privilege:

Host.Config.Storage

Args:

partition (vim.host.ScsiDisk.Partition, optional):

Returns:

None

Raises:

vim.fault.NotFound:

if the diagnostic partition does not exist.

vim.fault.HostConfigFault:

on some internal failure while selecting the active partition.

vmodl.fault.NotSupported:

if the host is not an ESX Server.

vmodl.fault.InvalidArgument:

if the partition is not a diagnostic partition.

QueryPartitionCreateOptions(storageType, diagnosticType):

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.

Privilege:

Host.Config.Storage

Args:

storageType (str):

diagnosticType (str):

Returns:

[vim.host.DiagnosticPartition.CreateOption]:

Raises:

vim.fault.HostConfigFault:

on some internal failure while querying the create options.

vmodl.fault.NotSupported:

if the host is not an ESX Server.

vmodl.fault.InvalidArgument:

if an invalid storage type is specified.

QueryPartitionCreateDesc(diskUuid, diagnosticType):

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

Privilege:

Host.Config.Storage

Args:

diskUuid (str):

See HostScsiDisk See uuid

diagnosticType (str):

See HostScsiDisk See uuid

Returns:

vim.host.DiagnosticPartition.CreateDescription:

Raises:

vim.fault.NotFound:

if the specified disk cannot be found.See HostScsiDisk See uuid

vim.fault.HostConfigFault:

on some internal failure while trying to query information about the disk.See HostScsiDisk See uuid

vmodl.fault.NotSupported:

if the host is not an ESX Server.See HostScsiDisk See uuid

vmodl.fault.InvalidArgument:

if an invalid storage type is specified or the specified disk is unable to accommodate a new diagnostic partition.See HostScsiDisk See uuid

CreateDiagnosticPartition(spec):

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.

Privilege:

Host.Config.Storage

Args:

spec (vim.host.DiagnosticPartition.CreateSpec):

Returns:

None

Raises:

vim.fault.NotFound:

if the specified disk cannot be found.

vim.fault.HostConfigFault:

on some internal failure while trying to create the diagnostic partition or to activate the diagnostic partition.

vmodl.fault.NotSupported:

if the host is not an ESX Server.

vmodl.fault.InvalidArgument:

if an invalid storage type is specified or the specified disk is unable to accommodate a new diagnostic partition.