OS Manuals

/usr/bin/dataplaneapi

HAProxy Data Plane API

From dataplaneapi 3.4.6-r0 (os), captured 2026-11-08 by running dataplaneapi --help (exit 0). permalink

Also provided by 1 other package version
2026/11/08 02:46:42 maxprocs: Leaving GOMAXPROCS=64: CPU quota undefined
2026/11/08 02:46:42 ERROR failed to set GOMEMLIMIT package=github.com/KimMachineGun/automemlimit/memlimit error="failed to set GOMEMLIMIT: cgroup v2 hierarchy found in /proc/self/cgroup but no cgroup2 mount found"
Usage:
  dataplaneapi [OPTIONS]

API for editing and managing haproxy instances

Application Options:
      --scheme=                  the listeners to enable, this can be repeated
                                 and defaults to the schemes in the swagger spec
      --cleanup-timeout=         grace period for which to wait before killing
                                 idle connections (default: 10s)
      --graceful-timeout=        grace period for which to wait before shutting
                                 down the server (default: 15s)
      --max-header-size=         controls the maximum number of bytes the
                                 server will read parsing the request header's
                                 keys and values, including the request line.
                                 It does not limit the size of the request
                                 body. (default: 1MiB)
      --max-body-size=           controls the maximum number of bytes the
                                 server will read from a request body before
                                 aborting the request. 0 means unlimited.
                                 (default: 1GiB)
      --socket-path=             the unix socket to listen on (default:
                                 /var/run/data-plane.sock)
      --host=                    the IP to listen on (default: localhost)
                                 [$HOST]
      --port=                    the port to listen on for insecure
                                 connections, defaults to a random value [$PORT]
      --listen-limit=            limit the number of outstanding requests
      --keep-alive=              sets the TCP keep-alive timeouts on accepted
                                 connections. It prunes dead TCP connections (
                                 e.g. closing laptop mid-download) (default: 3m)
      --read-timeout=            maximum duration before timing out read of the
                                 request (default: 30s)
      --write-timeout=           maximum duration before timing out write of
                                 the response (default: 30s)
      --tls-host=                the IP to listen on for tls, when not
                                 specified it's the same as --host [$TLS_HOST]
      --tls-port=                the port to listen on for secure connections,
                                 defaults to a random value [$TLS_PORT]
      --tls-certificate=         the certificate to use for secure connections
                                 [$TLS_CERTIFICATE]
      --tls-key=                 the private key to use for secure connections
                                 [$TLS_PRIVATE_KEY]
      --tls-ca=                  the certificate authority file to be used with
                                 mutual tls auth [$TLS_CA_CERTIFICATE]
      --tls-listen-limit=        limit the number of outstanding requests
      --tls-keep-alive=          sets the TCP keep-alive timeouts on accepted
                                 connections. It prunes dead TCP connections (
                                 e.g. closing laptop mid-download)
      --tls-read-timeout=        maximum duration before timing out read of the
                                 request
      --tls-write-timeout=       maximum duration before timing out write of
                                 the response

HAProxy options:
      --spoe-dir=                Path to SPOE directory. (default:
                                 /etc/haproxy/spoe)
      --service=                 Name of the HAProxy service
  -b, --haproxy-bin=             Path to the haproxy binary file (default:
                                 haproxy)
      --userlist-file=           Path to the dataplaneapi userlist file. By
                                 default userlist is read from HAProxy conf.
                                 When specified userlist would be read from
                                 this file
  -r, --reload-cmd=              Reload command
  -s, --restart-cmd=             Restart command
      --status-cmd=              Status command
      --pid-file=                Path to file that will dataplaneapi use to
                                 write its pid
      --reload-strategy=         Either systemd, s6 or custom (default: custom)
  -t, --transaction-dir=         Path to the transaction directory (default:
                                 /tmp/haproxy)
      --validate-cmd=            Executes a custom command to perform the
                                 HAProxy configuration check
      --validate-files-before=   A list of configuration files to be loaded
                                 before the main file for validation
      --validate-files-after=    A list of configuration files to be loaded
                                 after the main file for validation
      --backups-dir=             Path to directory in which to place backup
                                 files
  -p, --maps-dir=                Path to directory of map files managed by
                                 dataplane (default: /etc/haproxy/maps)
      --spoe-transaction-dir=    Path to the SPOE transaction directory
                                 (default: /tmp/spoe-haproxy)
  -f=                            Path to the dataplane configuration file
                                 (default: /etc/haproxy/dataplaneapi.yaml)
  -c, --config-file=             Path to the haproxy configuration file
                                 (default: /etc/haproxy/haproxy.cfg)
  -u, --userlist=                Userlist in HAProxy configuration to use for
                                 API Basic Authentication (default: controller)
  -m, --master-runtime=          Path to the master Runtime API socket
      --ssl-certs-dir=           Path to SSL certificates directory (default:
                                 /etc/haproxy/ssl)
      --general-storage-dir=     Path to general storage directory (default:
                                 /etc/haproxy/general)
      --dataplane-storage-dir=   Path to dataplane internal storage directory
                                 (default: /etc/haproxy/dataplane)
      --time-suffix=             Preferred time unit to use when writing time
                                 values in configuration (nearest, none, ms, s,
                                 m, h, d) (default: nearest)
      --update-map-files-period= Elapsed time in seconds between two maps
                                 syncing operations (default: 10)
  -d, --reload-delay=            Minimum delay between two reloads (in s)
                                 (default: 5)
      --max-open-transactions=   Limit for active transaction in pending state
                                 (default: 20)
  -n, --backups-number=          Number of backup configuration files you want
                                 to keep, stored in the config dir with version
                                 number suffix (default: 0)
      --reload-retention=        Reload retention in days, every older reload
                                 id will be deleted (default: 1)
      --uid=                     User id value to set on start
      --gid=                     Group id value to set on start
      --update-map-files         Flag used for syncing map files with runtime
                                 maps values
  -i, --show-system-info         Show system info on info endpoint
      --master-worker-mode       Flag to enable helpers when running within
                                 HAProxy
      --disable-inotify          Disables inotify watcher for the configuration
                                 file
      --debug-socket-path=       Unix socket path for the debugging command
                                 socket
      --delayed-start-max=       Maximum duration to wait for the haproxy
                                 runtime socket to be ready (default: 30s)
      --delayed-start-tick=      Duration between checks for the haproxy
                                 runtime socket to be ready (default: 500ms)

Show version:
  -v, --version                  Version and build information

Help Options:
  -h, --help                     Show this help message
Options (60)
OptionDescriptionSource
--schemethe listeners to enable, this can be repeated and defaults to the schemes in the swagger spechelp
--cleanup-timeoutgrace period for which to wait before killing idle connections (default: 10s)help
--graceful-timeoutgrace period for which to wait before shutting down the server (default: 15s)help
--max-header-sizecontrols the maximum number of bytes the server will read parsing the request header's keys and values, including the request line.help
--max-body-sizecontrols the maximum number of bytes the server will read from a request body before aborting the request.help
--socket-paththe unix socket to listen on (default: /var/run/data-plane.sock)help
--hostthe IP to listen on (default: localhost) [$HOST]help
--portthe port to listen on for insecure connections, defaults to a random value [$PORT]help
--listen-limitlimit the number of outstanding requestshelp
--keep-alivesets the TCP keep-alive timeouts on accepted connections.help
--read-timeoutmaximum duration before timing out read of the request (default: 30s)help
--write-timeoutmaximum duration before timing out write of the response (default: 30s)help
--tls-hostthe IP to listen on for tls, when not specified it's the same as --host [$TLS_HOST]help
--tls-portthe port to listen on for secure connections, defaults to a random value [$TLS_PORT]help
--tls-certificatethe certificate to use for secure connections [$TLS_CERTIFICATE]help
--tls-keythe private key to use for secure connections [$TLS_PRIVATE_KEY]help
--tls-cathe certificate authority file to be used with mutual tls auth [$TLS_CA_CERTIFICATE]help
--tls-listen-limitlimit the number of outstanding requestshelp
--tls-keep-alivesets the TCP keep-alive timeouts on accepted connections.help
--tls-read-timeoutmaximum duration before timing out read of the requesthelp
--tls-write-timeoutmaximum duration before timing out write of the responsehelp
--spoe-dirPath to SPOE directory.help
--serviceName of the HAProxy servicehelp
-b, --haproxy-binPath to the haproxy binary file (default: haproxy)help
--userlist-filePath to the dataplaneapi userlist file.help
-r, --reload-cmdReload commandhelp
-s, --restart-cmdRestart commandhelp
--status-cmdStatus commandhelp
--pid-filePath to file that will dataplaneapi use to write its pidhelp
--reload-strategyEither systemd, s6 or custom (default: custom)help
-t, --transaction-dirPath to the transaction directory (default: /tmp/haproxy)help
--validate-cmdExecutes a custom command to perform the HAProxy configuration checkhelp
--validate-files-beforeA list of configuration files to be loaded before the main file for validationhelp
--validate-files-afterA list of configuration files to be loaded after the main file for validationhelp
--backups-dirPath to directory in which to place backup fileshelp
-p, --maps-dirPath to directory of map files managed by dataplane (default: /etc/haproxy/maps)help
--spoe-transaction-dirPath to the SPOE transaction directory (default: /tmp/spoe-haproxy)help
-fPath to the dataplane configuration file (default: /etc/haproxy/dataplaneapi.yaml)help
-c, --config-filePath to the haproxy configuration file (default: /etc/haproxy/haproxy.cfg)help
-u, --userlistUserlist in HAProxy configuration to use for API Basic Authentication (default: controller)help
-m, --master-runtimePath to the master Runtime API sockethelp
--ssl-certs-dirPath to SSL certificates directory (default: /etc/haproxy/ssl)help
--general-storage-dirPath to general storage directory (default: /etc/haproxy/general)help
--dataplane-storage-dirPath to dataplane internal storage directory (default: /etc/haproxy/dataplane)help
--time-suffixPreferred time unit to use when writing time values in configuration (nearest, none, ms, s, m, h, d) (default: nearest)help
-d, --reload-delayMinimum delay between two reloads (in s) (default: 5)help
--max-open-transactionsLimit for active transaction in pending state (default: 20)help
-n, --backups-numberNumber of backup configuration files you want to keep, stored in the config dir with version number suffix (default: 0)help
--reload-retentionReload retention in days, every older reload id will be deleted (default: 1)help
--uidUser id value to set on starthelp
--gidGroup id value to set on starthelp
--update-map-filesFlag used for syncing map files with runtime maps valueshelp
-i, --show-system-infoShow system info on info endpointhelp
--master-worker-modeFlag to enable helpers when running within HAProxyhelp
--disable-inotifyDisables inotify watcher for the configuration filehelp
--debug-socket-pathUnix socket path for the debugging command sockethelp
--delayed-start-maxMaximum duration to wait for the haproxy runtime socket to be ready (default: 30s)help
--delayed-start-tickDuration between checks for the haproxy runtime socket to be ready (default: 500ms)help
-v, --versionVersion and build informationhelp
-h, --helpShow this help messagehelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.