KEMP Technologies leads the industry in driving the price/performance value proposition for application delivery and load balancing to levels that our customers can afford. Our productsâ€™ versatile and powerful architecture provide the highest value, while enabling our customers to optimize their businesses that rely on Internet-based infrastructure to conduct business with their customers, employees and partners.
KEMP Technologies products optimize web and application infrastructure as defined by high-availability, high-performance, flexible scalability, security and ease of management. They maximize the total cost-of-ownership for web infrastructure, while enabling flexible and comprehensive deployment options.
This document describes the Command Line Interface (CLI) to the KEMP LoadMaster. It describes in detail how to configure the various features of the KEMP LoadMaster using the CLI.
This document is intended to help anyone who wishes to configure the KEMP LoadMaster using the CLI.
The Command Line Interface allows users to interface with the LoadMaster via a command line shell or a menu-based series of options.
You will need a PC to connect via COM+ (Console) port with a terminal emulation application, or a standard VGA and keyboard. Use a null modem cable (reversal) to connect the COM+ port to the LoadMaster COM port on the rear of the unit.
The COM+ settings should 115200,8,N,1.
After initially deploying and powering on a LoadMaster, ideally the IP address of the LoadMaster will be obtained via DHCP.
If the IP address has not been obtained via DHCP, or if the address details of the LoadMaster need to be changed, the console can be used to configure the IP address of the LoadMaster, the default gateway address and the name server addresses. To go through this menu, simply log in to the console using the default username and password (bal and 1fourall).
After configuring the address details and accessing the LoadMaster via the Web User Interface (WUI), the LoadMaster needs to be licensed. For further information on licensing, refer to the Licensing, Feature Description.
If licensing fails for any reason, various debug options will become available on both the WUI and the console. These options can be used to troubleshoot problems which may occur when trying to license the LoadMaster.
If licensing fails for any reason, a diagnostics menu will appear when the LoadMaster console is accessed. This menu has the following options:
Ping: Performs a ping on the specified host. The LoadMaster will try to auto-detect what type of ping to use (ping for IPv4 and ping6 for IPv6). If this auto-detection does not work, you will be asked which ping to use.
Traceroute: Performs a traceroute of the specific host.
Ifconfig: Displays raw ifconfig output.
Continue configuration: Use this option to reconfigure the address details of the LoadMaster.
After a LoadMaster has been successfully licensed, the console main menu will be displayed whenever the console is accessed. Many features of the LoadMaster can be configured using the menu system. The menu system can be used by logging onto the console as â€œbalâ€, or by remotely logging into the system using the SSH protocol.
Remote access is only permitted if the SSH service is enabled and the password for â€œbalâ€ has been changed from its default value. If the password has not been changed from its default value, the user â€œbalâ€ will only be allowed to login from a directly connected console.
If the password for â€œbalâ€ has been forgotten, a user can login on the console as pwreset. The password is 1pwreset. This will reset the password for â€œbalâ€ to 1fourall until the LoadMaster is rebooted. If unit is rebooted without the password being changed, the password will be reset to its old (unknown) value. It is thus strongly advised that the password should be changed using the configuration menu before the next reboot.
The configuration menu system is made up of a number of hierarchical menus split into functional groups. Navigation around the menus can be performed by using the Up and Down cursor keys, or by using the â€œ+â€ and â€œ-â€œ keys. On menus with numeric entries, the number can also be given.
Using â€œqâ€<CR> or â€œESCAPEâ€ or using the [CANCEL] button will return the user to the previous menu.
To access the [OK], and [CANCEL] buttons, use the TAB key to toggle between the menu and the buttons.
Using the [CANCEL] button from the main menu, all changes made to the configuration will be ignored.
Using the [OK] button from the main menu performs the menu point, which is currently highlighted.
When the LoadMaster is configured in a HA cluster, and the user is logged onto the standby machine, only the configuration of the local IP interfaces, changing the local password and performing a backup/restore should be performed, all other configuration parameters should only be changed on the active machine.
The following options are available on the initial CLI menu.
Quick setup allows a LoadMaster to be quickly configured; only the most important parameters needed by the LoadMaster are setup.
Service Management (CLI)
This menu allows you to administrate options such as password, time, backups etc. within the LoadMaster
From this menu option various aspects of the LoadMaster such as interfaces, hostname, DNS etc. can be configured.
Packet Filter and Blacklists
From this menu Access Control Lists can be administered.
A variety of utilities can be administered such as Software Upgrades, determining the Transfer Protocol used, License Updates and configuring a number of diagnostic tools.
Selecting the Reboot option enables you to reboot the LoadMaster
Exits the menu
These options are discussed in more detail in subsequent sections of this document.
Quick setup automatically begins when you log into the LoadMaster for the first time and the license key has been validated. It can also be started by selecting option 1 from the main menu.
Quick setup allows a LoadMaster to be quickly configured; only the most important parameters needed by the LoadMaster are setup. Once the LoadMaster is configured and running, all the parameters can be changed using the Web User Interface.
Quick Setup welcomes you with the following message:
The Quick Setup procedure allows the configuration of the following parameters:
Ethernet IP address(s) â€“ for eth0
Ethernet IP address(s) â€“ for eth1
After these parameters have been set, the configuration should be activated. The LoadMaster is then ready for use.
If a parameter has been incorrectly set. Use the [CANCEL] button until the main menu appears. Quick Setup can then be performed again to correct the error.
Ethernet IP address(s) â€“ eth0
The user is asked to input the IP address of the eth0 (NETWORK side) Ethernet interface. This should be input as a â€œdotted quadâ€ followed by a network specifier.
If no network specifier is given, the user will then be asked to specify the netmask, this may be input as either a network specifier (I.e. for the above example /24.) or as a â€œdotted quadâ€ (I.e. If the IP address is 192.168.200.12 then the network mask should be 255.255.255.0).
Ethernet IP address(s) â€“ eth1
The user will now be asked to input the IP address of the eth1 (FARM side) Ethernet interface. When running in a Single-Armed configuration, this entry should be left empty.
The format of the input is the same as used for eth0. If an address is given, then this must be on a different network to the address(s) on eth0.
The hostname of the LoadMaster must now be set. A standard (or previously set) name is suggested.
When configuring a LoadMaster HA cluster, the name of the partner machine is requested, a standard name is also suggested here. This name also does not need to be changed unless the configuration requires it.
The DNS resolver may now be configured. Up to three DNS servers may be specified (Addresses must be in â€œdotted quadâ€ syntax).
A list of search domains can now also be given. Up to 6 domains can be specified.
Selecting option 3, Local Administration, in the Main Menu brings up the Local Administration screen
This menu performs administration tasks for the current LoadMaster balancer. The following options are available:
Using this option, the user may change the local password for the user â€œbalâ€. The password should be changed for security reasons. Remote access over SSH is not allowed until the password has been changed.
The password is not saved when performing a backup and is not replaced when performing a restore.
This option allows the local date, time and time zone to be set.
A list of time zones is given; the current time zone is always at the start of the list. The user may select a different time zone if required.
The date should be entered in the following format:
Followed by the time in the following format:
When first delivered the LoadMaster is set to use UTC.
Selecting the Backup/Restore option is selected a screen opens with two options:
Save Backup to Remote Host
Restore Backup from Remote Host
When option 1 is selected, the backup process begins. The following information is requested:
The host IP address where the backup will be stored
The username on the backup host
The filename of the backup
The backup server machine must run an FTP daemon or an SSH daemon.
When option 2 is selected, the backup restore process begins. The following information is requested:
The host IP address where the backup will be stored
The username on the backup host
The filename of the backup
What is to be restored, the options include
- Only the Virtual Service configuration
- Only the information about the Virtual Services will be restored.
- Only the LoadMaster Base Configuration
- Only the LoadMaster configuration not including the Virtual Service configuration.
- Both the Virtual Service and Base Configuration information
- All the configuration information on the LoadMaster.
Restoring the Virtual Service Configuration on the standby LoadMaster of a HA cluster is not permitted since the Virtual Service configuration is always taken from the Active LoadMaster, and this would overwrite any restored configuration.
The LoadMaster is delivered with the WUI configured to be only accessible via the â€œnetworkâ€ side address.
When the Web Address option is selected, a number of options appear:
Use <IP address:Port>: This displays the IP address which will be used by the LoadMaster WUI. Depending on the value that the IP address is set to, this could be a network side or the farm side IP address. To change the IP address, go to the Basic Setup menu item and use the Network Configuration option. For more information, refer to the Basic Setup section.
Change Server Port: Change the port used by the interface.
Immediately Stop/Start Web Server Access: With this option you can disable or enable access to the LoadMaster WUI.
Regenerate Web Server SSL Keys: This option resets the SSL certificates for the WUI. In a HA environment, the certificates get reset for both the local and shared WUI. Therefore, this needs to be run on both LoadMasters in a HA pair (to remove the local certificate). The certificate on the shared WUI will be corrected on both machines after the first invocation.
Selecting the Basic Setup option in the main menu opens the Basic Setup screen
The configuration of the various IP addresses of the Ethernet interfaces can be configured.
When using the LoadMaster in a one-armed configuration, the second interface does not have to be configured. When asked to configure the second interface (eth1) just press the [OK] button with no IP address supplied.
If the LoadMaster is supplied with extra optional Ethernet interfaces, these interfaces can only be configured using this menu. In this case, the on-board interfaces are no longer eth0 and eth1 but the highest numbered Ethernet interfaces. I.e. the optional interfaces will be designated as eth0 and eth1. For more information on this topic please contact customer support.
This option allows the configuration of the LoadMaster name resolution facility. If no DNS parameters are specified, the administration of the LoadMaster must be performed using â€œdotted quadâ€ addressing only.
This option allows the configuration of up to three DNS server addresses. These must be in â€œdotted quadâ€ format.
Up to 6 search domains may also be specified.
Default Gateway Configuration
The LoadMaster requires a default gateway through which it can communicate with the Internet. Enter the IP address of the default gateway here. This must be an IP address on the network.
Selecting the Packet Filter and Blacklists option from the Main Menu opens the Firewall Configuration screen.
Access Control Lists
The LoadMaster supports a â€œblacklistâ€ (blocked list) and â€˜whitelistâ€™ (allowed list) Access Control List system. Any host or network entered into the blocked list will be blocked from accessing any service provided by the LoadMaster whereas any host or network entered into the allowed list will be allowed to access any service provided by the LoadMaster. The allowed list is used to â€˜punch holesâ€™ in the blocked list.
The LoadMaster also has a packet filter. When enabled the packet filter blocks all IP packets which are not directed at a configured port.
The Access Control list is only enabled when the packet filter is enabled. By default the Access Control List is disabled. This means that all source IP addresses are accepted by the LoadMaster.
The following options are available when you select the Access Control Lists option:
Enable Access Control Lists: Using this toggle option the Packet Filter/Access Control List can be activated / deactivated.
Show blocked addresses: This option lists the content of the current blocked list.
Add address to blocked list: This option allows a user to add a host or network IP address to the blocked list. IPv4 and IPv6 addresses are allowed. A network is specified by using a network specifier, i.e. Specifying 192.168.200.0/24 will block all hosts on the 192.168.200 network.
Delete address from blocked list: This option allows an IP address or network to be deleted from the blocked list.
Show allowed addresses: This option lists the content of the current allowed list
Add address to allowed list: This option allows a user to add a host or network IP address to the allowed list.
Delete address from allowed list: This option allows an IP address or network to be deleted from the allowed list.
Reject/Drop blocked packets: When a connection request is received from a host, which is blocked using the ACL, the request is normally ignored (dropped). The LoadMaster may however be configured to send back an ICMP reject packet. For security reasons it is usually best to drop any blocked requests.
Selecting the Utilities option from the Main Menu opens the LoadMaster Utilities screen.
Using this option, patches for the operating software of the LoadMaster may be installed or removed. A number of options are available when the Software Upgrade option is selected:
With this option, a patch can be downloaded onto the LoadMaster from a remote server. The server must be running a SSH daemon.
Once the patch has been downloaded, the patch is unpacked and verified. If the patch is valid, then the name of the patch will be displayed and the user will be asked to confirm if the patch should be installed. A copy of the current operating software is saved before the patch is installed, this may be recovered at a later date using the â€œrollback updateâ€ option.
If a patch needs to be removed, this option allows the previous version of the operating software to be recovered. Only one previous version is available. When the software has been recovered, it is not possible to recover any earlier versions.
Reset the configuration of the appliance with exception to the license information, usernames and passwords.
This option allows the user to specify which transfer method should be used to transfer data between the LoadMaster and a remote server. The selected method is used to store a backup on a remote server or to download software patches. The default method is â€œftpâ€.
Use ftp protocol
Using this option, the Internet standard â€œftpâ€ protocol is used. Most servers support this protocol.
Use scp protocol
The â€œscpâ€ - secure copy â€“ transfer method may be selected. This is more secure than â€œftpâ€ but is normally only supported on UNIX servers. If this mode is selected, the transfer of SSL certificates can only be performed via the menu system and not via the Web interface.
Use http protocol
Using this transfer method, backups to a remote server cannot be performed.
Software patches can however be downloaded from any Web server where the patch has been made available.
This option permits the input of a new license key, for example, when updating from an evaluation to a full license. KEMP recommends rebooting after updating the license.
This menu allows the user to perform diagnostic functions on the LoadMaster. The following options are available
Ping Remote Host
A remote host may be â€œpingedâ€.
Tests that the Layer 4 and Layer 7 daemons are running correctly
View Log Files
Allows the user to view various messages (boot.msg, warning messages, standard messages and the HA logfile) in a terminal view.
Displays the software version running on the LoadMaster
Enable Diagnostic login
Allows root access to the kernel. An â€˜Xroot keyâ€™ is also supplied which enables temporary (six hours) xroot access
The option â€œEnable diagnostic loginâ€ should only ever be enabled when requested to by LoadMaster support staff.
If this option is enabled in normal operation, this may result in unauthorized access to the LoadMaster. The diagnostic login will be disabled upon reboot of the LoadMaster or it can be disabled from this menu
Disable Diagnostic Login
Disables the Diagnostic Login
Opens a shell from where you can perform diagnostic operations on the LoadMaster kernel.
Telnet can be used as a troubleshooting tool for testing connectivity from within the Diagnostic Shell
This should only be done with the assistance of a KEMP Engineer
Selecting the Reboot option enables you to reboot the LoadMaster.
If you select the Yes option, the LoadMaster reboots.
The command interface syntax is loosely based on the industry standard syntax as used by other Load Balancer manufacturers.
The command interface has a line based, hierarchical command set. Changes made to the configuration are only performed when returning to the top level.
A port can either be specified as a numeric value or as a symbolic name. The following names are recognized:
At the top level the following commands may be specified.
This command switches the input to the adaptive parameters command set.
This command will delete the specified VIP.
This command will disable the specified Real Server. I.e. No more traffic will be directed to the Real Server. This command will disable the Real Server on all Virtual Services where this Real Server is configured.
This command switches the input to the health check parameter command set.
This command switches the input to the Virtual Service command set. A <VIP> is the IP address of the Virtual Service. A <name> is the name of the Virtual Service.
If no Virtual Service with the specified IP address (or IP name respectively), then a new Virtual Service will be created. No changes will occur to the configuration until the user returns to the top level command level.
Prints a summary of commands at the current level.
Since the input level is at the top level, this command has no affect.
The following commands are available at the adaptive command level. No changes to the configuration will occur until the command level returns to the top level i.e. when the user types â€œexitâ€.
With this command, the interval of sampling the server loads will be set to <Integer> seconds.
The minimum load (as a percentage) where adaptive balancing takes effect can be set.
If the mean load of the server falls below this threshold, the Virtual Service will be considered "idle" and the weights will return gradually to their "static" values.
The specified port will be used to access the Real Servers where adaptive checking is enabled.
Displays the current adaptive checking parameters.
<String> specifies a URL, which will be fetched by the adaptive checking system. The contents of this URL should specify the load on the current Real Server, with 0 representing no load and 100 representing a fully loaded server.
This specifies the minimal value of the weight (as a percentage of the static weight).
The adaptive scheduling method will not adjust a server weight below this value.
Prints out a list of the available commands at the adaptive command level.
Returns the input to the top command level. Any changes will be written to the configuration file, and the system will be updated accordingly.
The following commands can be performed at the health check command level. Please note that UDP health checks are not supported via the console.
Displays the current health check parameters.
Lists the commands that are available at the health check command level.
Leave the health check command level, any changes to the health check parameters will be saved and the system will be configured accordingly.
The following commands can be performed at the rules command level.
This command creates a new rule <Rule-name>. It also switches into the Rule Edit command level. Upon return to the Rules command level. Further rules may be added.
This command switches into the Rule Edit command level, so that the rule <Rule-name> can be edited.
This deletes the specified rule. The rule will be deleted from all Real Servers to which it has been assigned.
Show [ <Rule-name> ]
Displays a list of all the rules (if no <Rule-name> parameter) is specified or the specified rule.
Lists the commands that are available at the rules command level.
Leave the rules command level, any changes to the rules will be saved and the system will be configured accordingly.
The following commands can be performed at the rule edit command level.
This option allows the match string value of the rule to be set. Spaces are significant. By default a string is treated as a regular expression. If <prefix> or <postfix> is set, then the string is treated as a literal string, which is then matched at the start or end of the received URL respectively.
This command inverts (reverts to normal if [no] is specified) the sense of a rule. I.e. If negation is set, the rule will be true if the received URL does NOT match the value of the rule.
This specifies that the value of the rule should be matched at the start of the received URL.
This specifies that the value of the rule should be matched at the end of the received URL.
This specifies that the value of the rule should be matched against the concatenated hostname and received URL string.
This specifies that the value of the rule should be matched at the start of the concatenated hostname and received URL string.
This specifies that the value of the rule should be matched at the end of the concatenated hostname and received URL string.
If no prefix or postfix option is enabled, the default rule matching will be a regular expression. Specifying no to any of the above options reverts the matching back to regular expression matching without any hostname concatenations.
Append the query string to the URL before performing a match
Ignore case when comparing strings.
The header field name must be matched. If no header field name is set, the default is to match the string within the URL.
Rules can be matched based on the Source IP of the client by entering â€˜src-ipâ€™ within the Header Field input field. The header field will be populated by the source IP of the client.
The value of the header field to be replaced.
Regular Expression: compares the header to the rule
Prefix: compares the prefix of the header according to the rule
Postfix: compares the postfix of the header according to the rule
If this rule is matched, then always fail to connect.
Only try to execute this rule if the specified flag is se
If the rule is successfully matched, set the specified flag
Displays the value of the current rule.
Lists the commands that are available at the rule edit command level.
Leave the rule edit command level and return to the rules command level. Modifications will not be saved until after the rules command level is â€œexitedâ€.
The following commands are available at the Virtual Service command level. No changes will be made to the system until the user performs an â€œexitâ€ from this level. If the VIP has errors, the user will be asked if the VIP should be discarded. If the VIP is discarded, the input will return to the top level. If the VIP is not discarded, the input will remain at the Virtual Service command level, the user may then correct the error.
[no] Adaptive <String>
Specifies whether the Virtual Service should support adaptive health checking. The only current method is â€œhttp_rsâ€. To disable adaptive health checking for a Virtual Service, the command <no adaptive> should be used.
This command adds the Real Server as specified by the <IPspec> to the Virtual Service. It also switches the input into the Real Server command level. Upon return from the Real Server command level, further Real Servers can be added to the Virtual Service.
Specifies the IP address of the Virtual Service.
Disable the Virtual Service. This means that the Virtual Service will accept no new requests.
Re-enable a Virtual Service. The Virtual Service will again accept new requests.
Follow <Port Spec>
When using L4 (source IP based persistency), An IP mask may be specified which is used to determine if two IP addresses should be treated as coming from the same source. By default the mask has a value of 255.255.255.255, which means that all IP addresses are different.
[no] Name <Name>
Specifies the â€œnameâ€ of the Virtual Service. To delete the name use the command <no name>.
This specifies which health-check method should be used for a given Virtual Service. If the Virtual Service has a well-known port, a health check method will be automatically set. The following health check methods may be specified.
Health Check Method
HTTP checking is enabled
The Simple Mail Transfer Protocol (SMTP) is used.
The Network News Transfer Protocol (NNTP) is used.
The File Transfer Protocol (FTP) is used.
The Telnet protocol is used.
The Post Office â€“ mail client protocol is used.
The IMAP â€“ mail client protocol is used.
A basic TCP connection is checked.
A DNS request is sent to the Real Servers port. This checking method is only valid when using a UDP protocol.
A dummy zero length UDP packet is sent to the port.
[no] Persist <Persist type>
This command specifies which type of connection persistence should be used for a Virtual Service. In no persistency should be specified for the Virtual Service, the command <no persist> should be specified. The following persistency types can be specified. If the L7 option has not been enabled, only the <src> persistency is allowed.
Server-generated cookies will be used.
LoadMaster-generated cookies will be used.
A request for a specific URL will always go to the same Real Server.
A request to the same virtual host will go to the same Real Server.
Enables IP-based persistency.
Server-generated cookies will be used. If the client does not return a cookie, the clientsâ€™ IP address will be used.
A LoadMaster generated cookie will be used. If the client does not return the cookie, the clientsâ€™ IP address will be used.
All connections with the same set of cookies will always be sent to the same Real Server. If no cookies are sent, normal scheduling will occur.
Port <Port spec>
Specifies the IP port to be used for the Virtual Service. If no health check mechanism has been specified and the port is a well-known port, the relevant health check mechanism will be selected.
Precedence <rule-name> <number>
The precedence of the rule <rule-name> is set to <number>. A value of 1 moves the rule to the start of the rule list. I.e. this rule is checked first. A higher value moves the rule to the respective position in the rule. If a <default> rule is specified for a Real Server, its precedence will always be lower than any user defined rules. I.e. a <default> rule will always be checked after every other rule.
Protocol to be used for the Virtual Service. This may be <tcp> or <udp>. By default the protocol will be set to <tcp>.
Specifies how long the LoadMaster should remember the persistency information associated with a connection. This value is specified in seconds.
Schedule <schedule method>
This allows the scheduling method between the Real Servers to be specified.
The following scheduling methods may be specified:
rr round robin (default).
wrrweighted round robin.
llcweighted least connection.
Configure the VS default gateway
[no] esplog <integer>
Configure what types of logging is allowed
0 - Off
1 - User Access
2 - Security
3 - User Access + Security
4 - Connection
5 - User Access + Connection
6 - Security + Connection
7 - All
[no] inauth <integer>
Configure how clients attempting to connect to the LoadMaster are authenticated
0 â€“ None: no client authentication is required
1 - Basic Authentication: standard Basic Authentication is used
2 - Form Based: clients must enter their user details within a form to be authenticated on the LoadMaster
[no] outauth <integer>
Configure how the LoadMaster is authenticated by the Real Servers
0 â€“ None: no authentication is required
1 - Basic Authentication: standard Basic Authentication is used
Note:outauth is restricted by inauth.
Value can only be the same or none.
Form Based auth can use any
Right now the only available option is Basic
0 - Legacy Operation
1 - X-Forwarded-For
2 - None
3 - X-ClientSide
4 - X-ClientSide (No Via)
5 - X-Forwarded-For (No Via)
6 - Via Only
[no] excludedir [<string>]
List virtual directories specified within this field will not be pre-authorized on this Virtual Service and will be passed directly to the relevant Real Servers.
[no] smtpallow [<string>]
List all the permitted domains that are allowed to be received by this Virtual Service
[no] altaddress [<IPspec>]duplicate <IPspec>[no] extraports <integer>[no] sslaccel[no] mtype [<string>]Show
Displays all the parameters of the current Virtual Service.
Prints out a list of commands at the Virtual Service command level.
Return the input to the top level. Any changes to the Virtual Service will be saved. If an error is detected in the Virtual Service, the system reports the error and asks if the Virtual Service should be discarded. If the Virtual Service is not discarded, the input remains at the Virtual Service level, where any corrections may be made.
This command adds the rule <Rule-name> to a Real Server. If this is the first assignment of <Rule-name> to a Real Server on the current Virtual Service, the rule will be placed on the precedence list as the lowest user defined rule I.e. checked after all other rules. Use the Virtual Service command Precedence to change the precedence order.
This command removes the association of rule <Rule-name> from the Real Server. If there are no more instances of the rule associated with the Virtual Service, the rule will be deleted from the Virtual Service precedence list.
Virtual Service will not be affected.
Forward <forwarding method>
This specifies the forwarding method, which should be used to access the Real Service.
This can be either <nat> or <route>. By default the forwarding method is <nat>, <route> should only be selected when using â€œdirect service returnâ€.
Lists the commands at this level.
Return to the Virtual Service command level. No changes will be saved until the editing of the current Virtual Service has been completed.
Web User Interface (WUI), Configuration Guide
KEMP LoadMaster, Product Overview
RESTful API, Interface Description
This document was last updated on 28 March 2018.