MicrosoftNLB_PortRuleFailover class
The MicrosoftNLB_PortRuleFailover WMI class represents a Network Load Balancing port rule set to Single-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_PortRuleFailover : MicrosoftNLB_PortRule
{
string SettingID;
string Caption;
string Description;
string Name;
string AdapterGuid;
uint32 EndPort = 65535;
uint32 Protocol;
uint32 StartPort = 0;
uint32 Priority = 1;
};
Members
The MicrosoftNLB_PortRuleFailover class has these types of members:
Methods
The MicrosoftNLB_PortRuleFailover 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_PortRuleFailover class has these properties.
-
AdapterGuid
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers:
Specifies the GUID of the adapter to which Network Load Balancing is bound.
This property is inherited from MicrosoftNLB_PortRule.
-
-
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
-
Qualifiers:
Not used.
This property inherits from MicrosoftNLB_PortRule.
-
-
Name
-
The name of the host to which this port rule applies
This property is inherited from MicrosoftNLB_PortRule.
-
Priority
-
-
Data type: uint32
-
Access type: Read-only
Specifies the local node's host priority for handling the networking traffic for this port rule. The node with the highest handling priority (lowest numerical value) for this rule among the current members of the cluster will handle all of the traffic for this rule. The allowed values range from 1, the highest priority (and the default), to the maximum number of nodes allowed. This value must be unique for all nodes in the cluster.
-
-
Protocol
-
-
Data type: uint32
-
Access type: Read-only
-
Qualifiers:
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)
Not used.
This property inherits 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_PortRuleFailover 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_PortRuleFailover properties, you must call the LoadAllSettings method of the MicrosoftNLB_NodeSetting class to bring the new values into effect.
The MicrosoftNLB_PortRuleFailover 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 |
|