Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

[MS_WLBS parameters] (Sysprep)

Updated: March 28, 2003

Applies To: Windows Server 2003, Windows Server 2003 R2, Windows Server 2003 with SP1, Windows Server 2003 with SP2

[MS_WLBS parameters]

The [MS_WLBS parameters] section contains entries for configuring Network Load Balancing (formerly, Windows Load Balancing Service, or WLBS) and binding Network Load Balancing to multiple network adapters.

By default, the bindings of all networking components (except Network Load Balancing) are enabled. You can selectively disable these by using the Disable entry in the [NetBindings] section. In addition, the Enable entry in the [NetBindings] section allows for explicit binding enabling.

All Network Load Balancing parameters are specific to individual adapters. Any section containing settings specific to an adapter must use the SpecificTo entry to specify the adapter to which the settings apply.

This section is available only for Windows Server 2003 operating systems.

Answer File Entries for the [ MS_WLBS parameters ] Section

 

Entry Description

AliveMsgPeriod

Specifies in milliseconds a period between sending Network Load Balancing cluster heartbeat messages.

AliveMsgTolerance

Specifies the number of lost heartbeat messages before Setup considers the Network Load Balancing cluster host inactive and initiates convergence.

ClusterIPAddress

Specifies the Network Load Balancing cluster's primary IP address.

ClusterModeOnStart

Specifies whether a host joins the Network Load Balancing cluster upon startup or waits for an explicit command to do so.

ClusterName

Specifies a full Internet name for the Network Load Balancing cluster.

ClusterNetworkMask

Specifies the subnet mask for the Network Load Balancing cluster IP address.

DedicatedIPAddress

Specifies the host's unique IP address.

DedicatedNetworkMask

Specifies the subnet mask for the dedicated IP address.

DescriptorsPerAlloc

Specifies the number of connection descriptors created for each allocation.

HostPriority

Specifies the host's unique priority ID in the Network Load Balancing cluster.

IGMPSupport

Specifies whether to use Internet Group Management Protocol (IGMP) support to prevent switch flooding.

MaskSourceMAC

Specifies whether to use source Media Access Control (MAC) address masking, allowing Network Load Balancing cluster hosts to connect to different switch ports.

Master

Specifies whether the host is the master.

MaxDescriptorAllocs

Specifies the maximum number of connection descriptor allocations.

McastIPaddress

Specifies the multicast IP address for sending IGMP join messages when you enable IGMPSupport.

MulticastSupportEnable

Specifies whether to use a multicast MAC address for Network Load Balancing cluster operations.

NetmonAliveMsgs

Specifies whether Network Load Balancing forwards heartbeat messages up to the bound protocols, allowing Network Monitor to capture heartbeats.

NumActions

Specifies the number of actions created for each allocation.

NumAliveMsgs

Specifies the number of heartbeat packet buffers created for each allocation.

NumPackets

Specifies the number of packets created for each allocation.

PersistedStates

Specifies whether a host that is shut down while in a suspended state will remain suspended when Windows is started.

Ports

Specifies rules for distributing traffic among Network Load Balancing cluster hosts according to protocol and destination ports.

RemoteControlEnabled

Specifies whether to enable remote-control operations.

RemoteControlPassword

Specifies a password for restricting access to the Network Load Balancing cluster from remote, networked computers running Windows and using the Wlbs.exe control program.

RemoteControlUDPPort

Specifies the remote control User Datagram Protocol (UDP) port.

ReverseHash

Specifies whether the adapter reverses the source and destination IP addresses and ports before making load balancing decisions.

TeamID

Specifies a valid GUID that identifies a bidirectional affinity (BDA) team.

The following portion of an answer file shows how to configure two network adapters with static IP addresses for Network Load Balancing. In addition to showing how to use entries in the [MS_WLBS parameters] section, this example shows how to use several entries in the [Networking] section.

[Networking]

[Identification]
DomainAdmin = domain\user
DomainAdminPassword = password
JoinDomain = domain

[NetAdapters]
Adapter01 = params.Adapter01
Adapter02 = params.Adapter02

[params.Adapter01]
ConnectionName = "Intel Adapter"
Netcardaddress = 0x0002A5D0510f

[params.Adapter02]
ConnectionName = "3Com Adapter"
Netcardaddress = 0x000476D5F57D

[NetClients]
MS_MSClient = params.MS_MSClient

[params.MS_MSClient]

[NetProtocols]
MS_TCPIP = params.MS_TCPIP

[params.MS_TCPIP]
AdapterSections = params.MS_TCPIP.Adapter01,params.MS_TCPIP.Adapter02

[params.MS_TCPIP.Adapter01]
DHCP = No
DNSServerSearchOrder = 192.168.1.1, 192.168.1.2
IPAddress = 192.168.1.3
SpecificTo = Adapter01
SubnetMask = 255.255.255.0
WINS = Yes
WINSServerList = 192.168.1.4, 192.168.1.5

[params.MS_TCPIP.Adapter02]
DefaultGateway = 192.168.1.6
DHCP = No
DNSServerSearchOrder = 192.168.1.7, 192.168.1.8
IPAddress = 192.168.1.9
SpecificTo = Adapter02
SubnetMask = 255.255.255.0
WINS = Yes
WINSServerList = 192.168.1.10, 192.168.1.11

[params.MS_WLBS]
AdapterSections = params.MS_WLBS.Adapter01,params.MS_WLBS.Adapter02

[params.MS_WLBS.Adapter01]
ClusterIpAddress = 192.168.1.12
ClusterModeOnStart = 1
ClusterName = nlbcluster.domain.com
ClusterNetworkMask = 255.255.255.0
DedicatedIPAddress = 192.168.1.13
DedicatedNetworkMask = 255.255.255.0
HostPriority = 1
IGMPSupport = 0
MulticastSupportEnable = 1
Ports = 1,65535,Both,Multiple,Single,Equal
RemoteControlEnabled = 1
SpecificTo = Adapter01

[params.MS_WLBS.Adapter02]
ClusterIpAddress = 192.168.1.14
ClusterModeOnStart = 1
ClusterName = nlbcluster.domain.com
ClusterNetworkMask = 255.255.255.0
DedicatedIPAddress = 192.168.1.15
DedicatedNetworkMask = 255.255.255.0
HostPriority = 1
IGMPSupport = 0
MulticastSupportEnable = 1
Ports = 1,65535,Both,Multiple,Single,Equal
RemoteControlEnabled = 1
SpecificTo = Adapter02

[NetBindings]
Disable = MS_WLBS,Adapter01
Enable = MS_WLBS,Adapter02

AliveMsgPeriod

Specifies in milliseconds a period between sending Network Load Balancing cluster heartbeat messages.

Syntax

                AliveMsgPeriod = 
                integer_between_100_and_10,000
              

 

Value Description

integer_between_100_and_10,000

Integer.

Example
[Networking]

[MS_WLBS parameters]
AliveMsgPeriod = 5000
Comments

The default value is 1000.

AliveMsgTolerance

Specifies the number of lost heartbeat messages before Setup considers the Network Load Balancing cluster host inactive and initiates convergence.

Syntax

                AliveMsgTolerance = 
                integer_between_5_and_100
              

 

Value Description

integer_between_5_and_100

Integer.

Example
[Networking]

[MS_WLBS parameters]
AliveMsgTolerance = 50
Comments

The default value is 5.

ClusterIPAddress

Specifies the Network Load Balancing cluster’s primary IP address.

Syntax

                ClusterIPAddress = 
                IP_address
              

 

Value Description

IP_address

IP address.

Example
[Networking]

[MS_WLBS parameters]
ClusterIPAddress = 192.168.1.1
Comments

The default is 0.0.0.0.

This entry is required if you are implementing Network Load Balancing. This address is a virtual IP address and it must be set identically for all hosts in the Network Load Balancing cluster. If you use one alias for several IP addresses to the Network Load Balancing cluster, then you must specify only the primary (main) IP address.

ClusterModeOnStart

Specifies whether a host joins the Network Load Balancing cluster upon startup or waits for an explicit command to do so.

Syntax

                ClusterModeOnStart = 0 | 1

 

Value Description

0

Host does not join the Network Load Balancing cluster upon startup, but instead waits for an explicit command.

1

Host joins the Network Load Balancing cluster upon startup.

Example
[Networking]

[MS_WLBS parameters]
ClusterModeOnStart = 0
Comments

The default value is 1.

ClusterName

Specifies a full Internet name for the Network Load Balancing cluster.

Syntax

                ClusterName = 
                fully_qualified_domain_name_of_the_cluster
              

 

Value Description

fully_qualified_domain_name_of_the_cluster

FQDN of the cluster.

Example
[Networking]

[MS_WLBS parameters]
ClusterName = cluster.microsoft.com
Comments

The default value is cluster.domain.com.

ClusterNetworkMask

Specifies the subnet mask for the Network Load Balancing cluster IP address.

Syntax

                ClusterNetworkMask = 
                network_mask
              

 

Value Description

network_mask

IP address.

Example
[Networking]

[MS_WLBS parameters]
ClusterNetworkMask = 255.255.255.0
Comments

The default value is 0.0.0.0.

This entry is required if you are implementing Network Load Balancing.

DedicatedIPAddress

Specifies the host’s unique IP address.

Syntax

                DedicatedIPAddress = 
                IP_address
              

 

Value Description

IP_address

IP address.

Example
[Networking]

[MS_WLBS parameters]
DedicatedIPAddress = 192.168.1.1
Comments

The default value is 0.0.0.0.

This entry is required if you are implementing Network Load Balancing.

DedicatedNetworkMask

Specifies the subnet mask for the dedicated IP address.

Syntax

                DedicatedNetworkMask = 
                network_mask
              

 

Value Description

network_mask

IP address.

Example
[Networking]

[MS_WLBS parameters]
DedicatedNetworkMask = 255.255.255.0
Comments

The default value is 0.0.0.0.

This entry is required if you are implementing Network Load Balancing.

DescriptorsPerAlloc

Specifies the number of connection descriptors created for each allocation.

Syntax

                DescriptorsPerAlloc = 
                integer_between_16_and_1024
              

 

Value Description

integer_between_16_and_1024

Integer.

Example
[Networking]

[MS_WLBS parameters]
DescriptorsPerAlloc = 1024
Comments

The default value is 512.

Change this value only when an event log message instructs you to do so.

HostPriority

Specifies the host’s unique priority ID in the Network Load Balancing cluster.

Syntax

                HostPriority = 
                integer_between_1_and_32
              

 

Value Description

integer_between_1_and_32

Integer.

Example
[Networking]

[MS_WLBS parameters]
HostPriority = 5
Comments

The default value is 1.

This entry is required if you are implementing Network Load Balancing.

IGMPSupport

Specifies whether to use Internet Group Management Protocol (IGMP) support to prevent switch flooding.

Syntax

                IGMPSupport = 0 | 1

 

Value Description

0

Do not use IGMP for Network Load Balancing cluster operations.

1

Uses IGMP for Network Load Balancing cluster operations.

Example
[Networking]

[MS_WLBS parameters]
IGMPSupport = 1
Comments

The default value is 0.

This entry requires MulticastSupportEnable = 1 in the [MS_WLBS parameters] section.

MaskSourceMAC

Specifies whether to use source Media Access Control (MAC) address masking, allowing Network Load Balancing cluster hosts to connect to different switch ports.

Syntax

                MaskSourceMAC = 0 | 1

 

Value Description

0

Does not use source MAC address masking. The Network Load Balancing cluster connects to a hub to re-enable learning in the upstream switch and conserve its bandwidth.

1

Uses source MAC address masking.

Example
[Networking]

[MS_WLBS parameters]
MaskSourceMAC = 0
Comments

The default value is 1.

Master

Specifies whether the host is the master.

Syntax

                Master = 0 | 1

 

Value Description

0

The host is not the master.

1

The host is the master.

Example
[Networking]

[MS_WLBS parameters]
Master = 0
Comments

None.

MaxDescriptorAllocs

Specifies the maximum number of connection descriptor allocations.

Syntax

                MaxDescriptorAllocs = 
                integer_between_1_and_1024
              

 

Value Description

integer_between_1_and_1024

Integer.

Example
[Networking]

[MS_WLBS parameters]
MaxDescriptorAllocs = 1024
Comments

The default value is 512.

Change this value only when an event log message instructs you to do so.

McastIPaddress

Specifies the multicast IP address for sending IGMP join messages when you enable IGMPSupport.

Syntax

                McastIPaddress = 
                IP_address
              

 

Value Description

IP_address

IP address.

Example
[Networking]

[MS_WLBS parameters]
McastIPaddress = ###.###.###.###

Where ###.###.###.### is a Class D IP address in the multicast address range.

Comments

The Primary Cluster IP automatically generates the default address.

MulticastSupportEnable

Specifies whether to use a multicast MAC address for Network Load Balancing cluster operations.

Syntax

                MulticastSupportEnable = 0 | 1

 

Value Description

0

Does not use multicast MAC addresses for Network Load Balancing cluster operations.

1

Uses multicast MAC addresses for Network Load Balancing cluster operations.

Example
[Networking]

[MS_WLBS parameters]
MulticastSupportEnable = 1
Comments

The default value is 0.

NetmonAliveMsgs

Specifies whether Network Load Balancing forwards heartbeat messages up to the bound protocols, allowing Network Monitor to capture heartbeats.

Syntax

                NetmonAliveMsgs = 0 | 1

 

Value Description

0

Does not forward heartbeat messages to bound protocols.

1

Forwards heartbeat messages to bound protocols.

Example
[Networking]

[MS_WLBS parameters]
NetmonAliveMsgs = 1
Comments

The default value is 0.

NumActions

Specifies the number of actions created for each allocation.

Syntax

                NumActions = 
                integer_between_5_and_500
              

 

Value Description

integer_between_5_and_500

Integer.

Example
[Networking]

[MS_WLBS parameters]
NumActions = 10
Comments

The default value is 50.

Change this value only when an event log message instructs you to do so.

NumAliveMsgs

Specifies the number of heartbeat packet buffers created for each allocation.

Syntax

                NumAliveMsgs = 
                integer_between_66_and_660
              

 

Value Description

integer_between_66_and_660

Integer.

Example
[Networking]

[MS_WLBS parameters]
NumAliveMsgs = 100
Comments

The default value is 66.

Change this value only when an event log message instructs you to do so.

NumPackets

Specifies the number of packets created for each allocation.

Syntax

                NumPackets = 
                integer_between_5_and_500
              

 

Value Description

integer_between_5_and_500

Integer.

Example
[Networking]

[MS_WLBS parameters]
NumPackets = 50
Comments

The default value is 100.

Change this value only when an event log message instructs you to do so.

PersistedStates

Specifies whether a host that is shut down while in a suspended state will remain suspended when Windows is started.

Syntax

                PersistedStates = 0 | 4

 

Value Description

0

Suspended state does not persist.

4

Suspended state persists.

Example
[Networking]

[MS_WLBS parameters]
PersistedStates = 0
Comments

None.

Ports

Specifies rules for distributing traffic among Network Load Balancing cluster hosts according to protocol and destination ports.

Syntax

                cluster_ip_address | All, starting_port_range, ending_port_range, Both | TCP | UDP, Multiple |Single | Disabled, mode entry,[...]       

Where mode_entry represents additional parameters if you select either of the following host filtering modes:

  1. Multiple hosts: None | Single | ClassC , Equal |load_weight

  2. Single host: handling_priority

 

Value Description

cluster_ip_address

Specifies the cluster IP address that the port rules apply to.

All

Specifies that the port rules are global and apply to all cluster IP addresses associated with the NLB cluster.

starting_port_range

Specifies the start of the port range for the port rule. The value must be an integer between 1 and 65535. The value must be less than or equal to the value of end_of_port_range.

ending_port_range

Specifies the end of the port range for the port rule. The value must be an integer between 1 and 65535. The value must be greater than or equal to the value of start_of_port_range.

Both

Specifies that you want the port rule to apply to both TCP and UDP network traffic.

TCP

Specifies that you want the port rule to apply to TCP network traffic only.

UDP

Specifies that you want the port rule to apply to UDP network traffic only.

Multiple

Specifies the host filtering mode. This setting specifies that you want multiple hosts in the cluster to handle network traffic for the associated port rule.

Single

Specifies the host filtering mode. This setting specifies that you want a single host in the cluster to handle network traffic for the associated port rule according to the specified handling priority.

Disabled

Specifies the host filtering mode. This setting specifies that you want to block all network traffic for the associated port rule.

None

Specifies the client affinity setting if multiple host filtering mode is selected for the associated port rule. This setting disables client affinity, which allows for more effective load balancing because it allows multiple connections from the same client to be handled concurrently by different cluster hosts.

Single

Specifies the client affinity setting if multiple host filtering mode is selected for the associated port rule. This setting specifies that NLB direct multiple requests from the same client IP address to the same cluster host.

ClassC

Specifies the client affinity setting if multiple host filtering mode is selected for the associated port rule. This setting specifies that NLB direct multiple requests from the same Class C IP subnet to the same cluster host.

Equal

Specifies the load weight setting if multiple host filtering mode is selected for the associated port rule. This setting specifies that you want to distribute the network load equally among all hosts.

load_weight

Specifies the load weight setting if multiple host filtering mode is selected for the associated port rule. This setting specifies the relative amount of load-balanced network traffic you want this host to handle for the associated port rule. The value must be between 0 and 100. The value is not a percentage. The actual fraction of traffic handled by each host can be calculated by dividing the local load weight by the sum of all load weights across the cluster.

handling_priority

Specifies the handling priority setting if single host filtering is selected for the associated port rule. This setting specifies the local host’s priority for handling the network traffic for the associated port rule. The value must be between 1 (highest priority) and 32 (lowest priority). This value must be unique for all hosts in the cluster.

Example
[Networking]

[MS_WLBS parameters]
Ports = All, 20, 21, TCP, Multiple, Single, Equal, All, 80, 80, Both, Multiple, None, Equal, All, 443, 443, Both, Multiple, Single, Equal, All, 1024, 65535, TCP, Multiple, Single, Equal
Ports = ALL, 20, 21, TCP, Multiple, Single, Equal, All, 80, 80, Both, Multiple, None, Equal, All, 443, 443, Both, Multiple, Single, Equal, All, 1024, 65535, TCP, Multiple, Single, Equal
Ports = 192.168.1.1, 20, 21, TCP, Multiple, Single, Equal, 192.168.1.2, 80, 80, Both, Multiple, None, Equal, All, 443, 443, Both, Multiple, Single, Equal, All, 1024, 65535, TCP, Multiple, Single, Equal
Comments

None.

RemoteControlEnabled

Specifies whether to enable remote-control operations.

Syntax

                RemoteControlEnabled = 0 | 1

 

Value Description

0

Does not enable remote-control operations.

1

Enables remote-control operations.

Example
[Networking]

[MS_WLBS parameters]
RemoteControlEnabled = 1
Comments

The default value is 0.

For security reasons, it is recommended that you place the Network Load Balancing UDP control port behind a firewall.

RemoteControlPassword

Specifies a password for restricting access to the Network Load Balancing cluster from remote, networked computers running Windows and using the Wlbs.exe control program.

Syntax

                RemoteControlPassword = 
                password
              

 

Value Description

password

Password.

Example
[Networking]

[MS_WLBS parameters]
RemoteControlPassword = B1gCluster
Comments

The default value is Null.

Note

  • If you create a password that starts with an asterisk (*), Windows sets the password to Null. A null password could be a security risk and is not recommended.

RemoteControlUDPPort

Specifies the remote control User Datagram Protocol (UDP) port.

Syntax

                RemoteControlUDPPort = 
                integer_between_1_and_65535
              

 

Value Description

integer_between_1_and_65535

Integer.

Example
[Networking]

[MS_WLBS parameters]
RemoteControlUDPPort = 1717
Comments

The default value is 2505.

ReverseHash

Specifies whether the adapter reverses the source and destination IP addresses and ports before making load balancing decisions.

Syntax

                ReverseHash = 0 | 1

 

Value Description

0

The adapter does not reverse the source and destination IP addresses and ports.

1

The adapter reverses the source and destination IP addresses and ports.

Example
[Networking]

[MS_WLBS parameters]
ReverseHash = 1
Comments

None.

TeamID

Specifies a valid GUID that identifies a bidirectional affinity (BDA) team.

Syntax

                TeamID = {GUID}

 

Value Description

{GUID}

Globally-unique identifier.

Example
[Networking]

[MS_WLBS parameters]
TeamID = {BF967924-0DE6-11D0-A285-00AA003049E2}
Comments

None.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft. All rights reserved.