🔧 Installation

git clone https://github.com/snmpware/snmpy.git
cd snmpy
python3 setup.py install

pip install pycryptodome

🚀 Quick Start

SNMPv2c GET

from snmpy import SnmpClient, SnmpVersion
# Create SNMP client
client = SnmpClient(
 host="192.168.1.1",
 port=161,
 community="public",
 version=SnmpVersion.V2C
)
# Single GET
result = client.get("1.3.6.1.2.1.1.1.0") # sysDescr
print(result)
# Multiple GET
oids = ["1.3.6.1.2.1.1.1.0", "1.3.6.1.2.1.1.3.0"]
results = client.get_multiple(oids)
for oid, value in results.items():
 print(f"{oid} = {value}")

SNMPv3 GET

from snmpy import SnmpClient, SnmpVersion, SnmpV3User, SnmpV3AuthProtocol, SnmpV3PrivProtocol
# Create SNMPv3 user
v3_user = SnmpV3User(
 username="admin",
 auth_protocol=SnmpV3AuthProtocol.SHA,
 auth_password="authpass123",
 priv_protocol=SnmpV3PrivProtocol.AES128,
 priv_password="privpass456"
)
# Create SNMPv3 client
client = SnmpClient(
 host="192.168.1.1",
 port=161,
 version=SnmpVersion.V3,
 v3_user=v3_user
)
result = client.get("1.3.6.1.2.1.1.1.0")
print(result)

⚡ UPS Monitoring Example

from snmpy import UpsMonitor, SnmpVersion
# Monitor UPS v2c
ups = UpsMonitor(
 host="192.168.1.100",
 port=161,
 community="public",
 version=SnmpVersion.V2C
)
# Test connection
if ups.test_connection():
 print("✅ Connection OK")
# Detect UPS type
ups_type = ups.detect_ups_type() # "APC", "Eaton", "CyberPower", etc.
# Get information
info = ups.get_ups_info()
print(f"Load: {info['load']}%")
print(f"Battery: {info['battery_charge']}%")
print(f"Input voltage: {info['input_voltage']}V")
print(f"Output voltage: {info['output_voltage']}V")
print(f"Temperature: {info['temperature']}°C")
print(f"Runtime: {info['estimated_runtime']} minutes")
# Interpret status
status = ups.interpret_status(info['ups_status'])
print(f"Status: {status}") # "Normal", "Battery", etc.
# Continuous monitoring with display
ups.monitor(interval=5.0) # Update every 5 seconds
# SNMP Walk on UPS MIB
ups_data = ups.walk_mib("1.3.6.1.2.1.33") # Complete UPS-MIB

📤 SNMP Traps

from snmpy import SnmpTrapSender, SnmpVersion, SnmpOctetString, SnmpInteger
# Create sender
sender = SnmpTrapSender(
 trap_host="192.168.1.50",
 trap_port=162,
 community="public",
 version=SnmpVersion.V2C
)
# Standard traps
sender.send_cold_start()
sender.send_link_down(if_index=1, if_descr="eth0")
# Custom trap
sender.send_test_trap("System under maintenance")
# UPS trap
sender.send_ups_trap(
 'on_battery',
 battery_charge=75,
 runtime=45,
 load_percent=80,
 message="Power failure"
)

🔒 SNMPv3 Authentication & Privacy

🛠️ Utilities

from snmpy import decode_snmp_hex
# Decode hex dump (e.g. from Wireshark)
hex_packet = "302c020101040670..."
result = decode_snmp_hex(hex_packet, return_dict=True)
print(f"Version: {result['version']}")
print(f"Community: {result['community']}")
print(f"PDU Type: {result['pdu_type']}")
for vb in result['varbinds']:
 print(f" {vb['oid']} = {vb['value']}")

🧪 Testing & Stability

📦 CLI Tool

# Monitor UPS
python snmpy.py monitor --ip 192.168.1.100 --interval 5
# Test connection
python snmpy.py monitor --ip 192.168.1.100 --test
# SNMP Walk
python snmpy.py monitor --ip 192.168.1.100 --walk
# Send trap
python snmpy.py trap --host 192.168.1.50 --type coldstart
# UPS trap
python snmpy.py trap --host 192.168.1.50 --type ups-battery
# Interactive test (guided menu)
python snmpy.py

📚 More Examples

📈 Roadmap

🤝 Contributing

📄 License