Copy docs into Zeek repo directly

This is based on commit 2731def9159247e6da8a3191783c89683363689c from the
zeek-docs repo.
This commit is contained in:
Tim Wojtulewicz 2025-09-15 15:52:18 -07:00
parent 83f1e74643
commit ded98cd373
1074 changed files with 169319 additions and 0 deletions

View file

@ -0,0 +1,14 @@
:tocdepth: 3
base/packet-protocols/vxlan/__load__.zeek
=========================================
:Imports: :doc:`base/packet-protocols/vxlan/main.zeek </scripts/base/packet-protocols/vxlan/main.zeek>`
Summary
~~~~~~~
Detailed Interface
~~~~~~~~~~~~~~~~~~

View file

@ -0,0 +1,12 @@
:orphan:
Package: base/packet-protocols/vxlan
====================================
:doc:`/scripts/base/packet-protocols/vxlan/__load__.zeek`
:doc:`/scripts/base/packet-protocols/vxlan/main.zeek`

View file

@ -0,0 +1,57 @@
:tocdepth: 3
base/packet-protocols/vxlan/main.zeek
=====================================
.. zeek:namespace:: PacketAnalyzer::VXLAN
:Namespace: PacketAnalyzer::VXLAN
Summary
~~~~~~~
Redefinable Options
###################
======================================================================================================== ============================================
:zeek:id:`PacketAnalyzer::VXLAN::default_analyzer`: :zeek:type:`PacketAnalyzer::Tag` :zeek:attr:`&redef`
:zeek:id:`PacketAnalyzer::VXLAN::vxlan_ports`: :zeek:type:`set` :zeek:attr:`&redef` The set of UDP ports used for VXLAN traffic.
======================================================================================================== ============================================
Redefinitions
#############
==================================================================== =
:zeek:id:`likely_server_ports`: :zeek:type:`set` :zeek:attr:`&redef`
==================================================================== =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: PacketAnalyzer::VXLAN::default_analyzer
:source-code: base/packet-protocols/vxlan/main.zeek 6 6
:Type: :zeek:type:`PacketAnalyzer::Tag`
:Attributes: :zeek:attr:`&redef`
:Default: ``PacketAnalyzer::ANALYZER_ETHERNET``
.. zeek:id:: PacketAnalyzer::VXLAN::vxlan_ports
:source-code: base/packet-protocols/vxlan/main.zeek 12 12
:Type: :zeek:type:`set` [:zeek:type:`port`]
:Attributes: :zeek:attr:`&redef`
:Default:
::
{
4789/udp
}
The set of UDP ports used for VXLAN traffic. Traffic using this
UDP destination port will attempt to be decapsulated. Note that if
if you customize this, you may still want to manually ensure that
:zeek:see:`likely_server_ports` also gets populated accordingly.