zeek/doc/scripts/base/bif/plugins/Zeek_DHCP.events.bif.zeek.rst
Patrick Kelley 8fd444092b initial
2025-05-07 15:35:15 -04:00

45 lines
1.1 KiB
ReStructuredText

:tocdepth: 3
base/bif/plugins/Zeek_DHCP.events.bif.zeek
==========================================
.. zeek:namespace:: GLOBAL
:Namespace: GLOBAL
Summary
~~~~~~~
Events
######
=========================================== ================================
:zeek:id:`dhcp_message`: :zeek:type:`event` Generated for all DHCP messages.
=========================================== ================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Events
######
.. zeek:id:: dhcp_message
:source-code: base/protocols/dhcp/main.zeek 301 308
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, msg: :zeek:type:`DHCP::Msg`, options: :zeek:type:`DHCP::Options`)
Generated for all DHCP messages.
:param c: The connection record describing the underlying UDP flow.
:param is_orig: Indicate if the message came in a packet from the
originator/client of the udp flow or the responder/server.
:param msg: The parsed type-independent part of the DHCP message. The message
type is indicated in this record.
:param options: The full set of supported and parsed DHCP options.