SNMPMgr Class
Properties Methods Events Config Settings Errors
The SNMPMgr class is used to implement UDP-based SNMP Management Applications.
Syntax
class ipworkssnmp.SNMPMgr
Remarks
The SNMPMgr class implements a UDP-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 calling the activate or deactivate method. These methods enable or disable sending and receiving. The activation status can be found in the active property.
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_data | Enables or disables data reception. |
active | Indicates whether the class is active. |
authentication_password | The password used for SNMPv3 authentication. |
authentication_protocol | The authentication protocol used for SNMPv3 packets. |
community | The community string used to authenticate SNMP packets. |
encryption_algorithm | The encryption algorithm used for SNMPv3 packets. |
encryption_password | The password used for SNMPv3 privacy. |
error_description | Description of the status code for the last SNMP packet received by the class. |
error_index | Index of the first variable (object) that caused an error from the last SNMP response. |
error_status | Status code for the last SNMP packet received by the class. |
local_engine_id | The Engine Id of the SNMP Manager. |
local_host | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
local_port | The port in the local host where the SNMP Manager is bound to. |
obj_count | The number of records in the Obj arrays. |
obj_type | The current object's type. |
obj_id | The current object's id which is encoded as a string of numbers separated by periods. |
obj_type_string | A string representation of the current object's ObjectType . |
obj_value | The current object's value. |
remote_engine_boots | The remote engine boots (SNMPv3). |
remote_engine_id | The Engine Id of the remote agent. |
remote_engine_time | The remote engine time (SNMPv3). |
remote_host | The address of the remote host. Domain names are resolved to IP addresses. |
remote_port | The port where the remote SNMP agent is listening. |
request_id | The request-id to mark outgoing packets with. |
snmp_version | Version of SNMP used for outgoing requests. |
store_walk_objects | Tells the class whether or not to store returned objects. |
timeout | A timeout for the class. |
user | The user name used for SNMPv3 authentication. |
walk_limit | The 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.
activate | Activates the class. |
config | Sets or retrieves a configuration setting. |
deactivate | Deactivates the class. |
discover | Performs SNMPv3 discovery. |
do_events | Processes events from the internal message queue. |
hash_passwords | Hashes all passwords in the cache. |
interrupt | Interrupt the current method. |
reset | Clears the object arrays. |
send_get_bulk_request | Send a GetBulkRequest packet. |
send_get_next_request | Send GetNextRequest packet. |
send_get_request | Send GetRequest packet. |
send_inform_request | Send an InformRequest packet. |
send_set_request | Send Set Request packet. |
value | Returns the value corresponding to an OID. |
walk | Does 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_packet | Fired for erroneous and/or malformed messages. |
on_discovery_request | Fired when an SNMPv3 discovery packet is received. |
on_discovery_response | Fired when an SNMPv3 discovery response is received. |
on_error | Fired when information is available about errors during data delivery. |
on_hash_password | Fired before and after a password is hashed. |
on_inform_request | Fired when an InformRequest packet is received. |
on_packet_trace | Fired for every packet sent or received. |
on_ready_to_send | Fired when the class is ready to send data. |
on_report | Fired when a Report packet is received. |
on_response | Fired when a GetResponse packet is received. |
on_trap | Fired when a SNMP trap packet is received. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AllowSingleStepDiscovery | Whether to allow discovery to be completed in a single step. |
CheckMessageOrigin | Whether to match the origin IP address when receiving responses. |
CheckSNMPVersion | Whether to check the version of incoming packets. |
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. |
ForceLocalPort | Forces the class to bind to a specific port. |
IgnoreDuplicateResponse | Whether to ignore duplicate responses. |
IgnorePortMismatch | Whether to check if the port matches when a response is received. |
IncomingContextEngineId | The engine Id of the received packet. |
IncomingContextName | The context name of the received packet. |
MsgMaxSize | The maximum supported message size. |
SourceAddress | The source address of the received packet. |
SourcePort | The source port of the received packet. |
TimeoutInMilliseconds | The timeout is treated as milliseconds. |
WalkInsideRange | Stops the SNMP walk if the OID value returned from an agent is outside the table. |
WalkStartOID | Specifies the OID to be used when a Walk is performed. |
CaptureIPPacketInfo | Used to capture the packet information. |
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
DestinationAddress | Used to get the destination address from the packet information. |
DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
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. |
MaxPacketSize | The maximum length of the packets that can be received. |
QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
ShareLocalPort | If set to True, allows more than one instance of the class to be active on the same local port. |
SourceIPAddress | Used to set the source IP address used when sending a packet. |
SourceMacAddress | Used to set the source MAC address used when sending a packet. |
UseConnection | Determines whether to use a connected socket. |
UseIPv6 | Whether or not to use IPv6. |
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. |
MaskSensitive | Whether sensitive data is masked in log messages. |
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 | Whether or not to use the system security libraries or an internal implementation. |
accept_data Property
Enables or disables data reception.
Syntax
def get_accept_data() -> bool: ... def set_accept_data(value: bool) -> None: ...
accept_data = property(get_accept_data, set_accept_data)
Default Value
TRUE
Remarks
Setting the property to False temporarily disables data reception. Setting the property to True re-enables data reception.
active Property
Indicates whether the class is active.
Syntax
def get_active() -> bool: ... def set_active(value: bool) -> None: ...
active = property(get_active, set_active)
Default Value
FALSE
Remarks
This property indicates whether the class is currently active and can send or receive data.
The class will be automatically activated if it is not already and you attempt to perform an operation which requires the class to be active.
Note: Use the activate or deactivate method to control whether the class is active.
authentication_password Property
The password used for SNMPv3 authentication.
Syntax
def get_authentication_password() -> str: ... def set_authentication_password(value: str) -> None: ...
authentication_password = property(get_authentication_password, set_authentication_password)
Default Value
""
Remarks
Every time encryption_password, authentication_password, or remote_engine_id are set, a localized key is computed automatically, and cached internally.
authentication_protocol Property
The authentication protocol used for SNMPv3 packets.
Syntax
def get_authentication_protocol() -> int: ... def set_authentication_protocol(value: int) -> None: ...
authentication_protocol = property(get_authentication_protocol, set_authentication_protocol)
Default Value
1
Remarks
This property defines the authentication protocol used when snmp_version is set to snmpverV3. Possible values are:
- 1 (HMAC-MD5-96 - default)
- 2 (HMAC-SHA-96)
- 3 (HMAC-192-SHA-256)
- 4 (HMAC-384-SHA-512)
community Property
The community string used to authenticate SNMP packets.
Syntax
def get_community() -> str: ... def set_community(value: str) -> None: ...
community = property(get_community, set_community)
Default Value
"public"
Remarks
Must match the community name that is specified on the agent.
Typical values are "public" or "private".
This property is used for all SNMP packets sent by the class.
encryption_algorithm Property
The encryption algorithm used for SNMPv3 packets.
Syntax
def get_encryption_algorithm() -> int: ... def set_encryption_algorithm(value: int) -> None: ...
encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)
Default Value
1
Remarks
In order to use encryption, you must set the encryption_password property. The supported algorithms for encryption are:
DES (1) | Data Encryption Standard. |
AES (2) | Advanced Encryption Standard with key length of 128. |
3DES (3) | Triple Data Encryption Standard. |
AES192 (4) | Advanced Encryption Standard with key length of 192. |
AES256 (5) | Advanced Encryption Standard with key length of 256. |
encryption_password Property
The password used for SNMPv3 privacy.
Syntax
def get_encryption_password() -> str: ... def set_encryption_password(value: str) -> None: ...
encryption_password = property(get_encryption_password, set_encryption_password)
Default Value
""
Remarks
Every time encryption_password, authentication_password, or remote_engine_id are set, a localized key is computed automatically, and cached internally.
error_description Property
Description of the status code for the last SNMP packet received by the class.
Syntax
def get_error_description() -> str: ...
error_description = property(get_error_description, None)
Default Value
"0"
Remarks
Please refer to the error_status property for more information.
This property is read-only.
error_index Property
Index of the first variable (object) that caused an error from the last SNMP response.
Syntax
def get_error_index() -> int: ...
error_index = property(get_error_index, None)
Default Value
0
Remarks
This property is used in conjunction with the error_status property, and refers to the object that caused the error reported in the last SNMP response. This value is parsed directly from the SNMP response, which will be a one-based value, so a value of i here maps to index i-1 in the objects collection.
The error_index property has no meaning when the error_status property is 0 (no error).
This property is read-only.
error_status Property
Status code for the last SNMP packet received by the class.
Syntax
def get_error_status() -> int: ...
error_status = property(get_error_status, None)
Default Value
0
Remarks
This property is used in conjunction with the error_index property, which denotes the index of the variable in error. The error_description property provides a textual description of the error.
The following is a list of valid SNMP status code values:
0 (noError) | No error. |
1 (tooBig) | The response cannot fit in a single SNMP message. |
2 (noSuchName) | Variable does not exist. |
3 (badValue) | Invalid value or syntax. |
4 (readOnly) | Variable is read-only. |
5 (genError) | Other error (SNMPv1). |
6 (noAccess) | Access denied. |
7 (wrongType) | Wrong object type. |
8 (wrongLength) | Wrong length. |
9 (wrongEncoding) | Wrong encoding. |
10 (wrongValue) | Wrong value. |
11 (noCreation) | No creation. |
12 (inconsistentValue) | Inconsistent value. |
13 (resourceUnavailable) | Resource unavailable. |
14 (commitFailed) | Commit failed. |
15 (undoFailed) | Undo failed. |
16 (authorizationError) | Authorization error. |
17 (notWritable) | Variable is not writable. |
18 (inconsistentName) | Inconsistent name. |
Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).
The default value is 0 (no error).
This property is read-only.
local_engine_id Property
The Engine Id of the SNMP Manager.
Syntax
def get_local_engine_id() -> bytes: ... def set_local_engine_id(value: bytes) -> None: ...
local_engine_id = property(get_local_engine_id, set_local_engine_id)
Default Value
""
Remarks
This property is only used for SNMPv3 packets (when snmp_version is 3).
local_host Property
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
def get_local_host() -> str: ... def set_local_host(value: str) -> None: ...
local_host = property(get_local_host, set_local_host)
Default Value
""
Remarks
The local_host property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: local_host is not persistent. You must always set it in code, and never in the property window.
local_port Property
The port in the local host where the SNMP Manager is bound to.
Syntax
def get_local_port() -> int: ... def set_local_port(value: int) -> None: ...
local_port = property(get_local_port, set_local_port)
Default Value
0
Remarks
The local_port property must be set before the class is activated (active is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine. The default port is 0 (random port). If you would like to receive traps, set local_port to 162 (standard trap port). However, it is recommended that the SNMPTrapMgr class be used for listening to traps, because SNMPMgr is limited to receiving SNMPv3 traps from a single agent only. SNMPTrapMgr does not have this limitation.
local_port cannot be changed once the class is active. Any attempt to set the local_port property when the class is active will generate an error.
Note: on macOS and iOS, root permissions are required to set local_port to any value below 1024.
obj_count Property
The number of records in the Obj arrays.
Syntax
def get_obj_count() -> int: ... def set_obj_count(value: int) -> None: ...
obj_count = property(get_obj_count, set_obj_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at obj_count - 1.
obj_type Property
The current object's type.
Syntax
def get_obj_type(obj_index: int) -> int: ... def set_obj_type(obj_index: int, value: int) -> None: ...
Default Value
5
Remarks
The current object's type. The default type is NULL (5).
The corresponding object id and value are specified by the obj_oid and obj_value properties.
Possible object type values include:
otInteger (2) | 2 |
otOctetString (4) | 4 |
otNull (5) | 5 |
otObjectID (6) | 6 |
otIPAddress (64) | 64 |
otCounter32 (65) | 65 |
otGauge32 (66) | 66 |
otTimeTicks (67) | 67 |
otOpaque (68) | 68 |
otNSAP (69) | 69 |
otCounter64 (70) | 70 |
otUnsignedInteger32 (71) | 71 |
The class also supports the following artificial object values used to designate error conditions:
otNoSuchObject (128) | No such object error. |
otNoSuchInstance (129) | No such instance error. |
otEndOfMibView (130) | End of MIB View error. |
The obj_index parameter specifies the index of the item in the array. The size of the array is controlled by the obj_count property.
obj_id Property
The current object's id which is encoded as a string of numbers separated by periods.
Syntax
def get_obj_id(obj_index: int) -> str: ... def set_obj_id(obj_index: int, value: str) -> None: ...
Default Value
""
Remarks
The current object's id which is encoded as a string of numbers separated by periods. For instance: "1.3.6.1.2.1.1.1.0" (OID for "system description").
The corresponding object type and value (if any) are specified by the object_type and obj_value properties.
Example
SNMPControl.ObjCount = 1
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
The obj_index parameter specifies the index of the item in the array. The size of the array is controlled by the obj_count property.
obj_type_string Property
A string representation of the current object's ObjectType .
Syntax
def get_obj_type_string(obj_index: int) -> str: ...
Default Value
""
Remarks
A string representation of the current object's object_type.
The corresponding object id and value are specified by the obj_oid and obj_value properties.
The obj_index parameter specifies the index of the item in the array. The size of the array is controlled by the obj_count property.
This property is read-only.
obj_value Property
The current object's value.
Syntax
def get_obj_value(obj_index: int) -> bytes: ... def set_obj_value(obj_index: int, value: bytes) -> None: ...
Default Value
""
Remarks
The current object's value. The corresponding object id and type are specified by the obj_oid and object_type properties.
Example
SNMPControl.ObjCount = 1
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
SNMPControl.ObjValue(0) = "New Value"
The obj_index parameter specifies the index of the item in the array. The size of the array is controlled by the obj_count property.
remote_engine_boots Property
The remote engine boots (SNMPv3).
Syntax
def get_remote_engine_boots() -> int: ... def set_remote_engine_boots(value: int) -> None: ...
remote_engine_boots = property(get_remote_engine_boots, set_remote_engine_boots)
Default Value
0
Remarks
This property is used in conjunction with the remote_engine_time property. Please refer to the description of the remote_engine_time property, and the discover method for further information.
remote_engine_id Property
The Engine Id of the remote agent.
Syntax
def get_remote_engine_id() -> bytes: ... def set_remote_engine_id(value: bytes) -> None: ...
remote_engine_id = property(get_remote_engine_id, set_remote_engine_id)
Default Value
""
Remarks
This property is only used for SNMPv3 packets (see snmp_version), and is reset every time remote_host or remote_port changes.
remote_engine_id is normally discovered through the discover method. However, by manually supplying a value for the property, remote_engine_id discovery step may be eliminated, thus avoiding the extra roundtrip to the agent (remote_engine_boots and remote_engine_time are also required for user authentication - please refer to the discover method for more information).
remote_engine_time Property
The remote engine time (SNMPv3).
Syntax
def get_remote_engine_time() -> int: ... def set_remote_engine_time(value: int) -> None: ...
remote_engine_time = property(get_remote_engine_time, set_remote_engine_time)
Default Value
0
Remarks
remote_engine_time is used by SNMPv3 authentication to ensure timeliness of requests, and avoid replay attacks.
The value of remote_engine_time is provided as what is expected to be the current value of the remote engine clock based on a cached time differential between the remote engine clock and the local engine time obtained during the discovery process (see discover).
This property is used in conjunction with remote_engine_boots. Please refer to the remote_engine_boots property and the discover method for more information.
remote_host Property
The address of the remote host. Domain names are resolved to IP addresses.
Syntax
def get_remote_host() -> str: ... def set_remote_host(value: str) -> None: ...
remote_host = property(get_remote_host, set_remote_host)
Default Value
""
Remarks
The remote_host property specifies the IP address (IP number in dotted internet format) or Domain Name of the host SNMP requests or traps are sent to.
If remote_host is set to 255.255.255.255, the class broadcasts data on the local subnet.
If the remote_host property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the remote_host property is set to the corresponding address. If the search is not successful, an error is returned.
remote_port Property
The port where the remote SNMP agent is listening.
Syntax
def get_remote_port() -> int: ... def set_remote_port(value: int) -> None: ...
remote_port = property(get_remote_port, set_remote_port)
Default Value
161
Remarks
The remote_port is the port on the remote_host to send SNMP requests to.
A valid port number (a value between 1 and 65535) is required. The default value is 161.
request_id Property
The request-id to mark outgoing packets with.
Syntax
def get_request_id() -> int: ... def set_request_id(value: int) -> None: ...
request_id = property(get_request_id, set_request_id)
Default Value
1
Remarks
If a custom value is needed for request_id, the property must be set before sending the request. The class increments request_id automatically after sending each packet.
snmp_version Property
Version of SNMP used for outgoing requests.
Syntax
def get_snmp_version() -> int: ... def set_snmp_version(value: int) -> None: ...
snmp_version = property(get_snmp_version, set_snmp_version)
Default Value
2
Remarks
This property takes one of the following values:
snmpverV1 (1) | SNMP Version 1. |
snmpverV2c (2) | SNMP Version 2c. |
snmpverV3 (3) | SNMP Version 3. |
store_walk_objects Property
Tells the class whether or not to store returned objects.
Syntax
def get_store_walk_objects() -> bool: ... def set_store_walk_objects(value: bool) -> None: ...
store_walk_objects = property(get_store_walk_objects, set_store_walk_objects)
Default Value
TRUE
Remarks
When a walk is performed, this property tells the class whether or not to store the objects that are returned by the server in the objects collection. If the data is accumulated through the events, and not desired to be saved by the class, set this property to false.
timeout Property
A timeout for the class.
Syntax
def get_timeout() -> int: ... def set_timeout(value: int) -> None: ...
timeout = property(get_timeout, set_timeout)
Default Value
60
Remarks
If the timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.
If timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of timeout seconds.
The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If timeout expires, and the operation is not yet complete, the class fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.
The default value for the timeout property is 60 seconds.
user Property
The user name used for SNMPv3 authentication.
Syntax
def get_user() -> str: ... def set_user(value: str) -> None: ...
user = property(get_user, set_user)
Default Value
""
Remarks
If authentication is desired, this property must be set before the class attempts to connect to an SNMPv3 Agent.
walk_limit Property
The limit of oid's returned in a walk.
Syntax
def get_walk_limit() -> int: ... def set_walk_limit(value: int) -> None: ...
walk_limit = property(get_walk_limit, set_walk_limit)
Default Value
0
Remarks
This property specifies the limit of how many oid's are to be traversed during an SNMP walk. If set to 0, the class will traverse all oid's in the specified table that are lexographically greater than the value of the specified table oid.
activate Method
Activates the class.
Syntax
def activate() -> None: ...
Remarks
This method activates the component and will allow it to send or receive data.
The class will be automatically activated if it is not already and you attempt to perform an operation which requires the class to be active.
Note: Use the active property to check whether the component is active.
config Method
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
Remarks
config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
deactivate Method
Deactivates the class.
Syntax
def deactivate() -> None: ...
Remarks
This method deactivates the component and will prohibit it from sending and receiving data.
Note: Use the active property to check whether the component is active.
discover Method
Performs SNMPv3 discovery.
Syntax
def discover() -> None: ...
Remarks
When the method is called an SNMPv3 engine discovery request is sent to remote_host.
If an authentication_password is provided, the engine id discovery request is followed by an engine time discovery request, as required by the SNMPv3 User Security Model (USM). In this case timeout must be set to a non-zero value before calling Discover and the class will wait until a response is received from remote_host.
The on_discovery_response event is fired upon receipt of a valid discovery response and the values of remote_engine_id, remote_engine_boots, and remote_engine_time will then be updated with the received Engine Id, Time, and Boots.
do_events Method
Processes events from the internal message queue.
Syntax
def do_events() -> None: ...
Remarks
When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
hash_passwords Method
Hashes all passwords in the cache.
Syntax
def hash_passwords() -> None: ...
Remarks
Forces computation of all passwords hashes in the cache. Used together with the on_hash_password event to enable implementations of external password hash storage.
interrupt Method
Interrupt the current method.
Syntax
def interrupt() -> None: ...
Remarks
If there is no method in progress, interrupt simply returns, doing nothing.
reset Method
Clears the object arrays.
Syntax
def reset() -> None: ...
Remarks
Clears the object arrays, and sets the trap and error properties to their default values. This is useful for reinitializing all the properties that are used to create outgoing packets before building a new packet.
Note: snmp_version will be reset to snmpverV2c (2).
send_get_bulk_request Method
Send a GetBulkRequest packet.
Syntax
def send_get_bulk_request(non_repeaters: int, max_repetitions: int) -> None: ...
Remarks
Sends a GetBulkRequest packet. This is only available for SNMP versions 2 and 3.
NonRepeaters specifies the number of variables for which a single lexicographic successor is to be returned.
MaxRepetitions specifies the number of lexicographic successors to be returned for variables other than those in the NonRepeaters list.
The object identifiers, types, and values for the request are taken from the objects collection.
A GetBulkRequest is very similar to a GetNextRequest, the difference is that Getbulk performs a continuous GetNext operation based on the MaxRepitions value. The NonRepeaters value will determine the number of objects for which a simple GetNext operation should be performed. For the remaining variables, a continuous GetNext operation is performed based on the MaxRepitions value.
So if you send a request containing X objects, the agent will perform N simple GetNext operations and M continuous GetNext operations X - N times. With X being the number of objects received, N being the number of NonRepeaters, and M being the number of MaxRepitions. Thus the SNMPMgr is expecting to receive N + M x (X - N) objects, assuming that each object has M successors.
Example (Sending a GetBulk Request)
SNMPControl.RemoteHost = "MyAgent"
SNMPControl.ObjCount = 2
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
SNMPControl.objId(1) = "1.3.6.1.2.1.1.3.0"
SNMPControl.SendGetBulkRequest(1,4)
The code sample above will send a GetBulkRequest with 1 non repeater, and a maxrepetitions of 4. Since there is only 1 non repeater, only one ObjID will "not repeat" and will only return one successor. The rest of the ObjID's (in this case, only 1) will return 4 successors. This particular example will return the following ObjID's:
1 | 1.3.6.1.2.1.1.2.0 |
2 | 1.3.6.1.2.1.1.4.0 |
3 | 1.3.6.1.2.1.1.5.0 |
4 | 1.3.6.1.2.1.1.6.0 |
5 | 1.3.6.1.2.1.1.7.0 |
send_get_next_request Method
Send GetNextRequest packet.
Syntax
def send_get_next_request() -> None: ...
Remarks
Sends a GetNextRequest packet. The object identifiers, types, and values for the request are taken from the objects collection.
Example (Sending a GetNext Request)
SNMPControl.ObjCount = 2
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
SNMPControl.SendGetNextRequest()
The agent will respond with the "next" (relative to the ObjID(s) you specify) OID in the table.
send_get_request Method
Send GetRequest packet.
Syntax
def send_get_request() -> None: ...
Remarks
Sends a GetRequest packet. The object identifiers, types, and values for the request are taken from the objects collection.
Example (Sending a GetRequest)
SNMPControl.RemoteHost = "MyAgent"
SNMPControl.ObjCount = 2
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
SNMPControl.ObjId(1) = "1.3.6.1.2.1.1.2.0"
SNMPControl.SendGetRequest()
send_inform_request Method
Send an InformRequest packet.
Syntax
def send_inform_request() -> None: ...
Remarks
Sends an InformRequest packet. The object identifiers, types, and values for the request are taken from the objects collection.
send_set_request Method
Send Set Request packet.
Syntax
def send_set_request() -> None: ...
Remarks
Sends a SetRequest packet. The object identifiers, types, and values for the request are taken from the objects collection.
Example (Sending a SetRequest)
SNMPControl.RemoteHost = "MyAgent"
SNMPControl.ObjCount = 1
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
SNMPControl.ObjValue(0) = "New Value"
SNMPControl.ObjType(0) = otOctetString
SNMPControl.SendSetRequest()
value Method
Returns the value corresponding to an OID.
Syntax
def value(oid: str) -> str: ...
Remarks
If the OID does not exist in the objects collection, a trappable error is generated.
Please refer to the SNMPObject type for more information.
walk Method
Does an SNMP walk starting with the specified oid.
Syntax
def walk(table_oid: str) -> None: ...
Remarks
A walk will traverse all OIDs in the TableOid that are lexographically greater than the value of the TableOid.
The results of the walk may be obtained through the Response events. During the event, the current returned object will exist inside of the objects collection. If store_walk_objects is set to true, the objects collection will contain all returned objects when the walk completes.
Use the walk_limit property to regulate how many objects the walk will traverse in the table.
NOTE: The collection of objects is cleared before the walk begins.
on_bad_packet Event
Fired for erroneous and/or malformed messages.
Syntax
class SNMPMgrBadPacketEventParams(object): @property def packet() -> bytes: ... @property def source_address() -> str: ... @property def source_port() -> int: ... @property def error_code() -> int: ... @property def error_description() -> str: ... @property def report() -> bool: ... @report.setter def report(value) -> None: ... # In class SNMPMgr: @property def on_bad_packet() -> Callable[[SNMPMgrBadPacketEventParams], None]: ... @on_bad_packet.setter def on_bad_packet(event_hook: Callable[[SNMPMgrBadPacketEventParams], None]) -> None: ...
Remarks
The full message is provided in the Packet parameter.
The on_bad_packet event is also fired when authentication fails for received packets due to a bad password or other reasons.
If the Report parameter is set to True, an unauthenticated error report will be sent to the client, otherwise the packet will be silently ignored.
on_discovery_request Event
Fired when an SNMPv3 discovery packet is received.
Syntax
class SNMPMgrDiscoveryRequestEventParams(object): @property def engine_id() -> bytes: ... @property def engine_boots() -> int: ... @property def engine_time() -> int: ... @property def user() -> str: ... @property def security_level() -> int: ... @property def source_address() -> str: ... @property def source_port() -> int: ... @property def respond() -> bool: ... @respond.setter def respond(value) -> None: ... # In class SNMPMgr: @property def on_discovery_request() -> Callable[[SNMPMgrDiscoveryRequestEventParams], None]: ... @on_discovery_request.setter def on_discovery_request(event_hook: Callable[[SNMPMgrDiscoveryRequestEventParams], None]) -> None: ...
Remarks
EngineId, EngineBoots, EngineTime, and User are the values received from SourceAddress.
For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.
The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.
Respond is True by default, and will automatically send a response using the value in local_engine_id. To suppress the response, set Respond to False.
The value returned to SourceAddress for EngineBoots is always 0, and EngineTime is the number of seconds since January 1st, 1970 (GMT).
on_discovery_response Event
Fired when an SNMPv3 discovery response is received.
Syntax
class SNMPMgrDiscoveryResponseEventParams(object): @property def engine_id() -> bytes: ... @property def engine_boots() -> int: ... @property def engine_time() -> int: ... @property def user() -> str: ... @property def security_level() -> int: ... @property def source_address() -> str: ... @property def source_port() -> int: ... # In class SNMPMgr: @property def on_discovery_response() -> Callable[[SNMPMgrDiscoveryResponseEventParams], None]: ... @on_discovery_response.setter def on_discovery_response(event_hook: Callable[[SNMPMgrDiscoveryResponseEventParams], None]) -> None: ...
Remarks
EngineId, EngineBoots, EngineTime, and User are the values received from SourceAddress and SourcePort.
The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated request, SecurityLevel is at least 1.
on_error Event
Fired when information is available about errors during data delivery.
Syntax
class SNMPMgrErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class SNMPMgr: @property def on_error() -> Callable[[SNMPMgrErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[SNMPMgrErrorEventParams], None]) -> None: ...
Remarks
The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
on_hash_password Event
Fired before and after a password is hashed.
Syntax
class SNMPMgrHashPasswordEventParams(object): @property def password() -> str: ... @property def auth_algorithm() -> int: ... @property def hash() -> str: ... @hash.setter def hash(value) -> None: ... # In class SNMPMgr: @property def on_hash_password() -> Callable[[SNMPMgrHashPasswordEventParams], None]: ... @on_hash_password.setter def on_hash_password(event_hook: Callable[[SNMPMgrHashPasswordEventParams], None]) -> None: ...
Remarks
SNMPv3 passwords are hashed in order to obtain authentication and encryption keys. This is an expensive operation, and in certain situations it may be preferable to store the hashed passwords externally and supply them on demand.
If a hash is required, the event fires with an empty string in the Hash parameter. In this case, you can choose to supply a value for the hash and stop the class from computing the hash.
The event also fires every time a hash is computed. In this case, the Hash parameter contains the value of the computed hash.
AuthAlgorithm contains either 1 for HMAC-MD5-96, 2 for HMAC-SHA-96 or 3 for HMAC-192-SHA-256
on_inform_request Event
Fired when an InformRequest packet is received.
Syntax
class SNMPMgrInformRequestEventParams(object): @property def request_id() -> int: ... @property def snmp_version() -> int: ... @property def community() -> str: ... @property def user() -> str: ... @property def security_level() -> int: ... @property def source_address() -> str: ... @property def source_port() -> int: ... @property def error_index() -> int: ... @error_index.setter def error_index(value) -> None: ... @property def error_status() -> int: ... @error_status.setter def error_status(value) -> None: ... @property def error_description() -> str: ... @property def respond() -> bool: ... @respond.setter def respond(value) -> None: ... # In class SNMPMgr: @property def on_inform_request() -> Callable[[SNMPMgrInformRequestEventParams], None]: ... @on_inform_request.setter def on_inform_request(event_hook: Callable[[SNMPMgrInformRequestEventParams], None]) -> None: ...
Remarks
The user in an InformRequest packet (SNMPv3) must match the user in the user property. If not, the request is rejected, and a on_bad_packet event is fired before on_inform_request is fired.
The list of variables in the SNMP packet, including optional values and types, is provided through the objects collection. Each object is of type SNMPObject. This type describes the obj_id, obj_type, and obj_value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.
The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.
The MessageId parameter identifies the received request.
For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.
The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.
To send a response, the Respond parameter must be set to true. By default, this value is false, which means no response will be sent. The ErrorStatus parameter may also be set to a valid SNMP status code (the default value is 0, which represents no error).
The following is a list of valid SNMP status code values:
0 (noError) | No error. |
1 (tooBig) | The response cannot fit in a single SNMP message. |
2 (noSuchName) | Variable does not exist. |
3 (badValue) | Invalid value or syntax. |
4 (readOnly) | Variable is read-only. |
5 (genError) | Other error (SNMPv1). |
6 (noAccess) | Access denied. |
7 (wrongType) | Wrong object type. |
8 (wrongLength) | Wrong length. |
9 (wrongEncoding) | Wrong encoding. |
10 (wrongValue) | Wrong value. |
11 (noCreation) | No creation. |
12 (inconsistentValue) | Inconsistent value. |
13 (resourceUnavailable) | Resource unavailable. |
14 (commitFailed) | Commit failed. |
15 (undoFailed) | Undo failed. |
16 (authorizationError) | Authorization error. |
17 (notWritable) | Variable is not writable. |
18 (inconsistentName) | Inconsistent name. |
Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).
on_packet_trace Event
Fired for every packet sent or received.
Syntax
class SNMPMgrPacketTraceEventParams(object): @property def packet() -> bytes: ... @property def direction() -> int: ... @property def packet_address() -> str: ... @property def packet_port() -> int: ... # In class SNMPMgr: @property def on_packet_trace() -> Callable[[SNMPMgrPacketTraceEventParams], None]: ... @on_packet_trace.setter def on_packet_trace(event_hook: Callable[[SNMPMgrPacketTraceEventParams], None]) -> None: ...
Remarks
The on_packet_trace event shows all the packets sent or received by the class.
Packet contains the full contents of the datagram.
Direction shows the direction of the packet: 1 for incoming packets, and 2 for outgoing packets.
In the case of an incoming packet, PacketAddress and PacketPort identify the source of the packet.
In the case of an outgoing packet, PacketAddress and PacketPort identify the destination of the packet.
on_ready_to_send Event
Fired when the class is ready to send data.
Syntax
class SNMPMgrReadyToSendEventParams(object): # In class SNMPMgr: @property def on_ready_to_send() -> Callable[[SNMPMgrReadyToSendEventParams], None]: ... @on_ready_to_send.setter def on_ready_to_send(event_hook: Callable[[SNMPMgrReadyToSendEventParams], None]) -> None: ...
Remarks
The on_ready_to_send event indicates that the underlying TCP/IP subsystem is ready to accept data after a failed data_to_send.
on_report Event
Fired when a Report packet is received.
Syntax
class SNMPMgrReportEventParams(object): @property def request_id() -> int: ... @property def snmp_version() -> int: ... @property def community() -> str: ... @property def user() -> str: ... @property def security_level() -> int: ... @property def source_address() -> str: ... @property def source_port() -> int: ... @property def error_index() -> int: ... @property def error_status() -> int: ... @property def error_description() -> str: ... # In class SNMPMgr: @property def on_report() -> Callable[[SNMPMgrReportEventParams], None]: ... @on_report.setter def on_report(event_hook: Callable[[SNMPMgrReportEventParams], None]) -> None: ...
Remarks
For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.
The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.
The list of variables in the SNMP packet, including optional values and types, is provided through the objects collection. Each object is of type SNMPObject. This type describes the obj_id, obj_type, and obj_value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.
The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.
on_response Event
Fired when a GetResponse packet is received.
Syntax
class SNMPMgrResponseEventParams(object): @property def request_id() -> int: ... @property def snmp_version() -> int: ... @property def community() -> str: ... @property def user() -> str: ... @property def security_level() -> int: ... @property def source_address() -> str: ... @property def source_port() -> int: ... @property def error_index() -> int: ... @property def error_status() -> int: ... @property def error_description() -> str: ... # In class SNMPMgr: @property def on_response() -> Callable[[SNMPMgrResponseEventParams], None]: ... @on_response.setter def on_response(event_hook: Callable[[SNMPMgrResponseEventParams], None]) -> None: ...
Remarks
The ErrorStatus and ErrorIndex parameters contain information about possible errors. ErrorDescription is a textual description of ErrorStatus. This value is parsed directly from the SNMP response, which will be a one-based value, so a value of i here maps to index i-1 in the objects collection.
The following is a list of valid SNMP status code values:
0 (noError) | No error. |
1 (tooBig) | The response cannot fit in a single SNMP message. |
2 (noSuchName) | Variable does not exist. |
3 (badValue) | Invalid value or syntax. |
4 (readOnly) | Variable is read-only. |
5 (genError) | Other error (SNMPv1). |
6 (noAccess) | Access denied. |
7 (wrongType) | Wrong object type. |
8 (wrongLength) | Wrong length. |
9 (wrongEncoding) | Wrong encoding. |
10 (wrongValue) | Wrong value. |
11 (noCreation) | No creation. |
12 (inconsistentValue) | Inconsistent value. |
13 (resourceUnavailable) | Resource unavailable. |
14 (commitFailed) | Commit failed. |
15 (undoFailed) | Undo failed. |
16 (authorizationError) | Authorization error. |
17 (notWritable) | Variable is not writable. |
18 (inconsistentName) | Inconsistent name. |
Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).
The list of variables in the SNMP packet, including optional values and types, is provided through the objects collection. Each object is of type SNMPObject. This type describes the obj_id, obj_type, and obj_value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.
The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.
on_trap Event
Fired when a SNMP trap packet is received.
Syntax
class SNMPMgrTrapEventParams(object): @property def request_id() -> int: ... @property def snmp_version() -> int: ... @property def community() -> str: ... @property def user() -> str: ... @property def security_level() -> int: ... @property def trap_oid() -> str: ... @property def time_stamp() -> int: ... @property def source_address() -> str: ... @property def source_port() -> int: ... # In class SNMPMgr: @property def on_trap() -> Callable[[SNMPMgrTrapEventParams], None]: ... @on_trap.setter def on_trap(event_hook: Callable[[SNMPMgrTrapEventParams], None]) -> None: ...
Remarks
The SNMPTrapMgr class should normally be used to receive traps, since it was designed and contains functionality specifically for that purpose. The SNMPMgr component can only receive traps from the agent that it is has most recently discovered with the discover method.
The TrapOID and TimeStamp parameters contain the Trap OID and TimeStamp. In the case of an SNMPv1 trap, there are two possible scenarios:
First, if the enterprise of the trap is "1.3.6.1.6.3.1.1.5", TrapOID will be a concatenation of TrapEnterprise and GenericTrap + 1. For instance a TrapOID of "1.3.6.1.6.3.1.1.5.5" has a TrapEnterprise of "1.3.6.1.6.3.1.1.5" and a GenericTrap of "4".
Second, In all other cases TrapOID will be a concatenation of the values for TrapEnterprise, GenericTrap, and SpecificTrap, separated by '.'.
For SNMPv2 and above, they are read from the variable-value list (if available).
For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.
The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.
The SNMPMgr class is limited to accepting authenticated traps only for the user specified in user and password and from the engine specified in remote_engine_id with time parameters in remote_engine_boots and remote_engine_time (usually this is the SNMP engine discovered through the last call to discover). If authenticated traps come from a different engine, or for a different user, they are ignored, and a on_bad_packet event is fired instead.
The list of variables in the SNMP packet, including optional values and types, is provided through the objects collection. Each object is of type SNMPObject. This type describes the obj_id, obj_type, and obj_value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.
The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.
SNMPMgr Config Settings
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.SNMPManager Config Settings
When making a discovery request in SNMPv3 while this setting is set to False (default), the component will send a second discovery request even if the agent responds to the first request with the EngineBoots and EngineTime. If set to True, the component will skip the second request if all the necessary information is returned in the first response.
This setting specifies whether the class matches the source IP address in the response to the destination IP address of the request. When True (default) the class makes sure that response are received from the same IP to which the request was sent. In most cases this does not need to be changed. If there is a specific reason that responses are expected to originate from a different IP from that which the request was sent, this may be set to False. When False the class will not check the origin of received responses.
By default only packets matching snmp_version can be received. Set this to False to ignore the version of incoming packets. The default is True.
This setting will cause the component to operate in a manner different than normal so that it is compatible with third-party products and libraries. The following table lists the possible values for this setting:
0 (default) | Component operates normally for greatest compatibility. |
1 | Component uses SNMP4j-compatible encryption (AES192 and AES256). |
2 | Component automatically detects whether to use SNMP4j-compatible encryption (AES192 and AES256). Note: This option is only applicable when receiving packets. If you are using SNMPMgr or sending secure traps, you will need to select either 0 or 1. |
If set, the context engine id included in the PDU will be set.
If set, the context name included in the PDU will be set.
When set to True this setting will cause the class to decrypt packets logged in on_packet_trace. This only applies when using SNMP Version 3. The default is False.
The default value is True, which makes the class throw an error if local_port is busy. When ForceLocalPort is set to False and the port is busy, the class silently chooses another random port.
In some scenarios an agent may send a duplicate response (identified by it's RequestID). To prevent processing of a duplicate response set this to True. The default is False
When a response is received, the class will validate that the port in the response is the same as the port in the request. To disable this, set this to True.
This setting holds the engine Id of the received packet. This may be queried at any time, including from within an event, and returns the engine Id of the received packet. This is not needed in most cases, but can be used to store the incoming engine Id to send an asynchronous response later. This value is read-only.
This setting holds the context name of the received packet. This may be queried at any time, including from within an event, and returns the context name of the received packet. This is not needed in most cases, but can be used to store the incoming context name to send an asynchronous response later. This value is read-only.
This setting specifies the maximum supported message size in bytes. This is only applicable when snmp_version is set to 3. This corresponds to the "msgMaxSize" field in the request.
This setting holds the source address of the received packet. This may be queried at any time, including from within an event, and returns the source address of the received packet. This value is read-only.
This setting holds the source port of the received packet. This may be queried at any time, including from within an event, and returns the source port of the received packet. This value is read-only.
Setting TimeoutInMilliseconds to true causes the class to use the value in timeout as milliseconds instead of seconds, which is the default.
When WalkInsideRange is set to true the Walk will continue only while the OID Values returned from the agent are greater than the current OID Value. If an object is returned with an OID value that is out of this range it is not added to the objects collection, the on_error event will fire, and walk will return. The default value is true.
When this property is set and walk is called, the first request sent will contain the specified WalkStartOID value. This feature is particularly useful in the case of errors, such as timeouts, that may occur during a Walk. In such a case, you can set WalkStartOID to the last OID returned before the Timeout occurred then call walk again (using the original tableOID parameter value). This will allow you to continue the Walk where it left off (when the Timeout error occurred).
Note that when store_walk_objects is set to true and WalkStartOID is set, the existing entries in objects will be maintained when walk is called and new returned objects will be added (just as if no error occurred in the initial walk call).
UDP Config Settings
If this is set to true, the component will capture the IP packet information.
The default value for this setting is False.
Note: This setting is only available in Windows.
This setting specifies whether a hostname is resolved immediately when remote_host is set. If True the class will resolve the hostname and the IP address will be present in the remote_host property. If False, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, resolve_remote_host may called to manually resolve the value in remote_host at any time.
The default value is False.
If CaptureIPPacketInfo is set to true, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event.
Note: This setting is only available in Windows.
When set to True, packets sent by the class will have the Don't Fragment flag set. The default value is False.
The local_host setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.
local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
This setting specifies the maximum size of the datagrams that the class will accept without truncation.
UseConnection must be True to use this setting. This option allows you to specify an arbitrary DSCP value between 0 and 63. The default is 0. When set to the default value the component will not set a DSCP value.
Note: This setting uses the qWAVE API is only available on Windows 7, Windows Server 2008 R2, and later.
UseConnection must be True to use this setting. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).
Note: This setting uses the qWAVE API which is only available on Windows Vista and Windows Server 2008 or above.
Note: QOSTrafficType must be set before setting active to true.
This option must be set before the class is activated through the active property or it will have no effect.
The default value for this setting is False.
This configuration setting can be used to override the source IP address when sending a packet.
Note: This setting is only available in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).
This configuration setting can be used to override the source MAC address when sending a packet.
Note: This setting is only available in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).
UseConnection specifies whether the class should use a connected socket or not. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional TCP sense. What it means is only that the class will send and receive data only to and from the specified destination.
The default value for this setting is False.
By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True.
Socket Config Settings
If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports.
When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
When queried, this setting will return a string containing information about the product's build.
The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is True.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.
If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.
When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
SNMPMgr Errors
SNMPMgr Errors
201 Timeout. | |
301 Bad Object Index when accessing the Obj* properties. Timeout when performing an operation. Check the error description for details. | |
302 Value exceeds maximum number of objects allowed. | |
303 The value must be an IP address in dotted format. | |
305 Unsupported SNMP version. | |
306 Unknown PDU type. | |
307 The class is busy performing the current action. | |
308 Verification failed. | |
309 Missing password for Verification. | |
310 Missing signature. | |
311 Missing remote time. | |
312 Missing timeout value. | |
313 Decryption Failed. | |
314 Missing password for decryption. | |
315 Not encrypted. | |
316 Security model not supported. | |
317 Defective packet | |
318 Not from bound point. | |
319 Operation not permitted in current role. | |
320 Bad packet. | |
321 Message not authenticated. | |
322 No such oid. | |
323 Missing privacy parameter. | |
324 Bad engine id. | |
325 Bad time frame. | |
326 Bad user name. | |
327 Security level was not accepted. | |
328 Discovery failed. | |
329 Incorrect key length. | |
330 No authentication password supplied. | |
333 Returned OID was out of range. This is applicable only when WalkInsideRange is set to true. |
The class may also return one of the following error codes, which are inherited from other classes.
UDP Errors
104 UDP is already active. | |
106 You cannot change the local_port while the class is active. | |
107 You cannot change the local_host at this time. A connection is in progress. | |
109 The class must be active for this operation. | |
112 Cannot change MaxPacketSize while the class is active. | |
113 Cannot change ShareLocalPort option while the class is active. | |
114 Cannot change remote_host when UseConnection is set and the class active. | |
115 Cannot change remote_port when UseConnection is set and the class is active. | |
116 remote_port can't be zero when UseConnection is set. Please specify a valid service port number. | |
117 Cannot change UseConnection while the class is active. | |
118 Message can't be longer than MaxPacketSize. | |
119 Message too short. | |
434 Unable to convert string to selected CodePage |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |