Real Servers
- Last Updated: February 27, 2024
- 2 minute read
- LoadMaster
- LoadMaster LTSF
- Documentation
A Real Server can be managed by using one of the commands below.
https://<LoadMasterIPAddress>/access/showrs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=<RSIPaddr>&rsport=<RSPort>
https://<LoadMasterIPAddress>/access/delrs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=<RSIPaddr>&rsport=<RSPort>
https://<LoadMasterIPAddress>/access/delrs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=!<RSIndex>
https://<LoadMasterIPAddress>/access/addrs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=<RSIPaddr>&rsport=<RSPort>
https://<LoadMasterIPAddress>/access/modrs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=<RSIPaddr>&rsport=<RSPort>
https://<LoadMasterIPAddress>/access/showrs?vs=<VirtualServiceID>&rs=<RSIPaddr>&rsport=<RSPort>The rs parameter accepts integers (ID), service names (for SubVSs) and IP addresses. The ID can be found in the <RSIndex> element when doing a showvs command, for example:
…
<Rs>
<Status>Up</Status>
<VSIndex>1</VSIndex>
<RsIndex>3</RsIndex>
<Addr>10.154.201.3</Addr>
<Port>80</Port>
<Forward>nat</Forward>
<Weight>1000</Weight>
<Limit>0</Limit>
<Enable>Y</Enable>
<Critical>N</Critical>
</Rs>
…
Alternatively, check the Modify Virtual Service screen in the WUI, which lists Real Server ID in the Id column in the Real Servers section.
For the rs parameter, when using <RSIndex>, always precede it with an exclamation mark (‘!’).
For example:
https://<LoadMasterIPAddress>/access/showrs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=!<RSIndex>
The Real Server IP address (that the rs parameter can be set to) can be in either IPv4 or IPv6 formats:
- Example IPv4 address:10.11.0.24
- Example IPv6 address: fdce:9b36:e54f:110::40:14
Some SubVS parameters, such as critical, need to be modified using the RsIndex of the SubVS, for example:
https://<LoadMasterIPAddress>/access/modrs?vs=<ParentVSIndex>&rs=!<RsIndexOfTheSubVS>&critical=<0/1>
To modify the settings of a Real Server which has been added to a SubVS, use the VS Index of the SubVS and the RsIndex of the Real Server, for example:
https://<LoadMasterIPAddress>/access/modrs?vs=<SubVSIndex>&rs=!<RsIndex>&critical=<0/1>
addrs and modrs accept the following additional (optional) parameters.
|
Name |
Type |
Default |
Range |
Description |
|---|---|---|---|---|
| addtoallsubvs | B | 0 | 0 - Disabled 1 - Enabled |
Enable this option when adding a Real Server to
all SubVSs of a Virtual Service. When using this parameter, ensure you set the vs parameter to the ID of the SubVS rather than the parent Virtual Service. Run the listvs command to retrieve the VSIndex of the SubVS. |
|
weight |
I |
1000 |
1-65535 |
When using weighted round robin scheduling, the weight of a Real Server is used to indicate what relative proportion of traffic should be sent to the server. Servers with higher values will receive more traffic. The weight of a SubVS can also be updated using the modrs command - set the rs to the number that appears in the Id column for the relevant SubVS in the parent Virtual Service modify screen. |
|
newport |
I |
<unset> |
3-65535 (change the Port of the Real Server) |
The port on the Real Server to be used. |
|
forward |
S |
nat |
nat, route |
The type of forwarding method used. The default method is NAT. Direct server return can only be used with Layer 4 services. |
|
enable |
B |
1 |
Enable or disable the Real Server. |
|
|
limit |
I |
0 |
0-100000 |
The maximum number of open connections that can be sent to a Real Server before it is taken out of rotation. |
|
non_local |
B |
0 |
0 - Disabled 1 - Enabled |
By default only Real Servers on local networks can be assigned to a Virtual Service. Enabling this option will allow a non-local Real Server to be assigned to the Virtual Service. This option will only be available if nonlocalrs has been enabled and the Transparent option has been disabled on the relevant Virtual Service. |
|
critical |
B |
0 |
0 - Disabled 1 - Enabled |
Enabling this parameter indicates that the Real Server is required for the Virtual Service to be considered available. The Virtual Service will be marked as down if the Real Server has failed or is disabled. |
|
follow |
I |
<unset> |
RsIndex of Real Server to follow |
Specify what Real Server the health check is based on by setting this parameter to the RsIndex of the Real Server to be followed. This can either be set to the RsIndex of the same Real Server to health check based on that particular Real Server status, or another Real Server can be specified. For example – if Real Server 1 is down, any Real Servers which have their health check based on Real Server 1 will also be marked as down, regardless of their actual Real Server status. |