Samples

Warning

Many of the examples were written a few years ago by the previous maintainers of PySNMP. They might still be valid and useful, but they might also be outdated and not reflect the best practices.

The most reliable resources to see the API in action are the unit test cases under the tests folder in the PySNMP GitHub repository.

If you find any issues with the examples, please report them to the current PySNMP maintainers.

Visit Support Options for more information.

SNMP is not simple (PySNMP implementation takes over 15K lines of Python code), but PySNMP tries to hide the complexities and let you carry out typical SNMP operations in a quick and intuitive way.

PySNMP offers three groups of programming interfaces to deal with SNMP protocol. In the order from most concise to most detailed those APIs follow.

High-Level API

The so-called high-level API (hlapi) is designed to be simple, concise and suitable for the most frequent operations. For that matter only Command Generator and Notification Originator Applications are currently wrapped into a nearly one-line Python expression.

It used to come in many flavours: one synchronous and a bunch of bindings to popular asynchronous I/O frameworks. Those varieties of APIs bring subtile differences, mostly to better match particular I/O framework customs. But now only asyncio based API is supported.

• Asynchronous: asyncio
  • Various SNMP versions
  • Walking operations
  • Advanced Command Generator
  • Common notifications
  • Advanced Notification Originator

Unless you have a very specific task, the high-level API might solve your SNMP needs.

Note

It is recommended that you move away from other APIs such as asyncore based ones, as they are not maintained and will be removed in future.

Native SNMP API

Complete implementation of all official Standard SNMP Applications. It should let you implement any SNMP operation defined in the standard at the cost of working at a somewhat low level.

This API also used to come in several transport varieties depending on I/O framework being used. But now only asyncio based API is supported.

• Asynchronous: asyncio
  • Command Responder Applications
  • Notification Receiver Applications

Note

It is recommended that you move away from other APIs such as asyncore based ones, as they are not maintained and will be removed in future.

Packet Level SNMP

In cases where performance is your top priority and you only need to work with SNMP v1 and v2c systems and you do not mind writing much more code, then there is a low-level API to SNMP v1/v2c PDU and PySNMP I/O engine. There’s practically no SNMP engine or SMI infrastructure involved in the operations of these almost wire-level interfaces. Although MIB services can still be used separately.

A packet-level API-based application typically manages both SNMP message building/parsing and network communication via one or more transports. It’s fully up to the application to handle failures on message and transport levels.

Command Generator

If you are developing an SNMP manager application, you will most likely want to study the following examples and learn how to send out SNMP requests.

• Fetching variables
  • Fetch scalar MIB variables (SNMPv1)
• Modifying variables
  • SET string and integer scalars (SNMPv2c)
• MIB walking operations
  • Walk Agent MIB (SNMPv1)
  • Bulk walk Agent MIB (SNMPv2c)
• Transport tweaks
  • Broadcast SNMP message (IPv4)

Command Responder

If you are developing an SNMP agent application, you will most likely want to study the following examples and learn how to respond to SNMP requests.

• Agent-side MIB implementations
  • Implementing scalar MIB objects

Notification Originator

These examples demonstrate how to send SNMP notifications, usually from an SNMP agent application.

• Transport tweaks
  • TRAP over multiple transports
  • INFORM over multiple transports

Notification Receiver

These examples demonstrate how to receive SNMP notifications, usually in an SNMP manager application.

• Transport tweaks
  • Listen for notifications at IPv4 & IPv6 interfaces

Low Level MIB Access

Accessing MIB objects is a common task in SNMP applications, so the following examples demonstrate how to do that.

• Manager side
  • PDU var-binds to MIB objects
  • MIB objects to PDU var-binds
  • SNMP MIB browser
• Agent side
  • Implementing MIB objects
  • Agent operations on MIB

Using these examples

Note

It is difficult to cover all examples on this site, so you might want to visit the examples folder in PySNMP GitHub repository.

Before using the sample code, make sure pysnmp and its dependencies are installed. You might refer to Quick Start for details.

Many sample scripts use the public, multilingual SNMP Command Responder and Notification Receiver configured at demo.pysnmp.com, which enable you to run them in a cut&paste fashion.

If you wish to use your own SNMP Agent with these scripts, make sure to either configure your local snmpd and/or snmptrapd, or use a valid address and SNMP credentials of your SNMP Agent in the examples to let them work.

Should you want to use a MIB to make SNMP operations more human-friendly, you are welcome to search for it and possibly download one from our public MIB repository mibs.pysnmp.com. Alternatively, you can configure PySNMP to fetch and cache required MIBs from there automatically.

Related Resources

• Quick Start

• Troubleshooting

• API References