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.

Add <IPspec>

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.

Address <IPspec>

Specifies the IP address of the Virtual Service.

Delete <IPspec>

Deletes a Real Server as specified by <IPspec> from the Virtual Service. A Virtual

Service must have at least one Real Server.

Disable

Disable the Virtual Service. This means that the Virtual Service will accept no new requests.

Enable

Re-enable a Virtual Service. The Virtual Service will again accept new requests.

Follow <Port Spec>

This command only works if the L7 option of the LoadMaster has been enabled. This specifies

Mask <Ipmask>

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>.

Healthcheck <String>

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

Description

http

HTTP checking is enabled

https

HTTPS (SSL) checking is enabled

smtp

The Simple Mail Transfer Protocol (SMTP) is used.

nntp

The Network News Transfer Protocol (NNTP) is used.

ftp

The File Transfer Protocol (FTP) is used.

telnet

The Telnet protocol is used.

pop3

The Post Office – mail client protocol is used.

imap

The IMAP – mail client protocol is used.

tcp

A basic TCP connection is checked.

dns

A DNS request is sent to the Real Servers port. This checking method is only valid when using a UDP protocol.

udp

A dummy zero length UDP packet is sent to the port.

icmp

An ICMP ping is sent to the Real Server.

Check Parameters

In LoadMaster firmware version 7.2.52, the check Interval, Timeout, and Retry Count settings can be configured on each Virtual Service or SubVS. If any of these parameters are set to 0 they inherit the global value. Previously, these were just global settings

[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.

Persistency type

Description

ssl

The Session ID in an SSL connection is used to maintain client to Real Server persistency.

cookie

Server-generated cookies will be used.

active-cookie

LoadMaster-generated cookies will be used.

url

A request for a specific URL will always go to the same Real Server.

host

A request to the same virtual host will go to the same Real Server.

src

Enables IP-based persistency.

cookie- src

Server-generated cookies will be used. If the client does not return a cookie, the clients’ IP address will be used.

active- cook-src

A LoadMaster generated cookie will be used. If the client does not return the cookie, the clients’ IP address will be used.

cookie- hash

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, meaning 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, meaning a <default> rule will always be checked after every other rule.

Protocol <tcp/udp>

Protocol to be used for the Virtual Service. This may be <tcp> or <udp>. By default the protocol will be set to <tcp>.

Ptimeout <Integer>

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.
  • lcleast connection.
  • llcweighted least connection.

Server <IPspec>

This command enters the Real Server command level for the specified Real Server.

The Real Server must already be assigned to the Virtual Service.

cache

Enable caching

compress

Enable compression

urlverify

Enable IPS

dfltgw

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

addvia <integer>

  • 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.

Help

Prints out a list of commands at the Virtual Service command level.

End

Terminate the CLI session. No changes made in the Virtual Service command level (or lower) will be saved.

Exit

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.