]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
DOC: cli: show cli sockets
authorWilliam Lallemand <wlallemand@haproxy.com>
Fri, 16 Dec 2016 15:38:58 +0000 (16:38 +0100)
committerWilly Tarreau <w@1wt.eu>
Fri, 16 Dec 2016 18:40:13 +0000 (19:40 +0100)
Add documentation for 'show cli sockets' on the CLI.

doc/management.txt

index f95dab234ed334fec8048b9f10cc3ab59d4d9f36..683b997901609f477538770adab0f3ac03a90677 100644 (file)
@@ -1674,6 +1674,23 @@ set weight <backend>/<server> <weight>[%]
   "admin". Both the backend and the server may be specified either by their
   name or by their numeric ID, prefixed with a sharp ('#').
 
+show cli sockets
+  List CLI sockets. The output format is composed of 3 fields separated by
+  spaces. The first field is the socket address, it can be a unix socket, a
+  ipv4 address:port couple or a ipv6 one. Socket of other types won't be dump.
+  The second field describe the level of the socket: 'admin', 'user' or
+  'operator'. The last field list the processes on which the socket is bound,
+  separated by commas, it can be numbers or 'all'.
+
+  Example :
+
+     $ echo 'show cli sockets' | socat stdio /tmp/sock1
+     # socket lvl processes
+     /tmp/sock1 admin all
+     127.0.0.1:9999 user 2,3,4
+     127.0.0.2:9969 user 2
+     [::1]:9999 operator 2
+
 show env [<name>]
   Dump one or all environment variables known by the process. Without any
   argument, all variables are dumped. With an argument, only the specified