GET command¶
-
pysnmp.hlapi.v1arch.
getCmd
(snmpDispatcher, authData, transportTarget, *varBinds, **options)¶ Creates a generator to perform one or more SNMP GET queries.
On each iteration, new SNMP GET request is send (RFC 1905#section-4.2.1). The iterator blocks waiting for response to arrive or error to occur.
Parameters: - snmpDispatcher (
SnmpDispatcher
) – Class instance representing asyncore-based asynchronous event loop and associated state information. - authData (
CommunityData
orUsmUserData
) – Class instance representing SNMP credentials. - transportTarget (
UdpTransportTarget
orUdp6TransportTarget
) – Class instance representing transport type along with SNMP peer address. - *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 False.
Yields: - errorIndication (str) – True value indicates local SNMP error.
- errorStatus (str) – True value indicates SNMP PDU error reported by remote.
- errorIndex (int) – Non-zero value refers to varBinds[errorIndex-1]
- varBinds (tuple) – A sequence of
ObjectType
class instances representing MIB variables returned in SNMP response.
Raises: PySnmpError
– Or its derivative indicating that an error occurred while performing SNMP operation.Notes
The getCmd generator will be exhausted immediately unless a new sequence of varBinds are send back into running generator (supported since Python 2.6).
Examples
>>> from pysnmp.hlapi.v1arch import * >>> >>> g = getCmd(snmpDispatcher(), >>> CommunityData('public'), >>> UdpTransportTarget(('demo.snmplabs.com', 161)), >>> ObjectType(ObjectIdentity('SNMPv2-MIB', 'sysDescr', 0))) >>> >>> next(g) (None, 0, 0, [ObjectType(ObjectIdentity(ObjectName('1.3.6.1.2.1.1.1.0')), DisplayString('SunOS zeus.snmplabs.com 4.1.3_U1 1 sun4m'))])
- snmpDispatcher (