Configuration reference
Defaults CRD
Selected version
Available since
version 1.7
The Defaults custom resource extends the Kubernetes API to let you manage default load balancer settings that apply to all services.
Install the Defaults custom resource Jump to heading
Before you can use the Defaults custom resource, you must install its definition into your Kubernetes cluster.
-
Download the v1-10 Defaults custom resource filev1-9 Defaults custom resource filev1-8 Defaults custom resource filev1-7 Defaults custom resource file.
-
Install the custom resource definition with
kubectl apply
:Community ingress controller
bashkubectl apply -f defaults.core.haproxy.org.yamlbashkubectl apply -f defaults.core.haproxy.org.yamlbashkubectl apply -f defaults.core.haproxy.org.yamlbashkubectl apply -f defaults.core.haproxy.org.yamlbashkubectl apply -f defaults.yamlbashkubectl apply -f defaults.yamlbashkubectl apply -f defaults.yamlbashkubectl apply -f defaults.yaml -
Verify that the installation worked by listing custom resources defined in your cluster:
bashkubectl get crdbashkubectl get crdoutputbashNAME CREATED ATdefaults.core.haproxy.org 2022-06-01T16:56:57ZoutputbashNAME CREATED ATdefaults.core.haproxy.org 2022-06-01T16:56:57Z
Use the Defaults custom resource Jump to heading
With the Defaults custom resource, you can manage default load balancer settings that apply to all services. To use it:
-
Create a YAML file that declares a
Defaults
resource and add properties to itsspec.config
section.In the example below, the
client_timeout
property sets how many milliseconds the ingress controller will wait for an inactive client to respond.example-defaults.yamlyamlapiVersion: "core.haproxy.org/v1alpha2"kind: Defaultsmetadata:name: example-defaultsnamespace: defaultspec:config:client_timeout: 10000example-defaults.yamlyamlapiVersion: "core.haproxy.org/v1alpha2"kind: Defaultsmetadata:name: example-defaultsnamespace: defaultspec:config:client_timeout: 10000example-defaults.yamlyamlapiVersion: "core.haproxy.org/v1alpha2"kind: Defaultsmetadata:name: example-defaultsnamespace: defaultspec:config:client_timeout: 10000example-defaults.yamlyamlapiVersion: "core.haproxy.org/v1alpha2"kind: Defaultsmetadata:name: example-defaultsnamespace: defaultspec:config:client_timeout: 10000example-defaults.yamlyamlapiVersion: "core.haproxy.org/v1alpha1"kind: Defaultsmetadata:name: example-defaultsnamespace: defaultspec:config:client_timeout: 10000example-defaults.yamlyamlapiVersion: "core.haproxy.org/v1alpha1"kind: Defaultsmetadata:name: example-defaultsnamespace: defaultspec:config:client_timeout: 10000example-defaults.yamlyamlapiVersion: "core.haproxy.org/v1alpha1"kind: Defaultsmetadata:name: example-defaultsnamespace: defaultspec:config:client_timeout: 10000example-defaults.yamlyamlapiVersion: "core.haproxy.org/v1alpha1"kind: Defaultsmetadata:name: example-defaultsnamespace: defaultspec:config:client_timeout: 10000 -
Deploy it to your cluster using
kubectl apply
.bashkubectl apply -f example-defaults.yamlbashkubectl apply -f example-defaults.yaml -
Create a new ConfigMap with the name
haproxy-kubernetes-ingress
to override the one that ships with the ingress controller. Add thecr-defaults
key to thedata
section to implement the defaults.example-configmap.yamlyamlapiVersion: v1kind: ConfigMapmetadata:name: haproxy-kubernetes-ingressnamespace: haproxy-controllerdata:cr-defaults: default/example-defaultsexample-configmap.yamlyamlapiVersion: v1kind: ConfigMapmetadata:name: haproxy-kubernetes-ingressnamespace: haproxy-controllerdata:cr-defaults: default/example-defaults -
Update the ConfigMap in your cluster by using
kubectl apply
.bashkubectl apply -f example-configmap.yamlbashkubectl apply -f example-configmap.yaml
Defaults custom resource reference Jump to heading
- CRD version:
- API version:
abortonclose
- enabled
- disabled
accept_invalid_http_request
- enabled
- disabled
accept_invalid_http_response
- enabled
- disabled
adv_check
- ssl-hello-chk
- smtpchk
- ldap-check
- mysql-check
- pgsql-check
- tcp-check
- redis-check
- httpchk
allbackups
- enabled
- disabled
backlog
balance
- algorithm string Values
- roundrobin
- static-rr
- leastconn
- first
- source
- uri
- url_param
- hdr
- random
- rdp-cookie
- hdr_name string
- hdr_use_domain_only boolean
- random_draws integer
- rdp_cookie_name string Constraints
- Must match pattern: ^[^\s]+$
- uri_depth integer
- uri_len integer
- uri_path_only boolean
- uri_whole boolean
- url_param string Constraints
- Must match pattern: ^[^\s]+$
- url_param_check_post integer
- url_param_max_wait integer
bind_process
- Must match pattern: ^[^\s]+$
check_timeout
clflog
client_fin_timeout
client_timeout
clitcpka
- enabled
- disabled
compression
- algorithms array
- offload boolean
- types array
connect_timeout
contstats
- enabled
cookie
- domain array
- dynamic boolean
- httponly boolean
- indirect boolean
- maxidle integer
- maxlife integer
- name string Constraints
- Must match pattern: ^[^\s]+$
- nocache boolean
- postonly boolean
- preserve boolean
- secure boolean
- type string Values
- rewrite
- insert
- prefix
default_backend
- Must match pattern: ^[A-Za-z0-9-_.:]+$
default_server
- address string Constraints
- Must match pattern: ^[^\s]+$
- agent-addr string Constraints
- Must match pattern: ^[^\s]+$
- agent-check string Values
- enabled
- disabled
- agent-inter integer
- agent-port integer
- agent-send string
- allow_0rtt boolean
- alpn string Constraints
- Must match pattern: ^[^\s]+$
- backup string Values
- enabled
- disabled
- ca_file string
- check string Values
- enabled
- disabled
- check-send-proxy string Values
- enabled
- disabled
- check-sni string Constraints
- Must match pattern: ^[^\s]+$
- check-ssl string Values
- enabled
- disabled
- check_alpn string Constraints
- Must match pattern: ^[^\s]+$
- check_proto string Constraints
- Must match pattern: ^[^\s]+$
- check_via_socks4 string Values
- enabled
- disabled
- ciphers string
- ciphersuites string
- cookie string Constraints
- Must match pattern: ^[^\s]+$
- crl_file string
- disabled string Values
- enabled
- disabled
- downinter integer
- enabled string Values
- enabled
- disabled
- error_limit integer
- fall integer
- fastinter integer
- force_sslv3 string Values
- enabled
- disabled
- force_tlsv10 string Values
- enabled
- disabled
- force_tlsv11 string Values
- enabled
- disabled
- force_tlsv12 string Values
- enabled
- disabled
- force_tlsv13 string Values
- enabled
- disabled
- health_check_port integer
- init-addr string Constraints
- Must match pattern: ^[^\s]+$
- inter integer
- log_proto string Values
- legacy
- octet-count
- max_reuse integer
- maxconn integer
- maxqueue integer
- minconn integer
- name string Constraints
- Must match pattern: ^[^\s]+$
- namespace string
- no_sslv3 string Values
- enabled
- disabled
- no_tlsv10 string Values
- enabled
- disabled
- no_tlsv11 string Values
- enabled
- disabled
- no_tlsv12 string Values
- enabled
- disabled
- no_tlsv13 string Values
- enabled
- disabled
- no_verifyhost string Values
- enabled
- disabled
- npn string
- observe string Values
- layer4
- layer7
- on-error string Values
- fastinter
- fail-check
- sudden-death
- mark-down
- on-marked-down string Values
- shutdown-sessions
- on-marked-up string Values
- shutdown-backup-sessions
- pool_low_conn integer
- pool_max_conn integer
- pool_purge_delay integer
- port integer
- proto string Constraints
- Must match pattern: ^[^\s]+$
- proxy-v2-options array
- redir string
- resolve-net string Constraints
- Must match pattern: ^[^\s]+$
- resolve-prefer string Values
- ipv4
- ipv6
- Must match pattern: ^[^\s]+$
- resolve_opts string Constraints
- Must match pattern: ^[^,\s][^\,]*[^,\s]*$
- resolvers string Constraints
- Must match pattern: ^[^\s]+$
- rise integer
- send-proxy string Values
- enabled
- disabled
- send-proxy-v2 string Values
- enabled
- disabled
- send_proxy_v2_ssl string Values
- enabled
- disabled
- send_proxy_v2_ssl_cn string Values
- enabled
- disabled
- slowstart integer
- sni string Constraints
- Must match pattern: ^[^\s]+$
- socks4 string Constraints
- Must match pattern: ^[^\s]+$
- source string
- ssl string Values
- enabled
- disabled
- ssl_certificate string Constraints
- Must match pattern: ^[^\s]+$
- ssl_max_ver string Values
- SSLv3
- TLSv1.0
- TLSv1.1
- TLSv1.2
- TLSv1.3
- ssl_min_ver string Values
- SSLv3
- TLSv1.0
- TLSv1.1
- TLSv1.2
- TLSv1.3
- ssl_reuse string Values
- enabled
- disabled
- stick string Values
- enabled
- disabled
- tcp_ut integer
- tfo string Values
- enabled
- disabled
- tls_tickets string Values
- enabled
- disabled
- track string
- verify string Values
- none
- required
- verifyhost string
- weight integer
disable_h2_upgrade
- enabled
- disabled
dontlognull
- enabled
- disabled
dynamic_cookie_key
- Must match pattern: ^[^\s]+$
error_files
-
code (*integer*)
Values
- 200
- 400
- 403
- 405
- 408
- 425
- 429
- 500
- 502
- 503
- 504
- file (*string*)
external_check
- enabled
- disabled
external_check_command
- Must match pattern: ^[^\s]+$
external_check_path
- Must match pattern: ^[^\s]+$
forwardfor
- enabled string Values
- enabled
- except string Constraints
- Must match pattern: ^[^\s]+$
- header string Constraints
- Must match pattern: ^[^\s]+$
- ifnone boolean
h1_case_adjust_bogus_client
- enabled
- disabled
h1_case_adjust_bogus_server
- enabled
- disabled
http-buffer-request
- enabled
- disabled
http-check
- addr string Constraints
- Must match pattern: ^[^\s]+$
- alpn string Constraints
- Must match pattern: ^[^\s]+$
- body string
- body_log_format string
- check_comment string
- default boolean
- error_status string Values
- L7OKC
- L7RSP
- L7STS
- L6RSP
- L4CON
- exclamation_mark boolean
- headers array
- index integer
- linger boolean
- match string Values
- status
- rstatus
- hdr
- fhdr
- string
- rstring
- Must match pattern: ^[^\s]+$
- method string
- min_recv integer
- ok_status string Values
- L7OK
- L7OKC
- L6OK
- L4OK
- on_error string
- on_success string
- pattern string
- port integer
- port_string string
- proto string
- send_proxy boolean
- sni string
- ssl boolean
- status-code string
- tout_status string Values
- L7TOUT
- L6TOUT
- L4TOUT
- type string Values
- comment
- connect
- disable-on-404
- expect
- send
- send-state
- set-var
- set-var-fmt
- unset-var
- uri string
- uri_log_format string
- var_expr string
- var_format string
- var_name string Constraints
- Must match pattern: ^[^\s]+$
- var_scope string Constraints
- Must match pattern: ^[^\s]+$
- version string
- via_socks4 boolean
http-use-htx
- enabled
- disabled
http_connection_mode
- httpclose
- http-server-close
- http-keep-alive
http_keep_alive_timeout
http_pretend_keepalive
- enabled
- disabled
http_request_timeout
http_reuse
- aggressive
- always
- never
- safe
httpchk_params
- method string Values
- HEAD
- PUT
- POST
- GET
- TRACE
- PATCH
- uri string Constraints
- Must match pattern: ^[^ ]*$
- version string
httplog
load_server_state_from_file
- global
- local
- none
log_format
log_format_sd
log_health_checks
- enabled
- disabled
log_separate_errors
- enabled
- disabled
log_tag
- Must match pattern: ^[^\s]+$
logasap
- enabled
- disabled
maxconn
mode
- tcp
- http
monitor_uri
mysql_check_params
- client_version string Values
- pre-41
- post-41
- username string
pgsql_check_params
- username string
queue_timeout
redispatch
- enabled string Values
- enabled
- disabled
- interval integer
retries
server_fin_timeout
server_timeout
smtpchk_params
- domain string
- hello string
srvtcpka
- enabled
- disabled
stats_options
- stats_admin boolean
- stats_admin_cond string Values
- if
- unless
- stats_admin_cond_test string
- stats_enable boolean
- stats_hide_version boolean
- stats_maxconn integer
- stats_refresh_delay integer
- stats_show_desc string
- stats_show_legends boolean
- stats_show_node_name string Constraints
- Must match pattern: ^[^\s]+$
- stats_uri_prefix string Constraints
- Must match pattern: ^[^\s]+$
tcpka
- enabled
- disabled
tcplog
tunnel_timeout
unique_id_format
unique_id_header
abortonclose
- enabled
- disabled
accept_invalid_http_request
- enabled
- disabled
accept_invalid_http_response
- enabled
- disabled
adv_check
- ssl-hello-chk
- smtpchk
- ldap-check
- mysql-check
- pgsql-check
- tcp-check
- redis-check
- httpchk
allbackups
- enabled
- disabled
backlog
balance
- algorithm string Values
- roundrobin
- static-rr
- leastconn
- first
- source
- uri
- url_param
- hdr
- random
- rdp-cookie
- hdr_name string
- hdr_use_domain_only boolean
- random_draws integer
- rdp_cookie_name string Constraints
- Must match pattern: ^[^\s]+$
- uri_depth integer
- uri_len integer
- uri_path_only boolean
- uri_whole boolean
- url_param string Constraints
- Must match pattern: ^[^\s]+$
- url_param_check_post integer
- url_param_max_wait integer
bind_process
- Must match pattern: ^[^\s]+$
check_timeout
clflog
client_fin_timeout
client_timeout
clitcpka
- enabled
- disabled
compression
- algorithms array
- offload boolean
- types array
connect_timeout
contstats
- enabled
cookie
- domain array
- dynamic boolean
- httponly boolean
- indirect boolean
- maxidle integer
- maxlife integer
- name string Constraints
- Must match pattern: ^[^\s]+$
- nocache boolean
- postonly boolean
- preserve boolean
- secure boolean
- type string Values
- rewrite
- insert
- prefix
default_backend
- Must match pattern: ^[A-Za-z0-9-_.:]+$
default_server
- address string Constraints
- Must match pattern: ^[^\s]+$
- agent-addr string Constraints
- Must match pattern: ^[^\s]+$
- agent-check string Values
- enabled
- disabled
- agent-inter integer
- agent-port integer
- agent-send string
- allow_0rtt boolean
- alpn string Constraints
- Must match pattern: ^[^\s]+$
- backup string Values
- enabled
- disabled
- ca_file string
- check string Values
- enabled
- disabled
- check-send-proxy string Values
- enabled
- disabled
- check-sni string Constraints
- Must match pattern: ^[^\s]+$
- check-ssl string Values
- enabled
- disabled
- check_alpn string Constraints
- Must match pattern: ^[^\s]+$
- check_proto string Constraints
- Must match pattern: ^[^\s]+$
- check_via_socks4 string Values
- enabled
- disabled
- ciphers string
- ciphersuites string
- cookie string Constraints
- Must match pattern: ^[^\s]+$
- crl_file string
- disabled string Values
- enabled
- disabled
- downinter integer
- enabled string Values
- enabled
- disabled
- error_limit integer
- fall integer
- fastinter integer
- force_sslv3 string Values
- enabled
- disabled
- force_tlsv10 string Values
- enabled
- disabled
- force_tlsv11 string Values
- enabled
- disabled
- force_tlsv12 string Values
- enabled
- disabled
- force_tlsv13 string Values
- enabled
- disabled
- health_check_port integer
- init-addr string Constraints
- Must match pattern: ^[^\s]+$
- inter integer
- log_proto string Values
- legacy
- octet-count
- max_reuse integer
- maxconn integer
- maxqueue integer
- minconn integer
- name string Constraints
- Must match pattern: ^[^\s]+$
- namespace string
- no_sslv3 string Values
- enabled
- disabled
- no_tlsv10 string Values
- enabled
- disabled
- no_tlsv11 string Values
- enabled
- disabled
- no_tlsv12 string Values
- enabled
- disabled
- no_tlsv13 string Values
- enabled
- disabled
- no_verifyhost string Values
- enabled
- disabled
- npn string
- observe string Values
- layer4
- layer7
- on-error string Values
- fastinter
- fail-check
- sudden-death
- mark-down
- on-marked-down string Values
- shutdown-sessions
- on-marked-up string Values
- shutdown-backup-sessions
- pool_low_conn integer
- pool_max_conn integer
- pool_purge_delay integer
- port integer
- proto string Constraints
- Must match pattern: ^[^\s]+$
- proxy-v2-options array
- redir string
- resolve-net string Constraints
- Must match pattern: ^[^\s]+$
- resolve-prefer string Values
- ipv4
- ipv6
- Must match pattern: ^[^\s]+$
- resolve_opts string Constraints
- Must match pattern: ^[^,\s][^\,]*[^,\s]*$
- resolvers string Constraints
- Must match pattern: ^[^\s]+$
- rise integer
- send-proxy string Values
- enabled
- disabled
- send-proxy-v2 string Values
- enabled
- disabled
- send_proxy_v2_ssl string Values
- enabled
- disabled
- send_proxy_v2_ssl_cn string Values
- enabled
- disabled
- slowstart integer
- sni string Constraints
- Must match pattern: ^[^\s]+$
- socks4 string Constraints
- Must match pattern: ^[^\s]+$
- source string
- ssl string Values
- enabled
- disabled
- ssl_certificate string Constraints
- Must match pattern: ^[^\s]+$
- ssl_max_ver string Values
- SSLv3
- TLSv1.0
- TLSv1.1
- TLSv1.2
- TLSv1.3
- ssl_min_ver string Values
- SSLv3
- TLSv1.0
- TLSv1.1
- TLSv1.2
- TLSv1.3
- ssl_reuse string Values
- enabled
- disabled
- stick string Values
- enabled
- disabled
- tcp_ut integer
- tfo string Values
- enabled
- disabled
- tls_tickets string Values
- enabled
- disabled
- track string
- verify string Values
- none
- required
- verifyhost string
- weight integer
disable_h2_upgrade
- enabled
- disabled
dontlognull
- enabled
- disabled
dynamic_cookie_key
- Must match pattern: ^[^\s]+$
error_files
-
code (*integer*)
Values
- 200
- 400
- 403
- 405
- 408
- 425
- 429
- 500
- 502
- 503
- 504
- file (*string*)
external_check
- enabled
- disabled
external_check_command
- Must match pattern: ^[^\s]+$
external_check_path
- Must match pattern: ^[^\s]+$
forwardfor
- enabled string Values
- enabled
- except string Constraints
- Must match pattern: ^[^\s]+$
- header string Constraints
- Must match pattern: ^[^\s]+$
- ifnone boolean
h1_case_adjust_bogus_client
- enabled
- disabled
h1_case_adjust_bogus_server
- enabled
- disabled
http-buffer-request
- enabled
- disabled
http-check
- addr string Constraints
- Must match pattern: ^[^\s]+$
- alpn string Constraints
- Must match pattern: ^[^\s]+$
- body string
- body_log_format string
- check_comment string
- default boolean
- error_status string Values
- L7OKC
- L7RSP
- L7STS
- L6RSP
- L4CON
- exclamation_mark boolean
- headers array
- index integer
- linger boolean
- match string Values
- status
- rstatus
- hdr
- fhdr
- string
- rstring
- Must match pattern: ^[^\s]+$
- method string
- min_recv integer
- ok_status string Values
- L7OK
- L7OKC
- L6OK
- L4OK
- on_error string
- on_success string
- pattern string
- port integer
- port_string string
- proto string
- send_proxy boolean
- sni string
- ssl boolean
- status-code string
- tout_status string Values
- L7TOUT
- L6TOUT
- L4TOUT
- type string Values
- comment
- connect
- disable-on-404
- expect
- send
- send-state
- set-var
- set-var-fmt
- unset-var
- uri string
- uri_log_format string
- var_expr string
- var_format string
- var_name string Constraints
- Must match pattern: ^[^\s]+$
- var_scope string Constraints
- Must match pattern: ^[^\s]+$
- version string
- via_socks4 boolean
http-use-htx
- enabled
- disabled
http_connection_mode
- httpclose
- http-server-close
- http-keep-alive
http_keep_alive_timeout
http_pretend_keepalive
- enabled
- disabled
http_request_timeout
http_reuse
- aggressive
- always
- never
- safe
httpchk_params
- method string Values
- HEAD
- PUT
- POST
- GET
- TRACE
- PATCH
- uri string Constraints
- Must match pattern: ^[^ ]*$
- version string
httplog
load_server_state_from_file
- global
- local
- none
log_format
log_format_sd
log_health_checks
- enabled
- disabled
log_separate_errors
- enabled
- disabled
log_tag
- Must match pattern: ^[^\s]+$
logasap
- enabled
- disabled
maxconn
mode
- tcp
- http
monitor_uri
mysql_check_params
- client_version string Values
- pre-41
- post-41
- username string
pgsql_check_params
- username string
queue_timeout
redispatch
- enabled string Values
- enabled
- disabled
- interval integer
retries
server_fin_timeout
server_timeout
smtpchk_params
- domain string
- hello string
srvtcpka
- enabled
- disabled
stats_options
- stats_admin boolean
- stats_admin_cond string Values
- if
- unless
- stats_admin_cond_test string
- stats_enable boolean
- stats_hide_version boolean
- stats_maxconn integer
- stats_refresh_delay integer
- stats_show_desc string
- stats_show_legends boolean
- stats_show_node_name string Constraints
- Must match pattern: ^[^\s]+$
- stats_uri_prefix string Constraints
- Must match pattern: ^[^\s]+$
tcpka
- enabled
- disabled
tcplog
tunnel_timeout
unique_id_format
unique_id_header
mode
- tcp
- http
balance
- algorithm string Values
- roundrobin
- static-rr
- leastconn
- first
- source
- uri
- url_param
- hdr
- random
- rdp-cookie
- uri_whole boolean
- uri_len integer
- uri_depth integer
- url_param string Constraints
- Must match pattern: ^[^\s]+$
- url_param_check_post integer
- url_param_max_wait integer
- hdr_name string
- hdr_use_domain_only boolean
- random_draws integer
- rdp_cookie_name string Constraints
- Must match pattern: ^[^\s]+$
- uri_path_only boolean
maxconn
adv_check
- ssl-hello-chk
- smtpchk
- ldap-check
- mysql-check
- pgsql-check
- tcp-check
- redis-check
- httpchk
smtpchk_params
- hello string
- domain string
mysql_check_params
- username string
- client_version string Values
- pre-41
- post-41
pgsql_check_params
- username string
httpchk_params
- method string Values
- HEAD
- PUT
- POST
- GET
- TRACE
- PATCH
- uri string Constraints
- Must match pattern: ^[^ ]*$
- version string
http-check
- type string Values
- disable-on-404
- expect
- send-state
- exclamation_mark boolean
- match string Values
- status
- rstatus
- string
- rstring
- Must match pattern: ^[^\s]+$
- pattern string
bind_process
- Must match pattern: ^[^\s]+$
http_connection_mode
- httpclose
- http-server-close
- http-keep-alive
http_pretend_keepalive
- enabled
- disabled
abortonclose
- enabled
- disabled
http-use-htx
- enabled
- disabled
dontlognull
- enabled
- disabled
http-buffer-request
- enabled
- disabled
httplog
clflog
tcplog
log_format
log_format_sd
log_tag
- Must match pattern: ^[^\s]+$
log_separate_errors
- enabled
- disabled
clitcpka
- enabled
- disabled
forwardfor
- enabled string Values
- enabled
- except string Constraints
- Must match pattern: ^[^\s]+$
- header string Constraints
- Must match pattern: ^[^\s]+$
- ifnone boolean
check_timeout
connect_timeout
contstats
- enabled
cookie
- name string Constraints
- Must match pattern: ^[^\s]+$
- type string Values
- rewrite
- insert
- prefix
- indirect boolean
- nocache boolean
- postonly boolean
- preserve boolean
- httponly boolean
- secure boolean
- domain array
- maxidle integer
- maxlife integer
- dynamic boolean
client_timeout
client_fin_timeout
http_request_timeout
http_keep_alive_timeout
http_reuse
- aggressive
- always
- never
- safe
server_timeout
server_fin_timeout
queue_timeout
tunnel_timeout
external_check
- enabled
- disabled
external_check_path
- Must match pattern: ^[^\s]+$
external_check_command
- Must match pattern: ^[^\s]+$
redispatch
- enabled string Values
- enabled
- disabled
- interval integer
retries
default_backend
- Must match pattern: ^[A-Za-z0-9-_.:]+$
default_server
- init-addr string Constraints
- Must match pattern: ^[^\s]+$
- inter integer
- fastinter integer
- downinter integer
- rise integer
- fall integer
- check-sni string Constraints
- Must match pattern: ^[^\s]+$
- slowstart integer
- sni string Constraints
- Must match pattern: ^[^\s]+$
- check-ssl string Values
- enabled
- disabled
- check-send-proxy string Values
- enabled
- disabled
- ca_file string
- enabled string Values
- enabled
- disabled
- disabled string Values
- enabled
- disabled
- port integer
- resolvers string Constraints
- Must match pattern: ^[^\s]+$
- resolve-prefer string Values
- ipv4
- ipv6
- Must match pattern: ^[^\s]+$
- resolve-net string Constraints
- Must match pattern: ^[^\s]+$
- name string Constraints
- Must match pattern: ^[^\s]+$
- address string Constraints
- Must match pattern: ^[^\s]+$
- health_check_port integer
- ssl_certificate string Constraints
- Must match pattern: ^[^\s]+$
- agent-check string Values
- enabled
- disabled
- agent-send string
- agent-inter integer
- agent-addr string Constraints
- Must match pattern: ^[^\s]+$
- agent-port integer
- allow_0rtt boolean
- alpn string Constraints
- Must match pattern: ^[^\s]+$
- backup string Values
- enabled
- disabled
- check string Values
- enabled
- disabled
- check_alpn string Constraints
- Must match pattern: ^[^\s]+$
- check_proto string Constraints
- Must match pattern: ^[^\s]+$
- check_via_socks4 string Values
- enabled
- disabled
- ciphers string
- ciphersuites string
- cookie string Constraints
- Must match pattern: ^[^\s]+$
- crl_file string
- error_limit integer
- force_sslv3 string Values
- enabled
- disabled
- force_tlsv10 string Values
- enabled
- disabled
- force_tlsv11 string Values
- enabled
- disabled
- force_tlsv12 string Values
- enabled
- disabled
- force_tlsv13 string Values
- enabled
- disabled
- log_proto string Values
- legacy
- octet-count
- maxconn integer
- maxqueue integer
- max_reuse integer
- minconn integer
- namespace string
- no_sslv3 string Values
- enabled
- disabled
- no_tlsv10 string Values
- enabled
- disabled
- no_tlsv11 string Values
- enabled
- disabled
- no_tlsv12 string Values
- enabled
- disabled
- no_tlsv13 string Values
- enabled
- disabled
- no_verifyhost string Values
- enabled
- disabled
- npn string
- observe string Values
- layer4
- layer7
- on-error string Values
- fastinter
- fail-check
- sudden-death
- mark-down
- on-marked-down string Values
- shutdown-sessions
- on-marked-up string Values
- shutdown-backup-sessions
- pool_low_conn integer
- pool_max_conn integer
- pool_purge_delay integer
- proto string Constraints
- Must match pattern: ^[^\s]+$
- redir string
- resolve_opts string Constraints
- Must match pattern: ^[^,\s][^\,]*[^,\s]*$
- send-proxy string Values
- enabled
- disabled
- send-proxy-v2 string Values
- enabled
- disabled
- proxy-v2-options array
- send_proxy_v2_ssl string Values
- enabled
- disabled
- send_proxy_v2_ssl_cn string Values
- enabled
- disabled
- source string
- ssl string Values
- enabled
- disabled
- ssl_max_ver string Values
- SSLv3
- TLSv1.0
- TLSv1.1
- TLSv1.2
- TLSv1.3
- ssl_min_ver string Values
- SSLv3
- TLSv1.0
- TLSv1.1
- TLSv1.2
- TLSv1.3
- ssl_reuse string Values
- enabled
- disabled
- stick string Values
- enabled
- disabled
- socks4 string Constraints
- Must match pattern: ^[^\s]+$
- tcp_ut integer
- tfo string Values
- enabled
- disabled
- track string
- tls_tickets string Values
- enabled
- disabled
- verify string Values
- none
- required
- verifyhost string
- weight integer
error_files
-
code (*integer*)
Values
- 200
- 400
- 403
- 405
- 408
- 425
- 429
- 500
- 502
- 503
- 504
- file (*string*)
unique_id_format
unique_id_header
logasap
- enabled
- disabled
allbackups
- enabled
- disabled
stats_options
- stats_enable boolean
- stats_hide_version boolean
- stats_maxconn integer
- stats_refresh_delay integer
- stats_show_desc string
- stats_show_legends boolean
- stats_show_node_name string Constraints
- Must match pattern: ^[^\s]+$
- stats_uri_prefix string Constraints
- Must match pattern: ^[^\s]+$
mode
- tcp
- http
balance
- algorithm string Values
- roundrobin
- static-rr
- leastconn
- first
- source
- uri
- url_param
- hdr
- random
- rdp-cookie
- uri_whole boolean
- uri_len integer
- uri_depth integer
- url_param string Constraints
- Must match pattern: ^[^\s]+$
- url_param_check_post integer
- url_param_max_wait integer
- hdr_name string
- hdr_use_domain_only boolean
- random_draws integer
- rdp_cookie_name string Constraints
- Must match pattern: ^[^\s]+$
- uri_path_only boolean
maxconn
adv_check
- ssl-hello-chk
- smtpchk
- ldap-check
- mysql-check
- pgsql-check
- tcp-check
- redis-check
- httpchk
smtpchk_params
- hello string
- domain string
mysql_check_params
- username string
- client_version string Values
- pre-41
- post-41
pgsql_check_params
- username string
httpchk_params
- method string Values
- HEAD
- PUT
- POST
- GET
- TRACE
- PATCH
- uri string Constraints
- Must match pattern: ^[^ ]*$
- version string
http-check
- type string Values
- disable-on-404
- expect
- send-state
- exclamation_mark boolean
- match string Values
- status
- rstatus
- string
- rstring
- Must match pattern: ^[^\s]+$
- pattern string
bind_process
- Must match pattern: ^[^\s]+$
http_connection_mode
- httpclose
- http-server-close
- http-keep-alive
http_pretend_keepalive
- enabled
- disabled
abortonclose
- enabled
- disabled
http-use-htx
- enabled
- disabled
dontlognull
- enabled
- disabled
http-buffer-request
- enabled
- disabled
httplog
clflog
tcplog
log_format
log_format_sd
log_tag
- Must match pattern: ^[^\s]+$
log_separate_errors
- enabled
- disabled
clitcpka
- enabled
- disabled
forwardfor
- enabled string Values
- enabled
- except string Constraints
- Must match pattern: ^[^\s]+$
- header string Constraints
- Must match pattern: ^[^\s]+$
- ifnone boolean
check_timeout
connect_timeout
contstats
- enabled
cookie
- name string Constraints
- Must match pattern: ^[^\s]+$
- type string Values
- rewrite
- insert
- prefix
- indirect boolean
- nocache boolean
- postonly boolean
- preserve boolean
- httponly boolean
- secure boolean
- domain array
- maxidle integer
- maxlife integer
- dynamic boolean
client_timeout
client_fin_timeout
http_request_timeout
http_keep_alive_timeout
http_reuse
- aggressive
- always
- never
- safe
server_timeout
server_fin_timeout
queue_timeout
tunnel_timeout
external_check
- enabled
- disabled
external_check_path
- Must match pattern: ^[^\s]+$
external_check_command
- Must match pattern: ^[^\s]+$
redispatch
- enabled string Values
- enabled
- disabled
- interval integer
retries
default_backend
- Must match pattern: ^[A-Za-z0-9-_.:]+$
default_server
- init-addr string Constraints
- Must match pattern: ^[^\s]+$
- inter integer
- fastinter integer
- downinter integer
- rise integer
- fall integer
- check-sni string Constraints
- Must match pattern: ^[^\s]+$
- slowstart integer
- sni string Constraints
- Must match pattern: ^[^\s]+$
- check-ssl string Values
- enabled
- disabled
- check-send-proxy string Values
- enabled
- disabled
- ca_file string
- enabled string Values
- enabled
- disabled
- disabled string Values
- enabled
- disabled
- port integer
- resolvers string Constraints
- Must match pattern: ^[^\s]+$
- resolve-prefer string Values
- ipv4
- ipv6
- Must match pattern: ^[^\s]+$
- resolve-net string Constraints
- Must match pattern: ^[^\s]+$
- name string Constraints
- Must match pattern: ^[^\s]+$
- address string Constraints
- Must match pattern: ^[^\s]+$
- health_check_port integer
- ssl_certificate string Constraints
- Must match pattern: ^[^\s]+$
- agent-check string Values
- enabled
- disabled
- agent-send string
- agent-inter integer
- agent-addr string Constraints
- Must match pattern: ^[^\s]+$
- agent-port integer
- allow_0rtt boolean
- alpn string Constraints
- Must match pattern: ^[^\s]+$
- backup string Values
- enabled
- disabled
- check string Values
- enabled
- disabled
- check_alpn string Constraints
- Must match pattern: ^[^\s]+$
- check_proto string Constraints
- Must match pattern: ^[^\s]+$
- check_via_socks4 string Values
- enabled
- disabled
- ciphers string
- ciphersuites string
- cookie string Constraints
- Must match pattern: ^[^\s]+$
- crl_file string
- error_limit integer
- force_sslv3 string Values
- enabled
- disabled
- force_tlsv10 string Values
- enabled
- disabled
- force_tlsv11 string Values
- enabled
- disabled
- force_tlsv12 string Values
- enabled
- disabled
- force_tlsv13 string Values
- enabled
- disabled
- log_proto string Values
- legacy
- octet-count
- maxconn integer
- maxqueue integer
- max_reuse integer
- minconn integer
- namespace string
- no_sslv3 string Values
- enabled
- disabled
- no_tlsv10 string Values
- enabled
- disabled
- no_tlsv11 string Values
- enabled
- disabled
- no_tlsv12 string Values
- enabled
- disabled
- no_tlsv13 string Values
- enabled
- disabled
- no_verifyhost string Values
- enabled
- disabled
- npn string
- observe string Values
- layer4
- layer7
- on-error string Values
- fastinter
- fail-check
- sudden-death
- mark-down
- on-marked-down string Values
- shutdown-sessions
- on-marked-up string Values
- shutdown-backup-sessions
- pool_low_conn integer
- pool_max_conn integer
- pool_purge_delay integer
- proto string Constraints
- Must match pattern: ^[^\s]+$
- redir string
- resolve_opts string Constraints
- Must match pattern: ^[^,\s][^\,]*[^,\s]*$
- send-proxy string Values
- enabled
- disabled
- send-proxy-v2 string Values
- enabled
- disabled
- proxy-v2-options array
- send_proxy_v2_ssl string Values
- enabled
- disabled
- send_proxy_v2_ssl_cn string Values
- enabled
- disabled
- source string
- ssl string Values
- enabled
- disabled
- ssl_max_ver string Values
- SSLv3
- TLSv1.0
- TLSv1.1
- TLSv1.2
- TLSv1.3
- ssl_min_ver string Values
- SSLv3
- TLSv1.0
- TLSv1.1
- TLSv1.2
- TLSv1.3
- ssl_reuse string Values
- enabled
- disabled
- stick string Values
- enabled
- disabled
- socks4 string Constraints
- Must match pattern: ^[^\s]+$
- tcp_ut integer
- tfo string Values
- enabled
- disabled
- track string
- tls_tickets string Values
- enabled
- disabled
- verify string Values
- none
- required
- verifyhost string
- weight integer
error_files
-
code (*integer*)
Values
- 200
- 400
- 403
- 405
- 408
- 425
- 429
- 500
- 502
- 503
- 504
- file (*string*)
unique_id_format
unique_id_header
logasap
- enabled
- disabled
allbackups
- enabled
- disabled
stats_options
- stats_enable boolean
- stats_hide_version boolean
- stats_maxconn integer
- stats_refresh_delay integer
- stats_show_desc string
- stats_show_legends boolean
- stats_show_node_name string Constraints
- Must match pattern: ^[^\s]+$
- stats_uri_prefix string Constraints
- Must match pattern: ^[^\s]+$
If this page was useful, please, Leave the feedback.