API Objects Reference

L7 server

This is the actual server. All servers contained within the same farm deliver the same service.

Server attributes and options define the way and conditions by which to forward requests to the actual server, as well as its capacity to process requests comparatively to other servers of the same farm.

Servers are identified by a name and the name of the farm that it belongs to. Allowed characters are alpha-numerics, dot, dash, and underscore.

address Jump to heading

  • Definition: Server IP address

  • Type: IP


Mandatory, no default available

port Jump to heading

  • Definition: Port to forward requests to this server

  • Type: port

  • Default value: Incoming connection destination port is reused

  • Particular value: 0 means destination port of incoming connection is reused

max-connections Jump to heading

  • Definition: Specifies the maximum number of concurrent connections to send to this server. If the number of incoming concurrent requests goes higher than this value, the requests go into a queue to wait for a connection to be free.

  • Type: integer

  • Default value: unlimited

weight Jump to heading

  • Definition: Used to adjust the server’s weight relative to other servers in the farm. All servers receive a load proportional to their weight relative to the sum of all weights; hence the higher the weight, the higher the load.

    The default weight is 1, and the maximum value is 256.

    If you use this parameter to distribute the load according to a server’s capacity, we recommend that you start with values that can both grow and shrink (e.g. between 10 and 100) to allow enough room for adjustments.

  • Type: integer

  • Default value: 1

  • Particular value: 0 means that the server does not participate in load-balancing, but still accepts persistent connections.

  • Definition: Defines the identifier used as a cookie value to identify this server.

  • Type: string

sorry Jump to heading

  • Definition: A backup server that only gets traffic when all other normal servers in the farm are either down or overloaded (health checks).

  • Type: enum

  • Default value: Server is not a backup server

Value Description
enabled The current server is a backup server.

check Jump to heading

  • Definition: Run health checks on the current server to determine its ability to receive traffic.

  • Type: enum

  • Default value: The server is not checked

Value Description
enabled The current server is checked.

maintenance Jump to heading

  • Definition: Server disabled for maintenance purpose.

  • Type: enum

  • Default value: Server is not disabled

Value Description
enabled The current server is disabled.

SSL Jump to heading

  • Definition: Force SSL/TLS protocol when exchanging data with the server.

  • Type: enum

  • Default value: Traffic is not ciphered

Value Description
enabled Traffic is ciphered.

Do you have any suggestions on how we can improve the content of this page?