ipng/govpp-snmp-agentx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add manpage

Browse Source
This commit is contained in:
Pim van Pelt
2025-06-17 00:27:35 +02:00
parent 82db92f344
commit 0b4ff36130
2 changed files with 73 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
docs/govpp-snmp-agentx.1 Normal file
View File

@ -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