Reference

Command-line arguments reference

On this page

At startup, you can pass arguments to HAProxy Data Plane API. Use these arguments to override values set in the dataplaneapi.yml configuration file. This allows for flexibility in deployment and testing. When a configuration option is set both in the YAML file and via a command-line argument, the command-line argument takes precedence.

Categories of arguments Jump to heading

HAProxy Data Plane API supports the following groups of arguments, which you can also see with the --help argument.

Group Contents
Application Options Listener, TLS, timeout, and other server-level settings
HAProxy options HAProxy binary, configuration file, reload, and managed-directory settings
VRRP options High-availability configuration management through Virtual Router Redundancy Protocol. Enterprise feature
GSLB options Global Server Load Balancing configuration management. Enterprise feature
Show version Version and build information
Help options Help message

Application Options Jump to heading

These arguments control how the API process listens for connections, authenticates, and shuts down.

--aloha-hash-file Jump to heading

Enterprise feature

This is an enterprise feature.

Removed

The --aloha-hash-file argument isn’t available in HAProxy Data Plane API 3.4 and newer.

Path to the temporary HAProxy ALOHA hash file. Defaults to /tmp/aloha-hash.cfg.

nix
hapee-dataplaneapi --aloha-hash-file /tmp/aloha-hash.cfg
nix
hapee-dataplaneapi --aloha-hash-file /tmp/aloha-hash.cfg

--aloha-mode, -a Jump to heading

Enterprise feature

This is an enterprise feature.

Removed

The --aloha-mode argument isn’t available in HAProxy Data Plane API 3.4 and newer.

Forward configuration to the HAProxy ALOHA API, without running HAProxy.

nix
hapee-dataplaneapi --aloha-mode
nix
hapee-dataplaneapi --aloha-mode

--api-address Jump to heading

The advertised API address. Overrides the dataplaneapi.advertised.api_address option.

nix
dataplaneapi --api-address 10.2.3.4
nix
dataplaneapi --api-address 10.2.3.4

--api-port Jump to heading

The advertised API port. Overrides the dataplaneapi.advertised.api_port option.

nix
dataplaneapi --api-port 80
nix
dataplaneapi --api-port 80

--cleanup-timeout Jump to heading

The grace period to wait before killing idle connections. Overrides the dataplaneapi.cleanup_timeout option. Defaults to 10s.

nix
dataplaneapi --cleanup-timeout 10s
nix
dataplaneapi --cleanup-timeout 10s

--debug-socket-path Jump to heading

Defines the path for the debugging command socket. Overrides the dataplaneapi.debug_socket_path option. See Debugging.

nix
dataplaneapi --debug-socket-path /var/run/dataplane-debug.sock
nix
dataplaneapi --debug-socket-path /var/run/dataplane-debug.sock

--disable-persistent-transactions Jump to heading

Enterprise feature

This is an enterprise feature.

Disable persisting transactions to disk. Overrides the dataplaneapi.transaction.disable_persistent_transactions option.

nix
hapee-dataplaneapi --disable-persistent-transactions
nix
hapee-dataplaneapi --disable-persistent-transactions

--graceful-timeout Jump to heading

The grace period to wait before shutting down the server. Overrides the dataplaneapi.graceful_timeout option. Defaults to 15s.

nix
dataplaneapi --graceful-timeout 15s
nix
dataplaneapi --graceful-timeout 15s

--host Jump to heading

The IP address on which to listen. Defaults to localhost. Overrides the dataplaneapi.host option. You can also set it via the environment variable $HOST.

nix
dataplaneapi --host localhost
nix
dataplaneapi --host localhost

--keep-alive Jump to heading

The TCP keep-alive timeout on accepted connections. It prunes dead TCP connections, for example when the client closes their laptop mid-download. Overrides the dataplaneapi.keep_alive option. Defaults to 3m.

nix
dataplaneapi --keep-alive 3m
nix
dataplaneapi --keep-alive 3m

--listen-limit Jump to heading

The limit on the number of outstanding requests. Overrides the dataplaneapi.listen_limit option.

nix
dataplaneapi --listen-limit 1024
nix
dataplaneapi --listen-limit 1024

--pam Jump to heading

Enterprise feature

This is an enterprise feature.

Use PAM instead of the userlist file for API authentication.

nix
hapee-dataplaneapi --pam
nix
hapee-dataplaneapi --pam

--port Jump to heading

The port on which to listen for non-secure connections. Overrides the dataplaneapi.port option. Defaults to a random value. You can also set it via the environment variable $PORT.

nix
dataplaneapi --port 80
nix
dataplaneapi --port 80

--read-timeout Jump to heading

Maximum duration before timing out read of the request. Overrides the dataplaneapi.read_timeout option. Defaults to 30s.

nix
dataplaneapi --read-timeout 30s
nix
dataplaneapi --read-timeout 30s

--scheme Jump to heading

The listeners to enable. This can be repeated and it defaults to the schemes in the OpenAPI specification. Overrides the dataplaneapi.scheme option.

nix
dataplaneapi --scheme http
nix
dataplaneapi --scheme http

--socket-path Jump to heading

The UNIX domain socket on which to listen. Overrides the dataplaneapi.socket_path option. Defaults to /var/run/data-plane.sock.

nix
dataplaneapi --socket-path /var/run/data-plane.sock
nix
dataplaneapi --socket-path /var/run/data-plane.sock

--ssl-certs-aloha Jump to heading

Enterprise feature

This is an enterprise feature.

Let HAProxy ALOHA manage SSL certificates instead of Data Plane API. Overrides the dataplaneapi.resources.ssl_certs_aloha option.

nix
hapee-dataplaneapi --ssl-certs-aloha
nix
hapee-dataplaneapi --ssl-certs-aloha

--tls-ca Jump to heading

TLS certificate authority file to be used with mutual TLS authentication. Overrides the dataplaneapi.tls.tls_ca option. You can also set the environment variable $TLS_CA_CERTIFICATE.

nix
dataplaneapi --tls-ca /etc/ssl/frontends/default/ca.pem
nix
dataplaneapi --tls-ca /etc/ssl/frontends/default/ca.pem

--tls-certificate Jump to heading

TLS certificate to use for secure connections. Overrides the dataplaneapi.tls.tls_certificate option. You can also set this with the environment variable $TLS_CERTIFICATE.

nix
dataplaneapi --tls-certificate /etc/ssl/frontends/default/crt.pem
nix
dataplaneapi --tls-certificate /etc/ssl/frontends/default/crt.pem

--tls-host Jump to heading

IP address on which to listen for TLS. When not specified, it’s the same as --host. Overrides the dataplaneapi.tls.tls_host option. You can also set this with the environment variable $TLS_HOST.

nix
dataplaneapi --tls-host 0.0.0.0
nix
dataplaneapi --tls-host 0.0.0.0

--tls-keep-alive Jump to heading

The TCP keep-alive timeout on accepted TLS connections. It prunes dead TCP connections, for example, when a user closes their laptop mid-download. Overrides the dataplaneapi.tls.tls_keep_alive option.

nix
dataplaneapi --tls-keep-alive 1m
nix
dataplaneapi --tls-keep-alive 1m

--tls-key Jump to heading

TLS private key to use for secure connections. Overrides the dataplaneapi.tls.tls_key option. You can also set the environment variable $TLS_PRIVATE_KEY.

nix
dataplaneapi --tls-key /etc/ssl/frontends/default/key.pem
nix
dataplaneapi --tls-key /etc/ssl/frontends/default/key.pem

--tls-listen-limit Jump to heading

Limit on the number of outstanding TLS requests. Overrides the dataplaneapi.tls.tls_listen_limit option.

nix
dataplaneapi --tls-listen-limit 10
nix
dataplaneapi --tls-listen-limit 10

--tls-port Jump to heading

Port on which to listen for secure connections. Defaults to a random value. Overrides the dataplaneapi.tls.tls_port option. You can also set this with the environment variable $TLS_PORT.

nix
dataplaneapi --tls-port 5555
nix
dataplaneapi --tls-port 5555

--tls-read-timeout Jump to heading

Maximum duration before timing out read of the request. Overrides the dataplaneapi.tls.tls_read_timeout option.

nix
dataplaneapi --tls-read-timeout 10s
nix
dataplaneapi --tls-read-timeout 10s

--tls-write-timeout Jump to heading

Maximum duration before timing out write of the response. Overrides the dataplaneapi.tls.tls_write_timeout option.

nix
dataplaneapi --tls-write-timeout 10s
nix
dataplaneapi --tls-write-timeout 10s

--waf-dir Jump to heading

Enterprise feature

This is an enterprise feature.

Path to the WAF directory. Defaults to /etc/haproxy/waf.

nix
hapee-dataplaneapi --waf-dir /etc/hapee-3.4
nix
hapee-dataplaneapi --waf-dir /etc/hapee-3.4

--write-timeout Jump to heading

Maximum duration before timing out write of the response. Overrides the dataplaneapi.write_timeout option. Defaults to 30s.

nix
dataplaneapi --write-timeout 30s
nix
dataplaneapi --write-timeout 30s

--max-header-size Jump to heading

Controls the maximum number of bytes the server will read when parsing the request header’s keys and values, including the request line. It doesn’t limit the size of the request body. Overrides the dataplaneapi.max_header_size option. Defaults to 1MiB.

nix
dataplaneapi --max-header-size 1MiB
nix
dataplaneapi --max-header-size 1MiB

--max-body-size Jump to heading

This section applies to:

  • HAProxy Data Plane API 3.4 and newer

Controls the maximum number of bytes the server will read from a request body before aborting the request. 0 means unlimited. Overrides the dataplaneapi.max_body_size option. Defaults to 1GiB.

nix
dataplaneapi --max-body-size 1MiB
nix
dataplaneapi --max-body-size 1MiB

HAProxy options Jump to heading

These arguments configure what the API manages: the HAProxy binary, configuration file, reload and lifecycle commands, and the directories the API reads and writes. They correspond to the HAProxy options group in --help.

--backups-dir Jump to heading

Path to directory in which to place backup files. Overrides the dataplaneapi.transaction.backups_dir option.

nix
dataplaneapi --backups-dir /tmp/backups
nix
dataplaneapi --backups-dir /tmp/backups

--backups-number, -n Jump to heading

Number of backup configuration files to keep, stored in the config dir with version number suffix. Overrides the dataplaneapi.transaction.backups_number option. Defaults to 0.

nix
dataplaneapi --backups-number 10
nix
dataplaneapi --backups-number 10

--cluster-tls-dir Jump to heading

Path where the cluster TLS certificates will be stored. Defaults to the same directory as the Data Plane API configuration file.

nix
dataplaneapi --cluster-tls-dir /etc/haproxy/
nix
dataplaneapi --cluster-tls-dir /etc/haproxy/

--config-file, -c Jump to heading

Path to the HAProxy configuration file. Overrides the haproxy.config_file option. Defaults to /etc/haproxy/haproxy.cfg.

nix
dataplaneapi --config-file /etc/haproxy/haproxy.cfg
nix
dataplaneapi --config-file /etc/haproxy/haproxy.cfg

--dataplane-storage-dir Jump to heading

Path to Data Plane API internal storage directory. Overrides the dataplaneapi.resources.dataplane_storage_dir option. Defaults to /etc/haproxy/dataplane.

nix
dataplaneapi --dataplane-storage-dir /etc/haproxy/dataplane
nix
dataplaneapi --dataplane-storage-dir /etc/haproxy/dataplane

--delayed-start-max Jump to heading

Maximum duration to wait for the haproxy runtime socket to be ready. Overrides the haproxy.delayed_start_max option. Defaults to 30s.

nix
dataplaneapi --delayed-start-max 30s
nix
dataplaneapi --delayed-start-max 30s

--delayed-start-tick Jump to heading

Duration between checks for the haproxy runtime socket to be ready. Overrides the haproxy.delayed_start_tick option. Defaults to 500ms.

nix
dataplaneapi --delayed-start-tick 500ms
nix
dataplaneapi --delayed-start-tick 500ms

--disable-inotify Jump to heading

Disables the inotify watcher for the configuration file. Overrides the dataplaneapi.disable_inotify option.

nix
dataplaneapi --disable-inotify false
nix
dataplaneapi --disable-inotify false

--fid Jump to heading

Path to file that the Data Plane API will use to write its ID (not a PID) that was given to it after joining a cluster. Overrides the haproxy.fid option.

nix
dataplaneapi --fid /etc/haproxy/fid
nix
dataplaneapi --fid /etc/haproxy/fid

--general-storage-dir Jump to heading

Path to general storage directory. Overrides the dataplaneapi.resources.general_storage_dir option. Defaults to /etc/haproxy/general.

nix
dataplaneapi --general-storage-dir /etc/haproxy/general
nix
dataplaneapi --general-storage-dir /etc/haproxy/general

--gid Jump to heading

Group id value to set on start. Overrides the dataplaneapi.gid option.

nix
dataplaneapi --gid 1000
nix
dataplaneapi --gid 1000

--haproxy-bin, -b Jump to heading

Path to the HAProxy binary file. Overrides the haproxy.haproxy_bin option. Defaults to haproxy.

nix
dataplaneapi --haproxy-bin /usr/sbin/haproxy
nix
dataplaneapi --haproxy-bin /usr/sbin/haproxy

--master-runtime, -m Jump to heading

Path to the master Runtime API socket. Overrides the haproxy.master_runtime option.

nix
dataplaneapi --master-runtime /var/run/haproxy/master.sock
nix
dataplaneapi --master-runtime /var/run/haproxy/master.sock

--master-worker-mode Jump to heading

Flag to enable helpers when running HAProxy in master worker mode. Overrides the haproxy.master_worker_mode option.

nix
dataplaneapi --master-worker-mode true
nix
dataplaneapi --master-worker-mode true

--max-open-transactions Jump to heading

Limit for active transaction in pending state. Overrides the dataplaneapi.transaction.max_open_transactions option. Defaults to 20.

nix
dataplaneapi --max-open-transactions 20
nix
dataplaneapi --max-open-transactions 20

--maps-dir, -p Jump to heading

Path to directory of map files managed by the Data Plane API. Overrides the dataplaneapi.resources.maps_dir option. Defaults to /etc/haproxy/maps.

nix
dataplaneapi --maps-dir /etc/haproxy/maps
nix
dataplaneapi --maps-dir /etc/haproxy/maps

--pid-file Jump to heading

Specifies the path to the file where the API’s PID will be written. Overrides the dataplaneapi.pid_file option.

nix
dataplaneapi --pid-file /tmp/dataplane.pid
nix
dataplaneapi --pid-file /tmp/dataplane.pid

--reload-cmd, -r Jump to heading

Reload command. Overrides the haproxy.reload.reload_cmd option.

nix
dataplaneapi --reload-cmd "systemctl reload haproxy"
nix
dataplaneapi --reload-cmd "systemctl reload haproxy"

--reload-delay, -d Jump to heading

Minimum delay between two reloads (in seconds). Overrides the haproxy.reload.reload_delay option. Defaults to 5.

nix
dataplaneapi --reload-delay 5
nix
dataplaneapi --reload-delay 5

--reload-retention Jump to heading

Reload retention in days; every older reload ID will be deleted. Overrides the haproxy.reload.reload_retention option. Defaults to 1.

nix
dataplaneapi --reload-retention 1
nix
dataplaneapi --reload-retention 1

--reload-strategy Jump to heading

Either systemd, s6 or custom. Overrides the haproxy.reload.reload_strategy option. Defaults to custom.

nix
dataplaneapi --reload-strategy systemd
nix
dataplaneapi --reload-strategy systemd

--restart-cmd, -s Jump to heading

Restart command. Overrides the haproxy.reload.restart_cmd option.

nix
dataplaneapi --restart-cmd "systemctl restart haproxy"
nix
dataplaneapi --restart-cmd "systemctl restart haproxy"

--service Jump to heading

Name of the HAProxy service. Overrides the haproxy.reload.service_name option.

nix
dataplaneapi --service haproxy.service
nix
dataplaneapi --service haproxy.service

--show-system-info, -i Jump to heading

Enables or disables the display of system information on the info endpoint. Overrides the dataplaneapi.show_system_info option.

nix
dataplaneapi --show-system-info false
nix
dataplaneapi --show-system-info false

--spoe-dir Jump to heading

Path to SPOE directory. Overrides the dataplaneapi.resources.spoe_dir option. Defaults to /etc/haproxy/spoe.

nix
dataplaneapi --spoe-dir /etc/haproxy/spoe
nix
dataplaneapi --spoe-dir /etc/haproxy/spoe

--spoe-transaction-dir Jump to heading

Path to the SPOE transaction directory. Overrides the dataplaneapi.resources.spoe_transaction_dir option. Defaults to /tmp/spoe-haproxy.

nix
dataplaneapi --spoe-transaction-dir /tmp/spoe-haproxy
nix
dataplaneapi --spoe-transaction-dir /tmp/spoe-haproxy

--ssl-certs-dir Jump to heading

Path to SSL certificates directory. Overrides the dataplaneapi.resources.ssl_certs_dir option. Defaults to /etc/haproxy/ssl.

nix
dataplaneapi --ssl-certs-dir /etc/haproxy/ssl
nix
dataplaneapi --ssl-certs-dir /etc/haproxy/ssl

--start-cmd Jump to heading

Enterprise feature

This is an enterprise feature.

Start command. Overrides the haproxy.reload.start_cmd option.

nix
hapee-dataplaneapi --start-cmd "/usr/bin/systemctl start 3.4-lb"
nix
hapee-dataplaneapi --start-cmd "/usr/bin/systemctl start 3.4-lb"

--status-cmd Jump to heading

Status command. Overrides the haproxy.reload.status_cmd option.

nix
dataplaneapi --status-cmd "systemctl status haproxy"
nix
dataplaneapi --status-cmd "systemctl status haproxy"

--stop-cmd Jump to heading

Enterprise feature

This is an enterprise feature.

Stop command. Overrides the haproxy.reload.stop_cmd option.

nix
hapee-dataplaneapi --stop-cmd "/usr/bin/systemctl stop 3.4-lb"
nix
hapee-dataplaneapi --stop-cmd "/usr/bin/systemctl stop 3.4-lb"

--time-suffix Jump to heading

Preferred time unit to use when writing time values in the configuration (nearest, none, ms, s, m, h, d). Defaults to nearest.

nix
dataplaneapi --time-suffix s
nix
dataplaneapi --time-suffix s

--transaction-dir, -t Jump to heading

Path to the transaction directory. Overrides the dataplaneapi.transaction.transaction_dir option. Defaults to /tmp/haproxy.

nix
dataplaneapi --transaction-dir /etc/haproxy/transactions
nix
dataplaneapi --transaction-dir /etc/haproxy/transactions

--uid Jump to heading

User id value to set on start. Overrides the dataplaneapi.uid option.

nix
dataplaneapi --uid 1000
nix
dataplaneapi --uid 1000

--update-map-files Jump to heading

Flag used for syncing map files with runtime maps values. Overrides the dataplaneapi.resources.update_map_files option.

nix
dataplaneapi --update-map-files false
nix
dataplaneapi --update-map-files false

--update-map-files-period Jump to heading

Elapsed time in seconds between two maps syncing operations. Overrides the dataplaneapi.resources.update_map_files_period option. Defaults to 10.

nix
dataplaneapi --update-map-files-period 10
nix
dataplaneapi --update-map-files-period 10

--userlist, -u Jump to heading

Userlist in HAProxy configuration to use for API Basic Authentication. Overrides the dataplaneapi.userlist.userlist option. Defaults to controller.

nix
dataplaneapi --userlist myuserlist
nix
dataplaneapi --userlist myuserlist

--userlist-file Jump to heading

Path to the Data Plane API userlist file. By default, the API reads the userlist from the HAProxy configuration. When specified, the API will read the userlist from this file. Overrides the dataplaneapi.userlist.userlist_file option.

nix
dataplaneapi --userlist-file /etc/haproxy/userlist.cfg
nix
dataplaneapi --userlist-file /etc/haproxy/userlist.cfg

--validate-cmd Jump to heading

Executes a custom command to perform the HAProxy configuration check. Overrides the haproxy.reload.validate_cmd option.

nix
dataplaneapi --validate-cmd /usr/local/bin/validate-haproxy.sh
nix
dataplaneapi --validate-cmd /usr/local/bin/validate-haproxy.sh

--validate-files-after Jump to heading

This section applies to:

  • HAProxy Data Plane API 3.4 and newer

A list of configuration files to be loaded after the main file for validation. You can specify this argument more than once to set multiple file paths. Overrides the haproxy.reload.validate_files_after option.

nix
dataplaneapi --validate-files-after /etc/haproxy/myconf1.cfg --validate-files-after /etc/haproxy/myconf2.cfg
nix
dataplaneapi --validate-files-after /etc/haproxy/myconf1.cfg --validate-files-after /etc/haproxy/myconf2.cfg

--validate-files-before Jump to heading

This section applies to:

  • HAProxy Data Plane API 3.4 and newer

A list of configuration files to be loaded before the main file for validation. You can specify this argument more than once to set multiple file paths. Overrides the haproxy.reload.validate_files_before option.

nix
dataplaneapi --validate-files-before /etc/haproxy/myconf1.cfg --validate-files-before /etc/haproxy/myconf2.cfg
nix
dataplaneapi --validate-files-before /etc/haproxy/myconf1.cfg --validate-files-before /etc/haproxy/myconf2.cfg

-f Jump to heading

Path to the Data Plane API configuration file. Defaults to /etc/haproxy/dataplaneapi.yaml.

nix
dataplaneapi -f /etc/haproxy/dataplaneapi.yaml
nix
dataplaneapi -f /etc/haproxy/dataplaneapi.yaml

Keepalived / VRRP options Jump to heading

Enterprise feature

This is an enterprise feature.

This section applies to:

  • HAProxy Data Plane API 3.4 and newer

The following arguments configure Data Plane API to manage a Keepalived configuration file.

Argument Description
--keepalived-config-file Path to the Keepalived configuration file. When set, the Keepalived endpoints are enabled. Overrides the keepalived.config_file option.
--keepalived-start-cmd Start command. Overrides the keepalived.start_cmd option.
--keepalived-reload-cmd Reload command. Overrides the keepalived.reload_cmd option.
--keepalived-restart-cmd Restart command. Overrides the keepalived.restart_cmd option.
--keepalived-stop-cmd Stop command. Overrides the keepalived.stop_cmd option.
--keepalived-status-cmd Status command. Overrides the keepalived.status_cmd option.
--keepalived-signal-cmd Command to send a signal to Keepalived; must support -s like kill(1). Defaults to sudo -n kill. Overrides the keepalived.signal_cmd option.
--keepalived-getpid-cmd Command to get the PID of Keepalived. Defaults to pgrep hapee-vrrp. Overrides the keepalived.getpid_cmd option.
--keepalived-readdump-cmd Command to read the Keepalived dump file. Defaults to sudo -n cat. Overrides the keepalived.read_dump_cmd option.
--keepalived-validate-cmd Command to validate the resulting configuration. The environment variable KEEPALIVED_TRANSACTION_FILE is injected, pointing to the configuration file to be committed. Overrides the keepalived.validate_cmd option.
--keepalived-reload-delay Minimum delay between two reloads, in seconds. Defaults to 5. Overrides the keepalived.reload_delay option.
--keepalived-transaction-dir Path to the transaction directory. Overrides the keepalived.transaction_dir option.
--keepalived-backups-dir Path to the committed configuration files backup directory. Overrides the keepalived.backups_dir option.
--keepalived-backups-number Number of backup configuration files to keep, stored in the backup directory with version number suffix. Defaults to 0. Overrides the keepalived.backups_number option. 
nix
hapee-dataplaneapi \
  --keepalived-config-file "/etc/hapee-extras/hapee-vrrp.cfg" \
  --keepalived-start-cmd "/bin/systemctl start hapee-extras-vrrp" \
  --keepalived-reload-cmd "/bin/systemctl reload hapee-extras-vrrp" \
  --keepalived-restart-cmd "/bin/systemctl restart hapee-extras-vrrp" \
  --keepalived-stop-cmd "/bin/systemctl stop hapee-extras-vrrp" \
  --keepalived-status-cmd "/bin/systemctl status hapee-extras-vrrp" \
  --keepalived-reload-delay 5 \
  --keepalived-transaction-dir "/var/run/hapee-extras/dataplaneapi/keepalived" \
  --keepalived-backups-dir "/var/lib/hapee-extras/dataplaneapi/keepalived" \
  --keepalived-backups-number 10
nix
hapee-dataplaneapi \
  --keepalived-config-file "/etc/hapee-extras/hapee-vrrp.cfg" \
  --keepalived-start-cmd "/bin/systemctl start hapee-extras-vrrp" \
  --keepalived-reload-cmd "/bin/systemctl reload hapee-extras-vrrp" \
  --keepalived-restart-cmd "/bin/systemctl restart hapee-extras-vrrp" \
  --keepalived-stop-cmd "/bin/systemctl stop hapee-extras-vrrp" \
  --keepalived-status-cmd "/bin/systemctl status hapee-extras-vrrp" \
  --keepalived-reload-delay 5 \
  --keepalived-transaction-dir "/var/run/hapee-extras/dataplaneapi/keepalived" \
  --keepalived-backups-dir "/var/lib/hapee-extras/dataplaneapi/keepalived" \
  --keepalived-backups-number 10

GSLB options Jump to heading

Enterprise feature

This is an enterprise feature.

This section applies to:

  • HAProxy Data Plane API 3.4 and newer

The following arguments configure the Global Server Load Balancing configuration file. Setting --gslb-config-file enables the /services/gslb endpoints.

Argument Description
--gslb-config-file Path to the GSLB configuration file. When set, the /services/gslb endpoints are enabled. Overrides the gslb.config_file option.
--gslb-transaction-dir Path to the GSLB transaction directory. Overrides the gslb.transaction_dir option.
--gslb-reload-cmd Reload command executed after a GSLB configuration change is applied. Overrides the gslb.reload_cmd option.
--gslb-restart-cmd Restart command. Overrides the gslb.restart_cmd option.
--gslb-start-cmd Start command. Overrides the gslb.start_cmd option.
--gslb-stop-cmd Stop command. Overrides the gslb.stop_cmd option.
--gslb-validate-bin Path to a binary used to validate the resulting GSLB configuration; the configuration file path is passed directly as its argument. Takes precedence over --gslb-validate-cmd. Overrides the gslb.validate_bin option.
--gslb-validate-cmd Command to validate the resulting GSLB configuration. The environment variable GSLB_CONFIGFILE is injected, pointing to the configuration file to be validated. Overrides the gslb.validate_cmd option.
--gslb-backups-dir Path to the committed configuration files backup directory. Overrides the gslb.backups_dir option.
--gslb-backups-number Number of backup configuration files to keep, stored in the backup directory with version number suffix. Defaults to 0. Overrides the gslb.backups_number option.
--gslb-disable-save-verification Don’t check, before saving a GSLB configuration change, that the configuration written out describes the same sections and entries once parsed back. Overrides the gslb.disable_save_verification option. 
nix
hapee-dataplaneapi \
  --gslb-config-file "/etc/hapee-extras/hapee-gslb.conf" \
  --gslb-transaction-dir "/etc/hapee-extras/gslb/transactions" \
  --gslb-reload-cmd "/usr/bin/systemctl reload hapee-extras-gslb" \
  --gslb-restart-cmd "/usr/bin/systemctl restart hapee-extras-gslb" \
  --gslb-start-cmd "/usr/bin/systemctl start hapee-extras-gslb" \
  --gslb-stop-cmd "/usr/bin/systemctl stop hapee-extras-gslb" \
  --gslb-validate-bin "/opt/hapee-extras/sbin/hapee-gslb" \
  --gslb-backups-dir "/etc/hapee-extras/gslb/backups" \
  --gslb-backups-number 10
nix
hapee-dataplaneapi \
  --gslb-config-file "/etc/hapee-extras/hapee-gslb.conf" \
  --gslb-transaction-dir "/etc/hapee-extras/gslb/transactions" \
  --gslb-reload-cmd "/usr/bin/systemctl reload hapee-extras-gslb" \
  --gslb-restart-cmd "/usr/bin/systemctl restart hapee-extras-gslb" \
  --gslb-start-cmd "/usr/bin/systemctl start hapee-extras-gslb" \
  --gslb-stop-cmd "/usr/bin/systemctl stop hapee-extras-gslb" \
  --gslb-validate-bin "/opt/hapee-extras/sbin/hapee-gslb" \
  --gslb-backups-dir "/etc/hapee-extras/gslb/backups" \
  --gslb-backups-number 10

Show version Jump to heading

Corresponds to the Show version group in --help.

--version, -v Jump to heading

Displays version and build information.

nix
dataplaneapi --version
nix
dataplaneapi --version

--specification Jump to heading

Enterprise feature

This is an enterprise feature.

Prints the OpenAPI specification describing the API capabilities.

nix
hapee-dataplaneapi --specification
nix
hapee-dataplaneapi --specification

Help options Jump to heading

Corresponds to the Help Options group in --help.

--help, -h Jump to heading

Shows the help message.

nix
dataplaneapi --help
nix
dataplaneapi --help

Do you have any suggestions on how we can improve the content of this page? Please leave feedback!

Previous page Reference Next page Configuration file reference