acl <aclname> <criterion> [flags] [operator] <value> ...
Declare or complete an access list.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes(!) | yes | yes | yes
backlog <conns>
Give hints to the system about the approximate listen backlog desired size
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
<conns> is the number of pending connections. Depending on the operating
system, it may represent the number of already acknowledged
balance <algorithm> [ <arguments> ]
balance url_param <param> [check_post]
Define the load balancing algorithm to be used in a backend.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<algorithm> is the algorithm used to select a server when doing load
balancing. This only applies when no persistence information
bind [<address>]:<port_range> [, ...] [param*]
bind /<path> [, ...] [param*]
Define one or several listening addresses and/or ports in a frontend.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | no
+
Arguments :
<address> is optional and can be a host name, an IPv4 address, an IPv6
address, or '*'. It designates the address the frontend will
capture cookie <name> len <length>
Capture and log a cookie in the request and in the response.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | no
+
Arguments :
<name> is the beginning of the name of the cookie to capture. In order
to match the exact name, simply suffix the name with an equal
capture request header <name> len <length>
Capture and log the last occurrence of the specified request header.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | no
+
Arguments :
<name> is the name of the header to capture. The header names are not
case-sensitive, but it is a common practice to write them as they
capture response header <name> len <length>
Capture and log the last occurrence of the specified response header.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | no
+
Arguments :
<name> is the name of the header to capture. The header names are not
case-sensitive, but it is a common practice to write them as they
clitcpka-cnt <count>
Sets the maximum number of keepalive probes TCP should send before dropping
the connection on the client side.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
<count> is the maximum number of keepalive probes.
Sets the time the connection needs to remain idle before TCP starts sending
keepalive probes, if enabled the sending of TCP keepalive packets on the
client side.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
<timeout> is the time the connection needs to remain idle before TCP starts
sending keepalive probes. It is specified in seconds by default,
clitcpka-intvl <timeout>
Sets the time between individual keepalive probes on the client side.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
<timeout> is the time between individual keepalive probes. It is specified
in seconds by default, but can be in any other unit if the number
compression algo-res <algorithm>
compression type <mime type> ...
Enable HTTP compression.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
algo is followed by the list of supported compression algorithms for
responses (legacy keyword)
compression offload
Makes HAProxy work as a compression offloader only.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | yes
compress only responses, or "both", when you want to compress both.
The default value is "response".
+ May be used in the following contexts: http
+
See also : "compression type", "compression algo", "compression offload"
cookie <name> [ rewrite | insert | prefix ] [ indirect ] [ nocache ]
[ domain <domain> ]* [ maxidle <idle> ] [ maxlife <life> ]
[ dynamic ] [ attr <value> ]*
Enable cookie-based persistence in a backend.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<name> is the name of the cookie which will be monitored, modified or
inserted in order to bring persistence. This cookie is sent to
declare capture [ request | response ] len <length>
Declares a capture slot.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | no
+
Arguments:
<length> is the length allowed for the capture.
default-server [param*]
Change default options for a server in a backend
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments:
<param*> is a list of parameters for this server. The "default-server"
keyword accepts an important number of options and has a complete
default_backend <backend>
Specify the backend to use when no "use_backend" rule has been matched.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
<backend> is the name of the backend to use.
description <string>
Describe a listen, frontend or backend.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | yes
+
Arguments : string
Allows to add a sentence to describe the related object in the HAProxy HTML
disabled
Disable a proxy, frontend or backend.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
The "disabled" keyword is used to disable an instance, mainly in order to
dispatch <address>:<port>
Set a default server address
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
no | no | yes | yes
+
Arguments :
<address> is the IPv4 address of the default server. Alternatively, a
dynamic-cookie-key <string>
Set the dynamic cookie secret key for a backend.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : The secret key to be used.
When dynamic cookies are enabled (see the "dynamic" directive for cookie),
enabled
Enable a proxy, frontend or backend.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
The "enabled" keyword is used to explicitly enable an instance, when the
errorfile <code> <file>
Return a file contents instead of errors generated by HAProxy
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<code> is the HTTP status code. Currently, HAProxy is capable of
generating codes 200, 400, 401, 403, 404, 405, 407, 408, 410,
errorfiles <name> [<code> ...]
Import, fully or partially, the error files defined in the <name> http-errors
section.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<name> is the name of an existing http-errors section.
errorloc <code> <url>
errorloc302 <code> <url>
Return an HTTP redirection to a URL instead of errors generated by HAProxy
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<code> is the HTTP status code. Currently, HAProxy is capable of
generating codes 200, 400, 401, 403, 404, 405, 407, 408, 410,
errorloc303 <code> <url>
Return an HTTP redirection to a URL instead of errors generated by HAProxy
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<code> is the HTTP status code. Currently, HAProxy is capable of
generating codes 200, 400, 401, 403, 404, 405, 407, 408, 410,
email-alert from <emailaddr>
Declare the from email address to be used in both the envelope and header
of email alerts. This is the address that email alerts are sent from.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | yes | yes | yes
email-alert level <level>
Declare the maximum log level of messages for which email alerts will be
sent. This acts as a filter on the sending of email alerts.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | yes | yes | yes
email-alert mailers <mailersect>
Declare the mailers to be used when sending email alerts
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | yes | yes | yes
email-alert myhostname <hostname>
Declare the to hostname address to be used when communicating with
mailers.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | yes | yes | yes
email-alert to <emailaddr>
Declare both the recipient address in the envelope and to address in the
header of email alerts. This is the address that email alerts are sent to.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | yes | yes | yes
error-log-format <string>
Specifies the log format string to use in case of connection error on the frontend side.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections: defaults | frontend | listen | backend
yes | yes | yes | no
force-persist { if | unless } <condition>
Declare a condition to force persistence on down servers
+
+ May be used in the following contexts: tcp, http
+
May be used in sections: defaults | frontend | listen | backend
no | no | yes | yes
filter <name> [param*]
Add the filter <name> in the filter list attached to the proxy.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | yes
+
Arguments :
<name> is the name of the filter. Officially supported filters are
referenced in section 9.
fullconn <conns>
Specify at what backend load the servers will reach their maxconn
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<conns> is the number of connections on the backend which will make the
servers use the maximal number of connections.
hash-balance-factor <factor>
Specify the balancing factor for bounded-load consistent hashing
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | no | yes
+
Arguments :
<factor> is the control for the maximum number of concurrent requests to
send to a server, expressed as a percentage of the average number
hash-type <method> <function> <modifier>
Specify a method to use for mapping hashes to servers
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<method> is the method used to select a server from the hash computed by
the <function> :
Access control for all Layer 7 responses (server, applet/service and internal
ones).
+ May be used in the following contexts: http
+
May be used in sections: defaults | frontend | listen | backend
yes(!) | yes | yes | yes
http-check comment <string>
Defines a comment for the following the http-check rule, reported in logs if
it fails.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
[via-socks4] [ssl] [sni <sni>] [alpn <alpn>] [linger]
[proto <name>] [comment <msg>]
Opens a new connection to perform an HTTP health check
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
http-check disable-on-404
Enable a maintenance mode upon HTTP/404 response to health-checks
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
When this option is set, a server which returns an HTTP code 404 will be
[on-success <fmt>] [on-error <fmt>] [status-code <expr>]
[!] <match> <pattern>
Make HTTP health checks consider response contents or specific status codes
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
[comment <msg>]
Add a possible list of headers and/or a body to the request sent during HTTP
health checks.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
comment <msg> defines a message to report if the rule evaluation fails.
http-check send-state
Enable emission of a state header with HTTP health checks
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
When this option is set, HAProxy will systematically send a special header
http-check set-var(<var-name>[,<cond>...]) <expr>
http-check set-var-fmt(<var-name>[,<cond>...]) <fmt>
This operation sets the content of a variable. The variable is declared inline.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
http-check unset-var(<var-name>)
Free a reference to a variable within its scope.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
file <file> | lf-file <file> | string <str> | lf-string <fmt> } ]
[ hdr <name> <fmt> ]*
Defines a custom error message to use instead of errors generated by HAProxy.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
status <code> is the HTTP status code. It must be specified.
Currently, HAProxy is capable of generating codes
http-request <action> [options...] [ { if | unless } <condition> ]
Access control for Layer 7 requests
+ May be used in the following contexts: http
+
May be used in sections: defaults | frontend | listen | backend
yes(!) | yes | yes | yes
http-response <action> <options...> [ { if | unless } <condition> ]
Access control for Layer 7 responses
+ May be used in the following contexts: http
+
May be used in sections: defaults | frontend | listen | backend
yes(!) | yes | yes | yes
http-reuse { never | safe | aggressive | always }
Declare how idle HTTP connections may be shared between requests
+ May be used in the following contexts: http
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
http-send-name-header [<header>]
Add the server name to a request. Use the header string given by <header>
+
+ May be used in the following contexts: http
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<header> The header string to use to send the server name
id <value>
Set a persistent ID to a proxy.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | yes
+
Arguments : none
Set a persistent ID for the proxy. This ID must be unique and positive.
ignore-persist { if | unless } <condition>
Declare a condition to ignore persistence
+
+ May be used in the following contexts: tcp, http
+
May be used in sections: defaults | frontend | listen | backend
no | no | yes | yes
load-server-state-from-file { global | local | none }
Allow seamless reload of HAProxy
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
<facility> [<level> [<minlevel>]]
no log
Enable per-instance logging of events and traffic.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
log-format <string>
Specifies the log format string to use for traffic logs
+
+ May be used in the following contexts: tcp, http
+
May be used in sections: defaults | frontend | listen | backend
yes | yes | yes | no
log-format-sd <string>
Specifies the RFC5424 structured-data log format string
+
+ May be used in the following contexts: tcp, http
+
May be used in sections: defaults | frontend | listen | backend
yes | yes | yes | no
log-tag <string>
Specifies the log tag to use for all outgoing logs
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | yes | yes | yes
max-keep-alive-queue <value>
Set the maximum server queue size for maintaining keep-alive connections
+
+ May be used in the following contexts: http
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
Set the maximum number of outgoing connections we can keep idling for a given
client session. The default is 5 (it precisely equals MAX_SRV_LIST which is
defined at build time).
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
maxconn <conns>
Fix the maximum number of concurrent connections on a frontend
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
<conns> is the maximum number of concurrent connections the frontend will
accept to serve. Excess connections will be queued by the system
monitor fail { if | unless } <condition>
Add a condition to report a failure to a monitor HTTP request.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | no
+
Arguments :
if <cond> the monitor request will fail if the condition is satisfied,
and will succeed otherwise. The condition should describe a
monitor-uri <uri>
Intercept a URI used by external components' monitor requests
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
<uri> is the exact URI which we want to intercept to return HAProxy's
health status instead of forwarding the request.
option abortonclose
no option abortonclose
Enable or disable early dropping of aborted requests pending in queues.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
In presence of very high loads, the servers will take some time to respond.
option accept-invalid-http-request
no option accept-invalid-http-request
Enable or disable relaxing of HTTP request parsing
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
By default, HAProxy complies with RFC7230 in terms of message parsing. This
option accept-invalid-http-response
no option accept-invalid-http-response
Enable or disable relaxing of HTTP response parsing
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
By default, HAProxy complies with RFC7230 in terms of message parsing. This
option allbackups
no option allbackups
Use either all backup servers at a time or only the first one
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
By default, the first operational backup server gets all traffic when normal
option checkcache
no option checkcache
Analyze all server responses and block responses with cacheable cookies
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
Some high-level frameworks set application cookies everywhere and do not
option clitcpka
no option clitcpka
Enable or disable the sending of TCP keepalive packets on the client side
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
When there is a firewall or any session-aware component between a client and
option contstats
Enable continuous traffic statistics updates
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
By default, counters used for statistics calculation are incremented
no option disable-h2-upgrade
Enable or disable the implicit HTTP/2 upgrade from an HTTP/1.x client
connection.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
By default, HAProxy is able to implicitly upgrade an HTTP/1.x client
option dontlog-normal
no option dontlog-normal
Enable or disable logging of normal, successful connections
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
There are large sites dealing with several thousand connections per second
option dontlognull
no option dontlognull
Enable or disable logging of null connections
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
In certain environments, there are components which will regularly connect to
[ for | for-expr <for_expr> ] [ for_port | for_port-expr <for_port_expr>]
no option forwarded
Enable insertion of the rfc 7239 forwarded header in requests sent to servers
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<host_expr> optional argument to specify a custom sample expression
those result will be used as 'host' parameter value
option forwardfor [ except <network> ] [ header <name> ] [ if-none ]
Enable insertion of the X-Forwarded-For header to requests sent to servers
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<network> is an optional argument used to disable this option for sources
matching <network>
option h1-case-adjust-bogus-client
no option h1-case-adjust-bogus-client
Enable or disable the case adjustment of HTTP/1 headers sent to bogus clients
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
There is no standard case for header names because, as stated in RFC7230,
option h1-case-adjust-bogus-server
no option h1-case-adjust-bogus-server
Enable or disable the case adjustment of HTTP/1 headers sent to bogus servers
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
There is no standard case for header names because, as stated in RFC7230,
option http-buffer-request
no option http-buffer-request
Enable or disable waiting for whole HTTP request body before proceeding
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
It is sometimes desirable to wait for the body of an HTTP request before
option http-ignore-probes
no option http-ignore-probes
Enable or disable logging of null connections and request timeouts
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
Recently some browsers started to implement a "pre-connect" feature
no option http-keep-alive
Enable or disable HTTP keep-alive from client to server for HTTP/1.x
connections
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
By default HAProxy operates in keep-alive mode with regards to persistent
option http-no-delay
no option http-no-delay
Instruct the system to favor low interactive delays over performance in HTTP
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
In HTTP, each payload is unidirectional and has no notion of interactivity.
no option http-pretend-keepalive
Define whether HAProxy will announce keepalive for HTTP/1.x connection to the
server or not
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
When running with "option http-server-close" or "option httpclose", HAProxy
option http-restrict-req-hdr-names { preserve | delete | reject }
Set HAProxy policy about HTTP request header names containing characters
outside the "[a-zA-Z0-9-]" charset
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
preserve disable the filtering. It is the default mode for HTTP proxies
with no FastCGI application configured.
option http-server-close
no option http-server-close
Enable or disable HTTP/1.x connection closing on the server side
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
By default HAProxy operates in keep-alive mode with regards to persistent
option http-use-proxy-header
no option http-use-proxy-header
Make use of non-standard Proxy-Connection header instead of Connection
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
While RFC7230 explicitly states that HTTP/1.1 agents must use the
option httpchk <method> <uri>
option httpchk <method> <uri> <version>
Enables HTTP protocol to check on the servers health
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<method> is the optional HTTP method used with the requests. When not set,
the "OPTIONS" method is used, as it generally requires low server
option httpclose
no option httpclose
Enable or disable HTTP/1.x connection closing
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
By default HAProxy operates in keep-alive mode with regards to persistent
option httplog [ clf ]
Enable logging of HTTP request, session state and timers
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
clf if the "clf" argument is added, then the output format will be
the CLF format instead of HAProxy's default HTTP format. You can
option httpslog
Enable logging of HTTPS request, session state and timers
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
option independent-streams
no option independent-streams
Enable or disable independent timeout processing for both directions
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
By default, when data is sent over a socket, both the write timeout and the
option ldap-check
Use LDAPv3 health checks for server testing
+
+ May be used in the following contexts: tcp
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
It is possible to test that the server correctly talks LDAPv3 instead of just
option external-check
Use external processes for server health checks
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
option idle-close-on-response
no option idle-close-on-response
Avoid closing idle frontend connections if a soft stop is in progress
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
By default, idle connections will be closed during a soft stop. In some
option log-health-checks
no option log-health-checks
Enable or disable logging of health checks status updates
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
By default, failed health check are logged if server is UP and successful
option log-separate-errors
no option log-separate-errors
Change log level for non-completely successful connections
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
Sometimes looking for errors in logs is not easy. This option makes HAProxy
option logasap
no option logasap
Enable or disable early logging.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
By default, logs are emitted when all the log format variables and sample
option mysql-check [ user <username> [ { post-41 | pre-41 } ] ]
Use MySQL health checks for server testing
+
+ May be used in the following contexts: tcp
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<username> This is the username which will be used when connecting to MySQL
server.
option nolinger
no option nolinger
Enable or disable immediate session resource cleaning after close
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
When clients or servers abort connections in a dirty way (e.g. they are
option originalto [ except <network> ] [ header <name> ]
Enable insertion of the X-Original-To header to requests sent to servers
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<network> is an optional argument used to disable this option for sources
matching <network>
option persist
no option persist
Enable or disable forced persistence on down servers
+
+ May be used in the following contexts: tcp, http
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
When an HTTP request reaches a backend with a cookie which references a dead
option pgsql-check user <username>
Use PostgreSQL health checks for server testing
+
+ May be used in the following contexts: tcp
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<username> This is the username which will be used when connecting to
PostgreSQL server.
option prefer-last-server
no option prefer-last-server
Allow multiple load balanced requests to remain on the same server
+
+ May be used in the following contexts: tcp, http
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
When the load balancing algorithm in use is not deterministic, and a previous
option redispatch <interval>
no option redispatch
Enable or disable session redistribution in case of connection failure
+
+ May be used in the following contexts: tcp, http
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<interval> The optional integer value that controls how often redispatches
occur when retrying connections. Positive value P indicates a
option redis-check
Use redis health checks for server testing
+
+ May be used in the following contexts: tcp
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
It is possible to test that the server correctly talks REDIS protocol instead
option smtpchk
option smtpchk <hello> <domain>
Use SMTP health checks for server testing
+
+ May be used in the following contexts: tcp
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<hello> is an optional argument. It is the "hello" command to use. It can
be either "HELO" (for SMTP) or "EHLO" (for ESMTP). All other
no option socket-stats
Enable or disable collecting & providing separate statistics for each socket.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
option splice-auto
no option splice-auto
Enable or disable automatic kernel acceleration on sockets in both directions
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
When this option is enabled either on a frontend or on a backend, HAProxy
option splice-request
no option splice-request
Enable or disable automatic kernel acceleration on sockets for requests
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
When this option is enabled either on a frontend or on a backend, HAProxy
option splice-response
no option splice-response
Enable or disable automatic kernel acceleration on sockets for responses
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
When this option is enabled either on a frontend or on a backend, HAProxy
option spop-check
Use SPOP health checks for server testing
+
+ May be used in the following contexts: tcp
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
It is possible to test that the server correctly talks SPOP protocol instead
option srvtcpka
no option srvtcpka
Enable or disable the sending of TCP keepalive packets on the server side
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
When there is a firewall or any session-aware component between a client and
option ssl-hello-chk
Use SSLv3 client hello health checks for server testing
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
When some SSL-based protocols are relayed in TCP mode through HAProxy, it is
option tcp-check
Perform health checks using tcp-check send/expect sequences
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
option tcp-smart-accept
no option tcp-smart-accept
Enable or disable the saving of one ACK packet during the accept sequence
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
When an HTTP connection request comes in, the system acknowledges it on
option tcp-smart-connect
no option tcp-smart-connect
Enable or disable the saving of one ACK packet during the connect sequence
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
On certain systems (at least Linux), HAProxy can ask the kernel not to
option tcpka
Enable or disable the sending of TCP keepalive packets on both sides
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
When there is a firewall or any session-aware component between a client and
option tcplog
Enable advanced logging of TCP connections with session state and timers
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments : none
By default, the log output format is very poor, as it only contains the
option transparent
no option transparent
Enable client-side transparent proxying
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
This option was introduced in order to provide layer 7 persistence to layer 3
external-check command <command>
Executable to run when performing an external-check
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
external-check path <path>
The value of the PATH environment variable used when running an external-check
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
persist rdp-cookie
persist rdp-cookie(<name>)
Enable RDP cookie-based persistence
+
+ May be used in the following contexts: tcp
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<name> is the optional name of the RDP cookie to check. If omitted, the
default cookie name "msts" will be used. There currently is no
rate-limit sessions <rate>
Set a limit on the number of new sessions accepted per second on a frontend
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
<rate> The <rate> parameter is an integer designating the maximum number
of new sessions per second to accept on the frontend.
redirect prefix <pfx> [code <code>] <option> [{if | unless} <condition>]
redirect scheme <sch> [code <code>] <option> [{if | unless} <condition>]
Return an HTTP redirection if/unless a condition is matched
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | yes
retries <value>
Set the number of retries to perform on a server after a failure
+
+ May be used in the following contexts: tcp, http
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<value> is the number of times a request or connection attempt should be
retried on a server after a failure.
Specify when to attempt to automatically retry a failed request.
This setting is only valid when "mode" is set to http and is silently ignored
otherwise.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<keywords> is a space-delimited list of keywords or HTTP status codes, each
representing a type of failure event on which an attempt to
server <name> <address>[:[port]] [param*]
Declare a server in a backend
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
no | no | yes | yes
+
Arguments :
<name> is the internal name assigned to this server. This name will
appear in logs and alerts. If "http-send-name-header" is
server-state-file-name [ { use-backend-name | <file> } ]
Set the server state file to read, load and apply to servers available in
this backend.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
no | no | yes | yes
server-template <prefix> <num | range> <fqdn>[:<port>] [params*]
Set a template to initialize servers with shared parameters.
The names of these servers are built from <prefix> and <num | range> parameters.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
no | no | yes | yes
source <addr>[:<port>] [usesrc { <addr2>[:<port2>] | hdr_ip(<hdr>[,<occ>]) } ]
source <addr>[:<port>] [interface <name>]
Set the source address for outgoing connections
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<addr> is the IPv4 address HAProxy will bind to before connecting to a
server. This address is also used as a source for health checks.
srvtcpka-cnt <count>
Sets the maximum number of keepalive probes TCP should send before dropping
the connection on the server side.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<count> is the maximum number of keepalive probes.
Sets the time the connection needs to remain idle before TCP starts sending
keepalive probes, if enabled the sending of TCP keepalive packets on the
server side.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<timeout> is the time the connection needs to remain idle before TCP starts
sending keepalive probes. It is specified in seconds by default,
srvtcpka-intvl <timeout>
Sets the time between individual keepalive probes on the server side.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<timeout> is the time between individual keepalive probes. It is specified
in seconds by default, but can be in any other unit if the number
stats admin { if | unless } <cond>
Enable statistics admin level if/unless a condition is matched
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | yes
stats auth <user>:<passwd>
Enable statistics with authentication and grant access to an account
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<user> is a user name to grant access to
stats enable
Enable statistics reporting with default settings
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
This statement enables statistics reporting with default settings defined
stats hide-version
Enable statistics and hide HAProxy version reporting
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
By default, the stats page reports some useful status information along with
[ { if | unless } <condition> ]
Access control for statistics
+ May be used in the following contexts: http
+
May be used in sections: defaults | frontend | listen | backend
no | no | yes | yes
stats realm <realm>
Enable statistics and set authentication realm
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<realm> is the name of the HTTP Basic Authentication realm reported to
the browser. The browser uses it to display it in the pop-up
stats refresh <delay>
Enable statistics with automatic refresh
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<delay> is the suggested refresh delay, specified in seconds, which will
be returned to the browser consulting the report page. While the
stats scope { <name> | "." }
Enable statistics and limit access scope
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<name> is the name of a listen, frontend or backend section to be
reported. The special name "." (a single dot) designates the
stats show-desc [ <desc> ]
Enable reporting of a description on the statistics page.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
stats show-legends
Enable reporting additional information on the statistics page
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
Enable reporting additional information on the statistics page :
stats show-modules
Enable display of extra statistics module on the statistics page
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments : none
New columns are added at the end of the line containing the extra statistics
stats show-node [ <name> ]
Enable reporting of a host name on the statistics page.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments:
<name> is an optional name to be reported. If unspecified, the
node name from global section is automatically used instead.
stats uri <prefix>
Enable statistics and define the URI prefix to access them
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<prefix> is the prefix of any URI which will be redirected to stats. This
prefix may contain a question mark ('?') to indicate part of a
stick match <pattern> [table <table>] [{if | unless} <cond>]
Define a request pattern matching condition to stick a user to a server
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
no | no | yes | yes
stick on <pattern> [table <table>] [{if | unless} <condition>]
Define a request pattern to associate a user to a server
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
no | no | yes | yes
stick store-request <pattern> [table <table>] [{if | unless} <condition>]
Define a request pattern used to create an entry in a stickiness table
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
no | no | yes | yes
size <size> [expire <expire>] [nopurge] [peers <peersect>] [srvkey <srvkey>]
[write-to <wtable>] [store <data_type>]*
Configure the stickiness table for the current section
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | yes
stick store-response <pattern> [table <table>] [{if | unless} <condition>]
Define a response pattern used to create an entry in a stickiness table
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
no | no | yes | yes
tcp-check comment <string>
Defines a comment for the following the tcp-check rule, reported in logs if
it fails.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
[ssl] [sni <sni>] [alpn <alpn>] [linger]
[proto <name>] [comment <msg>]
Opens a new connection
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
[on-success <fmt>] [on-error <fmt>] [status-code <expr>]
[!] <match> <pattern>
Specify data to be collected and analyzed during a generic health check
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
tcp-check send-lf <fmt> [comment <msg>]
Specify a string or a log-format string to be sent as a question during a
generic health check
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
tcp-check send-binary-lf <hexfmt> [comment <msg>]
Specify an hex digits string or an hex digits log-format string to be sent as
a binary question during a raw tcp health check
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
tcp-check set-var(<var-name>[,<cond>...]) <expr>
tcp-check set-var-fmt(<var-name>[,<cond>...]) <fmt>
This operation sets the content of a variable. The variable is declared inline.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
tcp-check unset-var(<var-name>)
Free a reference to a variable within its scope.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
tcp-request connection <action> <options...> [ { if | unless } <condition> ]
Perform an action on an incoming connection depending on a layer 4 condition
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes(!) | yes | yes | no
+
Arguments :
<action> defines the action to perform if the condition applies. See
below.
tcp-request content <action> [{if | unless} <condition>]
Perform an action on a new session depending on a layer 4-7 condition
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes(!) | yes | yes | yes
+
Arguments :
<action> defines the action to perform if the condition applies. See
below.
tcp-request inspect-delay <timeout>
Set the maximum allowed time to wait for data during content inspection
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes(!) | yes | yes | yes
+
Arguments :
<timeout> is the timeout value specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
tcp-request session <action> [{if | unless} <condition>]
Perform an action on a validated session depending on a layer 5 condition
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes(!) | yes | yes | no
+
Arguments :
<action> defines the action to perform if the condition applies. See
below.
tcp-response content <action> [{if | unless} <condition>]
Perform an action on a session response depending on a layer 4-7 condition
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes(!) | no | yes | yes
+
Arguments :
<action> defines the action to perform if the condition applies. See
below.
tcp-response inspect-delay <timeout>
Set the maximum allowed time to wait for a response during content inspection
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes(!) | no | yes | yes
+
Arguments :
<timeout> is the timeout value specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
Set additional check timeout, but only after a connection has been already
established.
+ May be used in the following contexts: tcp, http, log
+
May be used in sections: defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments:
<timeout> is the timeout value specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
timeout client <timeout>
Set the maximum inactivity time on the client side.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
<timeout> is the timeout value specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
timeout client-fin <timeout>
Set the inactivity timeout on the client side for half-closed connections.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
<timeout> is the timeout value specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
timeout client-hs <timeout>
Set the maximum time to wait for a client TLS handshake to complete. This is
usable both for TCP and QUIC connections.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
<timeout> is the timeout value specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
timeout connect <timeout>
Set the maximum time to wait for a connection attempt to a server to succeed.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<timeout> is the timeout value specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
timeout http-keep-alive <timeout>
Set the maximum allowed time to wait for a new HTTP request to appear
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<timeout> is the timeout value specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
timeout http-request <timeout>
Set the maximum allowed time to wait for a complete HTTP request
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<timeout> is the timeout value specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
timeout queue <timeout>
Set the maximum time to wait in the queue for a connection slot to be free
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<timeout> is the timeout value specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
timeout server <timeout>
Set the maximum inactivity time on the server side.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<timeout> is the timeout value specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
timeout server-fin <timeout>
Set the inactivity timeout on the server side for half-closed connections.
+
+ May be used in the following contexts: tcp, http, log
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<timeout> is the timeout value specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
timeout tarpit <timeout>
Set the duration for which tarpitted connections will be maintained
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | yes
+
Arguments :
<timeout> is the tarpit duration specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
timeout tunnel <timeout>
Set the maximum inactivity time on the client and server side for tunnels.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments :
<timeout> is the timeout value specified in milliseconds by default, but
can be in any other unit if the number is suffixed by the unit,
transparent (deprecated)
Enable client-side transparent proxying
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | no | yes | yes
+
Arguments : none
This keyword was introduced in order to provide layer 7 persistence to layer
unique-id-format <string>
Generate a unique ID for each request.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
<string> is a log-format string.
unique-id-header <name>
Add a unique ID header in the HTTP request.
+
+ May be used in the following contexts: http
+
May be used in sections : defaults | frontend | listen | backend
yes | yes | yes | no
+
Arguments :
<name> is the name of the header.
use_backend <backend> [{if | unless} <condition>]
Switch to a specific backend if/unless an ACL-based condition is matched.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
no | yes | yes | no
+
Arguments :
<backend> is the name of a valid backend or "listen" section, or a
"log-format" string resolving to a backend name.
use-fcgi-app <name>
Defines the FastCGI application to use for the backend.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
no | no | yes | yes
+
Arguments :
<name> is the name of the FastCGI application to use.
use-server <server> if <condition>
use-server <server> unless <condition>
Only use a specific server if/unless an ACL-based condition is matched.
+
+ May be used in the following contexts: tcp, http
+
May be used in sections : defaults | frontend | listen | backend
no | no | yes | yes
+
Arguments :
<server> is the name of a valid server in the same backend section
or a "log-format" string resolving to a server name.
projects / thirdparty / haproxy.git / commitdiff
