[DRAFT] docs: SONiC SNMP NMS compliance reference — Entity MIB, Sensor MIB, Interface MIB, Traps & pytest blueprint#375
Closed
thongal-upscale wants to merge 5 commits into
Closed
Conversation
Add upscaleai/compliance.md on branch thongal_nms_snmp1. The document covers: - Full SONiC system architecture block diagram (Mermaid, colored) highlighting docker-snmp and mgmt-framework containers - SNMP two-layer AgentX architecture deep dive - SNMP operations primer with sequence diagrams (GET/GETNEXT/GETBULK/Trap/AgentX) - Interface MIB (RFC 1213 / RFC 2863) compliance analysis with per-OID status - Entity MIB (RFC 2737) compliance analysis including physical tree diagram and 9-digit OID encoding scheme - Entity Sensor MIB (RFC 3433) full pipeline diagram and sensor type/scale/ precision reference table - Alarms and Traps gap analysis - Prioritized compliance gap summary (P0–P3) - External pytest testing blueprint with runnable test modules for all MIBs, xfail markers for known gaps, and CI integration guidance Intended audience: medium-to-advanced NMS/test engineers validating SONiC SNMP compliance and writing external pytest scripts against live devices. Co-authored-by: Cursor <cursoragent@cursor.com>
Move compliance.md to repo root for discoverability. Covers Entity MIB, Sensor MIB, Interface MIB, Traps/Alarms, SONiC architecture diagrams, gap analysis, and pytest blueprint. Co-authored-by: Cursor <cursoragent@cursor.com>
|
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Collaborator
|
/azp run |
3 similar comments
Collaborator
|
/azp run |
Collaborator
|
/azp run |
Collaborator
|
/azp run |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds
compliance.md— a comprehensive SNMP compliance reference document for SONiC, targeted at NMS/test engineers who need to understand what is implemented, what is missing, and how to write external pytest validation scripts against live devices.What's in the document
docker-snmpandmgmt-frameworkhighlighted as primary NMS-facing containerssonic_ax_implPython subagent + FRR subagent), MIB tree overviewifLastChange=0,ifLinkUpDownTrapEnable=2)entLogicalTable)entConfigChangemissing), prioritized gap listconftest.py,SnmpClientutility, and test modules for all MIBs withxfailmarkers for known gapsTest plan
pytest tests/ --snmp-host <DUT_IP> --community public -vxfailtests are correctly skipped/markedsonic_ax_implsourceNotes
thongal_nms_snmp1sonic-snmpagentcommit329f1ccaandsonic-buildimagemainMade with Cursor