Products
Support
Downloads
Purchase
Company
Subscriptions
Search: 
Available in: SNMPV3
SNMPTrapMgr Component [IP*Works! S/SNMP V6]

Properties   Methods   Events   Configuration Settings  

The SNMPTrapMgr component provides a listening point for SNMP traps.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The SNMPTrapMgr component provides a listening point for SNMP traps and informs as specified by the SNMP RFCs. The component supports v1, v2c, and v3 traps.

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

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

Messages are received through events such as Trap, InformRequest, or DiscoveryRequest.

SNMP OIDs, types, and values are provided in arrays such as ObjId, ObjType, and ObjValue, for both sent and received packets. ObjCount provides the number of elements in each of the arrays.

SNMPv3 USM security passwords are requested through the GetUserPassword 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 AddUser, RemoveUser, ShowCache, ClearCache, AddEngine, and RemoveEngine methods are used to manage an internal authentication cache. This internal cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.

AcceptData Enables or disables data reception.
Active Enables or disables sending and receiving of SNMP packets.
LocalEngineId The Engine Id (for SNMPv3).
LocalHost The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort The UDP port in the local host where the component is bound to.
ObjCount Number of objects in the current request.
ObjId Array of OIDs encoded as strings.
ObjType Array of object types.
ObjValue Array of object values.
RequestId The request-id to mark outgoing packets with.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.

AddEngine Adds the engine specified by EngineId to the internal authentication cache.
AddUser Adds a user for the engine specified by EngineId to the internal authentication cache.
ClearCache Clears the internal authentication database.
Config Sets or retrieves a component configuration setting.
DoEvents Processes events from the internal message queue.
HashPasswords Hashes all passwords in the cache.
RemoveEngine Removes the engine specified by EngineId from the internal authentication cache.
RemoveUser Removes the user specified by User of the engine specified by EngineId from the internal authentication cache.
Reset Clears the object arrays.
ShowCache Lists all entries in the internal user and engine database.
Value Returns the value corresponding to an OID.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

BadPacket Fired for erroneous and/or malformed messages.
CacheEntry Shows engines and users in the internal cache.
CheckEngine Fired to check engine parameters (timeliness, etc..).
DiscoveryRequest Fired when an SNMPv3 discovery packet is received.
Error Information about errors during data delivery.
GetUserPassword Retrieves a password associated with a user.
GetUserSecurityLevel Sets the security level for an incoming packet.
HashPassword Fired before and after a password is hashed.
InformRequest Fired when an InformRequest packet is received.
PacketTrace Fired for every packet sent or received.
Trap Fired when a SNMP trap packet is received.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
ContextEngineId The context engine id in the message.
ContextName The context name in the message.
FirewallData Used to send extra data to the firewall.
ForceLocalPort Forces the component to bind to a specific port.
InBufferSize The size in bytes of the incoming queue of the socket.
MaxPacketSize The maximum length of the packets that can be received.
OutBufferSize The size in bytes of the outgoing queue of the socket.
QOSFlags Flags determining Quality Of Service bits of packets sent by the socket.
ShareLocalPort If set to True, allows more than one instance of the component to be active on the same local port.
SocketHandle The handle of the main socket used by the component.
TimeWindow The time window used for SNMPv3 timeliness checking (authentication).
UseConnection Determines whether to use a connected socket.
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.