HAProxy Enterprise Documentation 1.6r2

CLI

The basic usage of the API is as follows:

$ hapee-dataplane-api [OPTIONS]
  • The options for editing and managing HAProxy Enterprise instances are listed below.

  • You can invoke the API with the --help flag to see a list of available options.

Application options

These options control how the Data Plane API is hosted and how it should manage shutdown.

Option

Description

--scheme=

The listeners to enable. Can be repeated and defaults to the schemes in the swagger specification

--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)

--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=

Limits 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 to wait to read the request before timing out (default: 30s)

--write-timeout=

Maximum duration to wait to write the response before timing out (default: 60s)

--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 use with mutual tls auth [$TLS_CA_CERTIFICATE]

--tls-listen-limit=

Limits 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 to wait to read the request before timing out

--tls-write-timeout=

Maximum duration to wait to write the response before timing out

HAProxy Enterprise options

These options configure the API's access and management of a running instance of HAProxy.

Option

Description

-c, --config-file=

Path to the HAProxy Enterprise configuration file (default: /etc/hapee-1.6/haproxy.cfg)

-u, --userlist=

Userlist in HAProxy Enterprise configuration to use for API Basic Authentication (default: controller)

-b, --haproxy-bin=

Path to the HAProxy Enterprise binary file (default: haproxy)

-d, --reload-delay=

Minimum delay between two reloads (in s) (default: 5)

-r, --reload-cmd=

Reload command

-s, --restart-cmd=

Restart command

--reload-retention=

Reload retention in days, every older reload id will be deleted (default: 1)

-t, --transaction-dir=

Path to the transaction directory (default: /tmp/haproxy)

-n, --backups-number=

Number of backup configuration files you want to keep, stored in the config dir with version number suffix (default: 0)

-m, --master-runtime=

Path to the HAProxy Enterprise Runtime API socket

-i, --show-system-info

Show system info on info endpoint

Logging options

These options configure the level of logging for requests to the API.

Option

Description

--log-to=[stdout|file]

Log target, can be stdout or file (default: stdout)

--log-file=

Location of the log file (default: /var/log/dataplaneapi/dataplaneapi.log)

--log-level=[trace|debug|info|warning|error]

Logging level (default: warning)

--log-format=[text|JSON]

Logging format (default: text)

Other options

These options provide additional information about the API.

Option

Description

-v, --version

Show version and build information

-h, --help

Show this help message


Next up

Usage