Reference
CLI reference
At startup, you can pass arguments to the 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.
List of arguments Jump to heading
The HAProxy Data Plane API supports the following command-line arguments at startup.
--api-address Jump to heading
The advertised API address. Overrides the dataplaneapi.advertised.api_address option.
nix
nix
--api-port Jump to heading
The advertised API port. Overrides the dataplaneapi.advertised.api_port option.
nix
nix
--backups-dir Jump to heading
Path to directory in which to place backup files. Overrides the dataplaneapi.transaction.backups_dir option.
nix
nix
--backups-number, -n Jump to heading
Number of backup configuration files to keep. Overrides the dataplaneapi.transaction.backups_number option.
nix
nix
--config-file, -c Jump to heading
Path to the HAProxy configuration file. Overrides the haproxy.config_file option.
nix
nix
--dataplane-storage-dir Jump to heading
Path to Data Plane API internal storage directory. Overrides the dataplaneapi.resources.dataplane_storage_dir option.
nix
nix
--debug-socket-path Jump to heading
Defines the path for the debugging command socket. Overrides the dataplaneapi.debug_socket_path option.
nix
nix
--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.
nix
nix
--delayed-start-tick Jump to heading
Duration between checks for the haproxy runtime socket to be ready. Overrides the haproxy.delayed_start_tick option.
nix
nix
--disable-inotify Jump to heading
Disables the inotify watcher for the configuration file. Overrides the dataplaneapi.disable_inotify option.
nix
nix
--fid Jump to heading
Path to file that the Data Plane API will use to write its id. Overrides the haproxy.fid option.
nix
nix
--general-storage-dir Jump to heading
Path to general storage directory. Overrides the dataplaneapi.resources.general_storage_dir option.
nix
nix
--gid Jump to heading
Group id value to set on start. Overrides the dataplaneapi.gid option.
nix
nix
--haproxy-bin, -b Jump to heading
Path to the HAProxy binary file. Overrides the haproxy.haproxy_bin option.
nix
nix
--log-file Jump to heading
Location of the log file. Overrides the log.log_file option.
nix
nix
--log-format Jump to heading
Logging format, allowed values are text, JSON. Overrides the log.log_format option.
nix
nix
--log-level Jump to heading
Logging level, allowed values are trace, debug, info, warning, error. Overrides the log.log_level option.
nix
nix
--log-to Jump to heading
Log target, can be stdout, file, or syslog. Overrides the log.log_to option.
nix
nix
--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.
nix
nix
--master-runtime, -m Jump to heading
Path to the master Runtime API socket. Overrides the haproxy.master_runtime option.
nix
nix
--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
nix
--max-open-transactions Jump to heading
Limit for active transaction in pending state. Overrides the dataplaneapi.transaction.max_open_transactions option.
nix
nix
--pid-file Jump to heading
Specifies the path to the file where the APIs PID will be written. Overrides the dataplaneapi.pid_file` option.
nix
nix
--reload-cmd, -r Jump to heading
Reload command. Overrides the haproxy.reload.reload_cmd option.
nix
nix
--reload-delay, -d Jump to heading
Minimum delay between two reloads (in seconds). Overrides the haproxy.reload.reload_delay option.
nix
nix
--reload-retention Jump to heading
Reload retention in days. Overrides the haproxy.reload.reload_retention option.
nix
nix
--reload-strategy Jump to heading
Either systemd, s6 or custom. Overrides the haproxy.reload.reload_strategy option.
nix
nix
--restart-cmd, -s Jump to heading
Restart command. Overrides the haproxy.reload.restart_cmd option.
nix
nix
--service Jump to heading
Name of the HAProxy service. Overrides the haproxy.reload.service_name option.
nix
nix
--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
nix
--spoe-dir Jump to heading
Path to SPOE directory. Overrides the dataplaneapi.resources.spoe_dir option.
nix
nix
--spoe-transaction-dir Jump to heading
Path to the SPOE transaction directory. Overrides the dataplaneapi.resources.spoe_transaction_dir option.
nix
nix
--ssl-certs-dir Jump to heading
Path to SSL certificates directory. Overrides the dataplaneapi.resources.ssl_certs_dir option.
nix
nix
--status-cmd Jump to heading
Status command. Overrides the haproxy.reload.status_cmd option.
nix
nix
--syslog-address Jump to heading
Syslog address (with port declaration in case of TCP type) where logs should be forwarded. It accepts a socket path in case of unix or unixgram. Overrides the log.syslog.syslog_address option.
nix
nix
--syslog-facility Jump to heading
Define the Syslog facility number, allowed values are kern, user, mail, daemon, auth, syslog, lpr, news, uucp, cron, authpriv, ftp, local0, local1, local2, local3, local4, local5, local6, local7. Overrides the log.syslog.syslog_facility option.
nix
nix
--syslog-level Jump to heading
Define the required syslog messages level, allowed values are debug, info, notice, warning, error, critical, alert, emergency. Overrides the log.syslog.syslog_level option.
nix
nix
--syslog-protocol Jump to heading
Syslog server protocol, allowed values are tcp, tcp4, tcp6, unix, unixgram. Overrides the log.syslog.syslog_protocol option.
nix
nix
--syslog-tag Jump to heading
String to tag the syslog messages. Overrides the log.syslog.syslog_tag option.
nix
nix
--transaction-dir, -t Jump to heading
Path to the transaction directory. Overrides the dataplaneapi.transaction.transaction_dir option.
nix
nix
--uid Jump to heading
User id value to set on start. Overrides the dataplaneapi.uid option.
nix
nix
--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
nix
--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.
nix
nix
--userlist, -u Jump to heading
Userlist in HAProxy configuration to use for API Basic Authentication. Overrides the dataplaneapi.userlist.userlist option.
nix
nix
--userlist-file Jump to heading
Path to the Data Plane API userlist file. Overrides the dataplaneapi.userlist.userlist_file option.
nix
nix
--validate-cmd Jump to heading
Executes a custom command to perform the HAProxy configuration check. Overrides the haproxy.reload.validate_cmd option.
nix
nix
Do you have any suggestions on how we can improve the content of this page?