Class MicrosoftNlbClusterPortRule

Namespace

CENTREL.XIA.Configuration.Types

Assembly

CENTREL.XIA.Configuration.Types.dll

Represents a port rule configured for a Microsoft network load balancing cluster.

public class MicrosoftNlbClusterPortRule : BaseTypeSection

Inheritance

object

BaseTypeSection

MicrosoftNlbClusterPortRule

Constructors

MicrosoftNlbClusterPortRule()

Intializes a new instance of the CENTREL.XIA.Configuration.Types.MicrosoftNlbClusterPortRule class.

public MicrosoftNlbClusterPortRule()

Properties

Affinity

Gets or sets the affinity mode assigned to the port rule. This setting only applies when the filtering mode is set to "MultipleHost".

public MicrosoftNlbClusterPortRuleAffinity Affinity { get; set; }

Property Value

MicrosoftNlbClusterPortRuleAffinity

AffinityString

Gets the affinity mode assigned to the port rule as a human readable string. This setting only applies when the filtering mode is set to "MultipleHost".

public string AffinityString { get; set; }

Property Value

string

ClientStickinessTimeout

Gets or sets the extended affinity time-out (in minutes) of load-balanced network traffic that this host should handle for the associated port rule. This applies to Windows 2008 R2 and above only.

public int ClientStickinessTimeout { get; set; }

Property Value

int

CollectionIndex

Gets the collection index used by the data comparer.

[Browsable(false)]
public string CollectionIndex { get; }

Property Value

string

EndPort

Gets or sets the ending port number to which this rule applies.

public int EndPort { get; set; }

Property Value

int

EqualLoad

Gets or sets whether the host accepts an equal portion of the load-balanced traffic in multiple-host filtering mode for this port rule.

public BooleanOption EqualLoad { get; set; }

Property Value

BooleanOption

FilteringMode

Gets or sets the filtering mode for this port rule.

public MicrosoftNlbClusterPortRuleFilteringMode FilteringMode { get; set; }

Property Value

MicrosoftNlbClusterPortRuleFilteringMode

FilteringModeString

Gets the filtering mode for this port rule as a human readable string.

public string FilteringModeString { get; set; }

Property Value

string

LoadWeight

Gets or sets the relative weight of load-balanced network traffic that this host should handle for the associated port rule. This setting only applies when "EqualLoad" is set to false.

public int LoadWeight { get; set; }

Property Value

int

LoadWeightString

Gets the relative weight of load-balanced network traffic (either as a numeric value or "Equal") that this host should handle for the associated port rule.

public string LoadWeightString { get; set; }

Property Value

string

PortState

Gets or sets the state of the port at the time of the scan.

public MicrosoftNlbClusterPortState PortState { get; set; }

Property Value

MicrosoftNlbClusterPortState

PortStateString

Gets the state of the port at the time of the scan as a human readable string.

public string PortStateString { get; set; }

Property Value

string

Priority

Gets or sets the priority of the host for handling the networking traffic for this port rule. This only applies when the filtering mode is set to single.

public int Priority { get; set; }

Property Value

int

Protocol

Gets or sets the protocol assigned to the port rule.

public MicrosoftNlbClusterPortRuleProtocol Protocol { get; set; }

Property Value

MicrosoftNlbClusterPortRuleProtocol

ProtocolString

Gets the protocol assigned to the port rule as a human readable string.

public string ProtocolString { get; set; }

Property Value

string

StartPort

Gets or sets the starting port number to which this rule applies.

public int StartPort { get; set; }

Property Value

int

VirtualIPAddress

Gets or sets the virtual IP address to which this rule applies. A value of "255.255.255.255" represents all addresses.

public string VirtualIPAddress { get; set; }

Property Value

string

VirtualIPAddressString

Gets the virtual IP address to which this rule applies, or "All Addresses".

public string VirtualIPAddressString { get; set; }

Property Value

string

Methods

ToString()

Returns the port rule in the format "VirtualIP [StartPort - EndPort]".

public override string ToString()

Returns

string

The port rule in the format "VirtualIP [StartPort - EndPort]".