Table of Contents

Class HyperVServerVirtualMachine

Namespace
CENTREL.XIA.Configuration.Types
Assembly
CENTREL.XIA.Configuration.Types.dll

Represents a virtual machine in a Hyper-V server.

public class HyperVServerVirtualMachine : GlobalSerializableBase, IComparable<HyperVServerVirtualMachine>
Inheritance
HyperVServerVirtualMachine
Implements

Constructors

HyperVServerVirtualMachine()

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

public HyperVServerVirtualMachine()

Properties

AutomaticCriticalErrorAction

Gets or sets the automatic critical error action. This only applies to Windows Server 2016 and above.

public HyperVServerVirtualMachineAutomaticCriticalErrorAction AutomaticCriticalErrorAction { get; set; }

Property Value

HyperVServerVirtualMachineAutomaticCriticalErrorAction

AutomaticCriticalErrorActionString

Gets the automatic critical error action as a human readable string. This only applies to Windows Server 2016 and above.

public string AutomaticCriticalErrorActionString { get; set; }

Property Value

string

AutomaticCriticalErrorActionTimeout

Gets or sets the timeout before performing the automatic critical error action in minutes. This only applies to Windows Server 2016 and above.

public int AutomaticCriticalErrorActionTimeout { get; set; }

Property Value

int

AutomaticStartAction

Gets or sets the automatic start action for the virtual machine.

public HyperVServerVirtualMachineAutomaticStartAction AutomaticStartAction { get; set; }

Property Value

HyperVServerVirtualMachineAutomaticStartAction

AutomaticStartActionString

Gets the automatic start action for the virtual machine as a human readable string.

public string AutomaticStartActionString { get; set; }

Property Value

string

AutomaticStartDelay

Gets or sets the automatic start delay for the virtual machine in seconds.

public int AutomaticStartDelay { get; set; }

Property Value

int

AutomaticStopAction

Gets or sets the automatic stop action for the virtual machine.

public HyperVServerVirtualMachineAutomaticStopAction AutomaticStopAction { get; set; }

Property Value

HyperVServerVirtualMachineAutomaticStopAction

AutomaticStopActionString

Gets the automatic stop action for the virtual machine as a human readable string.

public string AutomaticStopActionString { get; set; }

Property Value

string

BaseboardSerialNumber

Gets or sets the serial number of the baseboard of the virtual machine.

public string BaseboardSerialNumber { get; set; }

Property Value

string

Bios

Gets or sets the BIOS settings. This only applies to generation 1 virtual machines.

public HyperVServerVirtualMachineBiosSettings Bios { get; set; }

Property Value

HyperVServerVirtualMachineBiosSettings

ChassisAssetTag

Gets or sets the chassis asset tag.

public string ChassisAssetTag { get; set; }

Property Value

string

ChassisSerialNumber

Gets or sets the chassis serial number.

public string ChassisSerialNumber { get; set; }

Property Value

string

CheckpointSettings

Gets or sets the checkpoint settings.

public HyperVServerVirtualMachineCheckpointSettings CheckpointSettings { get; set; }

Property Value

HyperVServerVirtualMachineCheckpointSettings

Checkpoints

Gets or sets the checkpoints.

public HyperVServerVirtualMachineCheckpoints Checkpoints { get; set; }

Property Value

HyperVServerVirtualMachineCheckpoints

CollectionIndex

Gets the index of the item when used by the data comparer. This is required because multiple virtual machines can be created with the same name.

public string CollectionIndex { get; }

Property Value

string

ComPorts

Gets or sets the COM ports. This only applies to Generation 1 virtual machines.

public HyperVServerVirtualMachineComPorts ComPorts { get; set; }

Property Value

HyperVServerVirtualMachineComPorts

Description

Gets or sets the description of the virtual machine.

public string Description { get; set; }

Property Value

string

DuplicateNameOffset

Gets or sets the duplicate name offset. Used by the data comparer.

public int DuplicateNameOffset { get; set; }

Property Value

int

DvdDrives

Gets or sets the DVD drives in the virtual machine.

public HyperVServerVirtualMachineDvdDrives DvdDrives { get; set; }

Property Value

HyperVServerVirtualMachineDvdDrives

FibreChannelAdapters

Gets or sets the fibre channel adapters in the virtual machine.

public HyperVServerVirtualMachineFibreChannelAdapters FibreChannelAdapters { get; set; }

Property Value

HyperVServerVirtualMachineFibreChannelAdapters

Firmware

Gets or sets the firmware settings for the virtual machine. This only applies to generation 2 virtual machines.

public HyperVServerVirtualMachineFirmwareSettings Firmware { get; set; }

Property Value

HyperVServerVirtualMachineFirmwareSettings

FloppyDiskDrive

Gets or sets the floppy disk drive in the virtual machine.

public HyperVServerVirtualMachineFloppyDiskDrive FloppyDiskDrive { get; set; }

Property Value

HyperVServerVirtualMachineFloppyDiskDrive

Generation

Gets or sets the generation of the virtual machine. This applies to Windows Server 2012 R2 and above.

public int Generation { get; set; }

Property Value

int

GuestInformation

Gets or sets the virtual machine guest information.

public HyperVServerVirtualMachineGuestInformation GuestInformation { get; set; }

Property Value

HyperVServerVirtualMachineGuestInformation

HardDiskDrives

Gets or sets the hard disk drives in the virtual machine.

public HyperVServerVirtualMachineHardDiskDrives HardDiskDrives { get; set; }

Property Value

HyperVServerVirtualMachineHardDiskDrives

IPAddresses

Gets the IP addresses assigned to all network adapters in the virtual machine. The virtual machine must be running for this information to be available.

public SerializableStringCollection IPAddresses { get; set; }

Property Value

SerializableStringCollection

Identifier

Gets or sets the unique identifier of the virtual machine.

public Guid Identifier { get; set; }

Property Value

Guid

IntegrationServices

Gets or sets the integration services settings.

public HyperVServerVirtualMachineIntegrationServices IntegrationServices { get; set; }

Property Value

HyperVServerVirtualMachineIntegrationServices

IsClustered

Gets or sets whether the virtual machine is clustered and available to multiple nodes.

public BooleanOption IsClustered { get; set; }

Property Value

BooleanOption

IsCritical

Gets whether the virtual machine is in a critical state.

public BooleanOption IsCritical { get; set; }

Property Value

BooleanOption

KeyStorageDrive

Gets or sets the key storage drive settings for the virtual machine. This only applies to generation 1 virtual machines. This only applies to Windows Server 2016 and above.

public HyperVServerVirtualMachineKeyStorageDrive KeyStorageDrive { get; set; }

Property Value

HyperVServerVirtualMachineKeyStorageDrive

Memory

Gets or sets the memory settings for the virtual machine.

public HyperVServerVirtualMachineMemorySettings Memory { get; set; }

Property Value

HyperVServerVirtualMachineMemorySettings

Name

Gets or sets the name of the virtual machine.

public string Name { get; set; }

Property Value

string

NetworkAdapters

Gets or sets the network adapters in the virtual machine.

public HyperVServerVirtualMachineNetworkAdapters NetworkAdapters { get; set; }

Property Value

HyperVServerVirtualMachineNetworkAdapters

Path

Gets or sets the virtual machine path.

public string Path { get; set; }

Property Value

string

Processor

Gets or sets the processor settings for the virtual machine.

public HyperVServerVirtualMachineProcessorSettings Processor { get; set; }

Property Value

HyperVServerVirtualMachineProcessorSettings

Replication

Gets or sets the replication settings for the virtual machine.

public HyperVServerVirtualMachineReplicationSettings Replication { get; set; }

Property Value

HyperVServerVirtualMachineReplicationSettings

Security

Gets or sets the security settings for the virtual machine. This only applies to Windows Server 2012 R2 and above.

public HyperVServerVirtualMachineSecuritySettings Security { get; set; }

Property Value

HyperVServerVirtualMachineSecuritySettings

SerialNumber

Gets or sets the serial number of the virtual machine. This is the BIOS serial number.

public string SerialNumber { get; set; }

Property Value

string

SmartPagingFilePath

Gets or sets the smart paging file path.

public string SmartPagingFilePath { get; set; }

Property Value

string

State

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

public HyperVServerVirtualMachineState State { get; set; }

Property Value

HyperVServerVirtualMachineState

StateString

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

public string StateString { get; set; }

Property Value

string

Version

Gets or sets the virtual machine configuration version - for example "10.0". This only applies to Windows Server 2016 and above.

public string Version { get; set; }

Property Value

string

Methods

Clone()

Returns a CENTREL.XIA.Configuration.Types.HyperVServerVirtualMachine cloned from this object.

public HyperVServerVirtualMachine Clone()

Returns

HyperVServerVirtualMachine

A CENTREL.XIA.Configuration.Types.HyperVServerVirtualMachine.

CompareTo(HyperVServerVirtualMachine)

Compares two CENTREL.XIA.Configuration.Types.HyperVServerVirtualMachine objects to allow sorting alphabetically by name.

public int CompareTo(HyperVServerVirtualMachine other)

Parameters

other HyperVServerVirtualMachine

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

Returns

int

The sort order of the two CENTREL.XIA.Configuration.Types.HyperVServerVirtualMachine objects.

ToString()

Returns the virtual machine as a human readable string.

public override string ToString()

Returns

string

The virtual machine as a human readable string.