1DATAPLANEAPI(8) System Administration Utilities DATAPLANEAPI(8)
2
6 dataplaneapi - HAProxy Data Plane API
7
9 Usage:
10 dataplaneapi [OPTIONS]
11 API for editing and managing haproxy instances
13 Application Options:
15 --scheme=
16 the listeners to enable, this can be repeated and defaults to
17 the schemes in the swagger spec
18 --cleanup-timeout=
20 grace period for which to wait before killing idle connections
21 (default: 10s)
22 --graceful-timeout=
24 grace period for which to wait before shutting down the server
25 (default: 15s)
26 --max-header-size=
28 controls the maximum number of bytes the server will read pars‐
29 ing the request header's keys and values, including the request
30 line. It does not limit the size of the request body. (default:
31 1MiB)
32 --socket-path=
34 the unix socket to listen on (default: /var/run/data-plane.sock)
35 --host=
37 the IP to listen on (default: localhost) [$HOST]
38 --port=
40 the port to listen on for insecure connections, defaults to a
41 random value [$PORT]
42 --listen-limit=
44 limit the number of outstanding requests
45 --keep-alive=
47 sets the TCP keep-alive timeouts on accepted connections. It
48 prunes dead TCP connections ( e.g. closing laptop mid-download)
49 (default: 3m)
50 --read-timeout=
52 maximum duration before timing out read of the request (default:
53 30s)
54 --write-timeout=
56 maximum duration before timing out write of the response (de‐
57 fault: 60s)
58 --tls-host=
60 the IP to listen on for tls, when not specified it's the same as
61 --host [$TLS_HOST]
62 --tls-port=
64 the port to listen on for secure connections, defaults to a ran‐
65 dom value [$TLS_PORT]
66 --tls-certificate=
68 the certificate to use for secure connections [$TLS_CERTIFICATE]
69 --tls-key=
71 the private key to use for secure connections [$TLS_PRIVATE_KEY]
72 --tls-ca=
74 the certificate authority file to be used with mutual tls auth
75 [$TLS_CA_CERTIFICATE]
76 --tls-listen-limit=
78 limit the number of outstanding requests
79 --tls-keep-alive=
81 sets the TCP keep-alive timeouts on accepted connections. It
82 prunes dead TCP connections ( e.g. closing laptop mid-download)
83 --tls-read-timeout=
85 maximum duration before timing out read of the request
86 --tls-write-timeout=
88 maximum duration before timing out write of the response
89 HAProxy options:
91 -c, --config-file=
92 Path to the haproxy configuration file (default:
93 /etc/haproxy/haproxy.cfg)
94 -u, --userlist=
96 Userlist in HAProxy configuration to use for API Basic Authenti‐
97 cation (default: controller)
98 -b, --haproxy-bin=
100 Path to the haproxy binary file (default: haproxy)
101 -d, --reload-delay=
103 Minimum delay between two reloads (in s) (default: 5)
104 -r, --reload-cmd=
106 Reload command
107 -s, --restart-cmd=
109 Restart command
110 --reload-retention=
112 Reload retention in days, every older reload id will be deleted
113 (default: 1)
114 -t, --transaction-dir=
116 Path to the transaction directory (default: /tmp/haproxy)
117 -n, --backups-number=
119 Number of backup configuration files you want to keep, stored in
120 the config dir with version number suffix (default: 0)
121 --backups-dir=
123 Path to directory in which to place backup files
124 -m, --master-runtime=
126 Path to the master Runtime API socket
127 -i, --show-system-info
129 Show system info on info endpoint
130 -f= Path to the dataplane configuration file (default:
132 /etc/haproxy/dataplaneapi-
133 .hcl)
135 --userlist-file=
137 Path to the dataplaneapi userlist file. By default userlist is
138 read from HAProxy conf. When specified userlist would be read
139 from this file
140 --fid= Path to file that will dataplaneapi use to write its id (not a
142 pid) that was given to him after joining a cluster
143 -p, --maps-dir=
145 Path to directory of map files managed by dataplane (default:
146 /etc/haproxy/maps)
147 --ssl-certs-dir=
149 Path to SSL certificates directory (default: /etc/haproxy/ssl)
150 --update-map-files
152 Flag used for syncing map files with runtime maps values
153 --update-map-files-period=
155 Elapsed time in seconds between two maps syncing operations (de‐
156 fault: 10)
157 --cluster-tls-dir=
159 Path where cluster tls certificates will be stored. Defaults to
160 same directory as dataplane configuration file
161 --spoe-dir=
163 Path to SPOE directory. (default: /etc/haproxy/spoe)
164 --spoe-transaction-dir=
166 Path to the SPOE transaction directory (default:
167 /tmp/spoe-haproxy)
168 --master-worker-mode
170 Flag to enable helpers when running within HAProxy
171 --max-open-transactions=
173 Limit for active transaction in pending state (default: 20)
174 --validate-cmd=
176 Executes a custom command to perform the HAProxy configuration
177 check
178 --disable-inotify
180 Disables inotify watcher watcher for the configuration file
181 --pid-file=
183 Path to file that will dataplaneapi use to write its pid
184 --uid= User id value to set on start
186 --gid= Group id value to set on start
188 Logging options:
190 --log-to=[stdout|file|syslog]
191 Log target, can be stdout, file, or syslog (default: stdout)
192 --log-file=
194 Location of the log file (default: /var/log/dataplaneapi/dat-
195 aplaneapi.log)
197 --log-level=[trace|debug|info|warning|error]
199 Logging level (default: warning)
200 --log-format=[text|JSON]
202 Logging format (default: text)
203 --apache-common-log-format=
205 Apache Common Log Format to format the access log entries (de‐
206 fault: %h %l %u %t "%r" %>s %b "%{Referer}i" "%{User-agent}i"
207 %{us}T)
208 Syslog options:
210 --syslog-address=
211 Syslog address (with port declaration in case of TCP type) where
212 logs should be forwarded: accepting socket path in case of unix
213 or unixgram
214 --syslog-protocol=[tcp|tcp4|tcp6|unix|unixgram] Syslog server protocol
216 (default: tcp)
217 --syslog-tag=
219 String to tag the syslog messages (default: dataplaneapi)
220 --syslog-level=
222 Define the required syslog messages level, allowed values: de‐
223 bug|info|notice|warning-
224 |error|critical|alert|eme-
226 rgency (default: debug)
228 --syslog-facility=
230 Define the Syslog facility number, allowed values:
231 kern|user|mail|daemon|aut-
232 h|syslog|lpr|news|uucp|cr-
234 on|authpriv|ftp|local0|lo-
236 cal1|local2|local3|local4-
238 |local5|local6|local7
240 (default: local0)
241 Show version:
243 -v, --version
244 Version and build information
245 Help Options:
247 -h, --help
248 Show this help message
249dataplaneapi 2.4.4 July 2022 DATAPLANEAPI(8)