Table of Contents

Class HyperVServerVirtualMachineNetworkAdapter

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

Represents a network adapter for a Hyper-V virtual machine.

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

Constructors

HyperVServerVirtualMachineNetworkAdapter()

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

public HyperVServerVirtualMachineNetworkAdapter()

Properties

Advanced

Gets or sets the advanced settings for the network adapter.

public HyperVServerVirtualMachineNetworkAdapterAdvancedSettings Advanced { get; set; }

Property Value

HyperVServerVirtualMachineNetworkAdapterAdvancedSettings

Bandwidth

Gets or sets the bandwidth settings for the network adapter.

public HyperVServerVirtualMachineNetworkAdapterBandwidthSettings Bandwidth { get; set; }

Property Value

HyperVServerVirtualMachineNetworkAdapterBandwidthSettings

CollectionIndex

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

public string CollectionIndex { get; }

Property Value

string

DisplayName

Gets the display name of the network adapter and network.

public string DisplayName { 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

Failover

Gets or sets the failover settings for the network adapter.

public HyperVServerVirtualMachineNetworkAdapterFailoverSettings Failover { get; set; }

Property Value

HyperVServerVirtualMachineNetworkAdapterFailoverSettings

HardwareAcceleration

Gets or sets the hardware acceleration settings. This does not apply to legacy network adapters.

public HyperVServerVirtualMachineNetworkAdapterHardwareAccelerationSettings HardwareAcceleration { get; set; }

Property Value

HyperVServerVirtualMachineNetworkAdapterHardwareAccelerationSettings

IPAddresses

Gets or sets the IP addresses assigned to the network adapter. The virtual machine must be running for this information to be available.

public SerializableIPAddressCollection IPAddresses { get; set; }

Property Value

SerializableIPAddressCollection

Identifier

Gets or sets the unique identifier of the network adapter.

public Guid Identifier { get; set; }

Property Value

Guid

InternalIdentifier

Gets or sets the internal identifier of the network adapter - for example "Microsoft:8725298F-47B6-4E4F-8DB2-73F7E456F3A0\CF4D33CE-2713-46A7-8219-3751F83B6B32".

public string InternalIdentifier { get; set; }

Property Value

string

IsLegacy

Gets or sets whether the network adapter is a legacy adapter. This only applies to generation 1 virtual machines.

public BooleanOption IsLegacy { get; set; }

Property Value

BooleanOption

Name

Gets or sets the name of the network adapter.

public string Name { get; set; }

Property Value

string

ResourcePoolName

Gets or sets the resource pool name.

public string ResourcePoolName { get; set; }

Property Value

string

SwitchDisplayName

Gets the switch display name.

public string SwitchDisplayName { get; set; }

Property Value

string

SwitchIdentifier

Gets or sets the unique identifier of the switch to which the network adapter is connected.

public Guid SwitchIdentifier { get; set; }

Property Value

Guid

SwitchName

Gets or sets the name of the virtual switch to which the network adapter is connected.

public string SwitchName { get; set; }

Property Value

string

Vlan

Gets or sets the VLAN settings for the network adapter.

public HyperVServerVirtualMachineNetworkAdapterVlanSettings Vlan { get; set; }

Property Value

HyperVServerVirtualMachineNetworkAdapterVlanSettings

Methods

Clone()

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

public HyperVServerVirtualMachineNetworkAdapter Clone()

Returns

HyperVServerVirtualMachineNetworkAdapter

A CENTREL.XIA.Configuration.Types.HyperVServerVirtualMachineNetworkAdapter.

CompareTo(HyperVServerVirtualMachineNetworkAdapter)

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

public int CompareTo(HyperVServerVirtualMachineNetworkAdapter other)

Parameters

other HyperVServerVirtualMachineNetworkAdapter

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

Returns

int

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

ToString()

Returns the network adapter as a human readable string.

public override string ToString()

Returns

string

The network adapter as a human readable string.