SET command¶
-
pysnmp.hlapi.v3arch.asyncore.
setCmd
(snmpEngine, authData, transportTarget, contextData, *varBinds, **options)¶ Performs SNMP SET query.
Based on passed parameters, prepares SNMP SET packet (RFC 1905#section-4.2.5) and schedules its transmission by I/O framework at a later point of time.
Parameters: - snmpEngine (
SnmpEngine
) – Class instance representing SNMP engine. - authData (
CommunityData
orUsmUserData
) – Class instance representing SNMP credentials. - transportTarget (
UdpTransportTarget
orUdp6TransportTarget
) – Class instance representing transport type along with SNMP peer address. - contextData (
ContextData
) – Class instance representing SNMP ContextEngineId and ContextName values. - *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:
- snmpEngine (
SnmpEngine
): Class instance representing SNMP engine. - sendRequestHandle (int): Unique request identifier. Can be used for matching multiple ongoing requests with received responses.
- errorIndication (str): True value indicates SNMP engine error.
- errorStatus (str): True value indicates SNMP PDU error.
- 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 in exactly the same order as varBinds in request. - cbCtx : Original user-supplied object.
Returns: sendRequestHandle (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.asyncore import * >>> def cbFun(snmpEngine, sendRequestHandle, errorIndication, errorStatus, errorIndex, varBinds, cbCtx): ... print(errorIndication, errorStatus, errorIndex, varBinds) >>> >>> snmpEngine = SnmpEngine() >>> setCmd(snmpEngine, ... CommunityData('public'), ... UdpTransportTarget(('demo.snmplabs.com', 161)), ... ContextData(), ... ObjectType(ObjectIdentity('SNMPv2-MIB', 'sysContact', 0), 'info@snmplabs.com'), ... cbFun=cbFun) >>> snmpEngine.transportDispatcher.runDispatcher() (None, 0, 0, [ObjectType(ObjectIdentity(ObjectName('1.3.6.1.2.1.1.4.0')), DisplayString('info@snmplabs.com'))]) >>>
- snmpEngine (