bvandeusenandClaude Opus 5.5
9ca2e38fa1
The operator, reviewing SNMP on #5214: "this system looks incomplete like there's something missing from it". The one device shown was plugin.yaml's example (core-switch 192.168.1.1, community public), polled every minute; devices could only be defined by editing YAML in the image; a failed poll was logged at DEBUG and stored nowhere, so the page said "waiting for the next poll" forever; v3 ran as v2c; counters showed as lifetime totals. - Devices are rows (snmp_devices, migration snmp_001): address, port, v1/v2c community or a v3 user with auth/priv protocols and keys (secrets encrypted), presets plus custom readings, an optional host binding, and the newest poll's outcome. The YAML device list and its example are gone. - The SNMP page adds, edits and deletes them (admin, audited, with get_audit_entities so the audit log names and links a device). Readings come from presets (system uptime, interface traffic by number, UPS-MIB, Linux net-snmp) and custom "OID name [unit]" lines. - One GET per device with every OID, devices polled at once. The outcome is written to the row in words ("No reply from … within 5 s. Check the address and port, that SNMP is on, and the community"), with readings it lacks. v1's whole-request error drops that OID and asks again. SNMPv3 signs in with USM (MD5/SHA-1/SHA-2, DES/3DES/AES). - Test asks the unsaved form's device for its name, description, uptime and interfaces by number. It is an admin's explicit action; every page reads only stored rows (System 178's ruling). - Each reading has a unit; a counter is stored as a per-second rate (bytes as bit/s), a reset or wrap skipped. The page, widget and host panel say values in units and why a device is silent; the device page draws a chart per reading on a dated axis. Tests: readings and presets, the form and its secrets, v3 checks, rates, the poller against a stand-in pysnmp (one GET, v1 retry, timeout wording, USM), the pages, and an integration test of the poll writing outcomes and rates on Postgres. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
43 lines
2.3 KiB
Python
43 lines
2.3 KiB
Python
# plugins/snmp/models.py
|
|
from __future__ import annotations
|
|
|
|
from datetime import datetime, timezone
|
|
|
|
from sqlalchemy import JSON, DateTime, Integer, String, Text
|
|
from sqlalchemy.orm import Mapped, mapped_column
|
|
|
|
from steward.core.ids import time_ordered_id
|
|
from steward.models.base import Base
|
|
|
|
|
|
class SnmpDevice(Base):
|
|
"""A device Steward polls over SNMP, edited on the SNMP page.
|
|
|
|
Secrets (the community, the v3 keys) are stored encrypted. The last_*
|
|
columns are the newest poll's outcome, written by the poller, so a page
|
|
can say why a device isn't answering without asking the device itself.
|
|
"""
|
|
__tablename__ = "snmp_devices"
|
|
|
|
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=time_ordered_id)
|
|
name: Mapped[str] = mapped_column(String(100), nullable=False, unique=True)
|
|
address: Mapped[str] = mapped_column(String(255), nullable=False)
|
|
port: Mapped[int] = mapped_column(Integer, nullable=False, default=161)
|
|
version: Mapped[str] = mapped_column(String(3), nullable=False, default="2c")
|
|
community: Mapped[str] = mapped_column(Text, nullable=False, default="")
|
|
v3_user: Mapped[str] = mapped_column(String(100), nullable=False, default="")
|
|
v3_auth: Mapped[str] = mapped_column(String(16), nullable=False, default="none")
|
|
v3_auth_key: Mapped[str] = mapped_column(Text, nullable=False, default="")
|
|
v3_priv: Mapped[str] = mapped_column(String(16), nullable=False, default="none")
|
|
v3_priv_key: Mapped[str] = mapped_column(Text, nullable=False, default="")
|
|
presets: Mapped[list] = mapped_column(JSON, nullable=False, default=list)
|
|
interfaces: Mapped[str] = mapped_column(String(255), nullable=False, default="")
|
|
custom: Mapped[str] = mapped_column(Text, nullable=False, default="")
|
|
host_id: Mapped[str | None] = mapped_column(String(36), nullable=True)
|
|
created_at: Mapped[datetime] = mapped_column(
|
|
DateTime(timezone=True), nullable=False, default=lambda: datetime.now(timezone.utc))
|
|
last_polled_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
|
|
last_ok_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
|
|
last_error: Mapped[str | None] = mapped_column(Text, nullable=True)
|
|
missing: Mapped[list] = mapped_column(JSON, nullable=False, default=list)
|