Documentation for HAProxy Enterprise 2.5r1
This is the latest version of HAProxy Enterprise
Release Notes
Getting Started
Overview
Hardware Recommendations
System Tuning
Installation
Amazon Web Services
Azure
BSD
Docker
Kubernetes
Linux
Additional Packages
Upgrade
Linux
BSD
Docker
Community to Enterprise
Uninstall
BSD
Linux
Docker
Configuration
Configuration Section Basics
Overview
Global
Frontend
Backend
Listen
Defaults
Userlist
Cache
Http-errors
Mailers
Resolvers
Fcgi-app
Peers
Aggregations
Program
Dynamic-update
Ring
Binds
Overview
Syntax
Bind Reference
Servers
Overview
Syntax
Server Reference
Fetches
Overview
Syntax
Fetch Reference
ACLs
Overview
Syntax
Inline ACLs
Predefined ACLs
ACL Reference
Converters
Overview
Converter Reference
Map Files
Overview
Syntax
Stick Tables
Overview
Syntax
Stick Table Reference
Variables
Overview
Syntax
Environment Variables
Reference Manual
Management
Start/Stop the Service
Enable/Disable Servers
Git Integration
Dynamic Data Updates
Installation
TLS session ticket keys
Update Module Reference
Real-time Dashboard
Installation
Lua Module
Dashboard Gateway
Using the Dashboard
Process Manager
Service Discovery
AWS EC2 Service Discovery
Consul Service Discovery
DNS Service Discovery
Discovery with A Records
Discovery with SRV Records
Multi-threading
Ansible
High Availability
Active/Active Clustering
Layer 4 Load Balancing
DNS Round-robin
Route Health Injection
Real-time Cluster-wide Tracking
Overview
Installation
Single-level setup
Multi-level setup
Highly-available setup
Display aggregated data
Configure CPU affinity
Bind outgoing connections
Encrypt traffic
Manage the service
Troubleshooting
Load Shedding with NS1
Active/Standby Clustering
AWS
Network Load Balancer
Load Balancing
Caching
Compression
Circuit Breaking
Device Detection
51Degrees
DeviceAtlas
WURFL InFuze
Geolocation
MaxMind
NetAcuity
Health Checking
Active Health Checks
Passive Health Checks
Agent Checks
LDAP Health Checks
MySQL Health Checks
PostgreSQL Health Checks
Redis Health Checks
SMTP Health Checks
Service Mesh
Consul
Protocols
FastCGI
gRPC
HTTP/2
TCP
WebSocket
Client IP preservation
Add an X-Forwarded-For header
Enable the Proxy Protocol
Response Body Injection
Session Persistence
Traffic Routing
Blue-Green Deployments
Redirects
Rewrites
Rewrite Requests
Rewrite Responses
Security
Global Profiling Engine
Overview
Installation
Real-time Aggregation
Configuration
Multi-level setup
Historical Aggregation
API Reference
Single Sign-on
Active Directory
Implementing SSO
Configuring SSO
SAML
SAML Quick Start on Azure
SAML configuration options
Response Policies
Deny
reCAPTCHA
Reject
Shadowban
Silent Drop
Tarpit
TLS
Authentication
Basic Authentication
Client Certificate Authentication
Bot Management
Fingerprint Module
Javascript Challenge
SSL/TLS Fingerprint Module
Verify Crawler
Handling a DoS attack
Web Application Firewall
Advanced WAF
Installation
Rule Customization
MainRule
CheckRule
BasicRule
Server Synchronization
WAF Logs
Track Triggered Rules
Custom Core Rules
WAF Filter Parameters
ModSecurity
SQL Injection/XSS
Observability
Logging
Overview
Log Custom Data
Log with Docker
Logging Reference
Metrics
Prometheus
Send Metrics
SNMP
Monitoring
Alerts
Monitor URI
Integrations
Grafana
Elastic Stack
InfluxDB
API
Command Line Interface
Data Plane API
Installation
HAProxy Community
HAProxy Enterprise
CLI
Usage
Data Plane API Reference
Lua
Lua scripts
Runtime API
Overview
abort ssl cert
add acl
add map
add ssl crt-list
clear acl
clear counters all
clear counters
clear map
clear table
commit ssl cert
del acl
del map
del ssl cert
del ssl crt-list
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 acl
get map
get weight
help
new ssl cert
operator
prompt
quit
set dynamic-cookie-key backend
set map
set maxconn frontend
set maxconn global
set maxconn server
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 cert
set ssl ocsp-response
set ssl tls-key
set table
set timeout cli
set weight
show acl
show backend
show cache
show cli level
show cli sockets
show env
show errors
show events
show info
show map
show peers
show pools
show resolvers
show schema json
show servers conn
show servers state
show sess
show ssl cert
show ssl crt-list
show stat
show table
show threads
show tls-keys
show trace
shutdown frontend
shutdown session
shutdown sessions server
trace
user
Troubleshooting
Contact Us
Licensing
More
More Versions
HAProxy Enterprise 2.5r1
Latest
HAProxy Enterprise 2.4r1
HAProxy Enterprise 2.3r1
HAProxy Enterprise 2.2r1
HAProxy Enterprise 2.1r1
HAProxy Enterprise 2.0r1
HAProxy Enterprise 1.8r2
HAProxy Enterprise 1.7r2
HAProxy Products Documentation
HAProxy ALOHA
HAProxy Enterprise Kubernetes Ingress Controller
Release Notes
Getting Started
Overview
Hardware Recommendations
System Tuning
Installation
Amazon Web Services
Azure
BSD
Docker
Kubernetes
Linux
Additional Packages
Upgrade
Linux
BSD
Docker
Community to Enterprise
Uninstall
BSD
Linux
Docker
Configuration
Configuration Section Basics
Overview
Global
Frontend
Backend
Listen
Defaults
Userlist
Cache
Http-errors
Mailers
Resolvers
Fcgi-app
Peers
Aggregations
Program
Dynamic-update
Ring
Binds
Overview
Syntax
Bind Reference
Servers
Overview
Syntax
Server Reference
Fetches
Overview
Syntax
Fetch Reference
ACLs
Overview
Syntax
Inline ACLs
Predefined ACLs
ACL Reference
Converters
Overview
Converter Reference
Map Files
Overview
Syntax
Stick Tables
Overview
Syntax
Stick Table Reference
Variables
Overview
Syntax
Environment Variables
Reference Manual
Management
Start/Stop the Service
Enable/Disable Servers
Git Integration
Dynamic Data Updates
Installation
TLS session ticket keys
Update Module Reference
Real-time Dashboard
Installation
Lua Module
Dashboard Gateway
Using the Dashboard
Process Manager
Service Discovery
AWS EC2 Service Discovery
Consul Service Discovery
DNS Service Discovery
Discovery with A Records
Discovery with SRV Records
Multi-threading
Ansible
High Availability
Active/Active Clustering
Layer 4 Load Balancing
DNS Round-robin
Route Health Injection
Real-time Cluster-wide Tracking
Overview
Installation
Single-level setup
Multi-level setup
Highly-available setup
Display aggregated data
Configure CPU affinity
Bind outgoing connections
Encrypt traffic
Manage the service
Troubleshooting
Load Shedding with NS1
Active/Standby Clustering
AWS
Network Load Balancer
Load Balancing
Caching
Compression
Circuit Breaking
Device Detection
51Degrees
DeviceAtlas
WURFL InFuze
Geolocation
MaxMind
NetAcuity
Health Checking
Active Health Checks
Passive Health Checks
Agent Checks
LDAP Health Checks
MySQL Health Checks
PostgreSQL Health Checks
Redis Health Checks
SMTP Health Checks
Service Mesh
Consul
Protocols
FastCGI
gRPC
HTTP/2
TCP
WebSocket
Client IP preservation
Add an X-Forwarded-For header
Enable the Proxy Protocol
Response Body Injection
Session Persistence
Traffic Routing
Blue-Green Deployments
Redirects
Rewrites
Rewrite Requests
Rewrite Responses
Security
Global Profiling Engine
Overview
Installation
Real-time Aggregation
Configuration
Multi-level setup
Historical Aggregation
API Reference
Single Sign-on
Active Directory
Implementing SSO
Configuring SSO
SAML
SAML Quick Start on Azure
SAML configuration options
Response Policies
Deny
reCAPTCHA
Reject
Shadowban
Silent Drop
Tarpit
TLS
Authentication
Basic Authentication
Client Certificate Authentication
Bot Management
Fingerprint Module
Javascript Challenge
SSL/TLS Fingerprint Module
Verify Crawler
Handling a DoS attack
Web Application Firewall
Advanced WAF
Installation
Rule Customization
MainRule
CheckRule
BasicRule
Server Synchronization
WAF Logs
Track Triggered Rules
Custom Core Rules
WAF Filter Parameters
ModSecurity
SQL Injection/XSS
Observability
Logging
Overview
Log Custom Data
Log with Docker
Logging Reference
Metrics
Prometheus
Send Metrics
SNMP
Monitoring
Alerts
Monitor URI
Integrations
Grafana
Elastic Stack
InfluxDB
API
Command Line Interface
Data Plane API
Installation
HAProxy Community
HAProxy Enterprise
CLI
Usage
Data Plane API Reference
Lua
Lua scripts
Runtime API
Overview
abort ssl cert
add acl
add map
add ssl crt-list
clear acl
clear counters all
clear counters
clear map
clear table
commit ssl cert
del acl
del map
del ssl cert
del ssl crt-list
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 acl
get map
get weight
help
new ssl cert
operator
prompt
quit
set dynamic-cookie-key backend
set map
set maxconn frontend
set maxconn global
set maxconn server
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 cert
set ssl ocsp-response
set ssl tls-key
set table
set timeout cli
set weight
show acl
show backend
show cache
show cli level
show cli sockets
show env
show errors
show events
show info
show map
show peers
show pools
show resolvers
show schema json
show servers conn
show servers state
show sess
show ssl cert
show ssl crt-list
show stat
show table
show threads
show tls-keys
show trace
shutdown frontend
shutdown session
shutdown sessions server
trace
user
Troubleshooting
Contact Us
Licensing
HAProxy Enterprise 2.5r1 Documentation
HAProxy Enterprise 2.5r1 Documentation
Security
Global Profiling Engine
Real-time Aggregation
Multi-level setup
HAProxy Enterprise Documentation 2.5r1
Multi-level setup
Next up
Historical Aggregation
Feedback
Your feedback is important to us!
* This field is required
This site is protected by reCAPTCHA and the Google
Privacy Policy
and
Terms of Service
apply.