MicrosoftNLB_PortRuleEx, ROOT\MicrosoftNLB

Class | Methods (1) | Properties (13) | Qualifiers (4) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

This class represents a rule for how TCP/IP traffic is handled. The provider will only return the instances for this class that correspond to the node upon which it resides.Consequently, to configure a node, the client must explicitly connect to that node. Enhancements in this class over the MicrosoftNLB_PortRule class include : Addition of VirtualIpAddress property (also a key), Aggregation of MicrosoftNLB_PortRuleFailover, MicrosoftNLB_PortRuleLoadbalanced and MicrosoftNLB_PortRuleDisabled classes, Addition of FilteringMode property.

MicrosoftNLB_PortRuleEx methods

MicrosoftNLB_PortRuleEx has 1 methods (1 Local)

NameOriginReturn
SetDefaultsMicrosoftNLB_PortRuleEx

MicrosoftNLB_PortRuleEx properties

MicrosoftNLB_PortRuleEx has 13 properties (13 Local)

NameOriginCIMType
AdapterGuidMicrosoftNLB_PortRuleEx8 [string]
AffinityMicrosoftNLB_PortRuleEx19 [uint32]
ClientStickinessTimeoutMicrosoftNLB_PortRuleEx19 [uint32]
EndPortMicrosoftNLB_PortRuleEx19 [uint32]
EqualLoadMicrosoftNLB_PortRuleEx11 [Boolean]
FilteringModeMicrosoftNLB_PortRuleEx19 [uint32]
LoadWeightMicrosoftNLB_PortRuleEx19 [uint32]
key
Name
MicrosoftNLB_PortRuleEx8 [string]
PortStateMicrosoftNLB_PortRuleEx19 [uint32]
PriorityMicrosoftNLB_PortRuleEx19 [uint32]
ProtocolMicrosoftNLB_PortRuleEx19 [uint32]
key
StartPort
MicrosoftNLB_PortRuleEx19 [uint32]
key
VirtualIpAddress
MicrosoftNLB_PortRuleEx8 [string]

Detailed description of MicrosoftNLB_PortRuleEx methods

Local methods (1) of MicrosoftNLB_PortRuleEx class

SetDefaults method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
Noderef:MicrosoftNLB_Node0-
Description'This method resets the node's port rule configuration to the default. The new configuration is not committed to the driver.'
ImplementedTrue
StaticTrue
ValueMap['1000']
Values['WLBS_OK']
SetDefaults method is in 7 classes of ROOT\MicrosoftNLB and in 6 namespaces

Detailed description of MicrosoftNLB_PortRuleEx properties

Local properties (13) of MicrosoftNLB_PortRuleEx class

AdapterGuid property
CIMTYPE'string'
Description'This is the GUID of the adapter NLB is bound to.'
readTrue
AdapterGuid property is in 11 classes of ROOT\MicrosoftNLB and in 2 namespaces
Affinity property
CIMTYPE'uint32'
Description'This option specifies the client affinity. The possible values are None, Single and Network. Single and Network are used to ensure that all network traffic from a particular client be directed to the same cluster host.'
ValueMap['0', '1', '2']
Values['None', 'Single', 'Network']
Affinity property is in 2 classes of ROOT\MicrosoftNLB and in 6 namespaces
ClientStickinessTimeout property
CIMTYPE'uint32'
Description'This property specifies the affinity timeout of load-balanced network traffic that this host should handle for the associated port rule. Allowed values range from 0 (zero) to 30 minutes.'
ClientStickinessTimeout property is in 1 class (MicrosoftNLB_PortRuleEx) of ROOT\MicrosoftNLB and in 2 namespaces
EndPort property
CIMTYPE'uint32'
Description'The ending port number to which this rule applies.'
EndPort property is in 5 classes of ROOT\MicrosoftNLB and in 3 namespaces
EqualLoad property
CIMTYPE'Boolean'
Description'This property specifies that the host accepts an equal portion of the load-balanced traffic in multiple-host filtering mode for this port rule. If this value is true, then the value for LoadWeight is ignored.'
EqualLoad property is in 2 classes of ROOT\MicrosoftNLB and in 2 namespaces
FilteringMode property
CIMTYPE'uint32'
Description'This specifies the filtering mode for this rule. The possible values are 'Multiple Host', 'Single Host' and 'Disabled'. If the value is 'Multiple Host', the value for Priority is ignored. If the value is 'Single Host', the values for EqualLoad, LoadWeight and Affinity are ignored. If the value is 'Disabled', the values forEqualLoad, LoadWeight, Affinity and Priority are ignored.'
ValueMap['1', '2', '3']
Values['Single Host', 'Multiple Host', 'Disabled']
FilteringMode property is in 1 class (MicrosoftNLB_PortRuleEx) of ROOT\MicrosoftNLB and in 2 namespaces
LoadWeight property
CIMTYPE'uint32'
Description'This property specifies the relative weight of load-balanced network traffic that this host should handle for the associated port rule. Allowed values range from 0 (zero) to 100. To prevent a host from handling any network traffic, set the load weight to 0 (zero). '
LoadWeight property is in 2 classes of ROOT\MicrosoftNLB and in 2 namespaces
Name property
CIMTYPE'string'
Description'The name of the host to which this port rule applies'
keyTrue
Override'Name'
Name property is in 24 classes of ROOT\MicrosoftNLB and in 142 namespaces
PortState property
CIMTYPE'uint32'
Description'The current status of the port rule. If this port rule was created using the WMI provider and the LoadAllSettings() method of the MicrosoftNLB_NodeSetting class was NOT called,then, this property will return NLB_PORT_RULE_NOT_FOUND.'
readTrue
ValueMap['0', '1', '2', '3']
Values['NLB_PORT_RULE_NOT_FOUND', 'NLB_PORT_RULE_ENABLED', 'NLB_PORT_RULE_DISABLED', 'NLB_PORT_RULE_DRAINING']
PortState property is in 1 class (MicrosoftNLB_PortRuleEx) of ROOT\MicrosoftNLB and in 4 namespaces
Priority property
CIMTYPE'uint32'
Description'This property specifies the local host's priority for handling the networking traffic for this port rule. The host 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, to the maximum number of hosts allowed. This value must be unique for all hosts in the cluster.'
Priority property is in 2 classes of ROOT\MicrosoftNLB and in 31 namespaces
Protocol property
CIMTYPE'uint32'
Description'This specifies the protocol for which this rule applies. The possible values include TCP, UDP or Both '
ValueMap['1', '2', '3']
Values['TCP', 'UDP', 'Both']
Protocol property is in 5 classes of ROOT\MicrosoftNLB and in 19 namespaces
StartPort property
CIMTYPE'uint32'
Description'The starting port number to which this rule applies.'
keyTrue
StartPort property is in 5 classes of ROOT\MicrosoftNLB and in 3 namespaces
VirtualIpAddress property
CIMTYPE'string'
Description'The virtual IP address to which this rule applies. The value of virtual Ip address to specify 'All Vip'(aka 'Rest of the VIPs') is '255.255.255.255''
keyTrue
VirtualIpAddress property is in 2 classes of ROOT\MicrosoftNLB and in 2 namespaces

MicrosoftNLB_PortRuleEx Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
Description'This class represents a rule for how TCP/IP traffic is handled. The provider will only return the instances for this class that correspond to the node upon which it resides.Consequently, to configure a node, the client must explicitly connect to that node. Enhancements in this class over the MicrosoftNLB_PortRule class include : Addition of VirtualIpAddress property (also a key), Aggregation of MicrosoftNLB_PortRuleFailover, MicrosoftNLB_PortRuleLoadbalanced and MicrosoftNLB_PortRuleDisabled classes, Addition of FilteringMode property.'
dynamicTrue
LOCALE1033
provider'Microsoft|NLB_Provider|V1.0'

MicrosoftNLB_PortRuleEx System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\MicrosoftNLB:MicrosoftNLB_PortRuleEx'___SYSTEM8
__NAMESPACE'ROOT\MicrosoftNLB'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION[]___SYSTEM8
__PROPERTY_COUNT13___SYSTEM3
__RELPATH'MicrosoftNLB_PortRuleEx'___SYSTEM8
__DYNASTY'MicrosoftNLB_PortRuleEx'___SYSTEM8
__SUPERCLASSnull___SYSTEM8
__CLASS'MicrosoftNLB_PortRuleEx'___SYSTEM8
__GENUS1___SYSTEM3
comments powered by Disqus
WUtils.com