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. (de‐
31 fault: 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 -m, --master-runtime=
123 Path to the master Runtime API socket
124 -i, --show-system-info
126 Show system info on info endpoint
127 -f= Path to the dataplane configuration file (default: data‐
129 planeapi.yaml)
130 --userlist-file=
132 Path to the dataplaneapi userlist file. By default userlist is
133 read from HAProxy conf. When specified userlist would be read
134 from this file
135 --fid= Path to file that will dataplaneapi use to write its id (not a
137 pid) that was given to him after joining a cluster
138 -p, --maps-dir=
140 Path to directory of map files managed by dataplane (default:
141 /etc/haproxy/maps)
142 --ssl-certs-dir=
144 Path to SSL certificates directory (default: /etc/haproxy/ssl)
145 --update-map-files
147 Flag used for syncing map files with runtime maps values
148 --update-map-files-period=
150 Elapsed time in seconds between two maps syncing operations (de‐
151 fault: 10)
152 --cluster-tls-dir=
154 Path where cluster tls certificates will be stored. Defaults to
155 same directory as dataplane configuration file
156 --spoe-dir=
158 Path to SPOE directory. (default: /etc/haproxy/spoe)
159 --spoe-transaction-dir=
161 Path to the SPOE transaction directory (default:
162 /tmp/spoe-haproxy)
163 --master-worker-mode
165 Flag to enable helpers when running within HAProxy
166 --max-open-transactions=
168 Limit for active transaction in pending state (default: 20)
169 Logging options:
171 --log-to=[stdout|file]
172 Log target, can be stdout or file (default: stdout)
173 --log-file=
175 Location of the log file (default: /var/log/dataplaneapi/datapl-
176 aneapi.log)
178 --log-level=[trace|debug|info|warning|error] Logging level (default:
180 warning)
181 --log-format=[text|JSON]
183 Logging format (default: text)
184 API options:
186 --api-address=
187 Advertised API address
188 --api-port=
190 Advertised API port
191 Show version:
193 -v, --version
194 Version and build information
195 Help Options:
197 -h, --help
198 Show this help message
199dataplaneapi 2.2.1 April 2021 DATAPLANEAPI(8)