Struct ipworkssnmp::SNMPTCPMgr

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworkssnmp::SNMPTCPMgr

Remarks

The SNMPTCPMgr struct implements a TCP-based standard SNMP Manager as specified in the SNMP RFCs. The struct supports SNMP v1, v2c, and v3.

The struct 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 struct 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 struct'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 struct through the respective properties.

By default, the struct 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 struct returns control immediately after a send, and responses are received exclusively through the on_response event.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksSNMP. Due to this, the SNMPTCPMgr struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of SNMPTCPMgr when you have finished using the instance.

Property List

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

Method List

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

Event List

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

accept_data property (SNMPTCPMgr Struct)

Enables or disables data reception.

Syntax

fn accept_data(&self ) -> Result<bool, IPWorksSNMPError> 

Default Value

true

Remarks

Setting the property to False temporarily disables data reception. Setting the property to True re-enables data reception.

This property is read-only.

Data Type

bool

active property (SNMPTCPMgr Struct)

Indicates whether the struct is active.

Syntax

fn active(&self ) -> Result<bool, IPWorksSNMPError> 

Default Value

false

Remarks

This property indicates whether the struct is currently active and can send or receive data.

The struct will be automatically activated if it is not already and you attempt to perform an operation which requires the struct to be active.

Use the activate and deactivate methods to control whether the struct is active.

This property is read-only.

Data Type

bool

authentication_password property (SNMPTCPMgr Struct)

The password used for SNMPv3 authentication.

Syntax

fn authentication_password(&self ) -> Result<String, IPWorksSNMPError> 
fn set_authentication_password(&self, value : &str) ->  Option<IPWorksSNMPError> 
fn set_authentication_password_ref(&self, value : &String) ->  Option<IPWorksSNMPError> 

Default Value

""

Remarks

Every time encryption_password, authentication_password, or remote_engine_id are set, a localized key is computed automatically, and cached internally.

Data Type

String

authentication_protocol property (SNMPTCPMgr Struct)

The authentication protocol used for SNMPv3 packets.

Syntax

fn authentication_protocol(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_authentication_protocol(&self, value : i32) ->  Option<IPWorksSNMPError> 

Possible Values

1   // HMACMD596
2   // HMACSHA96
3   // HMAC192SHA256
4   // HMAC384SHA512
5   // HMAC128SHA224
6   // HMAC256SHA384

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)
• 5 (HMAC-128-SHA-224)
• 6 (HMAC-256-SHA-384)

Data Type

i32

community property (SNMPTCPMgr Struct)

The community string used to authenticate SNMP packets.

Syntax

fn community(&self ) -> Result<String, IPWorksSNMPError> 
fn set_community(&self, value : &str) ->  Option<IPWorksSNMPError> 
fn set_community_ref(&self, value : &String) ->  Option<IPWorksSNMPError> 

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 struct.

Data Type

String

encryption_algorithm property (SNMPTCPMgr Struct)

The encryption algorithm used for SNMPv3 packets.

Syntax

fn encryption_algorithm(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_encryption_algorithm(&self, value : i32) ->  Option<IPWorksSNMPError> 

Possible Values

1   // DES
2   // AES
3   // 3DES
4   // AES192
5   // AES256

Default Value

1

Remarks

In order to use encryption, you must set the encryption_password property. The supported algorithms for encryption are:

Data Type

i32

encryption_password property (SNMPTCPMgr Struct)

The password used for SNMPv3 privacy.

Syntax

fn encryption_password(&self ) -> Result<String, IPWorksSNMPError> 
fn set_encryption_password(&self, value : &str) ->  Option<IPWorksSNMPError> 
fn set_encryption_password_ref(&self, value : &String) ->  Option<IPWorksSNMPError> 

Default Value

""

Remarks

Every time encryption_password, authentication_password, or remote_engine_id are set, a localized key is computed automatically, and cached internally.

Data Type

String

error_description property (SNMPTCPMgr Struct)

Description of the status code for the last SNMP packet received by the struct.

Syntax

fn error_description(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

"0"

Remarks

Please refer to the error_status property for more information.

This property is read-only.

Data Type

String

error_index property (SNMPTCPMgr Struct)

Index of the first variable (object) that caused an error from the last SNMP response.

Syntax

fn error_index(&self ) -> Result<i32, IPWorksSNMPError> 

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.

Data Type

i32

error_status property (SNMPTCPMgr Struct)

Status code for the last SNMP packet received by the struct.

Syntax

fn error_status(&self ) -> Result<i32, IPWorksSNMPError> 

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:

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.

Data Type

i32

local_engine_id property (SNMPTCPMgr Struct)

The Engine Id of the SNMP Manager.

Syntax

fn local_engine_id(&self ) -> Result<Vec<u8>, IPWorksSNMPError> 
fn set_local_engine_id(&self, value : Vec<u8>) ->  Option<IPWorksSNMPError> 
fn set_local_engine_id_ref(&self, value : &[u8]) ->  Option<IPWorksSNMPError> 

Default Value

""

Remarks

This property is only used for SNMPv3 packets (when snmp_version is 3).

Data Type

Vec

local_host property (SNMPTCPMgr Struct)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

fn local_host(&self ) -> Result<String, IPWorksSNMPError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksSNMPError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksSNMPError> 

Default Value

""

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the struct 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 multihomed 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.

Data Type

String

local_port property (SNMPTCPMgr Struct)

The port in the local host where the SNMP Manager is bound to.

Syntax

fn local_port(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_local_port(&self, value : i32) ->  Option<IPWorksSNMPError> 

Default Value

0

Remarks

The local_port property must be set before the struct is activated (active is set to True). It instructs the struct 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 struct 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 struct is active. Any attempt to set the local_port property when the struct is active will generate an error.

NOTE: on macOS and iOS, root permissions are required to set local_port to any value below 1024.

Data Type

i32

obj_count property (SNMPTCPMgr Struct)

The number of records in the Obj arrays.

Syntax

fn obj_count(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_obj_count(&self, value : i32) ->  Option<IPWorksSNMPError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• obj_id
• obj_type
• obj_type_string
• obj_value

The array indices start at 0 and end at obj_count - 1.

Data Type

i32

obj_type property (SNMPTCPMgr Struct)

The current object's type.

Syntax

fn obj_type(&self , ObjIndex : i32) -> Result<i32, IPWorksSNMPError> 
fn set_obj_type(&self, ObjIndex : i32, value : i32) ->  Option<IPWorksSNMPError> 

Possible Values

2   // Integer
4   // OctetString
5   // Null
6   // ObjectId
64   // IPAddress
65   // Counter32
66   // Gauge32
67   // TimeTicks
68   // Opaque
69   // NSAP
70   // Counter64
71   // UnsignedInteger32
128   // NoSuchObject
129   // NoSuchInstance
130   // EndOfMibView

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:

The struct also supports the following artificial object values used to designate error conditions:

The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.

Data Type

i32

obj_id property (SNMPTCPMgr Struct)

The current object's id which is encoded as a string of numbers separated by periods.

Syntax

fn obj_id(&self , ObjIndex : i32) -> Result<String, IPWorksSNMPError> 
fn set_obj_id(&self, ObjIndex : i32, value : &str) ->  Option<IPWorksSNMPError> 
fn set_obj_id_ref(&self, ObjIndex : i32, value : &String) ->  Option<IPWorksSNMPError> 

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 obj_object_type and obj_value properties.

Example

SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"

The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.

Data Type

String

obj_type_string property (SNMPTCPMgr Struct)

A string representation of the current object's ObjectType .

Syntax

fn obj_type_string(&self , ObjIndex : i32) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

A string representation of the current object's obj_object_type.

The corresponding object id and value are specified by the obj_oid and obj_value properties.

The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.

This property is read-only.

Data Type

String

obj_value property (SNMPTCPMgr Struct)

The current object's value.

Syntax

fn obj_value(&self , ObjIndex : i32) -> Result<Vec<u8>, IPWorksSNMPError> 
fn set_obj_value(&self, ObjIndex : i32, value : Vec<u8>) ->  Option<IPWorksSNMPError> 
fn set_obj_value_ref(&self, ObjIndex : i32, value : &[u8]) ->  Option<IPWorksSNMPError> 

Default Value

""

Remarks

The current object's value. The corresponding object id and type are specified by the obj_oid and obj_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 ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.

Data Type

Vec

remote_engine_boots property (SNMPTCPMgr Struct)

The remote engine boots (SNMPv3).

Syntax

fn remote_engine_boots(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_remote_engine_boots(&self, value : i32) ->  Option<IPWorksSNMPError> 

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.

Data Type

i32

remote_engine_id property (SNMPTCPMgr Struct)

The Engine Id of the remote agent.

Syntax

fn remote_engine_id(&self ) -> Result<Vec<u8>, IPWorksSNMPError> 
fn set_remote_engine_id(&self, value : Vec<u8>) ->  Option<IPWorksSNMPError> 
fn set_remote_engine_id_ref(&self, value : &[u8]) ->  Option<IPWorksSNMPError> 

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).

Data Type

Vec

remote_engine_time property (SNMPTCPMgr Struct)

The remote engine time (SNMPv3).

Syntax

fn remote_engine_time(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_remote_engine_time(&self, value : i32) ->  Option<IPWorksSNMPError> 

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.

Data Type

i32

remote_host property (SNMPTCPMgr Struct)

The address of the remote host. Domain names are resolved to IP addresses.

Syntax

fn remote_host(&self ) -> Result<String, IPWorksSNMPError> 
fn set_remote_host(&self, value : &str) ->  Option<IPWorksSNMPError> 
fn set_remote_host_ref(&self, value : &String) ->  Option<IPWorksSNMPError> 

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 struct 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.

Data Type

String

remote_port property (SNMPTCPMgr Struct)

The port where the remote SNMP agent is listening.

Syntax

fn remote_port(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_remote_port(&self, value : i32) ->  Option<IPWorksSNMPError> 

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.

Data Type

i32

request_id property (SNMPTCPMgr Struct)

The request-id to mark outgoing packets with.

Syntax

fn request_id(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_request_id(&self, value : i32) ->  Option<IPWorksSNMPError> 

Default Value

1

Remarks

If a custom value is needed for request_id, the property must be set before sending the request. The struct increments request_id automatically after sending each packet.

Data Type

i32

snmp_version property (SNMPTCPMgr Struct)

Version of SNMP used for outgoing requests.

Syntax

fn snmp_version(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_snmp_version(&self, value : i32) ->  Option<IPWorksSNMPError> 

Possible Values

1   // V1
2   // V2c
3   // V3

Default Value

2

Remarks

This property takes one of the following values:

Data Type

i32

ssl_accept_server_cert_effective_date property (SNMPTCPMgr Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_expiration_date property (SNMPTCPMgr Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_extended_key_usage property (SNMPTCPMgr Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint property (SNMPTCPMgr Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha1 property (SNMPTCPMgr Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha256 property (SNMPTCPMgr Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_accept_server_cert_issuer property (SNMPTCPMgr Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key property (SNMPTCPMgr Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (SNMPTCPMgr Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, IPWorksSNMPError> 

Default Value

false

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (SNMPTCPMgr Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (SNMPTCPMgr Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_algorithm property (SNMPTCPMgr Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_length property (SNMPTCPMgr Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, IPWorksSNMPError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_serial_number property (SNMPTCPMgr Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_accept_server_cert_signature_algorithm property (SNMPTCPMgr Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_store property (SNMPTCPMgr Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksSNMPError> 
fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksSNMPError> 
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksSNMPError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_accept_server_cert_store_password property (SNMPTCPMgr Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_accept_server_cert_store_password(&self ) -> Result<String, IPWorksSNMPError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<IPWorksSNMPError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksSNMPError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_accept_server_cert_store_type property (SNMPTCPMgr Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<IPWorksSNMPError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (SNMPTCPMgr Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (SNMPTCPMgr Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha1 property (SNMPTCPMgr Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha256 property (SNMPTCPMgr Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage property (SNMPTCPMgr Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage_flags property (SNMPTCPMgr Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, IPWorksSNMPError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (SNMPTCPMgr Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_accept_server_cert_subject property (SNMPTCPMgr Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_accept_server_cert_subject(&self ) -> Result<String, IPWorksSNMPError> 
fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<IPWorksSNMPError> 
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<IPWorksSNMPError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_accept_server_cert_encoded property (SNMPTCPMgr Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksSNMPError> 
fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksSNMPError> 
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksSNMPError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

Data Type

Vec

ssl_authenticate_clients property (SNMPTCPMgr Struct)

If set to True, the server asks the client(s) for a certificate.

Syntax

fn ssl_authenticate_clients(&self ) -> Result<bool, IPWorksSNMPError> 
fn set_ssl_authenticate_clients(&self, value : bool) ->  Option<IPWorksSNMPError> 

Default Value

false

Remarks

This property is used in conjunction with the on_ssl_client_authentication event. Please refer to the documentation of the on_ssl_client_authentication event for details.

Data Type

bool

ssl_cert_effective_date property (SNMPTCPMgr Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (SNMPTCPMgr Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (SNMPTCPMgr Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (SNMPTCPMgr Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (SNMPTCPMgr Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (SNMPTCPMgr Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_cert_issuer property (SNMPTCPMgr Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_cert_private_key property (SNMPTCPMgr Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (SNMPTCPMgr Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, IPWorksSNMPError> 

Default Value

false

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (SNMPTCPMgr Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (SNMPTCPMgr Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (SNMPTCPMgr Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (SNMPTCPMgr Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, IPWorksSNMPError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (SNMPTCPMgr Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (SNMPTCPMgr Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_store property (SNMPTCPMgr Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, IPWorksSNMPError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksSNMPError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksSNMPError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_cert_store_password property (SNMPTCPMgr Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, IPWorksSNMPError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksSNMPError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksSNMPError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_cert_store_type property (SNMPTCPMgr Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<IPWorksSNMPError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_cert_subject_alt_names property (SNMPTCPMgr Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (SNMPTCPMgr Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (SNMPTCPMgr Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (SNMPTCPMgr Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_usage property (SNMPTCPMgr Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (SNMPTCPMgr Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, IPWorksSNMPError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_cert_version property (SNMPTCPMgr Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_cert_subject property (SNMPTCPMgr Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, IPWorksSNMPError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<IPWorksSNMPError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<IPWorksSNMPError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_cert_encoded property (SNMPTCPMgr Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksSNMPError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksSNMPError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksSNMPError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

Data Type

Vec

ssl_enabled property (SNMPTCPMgr Struct)

Whether TLS/SSL is enabled.

Syntax

fn ssl_enabled(&self ) -> Result<bool, IPWorksSNMPError> 
fn set_ssl_enabled(&self, value : bool) ->  Option<IPWorksSNMPError> 

Default Value

false

Remarks

This setting specifies whether TLS/SSL is enabled in the struct. When False (default) the struct operates in plaintext mode. When True TLS/SSL is enabled.

Data Type

bool

ssl_server_cert_effective_date property (SNMPTCPMgr Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_expiration_date property (SNMPTCPMgr Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_extended_key_usage property (SNMPTCPMgr Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint property (SNMPTCPMgr Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha1 property (SNMPTCPMgr Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha256 property (SNMPTCPMgr Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_server_cert_issuer property (SNMPTCPMgr Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_private_key property (SNMPTCPMgr Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (SNMPTCPMgr Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self ) -> Result<bool, IPWorksSNMPError> 

Default Value

false

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (SNMPTCPMgr Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_server_cert_private_key_container(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (SNMPTCPMgr Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_algorithm property (SNMPTCPMgr Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_length property (SNMPTCPMgr Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_server_cert_public_key_length(&self ) -> Result<i32, IPWorksSNMPError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_server_cert_serial_number property (SNMPTCPMgr Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_server_cert_signature_algorithm property (SNMPTCPMgr Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_store property (SNMPTCPMgr Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksSNMPError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Vec

ssl_server_cert_store_password property (SNMPTCPMgr Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_server_cert_store_password(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

ssl_server_cert_store_type property (SNMPTCPMgr Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self ) -> Result<i32, IPWorksSNMPError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (SNMPTCPMgr Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (SNMPTCPMgr Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha1 property (SNMPTCPMgr Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha256 property (SNMPTCPMgr Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_usage property (SNMPTCPMgr Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_server_cert_usage_flags property (SNMPTCPMgr Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self ) -> Result<i32, IPWorksSNMPError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_server_cert_version property (SNMPTCPMgr Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_server_cert_subject property (SNMPTCPMgr Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self ) -> Result<String, IPWorksSNMPError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (SNMPTCPMgr Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksSNMPError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

Data Type

Vec

store_walk_objects property (SNMPTCPMgr Struct)

Tells the struct whether or not to store returned objects.

Syntax

fn store_walk_objects(&self ) -> Result<bool, IPWorksSNMPError> 
fn set_store_walk_objects(&self, value : bool) ->  Option<IPWorksSNMPError> 

Default Value

true

Remarks

When a walk is performed, this property tells the struct 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 struct, set this property to false.

Data Type

bool

timeout property (SNMPTCPMgr Struct)

This property includes the timeout for the struct.

Syntax

fn timeout(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_timeout(&self, value : i32) ->  Option<IPWorksSNMPError> 

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 struct will wait for the operation to complete before returning control. The struct will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of timeout seconds.

The struct 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 struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, 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.

Data Type

i32

user property (SNMPTCPMgr Struct)

The user name used for SNMPv3 authentication.

Syntax

fn user(&self ) -> Result<String, IPWorksSNMPError> 
fn set_user(&self, value : &str) ->  Option<IPWorksSNMPError> 
fn set_user_ref(&self, value : &String) ->  Option<IPWorksSNMPError> 

Default Value

""

Remarks

If authentication is desired, this property must be set before the struct attempts to connect to an SNMPv3 Agent.

Data Type

String

walk_limit property (SNMPTCPMgr Struct)

The limit of oid's returned in a walk.

Syntax

fn walk_limit(&self ) -> Result<i32, IPWorksSNMPError> 
fn set_walk_limit(&self, value : i32) ->  Option<IPWorksSNMPError> 

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 struct will traverse all oid's in the specified table that are lexicographically greater than the value of the specified table oid.

Data Type

i32

activate method (SNMPTCPMgr Struct)

Activates the struct.

Syntax

fn activate(&self) -> Result<(), IPWorksSNMPError>

Remarks

This method activates the component and will allow it to send or receive data.

The struct will be automatically activated if it is not already and you attempt to perform an operation which requires the struct to be active.

NOTE: Use the active property to check whether the component is active.

config method (SNMPTCPMgr Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksSNMPError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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 (SNMPTCPMgr Struct)

Deactivates the struct.

Syntax

fn deactivate(&self) -> Result<(), IPWorksSNMPError>

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 (SNMPTCPMgr Struct)

Performs SNMPv3 discovery.

Syntax

fn discover(&self) -> Result<(), IPWorksSNMPError>

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 struct 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 (SNMPTCPMgr Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksSNMPError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

hash_passwords method (SNMPTCPMgr Struct)

Hashes all passwords in the cache.

Syntax

fn hash_passwords(&self) -> Result<(), IPWorksSNMPError>

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 (SNMPTCPMgr Struct)

This method interrupts the current method.

Syntax

fn interrupt(&self) -> Result<(), IPWorksSNMPError>

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

reset method (SNMPTCPMgr Struct)

Clears the object arrays.

Syntax

fn reset(&self) -> Result<(), IPWorksSNMPError>

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 (SNMPTCPMgr Struct)

Send a GetBulkRequest packet.

Syntax

fn send_get_bulk_request(&self, non_repeaters : i32, max_repetitions : i32) -> Result<(), IPWorksSNMPError>

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 MaxRepetitions 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 MaxRepetitions 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 MaxRepetitions. 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:

send_get_next_request method (SNMPTCPMgr Struct)

Send GetNextRequest packet.

Syntax

fn send_get_next_request(&self) -> Result<(), IPWorksSNMPError>

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 (SNMPTCPMgr Struct)

Send GetRequest packet.

Syntax

fn send_get_request(&self) -> Result<(), IPWorksSNMPError>

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 (SNMPTCPMgr Struct)

Send an InformRequest packet.

Syntax

fn send_inform_request(&self) -> Result<(), IPWorksSNMPError>

Remarks

Sends an InformRequest packet. The object identifiers, types, and values for the request are taken from the objects collection.

send_set_request method (SNMPTCPMgr Struct)

Send Set Request packet.

Syntax

fn send_set_request(&self) -> Result<(), IPWorksSNMPError>

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 (SNMPTCPMgr Struct)

Returns the value corresponding to an OID.

Syntax

fn value(&self, oid : &str) ->  Result<String, IPWorksSNMPError>

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 (SNMPTCPMgr Struct)

Does an SNMP walk starting with the specified oid.

Syntax

fn walk(&self, table_oid : &str) -> Result<(), IPWorksSNMPError>

Remarks

A walk will traverse all OIDs in the TableOid that are lexicographically 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 (SNMPTCPMgr Struct)

Fired for erroneous and/or malformed messages.

Syntax

// SNMPTCPMgrBadPacketEventArgs carries the SNMPTCPMgr BadPacket event's parameters.
pub struct SNMPTCPMgrBadPacketEventArgs {
  fn packet(&self) -> &[u8]
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
  fn error_code(&self) -> i32
  fn error_description(&self) -> &String
  fn report(&self) -> bool
  fn set_report(&self, value : bool)
}

// SNMPTCPMgrBadPacketEvent defines the signature of the SNMPTCPMgr BadPacket event's handler function.
pub trait SNMPTCPMgrBadPacketEvent {
  fn on_bad_packet(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrBadPacketEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_bad_packet(&self) -> &'a dyn SNMPTCPMgrBadPacketEvent;
  pub fn set_on_bad_packet(&mut self, value : &'a dyn SNMPTCPMgrBadPacketEvent);
  ...
}

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_connected event (SNMPTCPMgr Struct)

Fired immediately after a connection completes (or fails).

Syntax

// SNMPTCPMgrConnectedEventArgs carries the SNMPTCPMgr Connected event's parameters.
pub struct SNMPTCPMgrConnectedEventArgs {
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// SNMPTCPMgrConnectedEvent defines the signature of the SNMPTCPMgr Connected event's handler function.
pub trait SNMPTCPMgrConnectedEvent {
  fn on_connected(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrConnectedEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_connected(&self) -> &'a dyn SNMPTCPMgrConnectedEvent;
  pub fn set_on_connected(&mut self, value : &'a dyn SNMPTCPMgrConnectedEvent);
  ...
}

Remarks

This event fires after a connection completes or fails.

StatusCode is the value returned by the system TCP/IP stack. This will be 0 if the connection was successful.

Description contains a human readable description of the status. This will be "OK" if the connection was successful.

RemoteAddress is the IP address of the remote host.

RemotePort is the port on the remote host.

on_connection_status event (SNMPTCPMgr Struct)

This event is fired to indicate changes in the connection state.

Syntax

// SNMPTCPMgrConnectionStatusEventArgs carries the SNMPTCPMgr ConnectionStatus event's parameters.
pub struct SNMPTCPMgrConnectionStatusEventArgs {
  fn connection_event(&self) -> &String
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// SNMPTCPMgrConnectionStatusEvent defines the signature of the SNMPTCPMgr ConnectionStatus event's handler function.
pub trait SNMPTCPMgrConnectionStatusEvent {
  fn on_connection_status(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrConnectionStatusEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_connection_status(&self) -> &'a dyn SNMPTCPMgrConnectionStatusEvent;
  pub fn set_on_connection_status(&mut self, value : &'a dyn SNMPTCPMgrConnectionStatusEvent);
  ...
}

Remarks

The on_connection_status event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Description contains a description of this code. The value of StatusCode is equal to the value of the error.

on_disconnected event (SNMPTCPMgr Struct)

Fired when a connection is closed.

Syntax

// SNMPTCPMgrDisconnectedEventArgs carries the SNMPTCPMgr Disconnected event's parameters.
pub struct SNMPTCPMgrDisconnectedEventArgs {
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// SNMPTCPMgrDisconnectedEvent defines the signature of the SNMPTCPMgr Disconnected event's handler function.
pub trait SNMPTCPMgrDisconnectedEvent {
  fn on_disconnected(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrDisconnectedEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_disconnected(&self) -> &'a dyn SNMPTCPMgrDisconnectedEvent;
  pub fn set_on_disconnected(&mut self, value : &'a dyn SNMPTCPMgrDisconnectedEvent);
  ...
}

Remarks

This event fires after a connection is broken.

StatusCode is the value returned by the system TCP/IP stack. This will be 0 if the connection was broken normally.

Description contains a human readable description of the status. This will be "OK" if the connection was broken normally.

RemoteAddress is the IP address of the remote host.

RemotePort is the port on the remote host.

on_discovery_request event (SNMPTCPMgr Struct)

Fired when an SNMPv3 discovery packet is received.

Syntax

// SNMPTCPMgrDiscoveryRequestEventArgs carries the SNMPTCPMgr DiscoveryRequest event's parameters.
pub struct SNMPTCPMgrDiscoveryRequestEventArgs {
  fn engine_id(&self) -> &[u8]
  fn engine_boots(&self) -> i32
  fn engine_time(&self) -> i32
  fn user(&self) -> &String
  fn security_level(&self) -> i32
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
  fn respond(&self) -> bool
  fn set_respond(&self, value : bool)
}

// SNMPTCPMgrDiscoveryRequestEvent defines the signature of the SNMPTCPMgr DiscoveryRequest event's handler function.
pub trait SNMPTCPMgrDiscoveryRequestEvent {
  fn on_discovery_request(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrDiscoveryRequestEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_discovery_request(&self) -> &'a dyn SNMPTCPMgrDiscoveryRequestEvent;
  pub fn set_on_discovery_request(&mut self, value : &'a dyn SNMPTCPMgrDiscoveryRequestEvent);
  ...
}

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 (SNMPTCPMgr Struct)

Fired when an SNMPv3 discovery response is received.

Syntax

// SNMPTCPMgrDiscoveryResponseEventArgs carries the SNMPTCPMgr DiscoveryResponse event's parameters.
pub struct SNMPTCPMgrDiscoveryResponseEventArgs {
  fn engine_id(&self) -> &[u8]
  fn engine_boots(&self) -> i32
  fn engine_time(&self) -> i32
  fn user(&self) -> &String
  fn security_level(&self) -> i32
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
}

// SNMPTCPMgrDiscoveryResponseEvent defines the signature of the SNMPTCPMgr DiscoveryResponse event's handler function.
pub trait SNMPTCPMgrDiscoveryResponseEvent {
  fn on_discovery_response(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrDiscoveryResponseEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_discovery_response(&self) -> &'a dyn SNMPTCPMgrDiscoveryResponseEvent;
  pub fn set_on_discovery_response(&mut self, value : &'a dyn SNMPTCPMgrDiscoveryResponseEvent);
  ...
}

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 (SNMPTCPMgr Struct)

Fired when information is available about errors during data delivery.

Syntax

// SNMPTCPMgrErrorEventArgs carries the SNMPTCPMgr Error event's parameters.
pub struct SNMPTCPMgrErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// SNMPTCPMgrErrorEvent defines the signature of the SNMPTCPMgr Error event's handler function.
pub trait SNMPTCPMgrErrorEvent {
  fn on_error(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrErrorEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_error(&self) -> &'a dyn SNMPTCPMgrErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn SNMPTCPMgrErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code 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 (SNMPTCPMgr Struct)

Fired before and after a password is hashed.

Syntax

// SNMPTCPMgrHashPasswordEventArgs carries the SNMPTCPMgr HashPassword event's parameters.
pub struct SNMPTCPMgrHashPasswordEventArgs {
  fn password(&self) -> &String
  fn auth_algorithm(&self) -> i32
  fn hash(&self) -> &String
  fn set_hash(&self, value : &str)
  fn set_hash_ref(&self, value : &String)
}

// SNMPTCPMgrHashPasswordEvent defines the signature of the SNMPTCPMgr HashPassword event's handler function.
pub trait SNMPTCPMgrHashPasswordEvent {
  fn on_hash_password(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrHashPasswordEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_hash_password(&self) -> &'a dyn SNMPTCPMgrHashPasswordEvent;
  pub fn set_on_hash_password(&mut self, value : &'a dyn SNMPTCPMgrHashPasswordEvent);
  ...
}

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 struct 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 (SNMPTCPMgr Struct)

Fired when an InformRequest packet is received.

Syntax

// SNMPTCPMgrInformRequestEventArgs carries the SNMPTCPMgr InformRequest event's parameters.
pub struct SNMPTCPMgrInformRequestEventArgs {
  fn request_id(&self) -> i32
  fn snmp_version(&self) -> i32
  fn community(&self) -> &String
  fn user(&self) -> &String
  fn security_level(&self) -> i32
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
  fn error_index(&self) -> i32
  fn set_error_index(&self, value : i32)
  fn error_status(&self) -> i32
  fn set_error_status(&self, value : i32)
  fn error_description(&self) -> &String
  fn respond(&self) -> bool
  fn set_respond(&self, value : bool)
}

// SNMPTCPMgrInformRequestEvent defines the signature of the SNMPTCPMgr InformRequest event's handler function.
pub trait SNMPTCPMgrInformRequestEvent {
  fn on_inform_request(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrInformRequestEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_inform_request(&self) -> &'a dyn SNMPTCPMgrInformRequestEvent;
  pub fn set_on_inform_request(&mut self, value : &'a dyn SNMPTCPMgrInformRequestEvent);
  ...
}

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:

Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).

on_packet_trace event (SNMPTCPMgr Struct)

Fired for every packet sent or received.

Syntax

// SNMPTCPMgrPacketTraceEventArgs carries the SNMPTCPMgr PacketTrace event's parameters.
pub struct SNMPTCPMgrPacketTraceEventArgs {
  fn packet(&self) -> &[u8]
  fn direction(&self) -> i32
  fn packet_address(&self) -> &String
  fn packet_port(&self) -> i32
}

// SNMPTCPMgrPacketTraceEvent defines the signature of the SNMPTCPMgr PacketTrace event's handler function.
pub trait SNMPTCPMgrPacketTraceEvent {
  fn on_packet_trace(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrPacketTraceEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_packet_trace(&self) -> &'a dyn SNMPTCPMgrPacketTraceEvent;
  pub fn set_on_packet_trace(&mut self, value : &'a dyn SNMPTCPMgrPacketTraceEvent);
  ...
}

Remarks

The on_packet_trace event shows all the packets sent or received by the struct.

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 (SNMPTCPMgr Struct)

Fired when the struct is ready to send data.

Syntax

// SNMPTCPMgrReadyToSendEventArgs carries the SNMPTCPMgr ReadyToSend event's parameters.
pub struct SNMPTCPMgrReadyToSendEventArgs {
}

// SNMPTCPMgrReadyToSendEvent defines the signature of the SNMPTCPMgr ReadyToSend event's handler function.
pub trait SNMPTCPMgrReadyToSendEvent {
  fn on_ready_to_send(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrReadyToSendEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_ready_to_send(&self) -> &'a dyn SNMPTCPMgrReadyToSendEvent;
  pub fn set_on_ready_to_send(&mut self, value : &'a dyn SNMPTCPMgrReadyToSendEvent);
  ...
}

Remarks

The on_ready_to_send event indicates that the underlying TCP/IP subsystem is ready to accept data after a failed DataToSend(TBD. DataToSend is removed).

on_report event (SNMPTCPMgr Struct)

Fired when a Report packet is received.

Syntax

// SNMPTCPMgrReportEventArgs carries the SNMPTCPMgr Report event's parameters.
pub struct SNMPTCPMgrReportEventArgs {
  fn request_id(&self) -> i32
  fn snmp_version(&self) -> i32
  fn community(&self) -> &String
  fn user(&self) -> &String
  fn security_level(&self) -> i32
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
  fn error_index(&self) -> i32
  fn error_status(&self) -> i32
  fn error_description(&self) -> &String
}

// SNMPTCPMgrReportEvent defines the signature of the SNMPTCPMgr Report event's handler function.
pub trait SNMPTCPMgrReportEvent {
  fn on_report(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrReportEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_report(&self) -> &'a dyn SNMPTCPMgrReportEvent;
  pub fn set_on_report(&mut self, value : &'a dyn SNMPTCPMgrReportEvent);
  ...
}

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 (SNMPTCPMgr Struct)

Fired when a GetResponse packet is received.

Syntax

// SNMPTCPMgrResponseEventArgs carries the SNMPTCPMgr Response event's parameters.
pub struct SNMPTCPMgrResponseEventArgs {
  fn request_id(&self) -> i32
  fn snmp_version(&self) -> i32
  fn community(&self) -> &String
  fn user(&self) -> &String
  fn security_level(&self) -> i32
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
  fn error_index(&self) -> i32
  fn error_status(&self) -> i32
  fn error_description(&self) -> &String
}

// SNMPTCPMgrResponseEvent defines the signature of the SNMPTCPMgr Response event's handler function.
pub trait SNMPTCPMgrResponseEvent {
  fn on_response(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrResponseEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_response(&self) -> &'a dyn SNMPTCPMgrResponseEvent;
  pub fn set_on_response(&mut self, value : &'a dyn SNMPTCPMgrResponseEvent);
  ...
}

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:

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_ssl_client_authentication event (SNMPTCPMgr Struct)

Fired when the client presents its credentials to the server.

Syntax

// SNMPTCPMgrSSLClientAuthenticationEventArgs carries the SNMPTCPMgr SSLClientAuthentication event's parameters.
pub struct SNMPTCPMgrSSLClientAuthenticationEventArgs {
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SNMPTCPMgrSSLClientAuthenticationEvent defines the signature of the SNMPTCPMgr SSLClientAuthentication event's handler function.
pub trait SNMPTCPMgrSSLClientAuthenticationEvent {
  fn on_ssl_client_authentication(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrSSLClientAuthenticationEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_ssl_client_authentication(&self) -> &'a dyn SNMPTCPMgrSSLClientAuthenticationEvent;
  pub fn set_on_ssl_client_authentication(&mut self, value : &'a dyn SNMPTCPMgrSSLClientAuthenticationEvent);
  ...
}

Remarks

This event fires when a client connects to the struct and presents a certificate for authentication. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

RemoteAddress is the IP address of the connecting client.

RemotePort is the source port of the connecting client.

CertEncoded is the base64 encoded certificate presented by the client.

CertSubject is the subject of the certificate presented by the client.

CertIssuer is the subject of the issuer of the certificate presented by the client.

Status is the status of the certificate.

Accept defines whether the certificate is accepted.

on_ssl_server_authentication event (SNMPTCPMgr Struct)

Fires when connecting to the server.

Syntax

// SNMPTCPMgrSSLServerAuthenticationEventArgs carries the SNMPTCPMgr SSLServerAuthentication event's parameters.
pub struct SNMPTCPMgrSSLServerAuthenticationEventArgs {
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SNMPTCPMgrSSLServerAuthenticationEvent defines the signature of the SNMPTCPMgr SSLServerAuthentication event's handler function.
pub trait SNMPTCPMgrSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrSSLServerAuthenticationEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn SNMPTCPMgrSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn SNMPTCPMgrSSLServerAuthenticationEvent);
  ...
}

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

RemoteAddress is the IP address of the server.

RemotePort is the source port of the server.

CertEncoded is the base64 encoded certificate presented by the server.

CertSubject is the subject of the certificate presented by the server.

CertIssuer is the subject of the issuer of the certificate presented by the server.

Status is the status of the certificate.

Accept defines whether the certificate is accepted.

on_ssl_status event (SNMPTCPMgr Struct)

Shows the progress of the secure connection.

Syntax

// SNMPTCPMgrSSLStatusEventArgs carries the SNMPTCPMgr SSLStatus event's parameters.
pub struct SNMPTCPMgrSSLStatusEventArgs {
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn message(&self) -> &String
}

// SNMPTCPMgrSSLStatusEvent defines the signature of the SNMPTCPMgr SSLStatus event's handler function.
pub trait SNMPTCPMgrSSLStatusEvent {
  fn on_ssl_status(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrSSLStatusEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn SNMPTCPMgrSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn SNMPTCPMgrSSLStatusEvent);
  ...
}

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

RemoteAddress is the IP address of the remote machine.

RemotePort is the port of the remote machine.

Message is the log message.

on_trap event (SNMPTCPMgr Struct)

Fired when a SNMP trap packet is received.

Syntax

// SNMPTCPMgrTrapEventArgs carries the SNMPTCPMgr Trap event's parameters.
pub struct SNMPTCPMgrTrapEventArgs {
  fn request_id(&self) -> i32
  fn snmp_version(&self) -> i32
  fn community(&self) -> &String
  fn user(&self) -> &String
  fn security_level(&self) -> i32
  fn trap_oid(&self) -> &String
  fn time_stamp(&self) -> i64
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
}

// SNMPTCPMgrTrapEvent defines the signature of the SNMPTCPMgr Trap event's handler function.
pub trait SNMPTCPMgrTrapEvent {
  fn on_trap(&self, sender : SNMPTCPMgr, e : &mut SNMPTCPMgrTrapEventArgs);
}

impl <'a> SNMPTCPMgr<'a> {
  pub fn on_trap(&self) -> &'a dyn SNMPTCPMgrTrapEvent;
  pub fn set_on_trap(&mut self, value : &'a dyn SNMPTCPMgrTrapEvent);
  ...
}

Remarks

The SNMPTrapMgr struct 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 struct 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.

Config Settings (SNMPTCPMgr Struct)

SNMPTCPManager Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (SNMPTCPMgr Struct)

SNMPTCPMgr Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors