Plugins

Plugin catalog

Ze features are composed from plugins. This catalog is generated from the live registry and explains what each plugin is for, what it configures, and which other plugins it relies on. Click any plugin to open a local detail page.

Generated from 95 registry entries: 89 runtime plugins and 6 test fixtures. Among runtime plugins, 68 declare configuration roots, 48 declare dependencies, and 69 ship YANG modules.

Anomaly

2 plugins

Generated group for registry entries mapped to the Anomaly area. Config roots: anomaly. Source area: internal/plugins/anomaly.

Anomaly

anomaly-detect-feature-source

Behavioral anomaly detector (report-only): per-entity pattern-of-life over trafficfeature

config:anomaly/detect needs:config-loaded YANG:1
Config
anomaly/detect
Needs
config-loaded
YANG
1 module
Anomaly

anomaly-shape-firewall

Shadow-first autonomous anomaly responder: per-source rate-limit with arm/auto-revert/kill-switch

config:anomaly/shape needs:config-loaded YANG:1
Config
anomaly/shape
Needs
config-loaded
YANG
1 module

BFD

1 plugin

Generated group for registry entries mapped to the BFD area. Config roots: bfd. Source area: internal/component/bfd.

BFD

bfd

Bidirectional Forwarding Detection (RFC 5880, 5881, 5883)

config:bfd YANG:3
Config
bfd
YANG
3 modules

BGP

19 plugins

Generated group for registry entries mapped to the BGP area. Config roots: bgp, environment. Source area: internal/component/bgp.

BGP

bgp

BGP routing daemon

config:bgp YANG:2
Config
bgp
YANG
2 modules
BGP

bgp-adj-rib-in

Adj-RIB-In storage (raw hex replay)

YANG:1
YANG
1 module
BGP

bgp-aigp

Accumulated IGP Metric (RFC 7311)

no config
Config
None
BGP

bgp-bmp

BMP receiver and sender (RFC 7854, 8671)

config:bgp config:environment YANG:2
Config
bgp, environment
YANG
2 modules
BGP

bgp-capa

Core BGP capability decoding (multiprotocol, asn4, add-path, paths-limit, extended-nexthop, extended-message)

no config
Config
None
BGP

bgp-gr

Graceful Restart capability and mechanism plugin

config:bgp needs:bgp needs:bgp-rib YANG:1
Config
bgp
Needs
bgp, bgp-rib
YANG
1 module
BGP

bgp-healthcheck

Service healthcheck plugin with watchdog route control

config:bgp needs:bgp needs:bgp-watchdog YANG:1
Config
bgp
Needs
bgp, bgp-watchdog
YANG
1 module
BGP

bgp-hostname

FQDN capability decoding

config:bgp needs:bgp YANG:1
Config
bgp
Needs
bgp
YANG
1 module
BGP

bgp-llnh

Link-Local Next-Hop capability plugin

config:bgp needs:bgp YANG:1
Config
bgp
Needs
bgp
YANG
1 module
BGP

bgp-persist

Route Persistence

no config
Config
None
BGP

bgp-rib

Route Information Base storage

config:bgp YANG:2
Config
bgp
YANG
2 modules
BGP

bgp-role

RFC 9234 BGP Role capability

config:bgp needs:bgp YANG:1
Config
bgp
Needs
bgp
YANG
1 module
BGP

bgp-route-refresh

Route Refresh capability decoding

config:bgp needs:bgp YANG:3
Config
bgp
Needs
bgp
YANG
3 modules
BGP

bgp-rpki

RPKI origin validation via RTR protocol

config:bgp needs:bgp needs:bgp-adj-rib-in YANG:1
Config
bgp
Needs
bgp, bgp-adj-rib-in
YANG
1 module
BGP

bgp-rpki-decorator

Correlates UPDATE + RPKI events into merged update-rpki events

needs:bgp needs:bgp-rpki YANG:1
Needs
bgp, bgp-rpki
YANG
1 module
BGP

bgp-rr

Route Reflector

needs:bgp-adj-rib-in YANG:1
Needs
bgp-adj-rib-in
YANG
1 module
BGP

bgp-rs

Route Server

config:bgp optional:bgp-adj-rib-in YANG:1
Config
bgp
Optional
bgp-adj-rib-in
YANG
1 module
BGP

bgp-softver

Software Version capability (code 75)

config:bgp needs:bgp YANG:1
Config
bgp
Needs
bgp
YANG
1 module
BGP

bgp-watchdog

Watchdog route management plugin

config:bgp needs:bgp
Config
bgp
Needs
bgp

BGP Filter

10 plugins

Generated group for registry entries mapped to the BGP Filter area. Config roots: bgp. Source area: internal/component/bgp.

BGP Filter

bgp-filter-aspath

Named AS-path regex filter (ordered entries, first match wins, accept/reject)

config:bgp needs:bgp YANG:1
Config
bgp
Needs
bgp
YANG
1 module
BGP Filter

bgp-filter-aspath-length

Named AS-path length filter (accept/reject based on hop count)

config:bgp needs:bgp YANG:1
Config
bgp
Needs
bgp
YANG
1 module
BGP Filter

bgp-filter-community

Community tag/strip filter (standard, large, extended)

config:bgp needs:bgp YANG:1
Config
bgp
Needs
bgp
YANG
1 module
BGP Filter

bgp-filter-community-match

Named community match filter (ordered entries, first match wins, accept/reject)

config:bgp needs:bgp YANG:1
Config
bgp
Needs
bgp
YANG
1 module
BGP Filter

bgp-filter-family

Named address-family policy filter: remove a family's NLRI or tear down the session

config:bgp needs:bgp YANG:1
Config
bgp
Needs
bgp
YANG
1 module
BGP Filter

bgp-filter-irr

IRR-based prefix-list filter for eBGP peers

config:bgp needs:bgp YANG:2
Config
bgp
Needs
bgp
YANG
2 modules
BGP Filter

bgp-filter-modify

Named route attribute modifier (set local-preference, med, origin, next-hop)

config:bgp needs:bgp YANG:1
Config
bgp
Needs
bgp
YANG
1 module
BGP Filter

bgp-filter-prefix

Named prefix-list filter (CIDR + ge/le + accept/reject)

config:bgp needs:bgp YANG:1
Config
bgp
Needs
bgp
YANG
1 module
BGP Filter

bgp-filter-remove-private-as

Named AS-path action filter that removes RFC 6996 Private Use ASNs

config:bgp needs:bgp YANG:1
Config
bgp
Needs
bgp
YANG
1 module
BGP Filter

loop

Route loop detection (RFC 4271 S9, RFC 4456 S8)

YANG:1
YANG
1 module

BGP NLRI

10 plugins

Generated group for registry entries mapped to the BGP NLRI area. Source area: internal/component/bgp.

BGP NLRI

bgp-nlri-labeled

Labeled Unicast family plugin (RFC 8277)

no config
Config
None
BGP NLRI

bgp-nlri-ls

BGP-LS family plugin

no config
Config
None
BGP NLRI

bgp-nlri-mup

Mobile User Plane family plugin (draft-ietf-bess-mup-safi)

no config
Config
None
BGP NLRI

bgp-nlri-mvpn

Multicast VPN family plugin (RFC 6514)

no config
Config
None
BGP NLRI

bgp-nlri-rtc

Route Target Constraint family plugin (RFC 4684)

no config
Config
None
BGP NLRI

bgp-nlri-srpolicy

SR-Policy family plugin (RFC 9830, SAFI 73)

no config
Config
None
BGP NLRI

bgp-nlri-vpls

VPLS family plugin (RFC 4761)

no config
Config
None
BGP NLRI

bgp-nlri-vpn

VPN family plugin

no config
Config
None

BGP Redistribute

2 plugins

Generated group for registry entries mapped to the BGP Redistribute area. Config roots: redistribute. Source area: internal/component/bgp.

BGP Redistribute

bgp-redistribute

Route redistribution ingress filter with loop prevention and family filtering

needs:bgp
Needs
bgp
BGP Redistribute

redistribute-orchestrator

Redistribute orchestrator: dispatches protocol route events to registered consumers

config:redistribute needs:bgp
Config
redistribute
Needs
bgp

Class of Service

1 plugin

Generated group for registry entries mapped to the Class of Service area. Config roots: class-of-service. Source area: internal/plugins/cos.

Class of Service

cos

802.1p class-of-service profile definitions

config:class-of-service YANG:1
Config
class-of-service
YANG
1 module

Connected

1 plugin

Generated group for registry entries mapped to the Connected area. Config roots: connected. Source area: internal/plugins/connected.

Connected

connected

Connected routes: redistribute directly connected interface prefixes

config:connected YANG:1
Config
connected
YANG
1 module

Control Plane Protection

1 plugin

Generated group for registry entries mapped to the Control Plane Protection area. Config roots: control-plane-protection. Source area: internal/plugins/copp.

Control Plane Pr...

copp-input-chain

Control-plane policing: rate-limit new TCP connections to BGP listen port

config:control-plane-protection needs:firewall YANG:1
Config
control-plane-protection
Needs
firewall
YANG
1 module

DDoS

5 plugins

Generated group for registry entries mapped to the DDoS area. Config roots: ddos. Source area: internal/plugins/ddos.

DDoS

ddos-detect-flow-source

Automatic DDoS attack detector with two-stage detection

config:ddos/detect needs:config-loaded YANG:1
Config
ddos/detect
Needs
config-loaded
YANG
1 module
DDoS

ddos-flowspec

DDoS FlowSpec/RTBH responder: upstream mitigation with leak-probe clear

config:ddos/flowspec YANG:1
Config
ddos/flowspec
YANG
1 module
DDoS

ddos-flowtriq

DDoS incident reporter for Flowtriq cloud API

config:ddos/flowtriq YANG:1
Config
ddos/flowtriq
YANG
1 module
DDoS

ddos-local

DDoS local responder: on-host nft drop on attack detection

config:ddos/local needs:firewall YANG:1
Config
ddos/local
Needs
firewall
YANG
1 module
DDoS

ddos-observe

DDoS observability: incident store and show ddos status/incidents CLI

config:ddos/observe YANG:1
Config
ddos/observe
YANG
1 module

Environment

1 plugin

Generated group for registry entries mapped to the Environment area. Config roots: environment. Source area: internal/plugins/ntp.

Environment

ntp

NTP client: system clock synchronization

config:environment YANG:2
Config
environment
YANG
2 modules

Exabgp

1 plugin

Generated group for registry entries mapped to the Exabgp area. Config roots: exabgp. Source area: internal/plugins/exabgp.

Exabgp

exabgp-bridge

In-process ExaBGP compatibility bridge: runs an operator ExaBGP-format script as a subprocess and translates to/from ze events (RFC-agnostic transport shim)

config:exabgp YANG:1
Config
exabgp
YANG
1 module

FIB

3 plugins

Generated group for registry entries mapped to the FIB area. Config roots: fib. Source area: internal/plugins/fib.

FIB

fib-kernel

FIB kernel: programs OS routes from system RIB via netlink/route socket

config:fib/kernel needs:rib needs:sysctl YANG:1
Config
fib/kernel
Needs
rib, sysctl
YANG
1 module
FIB

fib-p4

FIB P4: programs P4 switch forwarding entries from system RIB via gRPC/P4Runtime

config:fib/p4 needs:rib YANG:1
Config
fib/p4
Needs
rib
YANG
1 module
FIB

fib-vpp

FIB VPP: programs VPP FIB entries from system RIB via GoVPP binary API

config:fib/vpp needs:rib needs:vpp YANG:1
Config
fib/vpp
Needs
rib, vpp
YANG
1 module

Firewall

2 plugins

Generated group for registry entries mapped to the Firewall area. Config roots: firewall. Source area: internal/component/firewall.

Firewall

firewall

Packet filter and NAT rules (nftables on Linux)

config:firewall YANG:2
Config
firewall
YANG
2 modules
Firewall

firewall-irr

IRR-based prefix-list filtering for firewall rules

config:firewall needs:firewall YANG:2
Config
firewall
Needs
firewall
YANG
2 modules

Flow Export

1 plugin

Generated group for registry entries mapped to the Flow Export area. Config roots: flow-export. Source area: internal/plugins/flowexport.

Flow Export

flow-export-conntrack-tracking

sFlow, NetFlow v9, and IPFIX counter export

config:flow-export needs:config-loaded YANG:1
Config
flow-export
Needs
config-loaded
YANG
1 module

Flowspec Firewall

1 plugin

Generated group for registry entries mapped to the Flowspec Firewall area. Source area: internal/plugins/flowspec-firewall.

Flowspec Firewall

flowspec-firewall

Translates BGP FlowSpec routes into nftables firewall rules

needs:firewall
Needs
firewall

IS-IS

1 plugin

Generated group for registry entries mapped to the IS-IS area. Config roots: isis. Source area: internal/plugins/isis.

IS-IS

isis

Intermediate System to Intermediate System (ISO/IEC 10589, RFC 1195): native link-state IGP

config:isis needs:fib-kernel needs:sysctl YANG:2
Config
isis
Needs
fib-kernel, sysctl
YANG
2 modules

Interface

4 plugins

Generated group for registry entries mapped to the Interface area. Config roots: interface. Source area: internal/component/iface, internal/plugins/iface, internal/plugins/vrrp.

Interface

iface-dhcp

DHCP client: DHCPv4/DHCPv6 lease acquisition and renewal

needs:interface
Needs
interface
Interface

iface-ra

Router Advertisement sender: advertises IPv6 prefixes, flags, and resolvers on a LAN (RFC 4861)

needs:interface
Needs
interface
Interface

interface

OS network interface monitoring and management

config:interface needs:sysctl YANG:6
Config
interface
Needs
sysctl
YANG
6 modules
Interface

vrrp

Virtual Router Redundancy Protocol (RFC 9568 / RFC 3768): first-hop gateway redundancy

config:interface needs:interface YANG:2
Config
interface
Needs
interface
YANG
2 modules

Kernel

1 plugin

Generated group for registry entries mapped to the Kernel area. Config roots: kernel. Source area: internal/plugins/kernel.

Kernel

kernel

Kernel routes: redistribute externally-installed kernel routes into BGP

config:kernel YANG:1
Config
kernel
YANG
1 module

L2TP

4 plugins

Generated group for registry entries mapped to the L2TP area. Config roots: l2tp. Source area: internal/component/l2tp.

L2TP

l2tp-auth-local

Static local user list for L2TP PPP authentication

config:l2tp YANG:1
Config
l2tp
YANG
1 module
L2TP

l2tp-auth-radius-servers

RADIUS authentication and accounting for L2TP PPP sessions

config:l2tp needs:radius-server YANG:1
Config
l2tp
Needs
radius-server
YANG
1 module
L2TP

l2tp-pool

IPv4 address and IPv6 prefix pool for L2TP PPP sessions

config:l2tp YANG:1
Config
l2tp
YANG
1 module
L2TP

l2tp-shaper

Traffic shaping for L2TP subscriber sessions

config:l2tp YANG:1
Config
l2tp
YANG
1 module

LDP

1 plugin

Generated group for registry entries mapped to the LDP area. Config roots: ldp. Source area: internal/plugins/ldp.

LDP

ldp-port

Label Distribution Protocol (RFC 5036): MPLS label distribution

config:ldp needs:fib-kernel YANG:2
Config
ldp
Needs
fib-kernel
YANG
2 modules

MRT

1 plugin

Generated group for registry entries mapped to the MRT area. Config roots: mrt. Source area: internal/plugins/mrt.

MRT

mrt

MRT routing information export (RFC 6396)

config:mrt YANG:1
Config
mrt
YANG
1 module

OSPF

1 plugin

Generated group for registry entries mapped to the OSPF area. Config roots: ospf. Source area: internal/plugins/ospf.

OSPF

ospf

Open Shortest Path First v2 (RFC 2328): native link-state IPv4 IGP

config:ospf needs:interface needs:fib-kernel needs:sysctl YANG:2
Config
ospf
Needs
interface, fib-kernel, sysctl
YANG
2 modules

Policy

1 plugin

Generated group for registry entries mapped to the Policy area. Config roots: policy. Source area: internal/plugins/policyroute.

Policy

policy-routes

Policy-based routing: nftables packet marking and ip rule table selection

config:policy needs:firewall YANG:2
Config
policy
Needs
firewall
YANG
2 modules

RIB

1 plugin

Generated group for registry entries mapped to the RIB area. Config roots: rib. Source area: internal/component/sysrib.

RIB

rib

System RIB: selects best route across protocols by admin distance

config:rib YANG:1
Config
rib
YANG
1 module

RSVP TE

1 plugin

Generated group for registry entries mapped to the RSVP TE area. Config roots: rsvp-te. Source area: internal/plugins/rsvpte.

RSVP TE

rsvp-te-rawsock

RSVP-TE: Resource Reservation Protocol - Traffic Engineering (RFC 3209)

config:rsvp-te needs:fib-kernel YANG:2
Config
rsvp-te
Needs
fib-kernel
YANG
2 modules

Routing Table

1 plugin

Generated group for registry entries mapped to the Routing Table area. Config roots: routing-table. Source area: internal/plugins/routingtable.

Routing Table

routing-table

Named routing table registry: maps names to kernel table IDs

config:routing-table YANG:1
Config
routing-table
YANG
1 module

Service

5 plugins

Generated group for registry entries mapped to the Service area. Config roots: service. Source area: internal/plugins/as112, internal/plugins/dhcpserver, internal/plugins/geodns.

Service

as112

AS112 anycast DNS node: authoritative sink for misdirected RFC 1918 / link-local reverse-DNS queries (RFC 7534, RFC 7535)

config:service YANG:2
Config
service
YANG
2 modules
Service

dhcpserver

DHCP server: address assignment for LAN clients (RFC 2131)

config:service YANG:1
Config
service
YANG
1 module
Service

geodns

GeoDNS server: DNS answers selected by client source IP (RFC 1035, RFC 7871 client-subnet)

config:service YANG:2
Config
service
YANG
2 modules
Service

imageserver

Image server: HTTP provisioning for disk images and boot files

config:service YANG:1
Config
service
YANG
1 module
Service

tftpserver

TFTP server: read-only file serving for PXE boot (RFC 1350, RFC 2347 option negotiation)

config:service YANG:1
Config
service
YANG
1 module

Static

1 plugin

Generated group for registry entries mapped to the Static area. Config roots: static. Source area: internal/plugins/static.

Static

static

Static routes: config-driven kernel/VPP route programming with ECMP

config:static needs:routing-table optional:interface YANG:2
Config
static
Needs
routing-table
Optional
interface
YANG
2 modules

Sysctl

1 plugin

Generated group for registry entries mapped to the Sysctl area. Config roots: sysctl. Source area: internal/component/sysctl.

Sysctl

sysctl

Kernel tunable management: three-layer precedence, restore on stop

config:sysctl YANG:1
Config
sysctl
YANG
1 module

Traffic

2 plugins

Generated group for registry entries mapped to the Traffic area. Config roots: traffic. Source area: internal/component/traffic, internal/plugins/trafficusage.

Traffic

traffic

Traffic control (tc) qdisc, class, and filter management

config:traffic/control optional:vpp YANG:1
Config
traffic/control
Optional
vpp
YANG
1 module
Traffic

traffic-usage

eBPF TCX per-port and per-IP byte accounting

config:traffic/usage needs:interface YANG:2
Config
traffic/usage
Needs
interface
YANG
2 modules

VPN

1 plugin

Generated group for registry entries mapped to the VPN area. Config roots: pki, vpn. Source area: internal/component/ike.

VPN

ipsec-xfrm

IKEv2 engine for native IPsec VPN

config:vpn config:pki needs:config-loaded
Config
vpn, pki
Needs
config-loaded

VPP

1 plugin

Generated group for registry entries mapped to the VPP area. Config roots: vpp. Source area: internal/component/vpp.

VPP

vpp

VPP data plane lifecycle management

config:vpp YANG:1
Config
vpp
YANG
1 module

Test Harness

6 plugins

Generated group for registry entries mapped to the Test Harness area. Config roots: ddos. Source area: internal/test/plugins.

Test Harness

ddos-fake

Test-only synthetic DDoS attack injector for the ddos-local withdraw test (harmless unless `ddos { fake { enabled true; } }` is configured)

config:ddos/fake needs:firewall YANG:1
Config
ddos/fake
Needs
firewall
YANG
1 module
Test Harness

fakeas112

Test-only synthetic AS112 route producer (use ze.fakeas112; harmless when not invoked)

YANG:2
YANG
2 modules
Test Harness

fakeenrich

Test-only in-process enricher (harmless when not invoked)

no config
Config
None
Test Harness

fakefib

Test-only sysrib event emitter for FIB functional tests (use ze.fakefib)

no config
Config
None
Test Harness

fakel2tp

Test-only synthetic L2TP route producer (use ze.fakel2tp; harmless when not invoked)

YANG:2
YANG
2 modules
Test Harness

fakeredist

Test-only synthetic route producer (use ze.fakeredist; harmless when not invoked)

YANG:2
YANG
2 modules