base/frameworks/control/main.zeek¶
-
Control
¶
The control framework provides the foundation for providing “commands” that can be taken remotely at runtime to modify a running Zeek instance or collect information from the running instance.
- Namespace
Control
Summary¶
Redefinable Options¶
This can be used by commands that take an argument. |
|
The command that is being done. |
|
The commands that can currently be given on the command line for remote control. |
|
Whether the controllee should call |
|
The address of the host that will be controlled. |
|
The port of the host that will be controlled. |
|
If |
Constants¶
Variable IDs that are to be ignored by the update process. |
|
The topic prefix used for exchanging control messages via Broker. |
Events¶
This event is a wrapper and alias for the
|
|
Inform the remote Zeek instance that it’s configuration may have been updated. |
|
Message in response to a configuration update request. |
|
Event for requesting the value of an ID (a variable). |
|
Event for returning the value of an ID after an
|
|
Requests the current net_stats. |
|
Returns the current net_stats. |
|
Requests the current communication status. |
|
Returns the current communication status. |
|
Requests that the Zeek instance begins shutting down. |
|
Message in response to a shutdown request. |
Detailed Interface¶
Redefinable Options¶
-
Control::arg
¶ -
This can be used by commands that take an argument.
-
Control::cmd
¶ -
The command that is being done. It’s typically set on the command line.
-
Control::commands
¶ - Type
- Attributes
- Default
{ "peer_status", "id_value", "net_stats", "configuration_update", "shutdown" }
The commands that can currently be given on the command line for remote control.
-
Control::controllee_listen
¶ -
Whether the controllee should call
Broker::listen
. In a cluster, this isn’t needed since the setup process calls it.
-
Control::host
¶ -
The address of the host that will be controlled.
-
Control::host_port
¶ -
The port of the host that will be controlled.
-
Control::zone_id
¶ -
If
Control::host
is a non-global IPv6 address and requires a specific RFC 4007zone_id
, it can be set here.
Events¶
-
Control::configuration_update
¶ - Type
event
()
This event is a wrapper and alias for the
Control::configuration_update_request
event. This event is also a primary hooking point for the control framework.
-
Control::configuration_update_request
¶ - Type
event
()
Inform the remote Zeek instance that it’s configuration may have been updated.
-
Control::configuration_update_response
¶ - Type
event
()
Message in response to a configuration update request.
-
Control::id_value_request
¶ -
Event for requesting the value of an ID (a variable).
-
Control::id_value_response
¶ -
Event for returning the value of an ID after an
Control::id_value_request
event.