SNMPAgent Class

Properties   Methods   Events   Configuration Settings   Errors  

The SNMPAgent class is used to implement UDP-based SNMP Agent Applications.

Syntax

class ipworkssnmp.SNMPAgent

Remarks

The SNMPAgent class implements a UDP-based standard SNMP Agent as specified in the SNMP RFCs. The class supports SNMP v1, v2c, and v3.

The class provides both encoding/decoding and transport capabilities, making the task of developing a custom SNMP agent as simple as setting a few key properties and handling a few events. SNMP data such as SNMP object id-s (OID-s) are exchanged as text strings, thus further simplifying the task of handling them.

The class is activated/deactivated by setting the active property. This property enables or disables sending and receiving.

The class operates asynchronously. Requests are received through events such as on_get_request, on_get_bulk_request, on_get_next_request, etc. and the corresponding responses are automatically sent when the events return. Traps are sent through the send_trap method.

SNMPv3 USM security passwords are requested through the on_get_user_password event, and event parameters such as User and SecurityLevel provide information about the security attributes of received requests, and enable granular decision capability about what to provide and what not to provide. The send_secure_trap method is used to send authenticated (secure) SNMPv3 traps.

The add_user, remove_user, show_cache, and clear_cache methods are used to manage an internal authentication cache. This internal cache can be used as an alternative to the on_get_user_password event, automatically checking the cache against the security parameters provided in the request signature.

SNMP OIDs, types, and values are provided in the objects collection of SNMP objects for both sent and received packets.

Other packet information is provided through corresponding event parameters, such as Community, or RequestId.