Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Protocol reference

This chapter is generated from the protocol definition IR of wpg-protocols (the catalog served at GET /api/protocols), so it always matches the code: 183 protocols. Each page lists the fields in wire order with their type, default, Auto rule and description, the lower layers that lead to the protocol, the next-layer table, the constraints checked after building and the bundled sample templates. The hand-written protocol notes explain how the protocols are reached, which fields you set by hand and the approximations that remain. After changing a definition, regenerate with just docs-gen.

IDNameFieldsNext layer byNotes
ethernet2Ethernet II3ethertypeEncapsulation and tunnels, L2 control protocols, SRv6 SRH / SR-MPLS (P2), User-defined protocols (protocols.d)
dot1q802.1Q VLAN4ethertypeUser-defined protocols (protocols.d)
dot1ad802.1ad S-VLAN4ethertype
dot3IEEE 802.33lengthL2 control protocols
llcIEEE 802.2 LLC3dsapL2 control protocols, OSI encapsulation (P2)
snapSNAP2pidL2 control protocols
arpARP9
lldpLLDP1L2 control protocols
cdpCDP4L2 control protocols
stpSTP BPDU15L2 control protocols
lacpLACP27L2 control protocols, PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
markerMarker Protocol11L2 control protocols, PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
eapolEAPOL4L2 control protocols
pppoe_discoveryPPPoE Discovery6L2 control protocols
pppoe_sessionPPPoE Session5session_idL2 control protocols
pppPPP1protocolL2 control protocols, OSI encapsulation (P2)
ppp_lcpPPP LCP4L2 control protocols
ppp_ipcpPPP IPCP4L2 control protocols
vxlanVXLAN4flagsEncapsulation and tunnels
mplsMPLS4sEncapsulation and tunnels, SRv6 SRH / SR-MPLS (P2)
geneveGeneve9protocol_typeEncapsulation and tunnels
macsecMACsec13MACsec / GTPv2-C / Diameter / SIP / RTP (P2)
esmcESMC8PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfmCFM6opcodePTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_ccmCFM CCM16PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_lbmCFM LBM7PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_lbrCFM LBR7PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_ltmCFM LTM11PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_ltrCFM LTR12PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_aisY.1731 AIS7PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_lckY.1731 LCK7PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_tstY.1731 TST7PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_rapsERPS R-APS14PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_lmmY.1731 LMM9PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_lmrY.1731 LMR9PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_1dmY.1731 1DM10PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_dmmY.1731 DMM14PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_dmrY.1731 DMR14PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_csfY.1731 CSF8PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_slmY.1731 SLM11PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_slrY.1731 SLR11PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
cfm_1slY.1731 1SL11PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
efm_oam802.3ah OAM4codePTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
efm_oam_information802.3ah OAM Information4PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
efm_oam_event_notification802.3ah OAM Event Notification5PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
efm_oam_variable_request802.3ah OAM Variable Request4PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
efm_oam_variable_response802.3ah OAM Variable Response4PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
efm_oam_loopback_control802.3ah OAM Loopback Control4PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
efm_oam_organization_specific802.3ah OAM Organization Specific5PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)

L3 (network)

IDNameFieldsNext layer byNotes
ipv4IPv415protocolEncapsulation and tunnels, IS-IS (P2), MACsec / GTPv2-C / Diameter / SIP / RTP (P2), LDP / RSVP-TE / BFD (P2), Multicast control protocols, User-defined protocols (protocols.d)
ipv6IPv69next_headerEncapsulation and tunnels, IS-IS (P2), MACsec / GTPv2-C / Diameter / SIP / RTP (P2), User-defined protocols (protocols.d)
ipv6_hopoptsIPv6 Hop-by-Hop Options4next_headerMulticast control protocols
ipv6_routeIPv6 Routing6next_headerSRv6 SRH / SR-MPLS (P2)
ipv6_srhIPv6 Segment Routing Header10next_headerSRv6 SRH / SR-MPLS (P2)
ipv6_fragIPv6 Fragment6next_header
ipv6_dstoptsIPv6 Destination Options4next_header
icmpv4ICMPv44
icmpv6ICMPv63typeMulticast control protocols
icmpv6_echoICMPv6 Echo2
ndp_rsNDP Router Solicitation2
ndp_raNDP Router Advertisement8
ndp_nsNDP Neighbor Solicitation3
ndp_naNDP Neighbor Advertisement6
ndp_redirectNDP Redirect4
greGRE2protocol_typeEncapsulation and tunnels
nvgreNVGRE4protocol_typeEncapsulation and tunnels
ospfv2OSPFv28typeRouting protocols
ospfv2_helloOSPFv2 Hello8
ospfv2_dbdOSPFv2 DBD5
ospfv2_lsrOSPFv2 LSR1
ospfv2_lsuOSPFv2 LSU1num_lsasRouting protocols
ospfv2_lsackOSPFv2 LSAck1
ospfv2_lsaOSPFv2 LSA8ls_typeOSPF Opaque / SR, BGP MP / VPN / EVPN (P2)
ospfv2_router_lsaOSPFv2 Router-LSA4
ospfv2_network_lsaOSPFv2 Network-LSA2
ospfv2_summary_lsaOSPFv2 Summary-LSA3
ospfv2_external_lsaOSPFv2 AS-External-LSA6
ospfv2_opaque_lsaOSPFv2 Opaque LSA9opaque_typeOSPF Opaque / SR, BGP MP / VPN / EVPN (P2)
ospfv2_te_lsaOSPFv2 TE LSA1OSPF Opaque / SR, BGP MP / VPN / EVPN (P2)
ospfv2_ri_lsaOSPFv2 Router Information LSA1OSPF Opaque / SR, BGP MP / VPN / EVPN (P2)
ospfv2_ext_prefix_lsaOSPFv2 Extended Prefix LSA1OSPF Opaque / SR, BGP MP / VPN / EVPN (P2)
ospfv2_ext_link_lsaOSPFv2 Extended Link LSA1OSPF Opaque / SR, BGP MP / VPN / EVPN (P2)
ospfv3OSPFv38typeRouting protocols
ospfv3_helloOSPFv3 Hello8
ospfv3_dbdOSPFv3 DBD7
ospfv3_lsrOSPFv3 LSR1
ospfv3_lsuOSPFv3 LSU1num_lsasRouting protocols
ospfv3_lsackOSPFv3 LSAck1
ospfv3_lsaOSPFv3 LSA7ls_type
ospfv3_router_lsaOSPFv3 Router-LSA3
ospfv3_network_lsaOSPFv3 Network-LSA3
ospfv3_inter_area_prefix_lsaOSPFv3 Inter-Area-Prefix-LSA6
ospfv3_as_external_lsaOSPFv3 AS-External-LSA6
ospfv3_link_lsaOSPFv3 Link-LSA5
ospfv3_intra_area_prefix_lsaOSPFv3 Intra-Area-Prefix-LSA5
eigrpEIGRP9Routing protocols
vrrpv2VRRPv210Redundancy protocols (FHRP)
vrrpv3VRRPv39versionRedundancy protocols (FHRP)
vrrpv3_ipv6VRRPv3 (IPv6)9Redundancy protocols (FHRP)
igmpIGMP3typeMulticast control protocols
igmpv2IGMPv1/v21Multicast control protocols
igmpv3_queryIGMPv3 Query7Multicast control protocols
igmpv3_reportIGMPv3 Report3Multicast control protocols
mldMLDv13Multicast control protocols
mldv2_queryMLDv2 Query9Multicast control protocols
mldv2_reportMLDv2 Report3Multicast control protocols
pimPIM4typeMulticast control protocols
pim_helloPIM Hello1Multicast control protocols
pim_join_prunePIM Join/Prune7Multicast control protocols
pim_registerPIM Register7typeMulticast control protocols
osiOSI network PDU2CLNP / ES-IS (P2), OSI encapsulation (P2)
clnpCLNP14CLNP / ES-IS (P2), IS-IS (P2), OSI encapsulation (P2)
esisES-IS9pdu_typeCLNP / ES-IS (P2)
esis_eshES-IS ESH11CLNP / ES-IS (P2)
esis_ishES-IS ISH10CLNP / ES-IS (P2), OSI encapsulation (P2)
esis_rdES-IS Redirect13CLNP / ES-IS (P2)
isisIS-IS10pdu_typeIS-IS (P2)
isis_l1_lan_helloIS-IS L1 LAN Hello18IS-IS (P2), OSI encapsulation (P2)
isis_l2_lan_helloIS-IS L2 LAN Hello18IS-IS (P2)
isis_p2p_helloIS-IS P2P Hello16IS-IS (P2)
isis_l1_lspIS-IS L1 LSP19IS-IS (P2)
isis_l2_lspIS-IS L2 LSP19IS-IS (P2)
isis_l1_csnpIS-IS L1 CSNP14IS-IS (P2)
isis_l2_csnpIS-IS L2 CSNP14IS-IS (P2)
isis_l1_psnpIS-IS L1 PSNP12IS-IS (P2)
isis_l2_psnpIS-IS L2 PSNP12IS-IS (P2)

L4 (transport)

Application and control

IDNameFieldsNext layer byNotes
bgpBGP3typeRouting protocols
bgp_openBGP OPEN6
bgp_updateBGP UPDATE5
bgp_notificationBGP NOTIFICATION3
bgp_route_refreshBGP ROUTE-REFRESH3
ripRIP4Routing protocols
ripngRIPng4Routing protocols
hsrpHSRPv110versionRedundancy protocols (FHRP)
hsrpv2HSRPv21Redundancy protocols (FHRP)
glbpGLBP6Redundancy protocols (FHRP)
dhcpv4DHCPv417Application protocols
dhcpv6DHCPv63msg_typeApplication protocols
dhcpv6_relayDHCPv6 Relay5Application protocols
dnsDNS16Application protocols
ntpNTP14Application protocols
snmpSNMP8versionApplication protocols
snmp_pduSNMP PDU3pdu_typeApplication protocols
snmp_trapSNMPv1 Trap3Application protocols
syslogSyslog1Application protocols
radiusRADIUS5Application protocols
tftpTFTP4opcodeApplication protocols
tftp_dataTFTP DATA3Application protocols
tftp_ackTFTP ACK2Application protocols
tftp_errorTFTP ERROR3Application protocols
tftp_oackTFTP OACK2Application protocols
ldpLDP5LDP / RSVP-TE / BFD (P2)
bfdBFD17LDP / RSVP-TE / BFD (P2)
gtpv2GTPv2-C12pMACsec / GTPv2-C / Diameter / SIP / RTP (P2)
diameterDiameter12MACsec / GTPv2-C / Diameter / SIP / RTP (P2)
sipSIP3MACsec / GTPv2-C / Diameter / SIP / RTP (P2)
rtpRTP11MACsec / GTPv2-C / Diameter / SIP / RTP (P2)
rtcpRTCP6packet_typeMACsec / GTPv2-C / Diameter / SIP / RTP (P2)
rtcp_srRTCP SR13versionMACsec / GTPv2-C / Diameter / SIP / RTP (P2)
rtcp_rrRTCP RR8versionMACsec / GTPv2-C / Diameter / SIP / RTP (P2)
rtcp_sdesRTCP SDES6versionMACsec / GTPv2-C / Diameter / SIP / RTP (P2)
rtcp_byeRTCP BYE7versionMACsec / GTPv2-C / Diameter / SIP / RTP (P2)
rtcp_appRTCP APP8versionMACsec / GTPv2-C / Diameter / SIP / RTP (P2)
ptpPTP16message_typePTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
ptp_syncPTP Sync18PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
ptp_delay_reqPTP Delay_Req18PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
ptp_pdelay_reqPTP Pdelay_Req19PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
ptp_pdelay_respPTP Pdelay_Resp20PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
ptp_follow_upPTP Follow_Up18PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
ptp_delay_respPTP Delay_Resp20PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
ptp_pdelay_resp_follow_upPTP Pdelay_Resp_Follow_Up20PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
ptp_announcePTP Announce28PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
ptp_signalingPTP Signaling18PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)
ptp_managementPTP Management23PTP / ESMC / CFM / R-APS / 802.3ah OAM (P2)

Payload