IPWorks SNMP 2020 Python Edition

Questions / Feedback?

on_response Event

Fired when a GetResponse packet is received.

Syntax

class SNMPMgrResponseEventParams(object):
  @property
  def request_id() -> int: ...
  @property
  def snmp_version() -> int: ...
  @property
  def community() -> str: ...
  @property
  def user() -> str: ...
  @property
  def security_level() -> int: ...
  @property
  def source_address() -> str: ...
  @property
  def source_port() -> int: ...
  @property
  def error_index() -> int: ...
  @property
  def error_status() -> int: ...
  @property
  def error_description() -> str: ...

# In class SNMPMgr:
@property
def on_response() -> Callable[[SNMPMgrResponseEventParams], None]: ...
@on_response.setter
def on_response(event_hook: Callable[[SNMPMgrResponseEventParams], None]) -> None: ...

Remarks

The ErrorStatus and ErrorIndex parameters contain information about possible errors. ErrorDescription is a textual description of ErrorStatus. This value is parsed directly from the SNMP response, which will be a one-based value, so a value of i here maps to index i-1 in the objects collection.

The following is a list of valid SNMP status code values:

0 (noError) No error.
1 (tooBig) The response cannot fit in a single SNMP message.
2 (noSuchName) Variable does not exist.
3 (badValue) Invalid value or syntax.
4 (readOnly) Variable is read-only.
5 (genError) Other error (SNMPv1).
6 (noAccess) Access denied.
7 (wrongType) Wrong object type.
8 (wrongLength) Wrong length.
9 (wrongEncoding) Wrong encoding.
10 (wrongValue) Wrong value.
11 (noCreation) No creation.
12 (inconsistentValue) Inconsistent value.
13 (resourceUnavailable) Resource unavailable.
14 (commitFailed) Commit failed.
15 (undoFailed) Undo failed.
16 (authorizationError) Authorization error.
17 (notWritable) Variable is not writable.
18 (inconsistentName) Inconsistent name.

The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).

The list of variables in the SNMP packet, including optional values and types, is provided through the objects collection. Each object is of type snmpobject. This type describes the obj_id, obj_type, and obj_value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SNMP 2020 Python Edition - Version 20.0 [Build 8202]