Search: 
Available in: SNMPV3
SNMPAgent Component [IP*Works! S/SNMP V6]

Properties   Methods   Events   Configuration Settings  

The SNMPAgent component is used to implement SNMP Agent Applications.

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 SNMPAgent component implements a standard SNMP Agent as specified in the SNMP RFCs. The component supports SNMP v1, v2c, and v3.

The component 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 component is activated/deactivated by setting the Active property. This property enables or disables sending and receiving.

The component operates asynchronously. Requests are received through events such as GetRequest, GetBulkRequest, GetNextRequest, etc.. and the corresponding responses are automatically sent when the events return. Traps are sent through the SendTrap method.

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 SendSecureTrap method is used to send authenticated (secure) SNMPv3 traps.

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.

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.

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

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 of the SNMP Agent.
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 listens.
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.
SNMPVersion Version of SNMP used for outgoing requests (traps).
SysUpTime Time passed since the agent was initialized (in hundredths of a second).

Method List

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

AddUser Adds a user 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.
RemoveUser Removes the user specified by User from the internal authentication cache.
Reset Clears the object arrays.
SendSecureTrap Sends an authenticated and/or encrypted SNMPv3 trap.
SendTrap Sends an SNMP Trap.
ShowCache Lists all entries in the internal user authentication cache.
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 in the internal cache.
DiscoveryRequest Fired when an SNMPv3 discovery packet is received.
Error Information about errors during data delivery.
GetBulkRequest Fired when a GetBulkRequest packet is received.
GetNextRequest Fired when a GetNextRequest packet is received.
GetRequest Fired when a GetRequest packet is received.
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.
PacketTrace Fired for every packet sent or received.
Report Fired when a Report packet is received.
SetRequest Fired when a SetRequest 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.
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).
TrapAgentAddress The address of the object generating the trap.
TrapCommunity The value of the Community parameter for SNMP traps.
TrapEnterprise The type of the object generating the trap.
TrapPort The port where SNMP traps are sent.
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 2010 /n software inc.