Table of Contents

Class HyperVServerVirtualSwitch

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

Represents a virtual switch in a Hyper-V server.

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

Constructors

HyperVServerVirtualSwitch()

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

public HyperVServerVirtualSwitch()

Properties

AllowManagementOperatingSystem

Gets or sets whether to allow the management operating system to share these network adapters.

public BooleanOption AllowManagementOperatingSystem { get; set; }

Property Value

BooleanOption

BandwidthReservationMode

Gets or sets the bandwidth reservation mode.

public HyperVServerVirtualSwitchBandwidthReservationMode BandwidthReservationMode { get; set; }

Property Value

HyperVServerVirtualSwitchBandwidthReservationMode

CollectionIndex

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

public string CollectionIndex { get; }

Property Value

string

DefaultFlowMinimumBandwidthAbsolute

Gets or sets the default minimum bandwidth, in bits per second.

public ulong DefaultFlowMinimumBandwidthAbsolute { get; set; }

Property Value

ulong

DefaultFlowMinimumBandwidthWeight

Gets or sets the default minimum bandwidth as a relative weight.

public ulong DefaultFlowMinimumBandwidthWeight { get; set; }

Property Value

ulong

Description

Gets or sets the description of the virtual switch.

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

EmbeddedTeamingEnabled

Gets or sets whether embedded teaming is enabled. This only applies to Windows Server 2016 and above.

public BooleanOption EmbeddedTeamingEnabled { get; set; }

Property Value

BooleanOption

Extensions

Gets or sets the configured virtual switch extensions.

public HyperVServerVirtualSwitchExtensions Extensions { get; set; }

Property Value

HyperVServerVirtualSwitchExtensions

ExternalInterfaceName

Gets or sets the name of the external interface.

public string ExternalInterfaceName { get; set; }

Property Value

string

ExternalTeamedInterfaceNames

Gets or sets the names of the external teamed network interfaces. This only applies to Windows Server 2016 and above.

public SerializableStringCollection ExternalTeamedInterfaceNames { get; set; }

Property Value

SerializableStringCollection

Identifier

Gets or sets the unique identifier of the virtual switch in GUID format.

public Guid Identifier { get; set; }

Property Value

Guid

IovEnabled

Gets or sets whether single-root I/O virtualization (SR-IOV) is enabled.

public BooleanOption IovEnabled { get; set; }

Property Value

BooleanOption

LoadBalancingAlgorithm

Gets or sets the load balancing algorithm to use with switch embedded teaming. This only applies to Windows Server 2016 and above.

public HyperVServerVirtualSwitchLoadBalancingAlgorithm LoadBalancingAlgorithm { get; set; }

Property Value

HyperVServerVirtualSwitchLoadBalancingAlgorithm

LoadBalancingAlgorithmString

Gets the load balancing algorithm to use with switch embedded teaming as a human readable string. This only applies to Windows Server 2016 and above.

public string LoadBalancingAlgorithmString { get; set; }

Property Value

string

Name

Gets or sets the name of the virtual switch.

public string Name { get; set; }

Property Value

string

PacketDirectEnabled

Gets or sets whether packet direct is enabled. This only applies to Windows Server 2016 and above.

public BooleanOption PacketDirectEnabled { get; set; }

Property Value

BooleanOption

SwitchType

Gets or sets the switch type.

public HyperVServerVirtualSwitchType SwitchType { get; set; }

Property Value

HyperVServerVirtualSwitchType

SwitchTypeString

Gets the switch type as a human readable string.

public string SwitchTypeString { get; set; }

Property Value

string

VlanIdentificationEnabled

Gets or sets whether to enable VLAN identification. This only applies to external virtual switches that are shared with the management operating system.

public BooleanOption VlanIdentificationEnabled { get; set; }

Property Value

BooleanOption

VlanIdentifier

Gets or sets the VLAN identifier.

public int VlanIdentifier { get; set; }

Property Value

int

Methods

Clone()

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

public HyperVServerVirtualSwitch Clone()

Returns

HyperVServerVirtualSwitch

A CENTREL.XIA.Configuration.Types.HyperVServerVirtualSwitch.

CompareTo(HyperVServerVirtualSwitch)

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

public int CompareTo(HyperVServerVirtualSwitch other)

Parameters

other HyperVServerVirtualSwitch

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

Returns

int

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

ToString()

Returns the virtual switch as a human readable string.

public override string ToString()

Returns

string

The virtual switch as a human readable string.