HAProxy API Manual

Directive

• ca-base
• chroot
• cpu-map
• crt-base
• daemon
• deviceatlas-json-file
• deviceatlas-log-level
• deviceatlas-separator
• deviceatlas-properties-cookie
• external-check
• gid
• hard-stop-after
• group
• log
• log-send-hostname
• log-tag
• lua-load
• master-worker
• nbproc
• nbthread
• pidfile
• presetenv
• resetenv
• stats bind-process
• server-state-base
• server-state-file
• setenv
• ssl-default-bind-ciphers
• ssl-default-bind-options
• ssl-default-server-ciphers
• ssl-default-server-options
• ssl-dh-param-file
• ssl-server-verify
• stats socket
• stats timeout
• stats maxconn
• uid
• ulimit-n
• unix-bind
• unsetenv
• user
• node
• description
• 51degrees-data-file
• 51degrees-property-name-list
• 51degrees-property-separator
• 51degrees-cache-size
• wurfl-data-file
• wurfl-information-list
• wurfl-information-list-separator
• wurfl-patch-file
• wurfl-engine-mode
• wurfl-cache-size
• wurfl-useragent-priority
• max-spread-checks
• maxconn
• maxconnrate
• maxcomprate
• maxcompcpuusage
• maxpipes
• maxsessrate
• maxsslconn
• maxsslrate
• maxzlibmem
• noepoll
• nokqueue
• nopoll
• nosplice
• nogetaddrinfo
• noreuseport
• spread-checks
• ssl-engine
• ssl-mode-async
• tune.buffers.limit
• tune.buffers.reserve
• tune.bufsize
• tune.chksize
• tune.comp.maxlevel
• tune.h2.header-table-size
• tune.h2.initial-window-size
• tune.h2.max-concurrent-streams
• tune.http.cookielen
• tune.http.logurilen
• tune.http.maxhdr
• tune.idletimer
• tune.lua.forced-yield
• tune.lua.maxmem
• tune.lua.session-timeout
• tune.lua.task-timeout
• tune.lua.service-timeout
• tune.maxaccept
• tune.maxpollevents
• tune.maxrewrite
• tune.pattern.cache-size
• tune.pipesize
• tune.rcvbuf.client
• tune.rcvbuf.server
• tune.recv_enough
• tune.sndbuf.client
• tune.sndbuf.server
• tune.ssl.cachesize
• tune.ssl.force-private-cache
• tune.ssl.lifetime
• tune.ssl.maxrecord
• tune.ssl.default-dh-param
• tune.ssl.ssl-ctx-cache-size
• tune.ssl.capture-cipherlist-size
• tune.vars.global-max-size
• tune.vars.proc-max-size
• tune.vars.reqres-max-size
• tune.vars.sess-max-size
• tune.vars.txn-max-size
• tune.zlib.memlevel
• tune.zlib.windowsize
• debug
• quiet
• userlist
• group
• user
• peers
• disabled
• enable
• peer
• mailers
• mailer
• timeout mail
• acl
• appsession
• backlog
• balance
• balance url_param
• bind
• bind-process
• block
• capture cookie
• capture request header
• capture response header
• clitimeout
• compression algo
• compression type
• compression offload
• contimeout
• cookie
• declare capture
• default-server
• default_backend
• description
• disabled
• dispatch
• dynamic-cookie-key
• enabled
• errorfile
• errorloc
• errorloc302
• errorloc303
• email-alert from
• email-alert level
• email-alert mailers
• email-alert myhostname
• email-alert to
• force-persist
• filter
• fullconn
• grace
• hash-balance-factor
• hash-type
• http-check disable-on-404
• http-check expect
• http-check send-state
• http-request
• http-response
• http-reuse
• http-send-name-header
• id
• ignore-persist
• load-server-state-from-file
• log global
• log
• no log
• log-format
• log-format-sd
• log-tag
• max-keep-alive-queue
• maxconn
• mode
• monitor fail
• monitor-net
• monitor-uri
• option abortonclose
• no option abortonclose
• option accept-invalid-http-request
• no option accept-invalid-http-request
• option accept-invalid-http-response
• no option accept-invalid-http-response
• option allbackups
• no option allbackups
• option checkcache
• no option checkcache
• option clitcpka
• no option clitcpka
• option contstats
• option dontlog-normal
• no option dontlog-normal
• option dontlognull
• no option dontlognull
• option forceclose
• no option forceclose
• option forwardfor
• option http-buffer-request
• no option http-buffer-request
• option http-ignore-probes
• no option http-ignore-probes
• option http-keep-alive
• no option http-keep-alive
• option http-no-delay
• no option http-no-delay
• option http-pretend-keepalive
• no option http-pretend-keepalive
• option http-server-close
• no option http-server-close
• option http-tunnel
• no option http-tunnel
• option http-use-proxy-header
• no option http-use-proxy-header
• option httpchk
• option httpclose
• no option httpclose
• option httplog
• option http_proxy
• no option http_proxy
• option independent-streams
• no option independent-streams
• option ldap-check
• option external-check
• option log-health-checks
• no option log-health-checks
• option log-separate-errors
• no option log-separate-errors
• option logasap
• no option logasap
• option mysql-check
• option nolinger
• no option nolinger
• option originalto
• option persist
• no option persist
• option pgsql-check
• option prefer-last-server
• no option prefer-last-server
• option redispatch
• no option redispatch
• option redis-check
• option smtpchk
• option socket-stats
• no option socket-stats
• option splice-auto
• no option splice-auto
• option splice-request
• no option splice-request
• option splice-response
• no option splice-response
• option spop-check
• option srvtcpka
• no option srvtcpka
• option ssl-hello-chk
• option tcp-check
• option tcp-smart-accept
• no option tcp-smart-accept
• option tcp-smart-connect
• no option tcp-smart-connect
• option tcpka
• option tcplog
• option transparent
• no option transparent
• external-check command
• external-check path
• persist rdp-cookie
• rate-limit sessions
• redirect location
• redirect prefix
• redirect scheme
• redisp
• redispatch
• reqadd
• reqallow
• reqiallow
• reqdel
• reqidel
• reqdeny
• reqideny
• reqpass
• reqipass
• reqrep
• reqirep
• reqtarpit
• reqitarpit
• retries
• rspadd
• rspdel
• rspidel
• rspdeny
• rspideny
• rsprep
• rspirep
• server
• server-state-file-name
• server-template
• source
• srvtimeout
• stats admin
• stats auth
• stats enable
• stats hide-version
• stats http-request
• stats realm
• stats refresh
• stats scope
• stats show-desc
• stats show-legends
• stats show-node
• stats uri
• stick match
• stick on
• stick store-request
• stick-table type
• stick store-response
• tcp-check connect
• tcp-check expect
• tcp-check send
• tcp-check send-binary
• tcp-request connection
• tcp-request content
• tcp-request inspect-delay
• tcp-response content
• tcp-request session
• tcp-response inspect-delay
• timeout check
• timeout client
• timeout clitimeout
• timeout client-fin
• timeout connect
• timeout contimeout
• timeout http-keep-alive
• timeout http-request
• timeout queue
• timeout server
• timeout srvtimeout
• timeout server-fin
• timeout tarpit
• timeout tunnel
• transparent
• unique-id-format
• unique-id-header
• use_backend
• use-server
• accept-netscaler-cip
• accept-proxy
• allow-0rtt
• alpn
• backlog
• curves
• ecdhe
• ca-file
• ca-ignore-err
• ca-sign-file
• ca-sign-pass
• ciphers
• crl-file
• crt
• crt-ignore-err
• crt-list
• defer-accept
• expose-fd listeners
• force-sslv3
• force-tlsv10
• force-tlsv11
• force-tlsv12
• force-tlsv13
• generate-certificates
• gid
• group
• id
• interface
• level
• severity-output
• maxconn
• mode
• mss
• name
• namespace
• nice
• no-ca-names
• no-sslv3
• no-tls-tickets
• no-tlsv10
• no-tlsv11
• no-tlsv12
• no-tlsv13
• npn
• prefer-client-ciphers
• process
• ssl
• ssl-max-ver
• ssl-min-ver
• strict-sni
• tcp-ut
• tfo
• tls-ticket-keys
• transparent
• v4v6
• v6only
• uid
• user
• verify
• addr
• agent-check
• agent-send
• agent-inter
• agent-addr
• agent-port
• backup
• ca-file
• check
• check-send-proxy
• check-sni
• check-ssl
• ciphers
• cookie
• crl-file
• crt
• disabled
• enabled
• error-limit
• fall
• force-sslv3
• force-tlsv10
• force-tlsv11
• force-tlsv12
• force-tlsv13
• id
• init-addr
• inter
• fastinter
• downinter
• maxconn
• maxqueue
• minconn
• namespace
• no-agent-check
• no-backup
• no-check
• no-check-ssl
• no-send-proxy
• no-send-proxy-v2
• no-send-proxy-v2-ssl
• no-send-proxy-v2-ssl-cn
• no-ssl
• no-ssl-reuse
• no-sslv3
• no-tls-tickets
• no-tlsv10
• no-tlsv11
• no-tlsv12
• no-tlsv13
• no-verifyhost
• non-stick
• observe
• on-error
• on-marked-down
• on-marked-up
• port
• redir
• rise
• resolve-opts
• resolve-prefer
• resolve-net
• resolvers
• send-proxy
• send-proxy-v2
• send-proxy-v2-ssl
• send-proxy-v2-ssl-cn
• slowstart
• sni
• source
• ssl
• ssl-max-ver
• ssl-min-ver
• ssl-reuse
• stick
• tcp-ut
• track
• tls-tickets
• verify
• verifyhost
• weight
• resolvers
• accepted_payload_size
• nameserver
• hold
• resolution_pool_size
• resolve_retries
• timeout
• 51d.single
• add
• and
• b64dec
• base64
• bool
• bytes
• cpl
• crc32
• da-csv-conv
• debug
• div
• djb2
• even
• field
• hex
• hex2i
• http_date
• in_table
• ipmask
• json
• language
• lower
• ltime
• map
• mod
• mul
• nbsrv
• neg
• not
• odd
• or
• regsub
• capture-req
• capture-res
• sdbm
• sha1
• sub
• table_bytes_in_rate
• table_bytes_out_rate
• table_conn_cnt
• table_conn_cur
• table_conn_rate
• table_gpt0
• table_gpc0
• table_gpc0_rate
• table_http_err_cnt
• table_http_err_rate
• table_http_req_cnt
• table_http_req_rate
• table_kbytes_in
• table_kbytes_out
• table_server_id
• table_sess_cnt
• table_sess_rate
• table_trackers
• upper
• url_dec
• utime
• word
• wt6
• xor
• xxh32
• xxh64
• always_false
• always_true
• avg_queue
• be_conn
• be_sess_rate
• bin
• bool
• connslots
• date
• distcc_body
• distcc_param
• env
• fe_conn
• fe_req_rate
• fe_sess_rate
• hostname
• int
• ipv4
• ipv6
• meth
• nbproc
• nbsrv
• proc
• queue
• rand
• srv_conn
• srv_is_up
• srv_queue
• srv_sess_rate
• stopping
• str
• table_avl
• table_cnt
• thread
• var
• be_id
• be_name
• dst
• dst_conn
• dst_is_local
• dst_port
• fc_http_major
• fc_rcvd_proxy
• fc_rtt
• fc_rttvar
• fc_unacked
• fc_sacked
• fc_retrans
• fc_fackets
• fc_lost
• fc_reordering
• fe_id
• fe_name
• sc_bytes_in_rate
• sc0_bytes_in_rate
• sc1_bytes_in_rate
• sc2_bytes_in_rate
• sc_bytes_out_rate
• sc0_bytes_out_rate
• sc1_bytes_out_rate
• sc2_bytes_out_rate
• sc_clr_gpc0
• sc0_clr_gpc0
• sc1_clr_gpc0
• sc2_clr_gpc0
• sc_conn_cnt
• sc0_conn_cnt
• sc1_conn_cnt
• sc2_conn_cnt
• sc_conn_cur
• sc0_conn_cur
• sc1_conn_cur
• sc2_conn_cur
• sc_conn_rate
• sc0_conn_rate
• sc1_conn_rate
• sc2_conn_rate
• sc_get_gpc0
• sc0_get_gpc0
• sc1_get_gpc0
• sc2_get_gpc0
• sc_get_gpt0
• sc0_get_gpt0
• sc1_get_gpt0
• sc2_get_gpt0
• sc_gpc0_rate
• sc0_gpc0_rate
• sc1_gpc0_rate
• sc2_gpc0_rate
• sc_http_err_cnt
• sc0_http_err_cnt
• sc1_http_err_cnt
• sc2_http_err_cnt
• sc_http_err_rate
• sc0_http_err_rate
• sc1_http_err_rate
• sc2_http_err_rate
• sc_http_req_cnt
• sc0_http_req_cnt
• sc1_http_req_cnt
• sc2_http_req_cnt
• sc_http_req_rate
• sc0_http_req_rate
• sc1_http_req_rate
• sc2_http_req_rate
• sc_inc_gpc0
• sc0_inc_gpc0
• sc1_inc_gpc0
• sc2_inc_gpc0
• sc_kbytes_in
• sc0_kbytes_in
• sc1_kbytes_in
• sc2_kbytes_in
• sc_kbytes_out
• sc0_kbytes_out
• sc1_kbytes_out
• sc2_kbytes_out
• sc_sess_cnt
• sc0_sess_cnt
• sc1_sess_cnt
• sc2_sess_cnt
• sc_sess_rate
• sc0_sess_rate
• sc1_sess_rate
• sc2_sess_rate
• sc_tracked
• sc0_tracked
• sc1_tracked
• sc2_tracked
• sc_trackers
• sc0_trackers
• sc1_trackers
• sc2_trackers
• so_id
• src
• src_bytes_in_rate
• src_bytes_out_rate
• src_clr_gpc0
• src_conn_cnt
• src_conn_cur
• src_conn_rate
• src_get_gpc0
• src_get_gpt0
• src_gpc0_rate
• src_http_err_cnt
• src_http_err_rate
• src_http_req_cnt
• src_http_req_rate
• src_inc_gpc0
• src_is_local
• src_kbytes_in
• src_kbytes_out
• src_port
• src_sess_cnt
• src_sess_rate
• src_updt_conn_cnt
• srv_id
• 51d.all
• ssl_bc
• ssl_bc_alg_keysize
• ssl_bc_cipher
• ssl_bc_protocol
• ssl_bc_unique_id
• ssl_bc_session_id
• ssl_bc_use_keysize
• ssl_c_ca_err
• ssl_c_ca_err_depth
• ssl_c_der
• ssl_c_err
• ssl_c_i_dn
• ssl_c_key_alg
• ssl_c_notafter
• ssl_c_notbefore
• ssl_c_s_dn
• ssl_c_serial
• ssl_c_sha1
• ssl_c_sig_alg
• ssl_c_used
• ssl_c_verify
• ssl_c_version
• ssl_f_der
• ssl_f_i_dn
• ssl_f_key_alg
• ssl_f_notafter
• ssl_f_notbefore
• ssl_f_s_dn
• ssl_f_serial
• ssl_f_sha1
• ssl_f_sig_alg
• ssl_f_version
• ssl_fc
• ssl_fc_alg_keysize
• ssl_fc_alpn
• ssl_fc_cipher
• ssl_fc_cipherlist_bin
• ssl_fc_cipherlist_hex
• ssl_fc_cipherlist_str
• ssl_fc_cipherlist_xxh
• ssl_fc_has_crt
• ssl_fc_has_early
• ssl_fc_has_sni
• ssl_fc_is_resumed
• ssl_fc_npn
• ssl_fc_protocol
• ssl_fc_unique_id
• ssl_fc_session_id
• ssl_fc_sni
• ssl_fc_use_keysize
• payload
• payload_lv
• req.hdrs
• req.hdrs_bin
• req.len
• req_len
• req.payload
• req.payload_lv
• req.proto_http
• req_proto_http
• req.rdp_cookie
• rdp_cookie
• req.rdp_cookie_cnt
• rdp_cookie_cnt
• req.ssl_ec_ext
• req.ssl_hello_type
• req_ssl_hello_type
• req.ssl_sni
• req_ssl_sni
• req.ssl_st_ext
• req.ssl_ver
• req_ssl_ver
• res.len
• res.payload
• res.payload_lv
• res.ssl_hello_type
• rep_ssl_hello_type
• wait_end
• base
• base32
• base32+src
• capture.req.hdr
• capture.req.method
• capture.req.uri
• capture.req.ver
• capture.res.hdr
• capture.res.ver
• req.body
• req.body_param
• req.body_len
• req.body_size
• req.cook
• cook
• req.cook_cnt
• cook_cnt
• req.cook_val
• cook_val
• cookie
• hdr
• req.fhdr
• req.fhdr_cnt
• req.hdr
• req.hdr_cnt
• hdr_cnt
• req.hdr_ip
• hdr_ip
• req.hdr_val
• hdr_val
• http_auth
• http_auth_group
• http_first_req
• method
• path
• query
• req.hdr_names
• req.ver
• req_ver
• res.comp
• res.comp_algo
• res.cook
• scook
• res.cook_cnt
• scook_cnt
• res.cook_val
• scook_val
• res.fhdr
• res.fhdr_cnt
• res.hdr
• shdr
• res.hdr_cnt
• shdr_cnt
• res.hdr_ip
• shdr_ip
• res.hdr_names
• res.hdr_val
• shdr_val
• res.ver
• resp_ver
• set-cookie
• status
• unique-id
• url
• url_ip
• url_port
• urlp
• url_param
• urlp_val
• url32
• url32+src
• filter trace
• filter compression
• filter spoe
• cache
• total-max-size
• max-age
• http-request cache-use
• http-response cache-store
• where
• interrupts are assigned under
• add acl
• add map
• clear counters
• clear counters all
• clear acl
• clear map
• clear table
• del acl
• del map
• disable agent
• disable dynamic-cookie backend
• disable frontend
• disable health
• disable server
• enable agent
• enable dynamic-cookie backend
• enable frontend
• enable health
• enable server
• get map
• get acl
• get weight
• help
• prompt
• quit
• set dynamic-cookie-key backend
• set map
• set maxconn frontend
• set maxconn server
• set maxconn global
• set rate-limit connections global
• set rate-limit http-compression global
• set rate-limit sessions global
• set rate-limit ssl-sessions global
• set server
• set severity-output
• set ssl ocsp-response
• set ssl tls-key
• set table
• set timeout cli
• set weight
• show acl
• show backend
• show cli sockets
• show cache
• show env
• show errors
• show fd
• show activity
• show info
• show map
• show pools
• show servers state
• show sess
• show stat
• show stat resolvers
• show table
• show tls-keys
• show schema json
• shutdown frontend
• shutdown session
• shutdown sessions server