Table operations

GET table row

Send SNMP GET request using the following options:

• with SNMPv3, user ‘usr-none-none’, no authentication, no privacy
• over IPv4/UDP
• to an Agent at demo.snmplabs.com:161
• for IF-MIB::ifInOctets.1 and IF-MIB::ifOutOctets.1 MIB object
• perform response OIDs and values resolution at MIB

Functionally similar to:

$ snmpget -v3 -l authPriv -u usr-md5-des -A authkey1 -X privkey1 demo.snmplabs.com IF-MIB::ifInOctets.1 IF-MIB::ifOutOctets.1

from pysnmp.hlapi import *

iterator = getCmd(
    SnmpEngine(),
    UsmUserData('usr-none-none'),
    UdpTransportTarget(('demo.snmplabs.com', 161)),
    ContextData(),
    ObjectType(ObjectIdentity('IF-MIB', 'ifInOctets', 1)),
    ObjectType(ObjectIdentity('IF-MIB', 'ifOutOctets', 1))
)

errorIndication, errorStatus, errorIndex, varBinds = next(iterator)

if errorIndication:
    print(errorIndication)

elif errorStatus:
    print('%s at %s' % (errorStatus.prettyPrint(),
                        errorIndex and varBinds[int(errorIndex) - 1][0] or '?'))

else:
    for varBind in varBinds:
        print(' = '.join([x.prettyPrint() for x in varBind]))

Download script.

Fetch table row by composite index

Send SNMP GET request using the following options:

• with SNMPv3, user ‘usr-sha-aes128’, SHA auth, AES128 privacy
• over IPv4/UDP
• to an Agent at demo.snmplabs.com:161
• for TCP-MIB::tcpConnLocalAddress.”0.0.0.0”.22.”0.0.0.0”.0 MIB object

Functionally similar to:

$ snmpget -v3 -l authPriv -u usr-md5-des -A authkey1 -X privkey1 -a SHA -x AES demo.snmplabs.com TCP-MIB::tcpConnLocalAddress.”0.0.0.0”.22.”0.0.0.0”.0

from pysnmp.hlapi import *

iterator = getCmd(
    SnmpEngine(),
    UsmUserData(
        'usr-sha-aes128', 'authkey1', 'privkey1',
        authProtocol=USM_AUTH_HMAC96_SHA,
        privProtocol=USM_PRIV_CFB128_AES
    ),
    UdpTransportTarget(('demo.snmplabs.com', 161)),
    ContextData(),
    ObjectType(
        ObjectIdentity(
            'TCP-MIB',
            'tcpConnLocalAddress',
            '0.0.0.0', 22,
            '0.0.0.0', 0
        )
    ).addAsn1MibSource('http://mibs.snmplabs.com/asn1/@mib@')
)

errorIndication, errorStatus, errorIndex, varBinds = next(iterator)

if errorIndication:
    print(errorIndication)

elif errorStatus:
    print('%s at %s' % (errorStatus.prettyPrint(),
                        errorIndex and varBinds[int(errorIndex) - 1][0] or '?'))

else:
    for varBind in varBinds:
        print(' = '.join([x.prettyPrint() for x in varBind]))

Download script.

Fetch scalar and table variables

Send a series of SNMP GETBULK requests using the following options:

• with SNMPv3 with user ‘usr-md5-des’, MD5 auth and DES privacy protocols
• over IPv6/UDP
• to an Agent at [::1]:161
• with values non-repeaters = 1, max-repetitions = 25
• for IP-MIB::ipAdEntAddr and all columns of the IF-MIB::ifEntry table
• stop when response OIDs leave the scopes of the table

Functionally similar to:

$ snmpbulkwalk -v3 -lauthPriv -u usr-md5-des -A authkey1 -X privkey1 -Cn1, -Cr25 demo.snmplabs.com IP-MIB::ipAdEntAddr IP-MIB::ipAddrEntry

from pysnmp.hlapi import *

iterator = bulkCmd(
    SnmpEngine(),
    UsmUserData('usr-md5-des', 'authkey1', 'privkey1'),
    Udp6TransportTarget(('::1', 161)),
    ContextData(),
    1, 25,
    ObjectType(ObjectIdentity('IP-MIB', 'ipAdEntAddr')),
    ObjectType(ObjectIdentity('IP-MIB', 'ipAddrEntry')),
    lexicographicMode=False
)

for errorIndication, errorStatus, errorIndex, varBinds in iterator:

    if errorIndication:
        print(errorIndication)
        break

    elif errorStatus:
        print('%s at %s' % (errorStatus.prettyPrint(),
                            errorIndex and varBinds[int(errorIndex) - 1][0] or '?'))
        break

    else:
        for varBind in varBinds:
            print(' = '.join([x.prettyPrint() for x in varBind]))

Download script.

Fetch whole SNMP table

Send a series of SNMP GETNEXT requests using the following options:

• with SNMPv1, community ‘public’
• over IPv4/UDP
• to an Agent at demo.snmplabs.com:161
• for some columns of the IF-MIB::ifEntry table
• stop when response OIDs leave the scopes of initial OIDs

Functionally similar to:

$ snmpwalk -v1 -c public demo.snmplabs.com IF-MIB::ifDescr IF-MIB::ifType IF-MIB::ifMtu IF-MIB::ifSpeed IF-MIB::ifPhysAddress IF-MIB::ifType

from pysnmp.hlapi import *

iterator = nextCmd(
    SnmpEngine(),
    CommunityData('public', mpModel=0),
    UdpTransportTarget(('demo.snmplabs.com', 161)),
    ContextData(),
    ObjectType(ObjectIdentity('IF-MIB', 'ifDescr')),
    ObjectType(ObjectIdentity('IF-MIB', 'ifType')),
    ObjectType(ObjectIdentity('IF-MIB', 'ifMtu')),
    ObjectType(ObjectIdentity('IF-MIB', 'ifSpeed')),
    ObjectType(ObjectIdentity('IF-MIB', 'ifPhysAddress')),
    ObjectType(ObjectIdentity('IF-MIB', 'ifType')),
    lexicographicMode=False
)

for errorIndication, errorStatus, errorIndex, varBinds in iterator:

    if errorIndication:
        print(errorIndication)
        break

    elif errorStatus:
        print('%s at %s' % (errorStatus.prettyPrint(),
                            errorIndex and varBinds[int(errorIndex)-1][0] or '?'))
        break

    else:
        for varBind in varBinds:
            print(' = '.join([x.prettyPrint() for x in varBind]))

Download script.

See also: library reference.