OS Manuals

/usr/bin/zeek-client

zeek-client, the Zeek cluster management client

From zeek-fips-client 9.0.1-r0 (enterprise-packages), captured 2026-11-08 by running zeek-client --help (exit 0). permalink

usage: zeek-client [-h] [-c FILE] [--controller HOST:PORT] [--set SECTION.KEY=VAL] [--quiet |
                   --verbose] [--version]
                   {deploy,deploy-config,get-config,get-id-value,get-instances,get-nodes,monitor,restart,stage-config,show-settings,test-timeout} ...

A Zeek management client

options:
  -h, --help            show this help message and exit
  -c, --configfile FILE
                        Path to zeek-client config file. (Default: /etc/zeek/zeek-client.cfg)
  --controller HOST:PORT
                        Address and port of the controller, either of which may be omitted
                        (default: 127.0.0.1:2149)
  --set SECTION.KEY=VAL
                        Adjust a configuration setting. Can use repeatedly. See show-settings.
  --quiet, -q           Suppress informational output to stderr.
  --verbose, -v         Increase informational output to stderr. Repeat for more output (e.g.
                        -vvv).
  --version             Show version number and exit.

commands:
  {deploy,deploy-config,get-config,get-id-value,get-instances,get-nodes,monitor,restart,stage-config,show-settings,test-timeout}
                        See `zeek-client <command> -h` for per-command usage info.
    deploy              Deploy a staged cluster configuration.
    deploy-config       Upload a cluster configuration and deploy it.
    get-config          Retrieve staged or deployed cluster configuration.
    get-id-value        Show the value of a given identifier in Zeek cluster nodes.
    get-instances       Show instances connected to the controller.
    get-nodes           Show active Zeek nodes at each instance.
    monitor             For troubleshooting: do nothing, just report events.
    restart             Restart cluster nodes.
    stage-config        Upload a cluster configuration for later deployment.
    show-settings       Show zeek-client's own configuration.
    test-timeout        Send timeout test event.

environment variables:

    ZEEK_CLIENT_CONFIG_FILE:      Same as `--configfile` argument, but lower precedence.
    ZEEK_CLIENT_CONFIG_SETTINGS:  Same as a space-separated series of `--set` arguments, but lower precedence.
Options (7)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
-c, --configfile FILEPath to zeek-client config file.help + man
--controller HOST:PORTAddress and port of the controller, either of which may be omitted (default: 127.0.0.1:2149)help + man
--set SECTION.KEY=VALAdjust a configuration setting.help + man
--quiet, -qSuppress informational output to stderr.help + man
--verbose, -vIncrease informational output to stderr.help + man
--versionShow version number and exit.help + man
Exit status (1) from the manual page
0success and 1 if a problem arises

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