HAProxy Runtime API
Reference
-
abort ssl ca-file
Abort and destroy a temporary SSL CA file update transaction.
-
abort ssl cert
Abort an SSL certificate transaction.
-
abort ssl crl-file
Abort and destroy a temporary SSL CRL file update transaction.
-
add acl
Add a value to an ACL expression or file.
-
add map
Add an entry to a Map file.
-
add server
Add a dynamic server to a backend.
-
add ssl ca-file
Add a new payload of certificates to an existing CA file.
-
add ssl crt-list
Add an entry to an SSL CRT list.
-
clear acl
Delete all entries from an ACL expression or file.
-
clear counters all
DClear all counters on the Stats page.
-
clear counters
Clear the Max counters on the Stats page.
-
clear map
Delete all entries from a Map file.
-
clear table
Remove one or more entries from a stick table.
-
commit acl
Commit a transaction of acl changes.
-
commit map
Commit a transaction of map file changes.
-
commit ssl ca-file
Commit a temporary SSL CA file update transaction.
-
commit ssl cert
Commit an SSL certificate transaction.
-
commit ssl crl-file
Commit a temporary SSL CRL file update transaction.
-
del acl
Delete a single value from an ACL expression or file.
-
del map
Delete a single entry from a Map file.
-
del server
Remove a dynamic server from a backend.
-
del ssl ca-file
Delete a CA file from HAProxy Enterprise.
-
del ssl cert
Delete a single SSL certificate from memory.
-
del ssl crl-file
Delete an SSL CRL file.
-
del ssl crt-list
Delete an entry from an SSL CRT list.
-
disable agent
Stop sending health check probes to an agent program running on a server.
-
disable dynamic-cookie backend
Enable session persistence when dynamic cookies are in use.
-
disable frontend
Stop routing traffic to a frontend that is declared in your HAProxy Enterprise configuration file.
-
disable health
Stop sending active health check probes to a server.
-
disable server
Put a server in maintenance mode.
-
enable agent
Resume sending health check probes to an agent program running on a server.
-
enable dynamic-cookie backend
Enable session persistence when dynamic cookies are in use.
-
enable frontend
Re-enable a frontend that was stopped.
-
enable health
Enable active health checks for a server.
-
enable server
Take a server out of maintenance mode.
-
experimental mode
Access features still in development.
-
expert-mode
Enable or disable access to restricted debugging commands.
-
get acl
Test whether a value would match an ACL.
-
get map
Test whether an input matches an entry in a map file.
-
get var
Get attributes of a process-wide variable.
-
get weight
Display the initial and current weight of a server.
-
help
Display a list of available Runtime API commands.
-
httpclient
Launch an HTTP client request and print the response.
-
new ssl ca-file
Create a new empty CA file.
-
new ssl cert
Add a new, empty SSL certificate store.
-
new ssl crl-file
Create a new empty CRL file.
-
operator
Decrease the CLI level to operator.
-
prepare acl
Start a transaction made up of multiple acl changes.
-
prepare map
Start a transaction made up of multiple map file changes.
-
prompt
Initiate an interactive session with the Runtime API.
-
quit
Disconnect from the Runtime API.
-
set anon global-key
Set the global anonymizing key.
-
set anon
Enable or disable anonymized mode.
-
set dynamic-cookie-key backend
Change the value of the dynamic-cookie-key directive.
-
set map
Change the value of a map file entry.
-
set maxconn frontend
Change a frontend's maximum concurrent connections.
-
set maxconn global
Change the load balancer's process-side maximum concurrent connections.
-
set maxconn server
Change a server's maximum concurrent connections.
-
set profiling
Enable or disable profiling.
-
set rate-limit connections global
Set the process-wide connection rate limit.
-
set rate-limit http-compression global
Set the process-wide compression rate limit.
-
set rate-limit sessions global
Set the process-wide session rate limit.
-
set rate-limit ssl-sessions global
Set the process-wide SSL session rate limit.
-
set server
Change a server's properties.
-
set severity-output
Change the severity level format.
-
set ssl ca-file
Reset an SSL CA file with new certificates.
-
set ssl cert
Add an SSL certificate to a transaction.
-
set ssl crl-file
Reset an SSL CRL file with new revocation lists.
-
set ssl ocsp-response
Set the Online Certificate Status Protocol (OCSP) response for an SSL/TLS certificate.
-
set ssl tls-key
Rotate the load balancer's session ticket encryption key used to encrypt TLS session tickets.
-
set table
Add or update a record in a stick table.
-
set timeout cli
Change the timeout period for an interactive session with the Runtime API.
-
set var
Set or overwrite a variable with the result of an expression or format string.
-
set weight
Change the weight of a server.
-
show acl
List all ACLs defined in the configuration.
-
show activity
Report counters related to internal process events.
-
show-anon
-
show backend
List all backends in the current running config.
-
show cache
Show cache status.
-
show cli level
Display the CLI level of the current session.
-
show cli sockets
Display information about all CLI sockets defined in the configuration.
-
show dev
Show platform and environment details.
-
show env
Display current HAProxy Enterprise process and environment information.
-
show errors
Show errors related to protocol violations.
-
show events
Show events from a running trace.
-
show info
Display information about the HAProxy Enterprise process.
-
show libs
Display information about shared dynamic libraries and object files.
-
show map
List map files or list the entries in a map file.
-
show peers
Display information about stick table data synchronized between load balancer peers.
-
show pools
Show the status of internal memory pools.
-
show profiling
Dump profiling details.
-
show quic
Display details on active QUIC frontend connections.
-
show resolvers
ADisplay statistics for each resolvers section in your configuration.
-
show schema json
Display the JSON schema for the output of the 'show info' and 'show stat' commands.
-
show servers conn
Dump the current and idle connections for a backend or backends.
-
show servers state
Get a block of data that represents the current of servers in backends.
-
show sess
Display all clients that have an ongoing streams connected to the load balancer.
-
show ssl ca-file
Display the list of CA files used by HAProxy Enterprise and their respective certificate counts.
-
show ssl cert
List certificates.
-
show ssl crl-file
Display information about CRL files.
-
show ssl crt-list
Display the contents of an SSL CRT list.
-
show ssl ocsp-response
Show the Online Certificate Status Protocol (OCSP) response for an SSL/TLS certificate.
-
show ssl ocsp-updates
Show the expected time of the next OCSP updates and the status of the last OCSP updates.
-
show ssl providers
Display the names of the providers loaded by OpenSSL during initialization.
-
show startup-logs
Display messages generated during startup.
-
show stat
Get statistics that describe traffic flowing through the load balancer.
-
show table
List entries in a stick table.
-
show threads
Show the internal states and structures of threads.
-
show tls-keys
Display the secret keys used to encrypt TLS session tickets.
-
show trace
Display the state and monitored events for a trace.
-
show version
Show the version of the current HAProxy Enterprise process.
-
shutdown frontend
Delete a frontend and release the ports on which it listens.
-
shutdown session
Terminate a client's stream.
-
shutdown sessions server
Terminate all client streams that are connected to a specific server.
-
trace
Monitor load balancer events in real-time using a trace.
-
update ssl ocsp-response
Request an immediate update of an OCSP response.
-
user
Decrease the CLI level to user.
Do you have any suggestions on how we can improve the content of this page?