MicrosoftNLB_PortRuleLoadbalanced class
The MicrosoftNLB_PortRuleLoadbalanced WMI class represents a Network Load Balancing port rule set to Multiple-host filtering mode. Do not use this class; use MicrosoftNLB_PortRuleEx for managing port rules instead.
The following syntax is simplified from MOF code and includes all inherited properties.
Syntax
[Dynamic, Provider("Microsoft|NLB_Provider|V1.0"), AMENDMENT]
class MicrosoftNLB_PortRuleLoadbalanced : MicrosoftNLB_PortRule
{
string SettingID;
string Caption;
string Description;
string Name;
string AdapterGuid;
uint32 EndPort = 65535;
uint32 Protocol;
uint32 StartPort = 0;
uint32 Affinity;
Boolean EqualLoad = TRUE;
uint32 LoadWeight = 50;
};
Members
The MicrosoftNLB_PortRuleLoadbalanced class has these types of members:
Methods
The MicrosoftNLB_PortRuleLoadbalanced class has these methods.
| Method | Description |
|---|---|
| SetDefaults | Qualifiers: Static, Implemented Resets the node's port rule configuration to the default. This method is inherited from MicrosoftNLB_PortRule. |
Properties
The MicrosoftNLB_PortRuleLoadbalanced class has these properties.
-
AdapterGuid
-
-
Data type: string
-
Access type: Read-only
Specifies the GUID of the adapter to which Network Load Balancing is bound.
This property is inherited from MicrosoftNLB_PortRule.
-
-
Affinity
-
-
Data type: uint32
-
Access type: Read-only
Specifies client affinity as one of the following values.
-
-
None (0)
-
Single (1)
-
Single (the default)
-
Network (2)
-
Class C
Caption
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
Not used.
This property inherits from CIM_Setting.
Description
-
Data type: string
-
Access type: Read-only
Not used.
This property inherits from CIM_Setting.
EndPort
-
Data type: uint32
-
Access type: Read-only
Not used.
This property inherits from MicrosoftNLB_PortRule.
EqualLoad
-
Data type: Boolean
-
Access type: Read-only
Indicates whether the node accepts an equal portion of the load-balanced traffic in multiple-host filtering mode for this port rule. If this property is set to TRUE (the default), the node accepts an equal portion of the load-balanced traffic.
LoadWeight
-
Data type: uint32
-
Access type: Read-only
The percentage of load-balanced network traffic that this node should handle for the associated port rule. Allowed values range from 0 (zero) to 100; defaults to 50. To prevent a node from handling any network traffic, set the load weight to 0 (zero).
Name
The name of the host to which this port rule applies
This property is inherited from MicrosoftNLB_PortRule.
Protocol
-
Data type: uint32
-
Access type: Read-only
Describes the network protocol to which this rule applies. The possible values are the following.
This property is inherited from MicrosoftNLB_PortRule.
TCP (1)
UDP (2)
Both (3)
Both (the default)
SettingID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (256)
The identifier by which the object is known.
This property is inherited from CIM_Setting.
StartPort
-
Data type: uint32
-
Access type: Read-only
-
Qualifiers: Key
Specifies the starting port number to which this rule applies. The default is 0 (zero).
This property is inherited from MicrosoftNLB_PortRule.
Remarks
An instance of the MicrosoftNLB_PortRuleLoadbalanced class corresponds to a port rule on a single cluster node (specified by the Name property).
The instance can be obtained from the GetPortRule method of the MicrosoftNLB_NodeSetting class. After changing any MicrosoftNLB_PortRuleLoadbalanced properties, you must call the LoadAllSettings method of the MicrosoftNLB_NodeSetting class to bring the new values into effect.
The MicrosoftNLB_PortRuleLoadbalanced class is derived from the MicrosoftNLB_PortRule class.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 |
| Namespace |
Root\MicrosoftNLB |
| MOF |
|
| DLL |
|