Various SNMP versions
*********************


SNMPv1
======

* with SNMPv1, community 'public'

* over IPv4/UDP

* to an Agent at 104.236.166.95:161

* for an OID in tuple form

This script performs similar to the following Net-SNMP command:

   $ snmpget -v1 -c public -ObentU 104.236.166.95 1.3.6.1.2.1.1.1.0

   from pysnmp.entity import engine, config
   from pysnmp.carrier.asyncore.dgram import udp
   from pysnmp.entity.rfc3413 import cmdgen

   # Create SNMP engine instance
   snmpEngine = engine.SnmpEngine()

   #
   # SNMPv1 setup
   #

   # SecurityName <-> CommunityName mapping
   config.addV1System(snmpEngine, 'my-area', 'public')

   # Specify security settings per SecurityName (SNMPv1 - 0, SNMPv2c - 1)
   config.addTargetParams(snmpEngine, 'my-creds', 'my-area', 'noAuthNoPriv', 0)

   #
   # Setup transport endpoint and bind it with security settings yielding
   # a target name
   #

   # UDP/IPv4
   config.addTransport(
       snmpEngine,
       udp.domainName,
       udp.UdpSocketTransport().openClientMode()
   )
   config.addTargetAddr(
       snmpEngine, 'my-router',
       udp.domainName, ('104.236.166.95', 161),
       'my-creds'
   )


   # Error/response receiver
   # noinspection PyUnusedLocal,PyUnusedLocal,PyUnusedLocal
   def cbFun(snmpEngine, sendRequestHandle, errorIndication,
             errorStatus, errorIndex, varBinds, cbCtx):
       if errorIndication:
           print(errorIndication)
       # SNMPv1 response may contain noSuchName error *and* SNMPv2c exception,
       # so we ignore noSuchName error here
       elif errorStatus and errorStatus != 2:
           print('%s at %s' % (errorStatus.prettyPrint(),
                               errorIndex and varBinds[int(errorIndex) - 1][0] or '?'))
       else:
           for oid, val in varBinds:
               print('%s = %s' % (oid.prettyPrint(), val.prettyPrint()))


   # Prepare and send a request message
   cmdgen.GetCommandGenerator().sendVarBinds(
       snmpEngine,
       'my-router',
       None, '',  # contextEngineId, contextName
       [((1, 3, 6, 1, 2, 1, 1, 1, 0), None)],
       cbFun
   )

   # Run I/O dispatcher which would send pending queries and process responses
   snmpEngine.transportDispatcher.runDispatcher()

"Download" script.


Set scalar value
================

Send a SNMP SET request * with SNMPv2c with community name 'private' *
over IPv4/UDP * to an Agent at 104.236.166.95:161 * for an OID in
tuple form and an integer-typed value

This script performs similar to the following Net-SNMP command:

   $ snmpset -v2c -c private -ObentU 104.236.166.95:161 1.3.6.1.2.1.1.9.1.4.1 t 123

   from pysnmp.entity import engine, config
   from pysnmp.carrier.asyncore.dgram import udp
   from pysnmp.entity.rfc3413 import cmdgen
   from pysnmp.proto import rfc1902

   # Create SNMP engine instance
   snmpEngine = engine.SnmpEngine()

   #
   # SNMPv2c setup
   #

   # SecurityName <-> CommunityName mapping
   config.addV1System(snmpEngine, 'my-area', 'private')

   # Specify security settings per SecurityName (SNMPv1 - 0, SNMPv2c - 1)
   config.addTargetParams(snmpEngine, 'my-creds', 'my-area', 'noAuthNoPriv', 1)

   #
   # Setup transport endpoint and bind it with security settings yielding
   # a target name
   #

   # UDP/IPv4
   config.addTransport(
       snmpEngine,
       udp.domainName,
       udp.UdpSocketTransport().openClientMode()
   )
   config.addTargetAddr(
       snmpEngine, 'my-router',
       udp.domainName, ('104.236.166.95', 161),
       'my-creds'
   )


   # Error/response receiver
   # noinspection PyUnusedLocal,PyUnusedLocal,PyUnusedLocal
   def cbFun(snmpEngine, sendRequestHandle, errorIndication,
             errorStatus, errorIndex, varBinds, cbCtx):
       if errorIndication:
           print(errorIndication)
       elif errorStatus:
           print('%s at %s' % (errorStatus.prettyPrint(),
                               errorIndex and varBinds[int(errorIndex) - 1][0] or '?'))
       else:
           for oid, val in varBinds:
               print('%s = %s' % (oid.prettyPrint(), val.prettyPrint()))


   # Prepare and send a request message
   cmdgen.SetCommandGenerator().sendVarBinds(
       snmpEngine,
       'my-router',
       None, '',  # contextEngineId, contextName
       [((1, 3, 6, 1, 2, 1, 1, 9, 1, 4, 1), rfc1902.TimeTicks(123))],
       cbFun
   )

   # Run I/O dispatcher which would send pending queries and process responses
   snmpEngine.transportDispatcher.runDispatcher()

"Download" script.


SNMPv3, auth: SHA, privacy: AES128
==================================

Send a SNMP GET request * with SNMPv3 with user 'usr-sha-aes', SHA
auth and AES128 privacy protocols * over IPv4/UDP * to an Agent at
104.236.166.95:161 * for an OID in tuple form

This script performs similar to the following Net-SNMP command:

   $ snmpget -v3 -l authPriv -u usr-sha-aes -a SHA -A authkey1 -x AES -X privkey1 -ObentU 104.236.166.95:161  1.3.6.1.2.1.1.1.0

   from pysnmp.entity import engine, config
   from pysnmp.carrier.asyncore.dgram import udp
   from pysnmp.entity.rfc3413 import cmdgen

   # Create SNMP engine instance
   snmpEngine = engine.SnmpEngine()

   #
   # SNMPv3/USM setup
   #

   # user: usr-sha-aes, auth: SHA, priv AES
   config.addV3User(
       snmpEngine, 'usr-sha-aes',
       config.usmHMACSHAAuthProtocol, 'authkey1',
       config.usmAesCfb128Protocol, 'privkey1'
   )
   config.addTargetParams(snmpEngine, 'my-creds', 'usr-sha-aes', 'authPriv')

   #
   # Setup transport endpoint and bind it with security settings yielding
   # a target name
   #

   # UDP/IPv4
   config.addTransport(
       snmpEngine,
       udp.domainName,
       udp.UdpSocketTransport().openClientMode()
   )
   config.addTargetAddr(
       snmpEngine, 'my-router',
       udp.domainName, ('104.236.166.95', 161),
       'my-creds'
   )


   # Error/response receiver
   # noinspection PyUnusedLocal,PyUnusedLocal,PyUnusedLocal
   def cbFun(snmpEngine, sendRequestHandle, errorIndication,
             errorStatus, errorIndex, varBinds, cbCtx):
       if errorIndication:
           print(errorIndication)
       elif errorStatus:
           print('%s at %s' % (errorStatus.prettyPrint(),
                               errorIndex and varBinds[int(errorIndex) - 1][0] or '?'))
       else:
           for oid, val in varBinds:
               print('%s = %s' % (oid.prettyPrint(), val.prettyPrint()))


   # Prepare and send a request message
   cmdgen.GetCommandGenerator().sendVarBinds(
       snmpEngine,
       'my-router',
       None, '',  # contextEngineId, contextName
       [((1, 3, 6, 1, 2, 1, 1, 1, 0), None)],
       cbFun
   )

   # Run I/O dispatcher which would send pending queries and process responses
   snmpEngine.transportDispatcher.runDispatcher()

   config.delTransport(
       snmpEngine,
       udp.domainName
   ).closeTransport()

"Download" script.


Set string value
================

Send a SNMP SET request with the following options:

* with SNMPv3 with user 'usr-sha-none', SHA auth and no privacy
  protocols

* over IPv4/UDP

* to an Agent at 104.236.166.95:161

* for an OID in tuple form and a string-typed value

This script performs similar to the following Net-SNMP command:

   $ snmpset -v3 -l authNoPriv -u usr-sha-none -a SHA -A authkey1 -ObentU 104.236.166.95:161 1.3.6.1.2.1.1.9.1.3.1 s 'my new value'

   from pysnmp.entity import engine, config
   from pysnmp.carrier.asyncore.dgram import udp
   from pysnmp.entity.rfc3413 import cmdgen
   from pysnmp.proto import rfc1902

   # Create SNMP engine instance
   snmpEngine = engine.SnmpEngine()

   #
   # SNMPv3/USM setup
   #

   # user: usr-sha-none, auth: SHA, priv none
   config.addV3User(
       snmpEngine, 'usr-sha-none',
       config.usmHMACSHAAuthProtocol, 'authkey1'
   )
   config.addTargetParams(snmpEngine, 'my-creds', 'usr-sha-none', 'authNoPriv')

   #
   # Setup transport endpoint and bind it with security settings yielding
   # a target name
   #

   # UDP/IPv4
   config.addTransport(
       snmpEngine,
       udp.domainName,
       udp.UdpSocketTransport().openClientMode()
   )
   config.addTargetAddr(
       snmpEngine, 'my-router',
       udp.domainName, ('104.236.166.95', 161),
       'my-creds'
   )


   # Error/response receiver
   # noinspection PyUnusedLocal,PyUnusedLocal,PyUnusedLocal
   def cbFun(snmpEngine, sendRequestHandle, errorIndication,
             errorStatus, errorIndex, varBinds, cbCtx):
       if errorIndication:
           print(errorIndication)
       elif errorStatus:
           print('%s at %s' % (errorStatus.prettyPrint(),
                               errorIndex and varBinds[int(errorIndex) - 1][0] or '?'))
       else:
           for oid, val in varBinds:
               print('%s = %s' % (oid.prettyPrint(), val.prettyPrint()))


   # Prepare and send a request message
   cmdgen.SetCommandGenerator().sendVarBinds(
       snmpEngine,
       'my-router',
       None, '',  # contextEngineId, contextName
       [((1, 3, 6, 1, 2, 1, 1, 9, 1, 3, 1), rfc1902.OctetString('my new value'))],
       cbFun
   )

   # Run I/O dispatcher which would send pending queries and process responses
   snmpEngine.transportDispatcher.runDispatcher()

"Download" script.

See also: library reference.
