GETBULK command

pysnmp.hlapi.v1arch.asyncore.bulkCmd(snmpDispatcher, authData, transportTarget, nonRepeaters, maxRepetitions, *varBinds, **options)

Initiate SNMP GETBULK query over SNMPv2c.

Based on passed parameters, prepares SNMP GETBULK packet (RFC 1905#section-4.2.3) and schedules its transmission by I/O framework at a later point of time.

Parameters:
  • snmpDispatcher (SnmpDispatcher) – Class instance representing SNMP dispatcher.
  • authData (CommunityData or UsmUserData) – Class instance representing SNMP credentials.
  • transportTarget (UdpTransportTarget or Udp6TransportTarget) – Class instance representing transport type along with SNMP peer address.
  • nonRepeaters (int) – One MIB variable is requested in response for the first nonRepeaters MIB variables in request.
  • maxRepetitions (int) – maxRepetitions MIB variables are requested in response for each of the remaining MIB variables in the request (e.g. excluding nonRepeaters). Remote SNMP dispatcher may choose lesser value than requested.
  • *varBinds (ObjectType) – One or more class instances representing MIB variables to place into SNMP request.
Other Parameters:
 

**options –

Request options:

  • lookupMib - load MIB and resolve response MIB variables at the cost of slightly reduced performance. Default is True.
  • cbFun (callable) - user-supplied callable that is invoked
    to pass SNMP response data or error to user at a later point of time. Default is None.
  • cbCtx (object) - user-supplied object passing additional
    parameters to/from cbFun. Default is None.

Notes

User-supplied cbFun callable must have the following call signature:

  • snmpDispatcher (snmpDispatcher): Class instance representing SNMP dispatcher.

  • stateHandle (int): Unique request identifier. Can be used for matching multiple ongoing requests with received responses.

  • errorIndication (str): True value indicates SNMP dispatcher error.

  • errorStatus (str): True value indicates SNMP PDU error.

  • errorIndex (int): Non-zero value refers to varBinds[errorIndex-1]

  • varBindTable (tuple): A sequence of sequences (e.g. 2-D array) of variable-bindings represented as tuple or ObjectType class instances representing a table of MIB variables returned in SNMP response, with up to maxRepetitions rows, i.e. len(varBindTable) <= maxRepetitions.

    For 0 <= i < len(varBindTable) and 0 <= j < len(varBinds), varBindTable[i][j] represents:

    • For non-repeaters (j < nonRepeaters), the first lexicographic successor of varBinds[j], regardless the value of i, or an ObjectType instance with the endOfMibView value if no such successor exists;
    • For repeaters (j >= nonRepeaters), the i-th lexicographic successor of varBinds[j], or an ObjectType instance with the endOfMibView value if no such successor exists.

    See RFC 3416#section-4.2.3 for details on the underlying GetBulkRequest-PDU and the associated GetResponse-PDU, such as specific conditions under which the server may truncate the response, causing varBindTable to have less than maxRepetitions rows.

  • cbCtx (object): Original user-supplied object.

Returns:stateHandle (int) – Unique request identifier. Can be used for matching received responses with ongoing requests.
Raises:PySnmpError – Or its derivative indicating that an error occurred while performing SNMP operation.

Examples

>>> from pysnmp.hlapi.v1arch.asyncore import *
>>>
>>> def cbFun(snmpDispatcher, stateHandle, errorIndication,
>>>           errorStatus, errorIndex, varBinds, cbCtx):
>>>     print(errorIndication, errorStatus, errorIndex, varBinds)
>>>
>>> snmpDispatcher = snmpDispatcher()
>>>
>>> stateHandle = bulkCmd(
>>>     snmpDispatcher,
>>>     CommunityData('public'),
>>>     UdpTransportTarget(('demo.snmplabs.com', 161)),
>>>     0, 2,
>>>     ('1.3.6.1.2.1.1', None),
>>>     cbFun=cbFun
>>> )
>>>
>>> snmpDispatcher.transportDispatcher.runDispatcher()