config.zeek

Management

Management framework configuration settings common to agent and controller. This does not include config settings that exist in both agent and controller but that they set differently, since setting defaults here would be awkward or pointless (since both node types would overwrite them anyway). For role-specific settings, see management/controller/config.zeek and management/agent/config.zeek.

Namespace:: Management
Imports:: base/misc/installation.zeek, policy/frameworks/management/types.zeek

Summary

Redefinable Options

`Management::connect_retry`: `interval` `&redef`	The retry interval for Broker connects.
`Management::default_address`: `string` `&redef`	The fallback listen address if more specific addresses, such as the controller’s `Management::Controller::listen_address` remains empty.
`Management::role`: `Management::Role` `&redef`	The role of this process in cluster management.
`Management::spool_dir`: `string` `&redef`	The toplevel directory in which the Management framework creates spool state for any Zeek nodes, including the Zeek cluster, agents, and the controller.
`Management::state_dir`: `string` `&redef`	The toplevel directory for variable state, such as Broker data stores.

Functions

`Management::get_spool_dir`: `function`	Returns the effective spool directory for the management framework.
`Management::get_state_dir`: `function`	Returns the effective state directory for the management framework.

Detailed Interface

Redefinable Options

Management::connect_retry 

Type:: interval
Attributes:: &redef
Default:: 1.0 sec

The retry interval for Broker connects. Defaults to a more aggressive value compared to Broker’s 30s.

Management::default_address 

Type:: string
Attributes:: &redef
Default:: "0.0.0.0"

The fallback listen address if more specific addresses, such as the controller’s Management::Controller::listen_address remains empty. Unless redefined, this listens on all interfaces.

Management::role 

Type:

Management::Role

Attributes:

&redef

Default:

Management::NONE

Redefinition:

from policy/frameworks/management/agent/main.zeek

=:

Management::AGENT

Redefinition:

from policy/frameworks/management/controller/main.zeek

=:

Management::CONTROLLER

Redefinition:

from policy/frameworks/management/node/main.zeek

=:

Management::NODE

The role of this process in cluster management. Use this to differentiate code based on the type of node in which it ends up running.

Management::spool_dir 

Type:: string
Attributes:: &redef
Default:: ""

The toplevel directory in which the Management framework creates spool state for any Zeek nodes, including the Zeek cluster, agents, and the controller. Don’t use this directly, use the Management::get_spool_dir function.

Management::state_dir 

Type:: string
Attributes:: &redef
Default:: ""

The toplevel directory for variable state, such as Broker data stores. Don’t use this directly, use the Management::get_state_dir function.

Functions

Management::get_spool_dir 

Type:: function () : string

Returns the effective spool directory for the management framework. That’s Management::spool_dir when set, otherwise the installation’s spool directory.

Management::get_state_dir 

Type:: function () : string

Returns the effective state directory for the management framework. That’s Management::state_dir when set, otherwise the installation’s state directory.