Class VMwareVirtualMachine

Namespace

CENTREL.XIA.Configuration.Types

Assembly

CENTREL.XIA.Configuration.Types.dll

Represents a VMware virtual machine.

public class VMwareVirtualMachine : VMwareManagedObject, IComparable<VMwareManagedObject>, IComparable<VMwareVirtualMachine>

Inheritance

object

VMwareManagedObject

VMwareVirtualMachine

Implements

IComparable<VMwareManagedObject>

IComparable<VMwareVirtualMachine>

Inherited Members

VMwareManagedObject.CompareTo(VMwareManagedObject)

VMwareManagedObject.Alarms

VMwareManagedObject.Name

VMwareManagedObject.ManagedObjectID

VMwareManagedObject.Permissions

Constructors

VMwareVirtualMachine()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.VMwareVirtualMachine class.

public VMwareVirtualMachine()

Properties

ConfigurationParameters

Gets or sets the additional configuration options for this virtual machine.

public VMwareConfigurationParameterCollection ConfigurationParameters { get; set; }

Property Value

VMwareConfigurationParameterCollection

CoresPerSocket

Gets or sets the number of cores per socket. Prior to vSphere 5.0 this value will always be set to 1.

public int CoresPerSocket { get; set; }

Property Value

int

CpuCount

Gets or sets the number of CPUs assigned to this virtual machine.

public int CpuCount { get; set; }

Property Value

int

CpuHotAddEnabled

Gets or sets whether CPU hot add is enabled for the virtual machine.

public BooleanOption CpuHotAddEnabled { get; set; }

Property Value

BooleanOption

CpuIdMaskType

Gets or sets the CPU mask identifier type.

public VMwareVirtualMachineCpuIdMaskType CpuIdMaskType { get; set; }

Property Value

VMwareVirtualMachineCpuIdMaskType

CpuMaskIdTypeString

Gets or sets the CPU mask identifier type as a human readable string.

public string CpuMaskIdTypeString { get; set; }

Property Value

string

Description

Gets or sets the description of this virtual machine.

public string Description { get; set; }

Property Value

string

FileLayout

Gets or sets the file layout for this virtual machine.

public VMwareVirtualMachineFileLayout FileLayout { get; set; }

Property Value

VMwareVirtualMachineFileLayout

Guest

Gets or sets the information about the guest operating system running on this virtual machine.

public VMwareVirtualMachineGuestInformation Guest { get; set; }

Property Value

VMwareVirtualMachineGuestInformation

GuestFullName

Gets or sets the configured guest operating system name.

public string GuestFullName { get; set; }

Property Value

string

HardwareDevices

Gets or sets the hardware items configured within this virtual machine.

public VMwareVirtualHardwareDevices HardwareDevices { get; set; }

Property Value

VMwareVirtualHardwareDevices

Host

Gets or sets the host entity hosting this virtual machine.

public VMwareManagedObjectReference Host { get; set; }

Property Value

VMwareManagedObjectReference

IsTemplate

Gets or sets whether this virtual machine is a template.

public BooleanOption IsTemplate { get; set; }

Property Value

BooleanOption

MemoryHotAddEnabled

Gets or sets whether memory hot add is enabled for the virtual machine.

public BooleanOption MemoryHotAddEnabled { get; set; }

Property Value

BooleanOption

MemorySize

Gets or sets the amount of memory allocated in MB.

public int MemorySize { get; set; }

Property Value

int

Networks

Gets or sets the names of the networks to which this virtual machine is connected.

public SerializableStringCollection Networks { get; set; }

Property Value

SerializableStringCollection

PowerState

Gets or sets the power state of the virtual machine at the time of the scan.

public VMwareVirtualMachinePowerState PowerState { get; set; }

Property Value

VMwareVirtualMachinePowerState

PowerStateString

Gets the power state of the virtual machine at the time of the scan as a human readable string.

public string PowerStateString { get; set; }

Property Value

string

QualifiedName

Gets or sets the full datacenter qualified name of this virtual machine if required - for example "Datastore1 [HQ]".

public string QualifiedName { get; set; }

Property Value

string

ResourceAllocation

Gets or sets the resource allocation settings for this virtual machine.

public VMwareResourceAllocation ResourceAllocation { get; set; }

Property Value

VMwareResourceAllocation

Screenshot

Gets or sets the screenshot assigned to this virtual machine in PNG format.

public byte[] Screenshot { get; set; }

Property Value

byte[]

ScreenshotImage

Gets or sets the screenshot assigned to this virtual machine in PNG format.

public Bitmap ScreenshotImage { get; set; }

Property Value

Bitmap

Snapshots

Gets or sets the snapshots configured for the virtual machine.

public VMwareVirtualMachineSnapshots Snapshots { get; set; }

Property Value

VMwareVirtualMachineSnapshots

ToolsConfiguration

Gets or sets the configuration of the VMware tools on this virtual machine.

public VMwareToolsConfiguration ToolsConfiguration { get; set; }

Property Value

VMwareToolsConfiguration

UUID

Gets or sets the unique ID of this virtual machine - for example "42073d13-466e-f41c-9fcd-c87c3ade21c0".

public string UUID { get; set; }

Property Value

string

VMPathName

Gets or sets the path to the virtual machine's VMX file - for example "[datastore1 (1)] CORP-DC01/CORP-DC01.vmx".

public string VMPathName { get; set; }

Property Value

string

Version

Gets or sets the version of this virtual machine - for example "vmx-04".

public string Version { get; set; }

Property Value

string

VersionString

Gets the version of this virtual machine - for example "ESXi 6.0 and later (VM version 11)".

public string VersionString { get; set; }

Property Value

string

Methods

CompareTo(VMwareVirtualMachine)

Compares two VMware virtual machines to allow sorting alphabetically by qualified name.

public int CompareTo(VMwareVirtualMachine other)

Parameters

other VMwareVirtualMachine

The CENTREL.XIA.Configuration.Types.VMwareVirtualMachine to compare to.

Returns

int

The sort order of the two CENTREL.XIA.Configuration.Types.VMwareVirtualMachine.