Package: easysnmp
Artwork courtesy ofOpen Clip Art
LibraryIntroductionEasy SNMP is a fork ofNet-SNMP Python
Bindingsthat attempts to bring a more Pythonic interface to the library. Check
out theNet-SNMP websitefor more
information about SNMP.This module provides a full-featured SNMP client API and supports all
dialects of the SNMP protocol.Why Another Library?Theoriginal Net-SNMP Python
libraryis a great starting point but is quite un-Pythonic and lacks proper unit tests and documentation.PySNMPis entirely written in Python
and therefore has a huge performance hit. In some brief tests, I
estimate that both the Net-SNMP Python bindings and Easy SNMP are more than 4 times faster than PySNMP. Further to this, PySNMP has an even less Pythonic interface than the official Net-SNMP bindings.Many other libraries likeSnimpyare sadly based on PySNMP, so they also suffer performance penalty.Quick StartThere are primarily two ways you can use the Easy SNMP library:1. By using a Session object which is most suitable
when you want to request multiple pieces of SNMP data from a
source:fromeasysnmpimportSession# Create an SNMP session to be used for all our requestssession=Session(hostname='localhost',community='public',version=2)# You may retrieve an individual OID using an SNMP GETlocation=session.get('sysLocation.0')# You may also specify the OID as a tuple (name, index)# Note: the index is specified as a string as it can be of other types than# just a regular integercontact=session.get(('sysContact','0'))# And of course, you may use the numeric OID toodescription=session.get('.1.3.6.1.2.1.1.1.0')# Set a variable using an SNMP SETsession.set('sysLocation.0','The SNMP Lab')# Perform an SNMP walksystem_items=session.walk('system')# Each returned item can be used normally as its related type (str or int)# but also has several extended attributes with SNMP-specific informationforiteminsystem_items:print'{oid}.{oid_index}{snmp_type}={value}'.format(oid=item.oid,oid_index=item.oid_index,snmp_type=item.snmp_type,value=item.value)2. By using Easy SNMP via its simple interface which is intended
for one-off operations (where you wish to specify all details in the
request):fromeasysnmpimportsnmp_get,snmp_set,snmp_walk# Grab a single piece of information using an SNMP GETsnmp_get('sysDescr.0',hostname='localhost',community='public',version=1)# Perform an SNMP SET to update datasnmp_set('sysLocation.0','My Cool Place',hostname='localhost',community='public',version=1)# Perform an SNMP walksnmp_walk('system',hostname='localhost',community='public',version=1)DocumentationPlease check out theEasy SNMP documentation at Read the
Docs. This includes installation
instructions for various operating systems.You may generate the documentation as follows:# Install Sphinxpipinstallsphinx# You may optionally export the READTHEDOCS environment variable to build docs
# on systems where you haven't built the C interfaceexportREADTHEDOCS=1# Build the documentation into static HTML pagescddocsmakehtmlAcknowledgmentsI’d like to say thanks to the following folks who have made this project
possible:Giovanni Marzot: the original authorScienceLogic, LLC: sponsored the initial development of this
moduleWes Hardaker and the net-snmp-coders: for their hard work and
dedicationfgimian and nnathan: the original contributors to this codebaseRunning TestsTests usePytest. You can run
them with the following:gitclonehttps://github.com/easysnmp/easysnmp.gitcdeasysnmppipinstallpytestpytestLicenseEasy SNMP is released under theBSDlicense. Please see theLICENSEfile for more details.CopyrightThe original version of this library is copyright (c) 2006 G. S. Marzot.
All rights reserved.This program is free software; you can redistribute it and/or modify it
under the same terms as Net-SNMP itself.Copyright (c) 2006 SPARTA, Inc. All Rights Reserved. This program is
free software; you can redistribute it and/or modify it under the same
terms as Net-SNMP itself.