IPWorks SNMP 2020 Python Edition

Questions / Feedback?

SNMPTCPMgr Class

Properties   Methods   Events   Configuration Settings   Errors  

The SNMPTCPMgr class is used to implement TCP-based SNMP Management Applications.

Syntax

class ipworkssnmp.SNMPTCPMgr

Remarks

The SNMPTCPMgr class implements a TCP-based standard SNMP Manager 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 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 on_response, on_trap, or on_inform_request. SNMP Traps are received through the on_trap event.

Messages are sent to other agents or managers by using class's methods such as send_get_request, send_get_next_request, send_get_bulk_request, send_set_request, and send_inform_request.

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

SNMPv3 USM security is enabled by setting properties such as user, authentication_password, and encryption_password and calling the discover method to bind to a particular agent (remote_engine_id). Upon successful discovery, received packets are checked for integrity (authentication) and timeliness. Note that the discovery step is optional, and may be avoided if the values for remote_engine_id, remote_engine_boots, and remote_engine_time are known in advance and provided to the class through the respective properties.

By default, the class operates synchronously (except for the discover method), sending a request and waiting until the corresponding response has been received. This behavior may be overridden by setting timeout to 0, in which case the class returns control immediately after a send, and responses are received exclusively through the on_response event.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

accept_dataEnables or disables data reception.
activeEnables or disables sending and receiving of SNMP packets.
authentication_passwordThe password used for SNMPv3 authentication.
authentication_protocolThe authentication protocol used for SNMPv3 packets.
communityThe community string used to authenticate SNMP packets.
encryption_algorithmThe encryption algorithm used for SNMPv3 packets.
encryption_passwordThe password used for SNMPv3 privacy.
error_descriptionDescription of the status code for the last SNMP packet received by the class.
error_indexIndex of the first variable (object) that caused an error from the last SNMP response.
error_statusStatus code for the last SNMP packet received by the class.
local_engine_idThe Engine Id of the SNMP Manager.
local_hostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
local_portThe port in the local host where the SNMP Manager is bound to.
obj_countThe number of records in the Obj arrays.
obj_typeThe current object's type.
obj_idThe current object's id which is encoded as a string of numbers separated by periods.
obj_type_stringA string representation of the current object's ObjectType .
obj_valueThe current object's value.
remote_engine_bootsThe remote engine boots (SNMPv3).
remote_engine_idThe Engine Id of the remote agent.
remote_engine_timeThe remote engine time (SNMPv3).
remote_hostThe address of the remote host. Domain names are resolved to IP addresses.
remote_portThe port where the remote SNMP agent is listening.
request_idThe request-id to mark outgoing packets with.
snmp_versionVersion of SNMP used for outgoing requests.
ssl_accept_server_cert_encodedThe certificate (PEM/base64 encoded).
ssl_authenticate_clientsIf true, the server asks the client(s) for a certificate.
ssl_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_storeThe name of the certificate store for the client certificate.
ssl_cert_store_passwordIf 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.
ssl_cert_store_typeThe type of certificate store for this certificate.
ssl_cert_subjectThe subject of the certificate used for client authentication.
ssl_enabledWhether TLS/SSL is enabled.
ssl_server_cert_encodedThe certificate (PEM/base64 encoded).
store_walk_objectsTells the class whether or not to store returned objects.
timeoutA timeout for the class.
userThe user name used for SNMPv3 authentication.
walk_limitThe limit of oid's returned in a walk.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

configSets or retrieves a configuration setting.
discoverPerforms SNMPv3 discovery.
do_eventsProcesses events from the internal message queue.
hash_passwordsHashes all passwords in the cache.
interruptInterrupt the current method.
resetClears the object arrays.
send_get_bulk_requestSend a GetBulkRequest packet.
send_get_next_requestSend GetNextRequest packet.
send_get_requestSend GetRequest packet.
send_inform_requestSend an InformRequest packet.
send_set_requestSend Set Request packet.
valueReturns the value corresponding to an OID.
walkDoes an SNMP walk starting with the specified 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.

on_bad_packetFired for erroneous and/or malformed messages.
on_connectedFired immediately after a connection completes (or fails).
on_connection_statusTBD.
on_disconnectedTBD.
on_discovery_requestFired when an SNMPv3 discovery packet is received.
on_discovery_responseFired when an SNMPv3 discovery response is received.
on_errorInformation about errors during data delivery.
on_hash_passwordFired before and after a password is hashed.
on_inform_requestFired when an InformRequest packet is received.
on_packet_traceFired for every packet sent or received.
on_ready_to_sendFired when the class is ready to send data.
on_reportFired when a Report packet is received.
on_responseFired when a GetResponse packet is received.
on_ssl_client_authenticationFired when the client presents its credentials to the server.
on_ssl_server_authenticationFires when connecting to the server.
on_ssl_statusShows the progress of the secure connection.
on_trapFired 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.

CheckMessageOriginWhether to match the origin IP address when receiving responses.
CompatibilityModeWhether to operate the class in a specific compatibility mode.
ContextEngineIdSets the context engine id of the SNMP entity.
ContextNameSets the context name of the SNMP entity.
DecryptLogPacketsWhether to decrypt logged packets.
ForceLocalPortForces the class to bind to a specific port.
MsgMaxSizeThe maximum supported message size.
SourceAddressThe source address of the received packet.
SourcePortThe source port of the received packet.
TimeoutInMillisecondsThe timeout is treated as milliseconds.
WalkInsideRangeStops the SNMP walk if the OID value returned from an agent is outside the table.
WalkStartOIDSpecifies the OID to be used when a Walk is performed.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

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