SNMPTCPTrapMgr Class
Properties Methods Events Configuration Settings Errors
The SNMPTCPTrapMgr class provides a TCP-based listening point for SNMP traps.
Syntax
SNMPTCPTrapMgr
Remarks
The SNMPTCPTrapMgr class provides a TCP-based listening point for SNMP traps and informs as specified by the SNMP RFCs. The class supports v1, v2c, and v3 traps.
The class 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 class 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 the Objects collection of SNMP objects for both sent and received packets.
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 class with short descriptions. Click on the links for further details.
| 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 port in the local host where the class is bound to. |
| ObjCount | The number of records in the Obj arrays. |
| ObjType | The current object's type. |
| ObjId | The current object's id which is encoded as a string of numbers separated by periods. |
| ObjTypeString | A string representation of the current object's ObjectType . |
| ObjValue | The current object's value. |
| RequestId | The request-id to mark outgoing packets with. |
| SSLAuthenticateClients | If true, the server asks the client(s) for a certificate. |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLEnabled | Whether TLS/SSL is enabled. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| 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 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 class with short descriptions. Click on the links for further details.
| 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.). |
| Connected | Fired immediately after a connection completes (or fails). |
| ConnectionStatus | TBD. |
| Disconnected | TBD. |
| 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. |
| SSLClientAuthentication | Fired when the client presents its credentials to the server. |
| SSLStatus | Shows the progress of the secure connection. |
| Trap | Fired when a SNMP trap packet is received. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| AuthenticationKey | The key to use for authentication. |
| CompatibilityMode | Whether to operate the class in a specific compatibility mode. |
| ContextEngineId | Sets the context engine id of the SNMP entity. |
| ContextName | Sets the context name of the SNMP entity. |
| DecryptLogPackets | Whether to decrypt logged packets. |
| EncryptionKey | The key to use for encryption. |
| ForceLocalPort | Forces the class to bind to a specific port. |
| ShowCacheForUser | Shows the cache entry for a single user. |
| SourceAddress | The source address of the received packet. |
| SourcePort | The source port of the received packet. |
| TimeWindow | The time window used for SNMPv3 timeliness checking (authentication). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the class binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
| SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |