diff --git a/debian/rules b/debian/rules index 40dd549..7849447 100755 --- a/debian/rules +++ b/debian/rules @@ -15,6 +15,7 @@ override_dh_auto_build: override_dh_auto_install: install -D -m 0755 govpp-snmp-agentx debian/govpp-snmp-agentx/usr/sbin/govpp-snmp-agentx install -D -m 0644 govpp-snmp-agentx.service debian/govpp-snmp-agentx/lib/systemd/system/govpp-snmp-agentx.service + install -D -m 0644 docs/govpp-snmp-agentx.1 debian/govpp-snmp-agentx/usr/share/man/man1/govpp-snmp-agentx.1 override_dh_auto_configure: # Skip auto configure diff --git a/docs/govpp-snmp-agentx.1 b/docs/govpp-snmp-agentx.1 new file mode 100644 index 0000000..27af20e --- /dev/null +++ b/docs/govpp-snmp-agentx.1 @@ -0,0 +1,72 @@ +.TH GOVPP-SNMP-AGENTX 1 "June 2025" "version 1.0.0" "User Commands" +.SH NAME +govpp-snmp-agentx \- VPP SNMP AgentX daemon for interface statistics +.SH SYNOPSIS +.B govpp-snmp-agentx +[\fIOPTION\fR]... +.SH DESCRIPTION +.B govpp-snmp-agentx +is an SNMP AgentX subagent that provides SNMP access to VPP (Vector Packet Processing) interface statistics and information. It connects to a master SNMP daemon via the AgentX protocol and populates standard IF-MIB tables with real-time VPP interface data. +.PP +The daemon implements two MIB tables: +.TP +.B ifEntry +Classic interface table (1.3.6.1.2.1.2.2.1) with basic interface statistics including counters for packets, bytes, errors, and discards. +.TP +.B ifXTable +Extended interface table (1.3.6.1.2.1.31.1.1.1) with high-capacity 64-bit counters and additional interface information. +.SH OPTIONS +.TP +.BR \-agentx.addr " " \fIADDRESS\fR +AgentX master agent address. Can be a TCP address (hostname:port) or Unix socket path. +Default: localhost:705 +.TP +.BR \-debug +Enable debug logging to show detailed operational information. +.TP +.BR \-vppcfg " " \fIFILE\fR +VPP configuration YAML file to read interface descriptions from. +.TP +.BR \-vppstats.api.addr " " \fIPATH\fR +VPP API socket path for interface enumeration. +Default: /var/run/vpp/api.sock +.TP +.BR \-vppstats.stats.addr " " \fIPATH\fR +VPP statistics socket path for interface counters. +Default: /var/run/vpp/stats.sock +.TP +.BR \-vppstats.ifindex-offset " " \fINUMBER\fR +Offset added to VPP interface indices for SNMP interface numbering. +Default: 1000 +.TP +.BR \-vppstats.period " " \fISECONDS\fR +Interval in seconds for querying VPP interface statistics. +Default: 10 +.SH EXAMPLES +.TP +Connect to AgentX master via TCP: +.B govpp-snmp-agentx -agentx.addr snmp.example.com:705 +.TP +Connect via Unix socket with debug logging: +.B govpp-snmp-agentx -agentx.addr /var/agentx/master -debug +.TP +Use custom VPP sockets and config: +.B govpp-snmp-agentx -vppstats.api.addr /opt/vpp/api.sock -vppcfg /etc/vpp/vppcfg.yaml +.SH FILES +.TP +.I /var/run/vpp/api.sock +Default VPP API socket +.TP +.I /var/run/vpp/stats.sock +Default VPP statistics socket +.TP +.I /var/agentx/master +Common AgentX Unix socket path +.SH SEE ALSO +.BR snmpd (8), +.BR snmpwalk (1), +.BR vpp (8) +.SH AUTHOR +Pim van Pelt <pim@ipng.ch> +.SH COPYRIGHT +Copyright 2025, IPng Networks GmbH \ No newline at end of file