HAProxy Enterprise Documentation 2.4r1
View help
To see which commands are available, call the help
command.
View help when using the UNIX socket
When using the UNIX socket, follow these steps:
-
Install the
socat
package.$ # On Debian/Ubuntu $ sudo apt-get install socat
$ # On CentOS/RedHat/Oracle $ sudo yum install socat
$ # On SUSE $ sudo zypper install socat
$ # On FreeBSD $ sudo pkg install socat
-
Call the
help
command:$ echo "help" | \ sudo socat stdio unix-connect:/var/run/hapee-2.4/hapee-lb.sock
The following commands are valid at this level: abort ssl ca-file <cafile> : abort a transaction for a CA file abort ssl cert <certfile> : abort a transaction for a certificate file abort ssl crl-file <crlfile> : abort a transaction for a CRL file add acl [@<ver>] <acl> <pattern> : add an acl entry add map [@<ver>] <map> <key> <val> : add a map entry (payload supported instead of key/val) ...
View help when using a TCP/IP address
When using a TCP/IP address to access the API, you can call the help
command:
$ echo "help" | socat stdio tcp4-connect:127.0.0.1:9999
The following commands are valid at this level: abort ssl ca-file <cafile> : abort a transaction for a CA file abort ssl cert <certfile> : abort a transaction for a certificate file abort ssl crl-file <crlfile> : abort a transaction for a CRL file add acl [@<ver>] <acl> <pattern> : add an acl entry add map [@<ver>] <map> <key> <val> : add a map entry (payload supported instead of key/val) ...
Next up
HAProxy Enterprise Runtime API reference guide