Struct ipworkssnmp::SNMPAgent

Properties   Methods   Events   Config Settings   Errors  

The SNMPAgent struct is used to implement UDP-based SNMP Agent Applications.

Syntax

ipworkssnmp::SNMPAgent

Remarks

The SNMPAgent struct implements a UDP-based standard SNMP Agent as specified in the SNMP RFCs. The struct supports SNMP v1, v2c, and v3.

SNMP over DTLS is also supported when ssl_enabled is set to True. When acting as a client, the on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status event provides information about the DTLS handshake. Additional SSL-related settings are also supported through the config method. When acting as a server, the SSLCert properties are used to select a certificate for the server. When client authentication is required, the ssl_authenticate_clients property can be set to True and the on_ssl_client_authentication event can be used to examine client credentials.

The struct provides both encoding/decoding and transport capabilities, making the task of developing a custom SNMP agent as simple as setting a few key properties and handling a few events. SNMP data such as SNMP object id-s (OID-s) are exchanged as text strings, thus further simplifying the task of handling them.

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

The struct operates asynchronously. Requests are received through events such as on_get_request, on_get_bulk_request, on_get_next_request, etc. and the corresponding responses are automatically sent when the events return. Traps are sent through the send_trap method.

SNMPv3 USM security passwords are requested through the on_get_user_password event, and event parameters such as User and SecurityLevel provide information about the security attributes of received requests, and enable granular decision capability about what to provide and what not to provide. The send_secure_trap method is used to send authenticated (secure) SNMPv3 traps.

The add_user, remove_user, show_cache, and clear_cache methods are used to manage an internal authentication cache. This internal cache can be used as an alternative to the on_get_user_password event, automatically checking the cache against the security parameters provided in the request signature.

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

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

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 SNMPAgent struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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

local_engine_id property (SNMPAgent Struct)

The Engine Id of the SNMP Agent.

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

The port in the local host where the struct listens.

Syntax

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

Default Value

161

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 (default 161).

You may also set local_port to 0. This allows the TCP/IP stack to choose a port at random. The value chosen is provided via the local_port property after the struct is activated through the active property.

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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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

request_id property (SNMPAgent 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 (SNMPAgent Struct)

Version of SNMP used for outgoing requests (traps).

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

Whether DTLS 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 DTLS is enabled in the struct. When False (default) the struct operates in plaintext mode. When True DTLS is enabled.

Data Type

bool

ssl_server_cert_effective_date property (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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 (SNMPAgent 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

sys_up_time property (SNMPAgent Struct)

Time passed since the agent was initialized (in hundredths of a second).

Syntax

fn sys_up_time(&self ) -> Result<i64, IPWorksSNMPError> 
fn set_sys_up_time(&self, value : i64) ->  Option<IPWorksSNMPError> 

Default Value

0

Remarks

This property is used when sending SNMP traps, and it normally provides the time since the system was restarted in 1/100s of a second.

If another value is desired, you may set this property to a custom value. From that point on, sys_up_time will return the value set plus time elapsed.

Data Type

i64

activate method (SNMPAgent 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.

add_user method (SNMPAgent Struct)

Adds a user to the internal authentication cache.

Syntax

fn add_user(&self, user : &str, authentication_protocol : i32, authentication_password : &str, encryption_algorithm : i32, encryption_password : &str) -> Result<(), IPWorksSNMPError>

Remarks

The internal authentication cache can be used as an alternative to the on_get_user_password event, automatically checking the cache against the security parameters provided in the request signature.

The show_cache method is used to show the contents of the internal authentication cache.

The clear_cache method can be used to completely clear the cache.

Valid Authentication Protocols are:

Valid Encryption Algorithms are:

NOTE: Specifying an authentication protocol of 0 is a special case where the struct will attempt to verify users with all valid authentication protocols.

clear_cache method (SNMPAgent Struct)

Clears the internal authentication database.

Syntax

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

Remarks

All user records are removed from the internal authentication cache as a result of this call.

config method (SNMPAgent 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 (SNMPAgent 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.

do_events method (SNMPAgent 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 (SNMPAgent 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.

pause_data method (SNMPAgent Struct)

This method pauses data reception.

Syntax

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

Remarks

This method pauses data reception when called. While data reception is paused, the on_data_in event will not fire. Call process_data to reenable data reception.

process_data method (SNMPAgent Struct)

This method reenables data reception after a call to PauseData .

Syntax

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

Remarks

This method reenables data reception after a previous call to pause_data. When pause_data is called, the on_data_in event will not fire. To reenable data reception and allow on_data_in to fire, call this method.

NOTE: This method is used only after previously calling pause_data. It does not need to be called to process incoming data by default.

remove_user method (SNMPAgent Struct)

Removes the user specified by User from the internal authentication cache.

Syntax

fn remove_user(&self, user : &str) -> Result<(), IPWorksSNMPError>

Remarks

The internal authentication cache can be used as an alternative to the on_get_user_password event, automatically checking the cache against the security parameters provided in the request signature.

The show_cache method is used to show the contents of the internal authentication cache.

The clear_cache method can be used to completely clear the cache.

reset method (SNMPAgent 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_response method (SNMPAgent Struct)

Sends a response packet to a Get, Get-Next, Get-Bulk, or Set request.

Syntax

fn send_response(&self, remote_host : &str, remote_port : i32, request_id : i32, community : &str, error_status : i32, error_index : i32) -> Result<(), IPWorksSNMPError>

Remarks

Use this method to send asynchronous response packets. A valid RequestId must be specified. send_response sends an unauthenticated response packet. Depending upon the value of the snmp_version property, the packet is constructed as an SNMPv1, SNMPv2c, or SNMPv3 (unauthenticated) response PDU. To send authenticated or encrypted SNMPv3 responses, use send_secure_response

The RemoteHost and RemotePort parameters are used to determine where the response is to be sent. The object identifiers, types, and values for the request are taken from the objects collection. The RequestId, Community, ErrorStatus, and ErrorIndex parameters are used to specify other properties of the response.

send_secure_response method (SNMPAgent Struct)

Sends an authenticated and/or encrypted SNMPv3 response.

Syntax

fn send_secure_response(&self, remote_host : &str, remote_port : i32, request_id : i32, message_id : i32, error_status : i32, error_index : i32, user : &str, authentication_protocol : i32, authentication_password : &str, encryption_algorithm : i32, encryption_password : &str) -> Result<(), IPWorksSNMPError>

Remarks

Similar to the send_response method except that User, Authentication Protocol, and AuthenticationPassword are used to authenticate the response. EncryptionAlgorithm and EncryptionPassword (if not empty) are used to encrypt the response.

The MessageId argument must match the MessageId parameter obtained from the on_get_request, on_get_next_request, on_set_request, or on_get_bulk_request event.

The user and password arguments used to send the response will be added to the internal user cache. If the user is already in the cache, its passwords will be updated with those supplied.

Valid Authentication Protocols are:

Valid Encryption Algorithms are:

send_secure_trap method (SNMPAgent Struct)

Sends an authenticated and/or encrypted SNMPv3 trap.

Syntax

fn send_secure_trap(&self, remote_host : &str, trap_oid : &str, user : &str, authentication_protocol : i32, authentication_password : &str, encryption_algorithm : i32, encryption_password : &str) -> Result<(), IPWorksSNMPError>

Remarks

Similar to the send_trap method except that User, AuthenticationPassword, and Authentication Protocol are used to authenticate the trap. EncryptionPassword (if not empty) and EncryptionAlgorithm are used to encrypt the message.

The user and password arguments used to send the trap will be added to the internal user cache. If the user is already in the cache, its passwords will be updated with those supplied.

Valid Authentication Protocols are:

Valid Encryption Algorithms are:

send_trap method (SNMPAgent Struct)

Sends an SNMP Trap.

Syntax

fn send_trap(&self, remote_host : &str, trap_oid : &str) -> Result<(), IPWorksSNMPError>

Remarks

Depending upon the value of the snmp_version property, the packet is constructed as an SNMPv1 or SNMPv2 Trap PDU. The following configuration settings provide more control about how traps are generated: TrapPort, TrapAgentAddress, TrapCommunity, TrapEnterprise. The sys_up_time property provides the trap timestamp.

send_trap sends an unauthenticated trap. The send_secure_trap method is used to send authenticated SNMPv3 traps.

If any values are provided in the objects collection, they are sent unchanged. In the case of an SNMPv2 or SNMPv3 Trap, if objects has a count that is equal to 0, the following values are set: sysUpTime.0 equal to sys_up_time and snmpTrapOID.0 equal to TrapOID.

For SNMPv2 and SNMPv3 Traps, TrapOID must contain the full OID of the Trap. For SNMPv1, TrapOID must be a string of the form "generic.specific" where generic and specific are numeric values providing the Trap Generic Type and Specific Type.

For SNMPv1, TrapOID must be of the form "GenericTrap.SpecificTrap". These values are sent in the PDU header. TrapAgentAddress and TrapEnterprise are taken from the corresponding configuration settings.

Additionally, the following symbolic values are recognized and translated as follows:

show_cache method (SNMPAgent Struct)

Lists all entries in the internal user authentication cache.

Syntax

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

Remarks

A on_cache_entry event is fired for every record in the internal user authentication cache.

The internal authentication cache can be used as an alternative to the on_get_user_password event, automatically checking the cache against the security parameters provided in the request signature.

The show_cache method is used to show the contents of the internal authentication cache.

The clear_cache method can be used to completely clear the cache.

value method (SNMPAgent 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.

on_bad_packet event (SNMPAgent Struct)

Fired for erroneous and/or malformed messages.

Syntax

// SNMPAgentBadPacketEventArgs carries the SNMPAgent BadPacket event's parameters.
pub struct SNMPAgentBadPacketEventArgs {
  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)
}

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

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

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.

Please refer to the on_get_user_password event for more information concerning SNMPv3 authentication.

on_cache_entry event (SNMPAgent Struct)

Shows in the internal cache.

Syntax

// SNMPAgentCacheEntryEventArgs carries the SNMPAgent CacheEntry event's parameters.
pub struct SNMPAgentCacheEntryEventArgs {
  fn user(&self) -> &String
  fn authentication_protocol(&self) -> &String
  fn authentication_password(&self) -> &String
  fn encryption_algorithm(&self) -> &String
  fn encryption_password(&self) -> &String
}

// SNMPAgentCacheEntryEvent defines the signature of the SNMPAgent CacheEntry event's handler function.
pub trait SNMPAgentCacheEntryEvent {
  fn on_cache_entry(&self, sender : SNMPAgent, e : &mut SNMPAgentCacheEntryEventArgs);
}

impl <'a> SNMPAgent<'a> {
  pub fn on_cache_entry(&self) -> &'a dyn SNMPAgentCacheEntryEvent;
  pub fn set_on_cache_entry(&mut self, value : &'a dyn SNMPAgentCacheEntryEvent);
  ...
}

Remarks

on_cache_entry events are triggered by a call to show_cache. One event is fired for each user.

on_connected event (SNMPAgent Struct)

Fired immediately after a connection completes (or fails).

Syntax

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

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

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

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_disconnected event (SNMPAgent Struct)

Fired when a connection is closed.

Syntax

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

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

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

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

Fired when an SNMPv3 discovery packet is received.

Syntax

// SNMPAgentDiscoveryRequestEventArgs carries the SNMPAgent DiscoveryRequest event's parameters.
pub struct SNMPAgentDiscoveryRequestEventArgs {
  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)
}

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

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

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_error event (SNMPAgent Struct)

Fired when information is available about errors during data delivery.

Syntax

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

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

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

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_get_bulk_request event (SNMPAgent Struct)

Fired when a GetBulkRequest packet is received.

Syntax

// SNMPAgentGetBulkRequestEventArgs carries the SNMPAgent GetBulkRequest event's parameters.
pub struct SNMPAgentGetBulkRequestEventArgs {
  fn request_id(&self) -> i32
  fn message_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 non_repeaters(&self) -> i32
  fn max_repetitions(&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)
}

// SNMPAgentGetBulkRequestEvent defines the signature of the SNMPAgent GetBulkRequest event's handler function.
pub trait SNMPAgentGetBulkRequestEvent {
  fn on_get_bulk_request(&self, sender : SNMPAgent, e : &mut SNMPAgentGetBulkRequestEventArgs);
}

impl <'a> SNMPAgent<'a> {
  pub fn on_get_bulk_request(&self) -> &'a dyn SNMPAgentGetBulkRequestEvent;
  pub fn set_on_get_bulk_request(&mut self, value : &'a dyn SNMPAgentGetBulkRequestEvent);
  ...
}

Remarks

This is only available for SNMP versions 2 and 3.

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:

The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

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

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.

on_get_next_request event (SNMPAgent Struct)

Fired when a GetNextRequest packet is received.

Syntax

// SNMPAgentGetNextRequestEventArgs carries the SNMPAgent GetNextRequest event's parameters.
pub struct SNMPAgentGetNextRequestEventArgs {
  fn request_id(&self) -> i32
  fn message_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)
}

// SNMPAgentGetNextRequestEvent defines the signature of the SNMPAgent GetNextRequest event's handler function.
pub trait SNMPAgentGetNextRequestEvent {
  fn on_get_next_request(&self, sender : SNMPAgent, e : &mut SNMPAgentGetNextRequestEventArgs);
}

impl <'a> SNMPAgent<'a> {
  pub fn on_get_next_request(&self) -> &'a dyn SNMPAgentGetNextRequestEvent;
  pub fn set_on_get_next_request(&mut self, value : &'a dyn SNMPAgentGetNextRequestEvent);
  ...
}

Remarks

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:

The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

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

on_get_request event (SNMPAgent Struct)

Fired when a GetRequest packet is received.

Syntax

// SNMPAgentGetRequestEventArgs carries the SNMPAgent GetRequest event's parameters.
pub struct SNMPAgentGetRequestEventArgs {
  fn request_id(&self) -> i32
  fn message_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)
}

// SNMPAgentGetRequestEvent defines the signature of the SNMPAgent GetRequest event's handler function.
pub trait SNMPAgentGetRequestEvent {
  fn on_get_request(&self, sender : SNMPAgent, e : &mut SNMPAgentGetRequestEventArgs);
}

impl <'a> SNMPAgent<'a> {
  pub fn on_get_request(&self) -> &'a dyn SNMPAgentGetRequestEvent;
  pub fn set_on_get_request(&mut self, value : &'a dyn SNMPAgentGetRequestEvent);
  ...
}

Remarks

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:

The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

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

on_get_user_password event (SNMPAgent Struct)

Retrieves a password associated with a user.

Syntax

// SNMPAgentGetUserPasswordEventArgs carries the SNMPAgent GetUserPassword event's parameters.
pub struct SNMPAgentGetUserPasswordEventArgs {
  fn password_type(&self) -> i32
  fn user(&self) -> &String
  fn password(&self) -> &String
  fn set_password(&self, value : &str)
  fn set_password_ref(&self, value : &String)
  fn algorithm(&self) -> i32
  fn set_algorithm(&self, value : i32)
}

// SNMPAgentGetUserPasswordEvent defines the signature of the SNMPAgent GetUserPassword event's handler function.
pub trait SNMPAgentGetUserPasswordEvent {
  fn on_get_user_password(&self, sender : SNMPAgent, e : &mut SNMPAgentGetUserPasswordEventArgs);
}

impl <'a> SNMPAgent<'a> {
  pub fn on_get_user_password(&self) -> &'a dyn SNMPAgentGetUserPasswordEvent;
  pub fn set_on_get_user_password(&mut self, value : &'a dyn SNMPAgentGetUserPasswordEvent);
  ...
}

Remarks

The on_get_user_password event is fired after initial inspection of SNMPv3 requests.

The type of password required is provided in the PasswordType parameter: 1 for authentication, and 2 for encryption (privacy).

The password corresponding to User (if any) must be provided in the Password parameter. If the password is valid, processing will continue to other events such as on_get_request, on_set_request, etc.

If the PasswordType parameter is 1 (authentication is used), the Algorithm parameter can be set. Possible values are:

If the PasswordType parameter is 2 (encryption is used), the Algorithm parameter must also be set. Possible values are:

If the password does not match the signature in the request, a on_bad_packet event will be fired, at which point you can decide whether to report the error to the client (see the description of the on_bad_packet event for more information).

If the User is invalid or unknown, set the password to empty string (default) to ignore the request. This will result in a on_bad_packet event being fired, at which point you can decide whether to report the error to the client or not.

on_get_user_security_level event (SNMPAgent Struct)

Sets the security level for an incoming packet.

Syntax

// SNMPAgentGetUserSecurityLevelEventArgs carries the SNMPAgent GetUserSecurityLevel event's parameters.
pub struct SNMPAgentGetUserSecurityLevelEventArgs {
  fn user(&self) -> &String
  fn engine_id(&self) -> &[u8]
  fn security_level(&self) -> i32
  fn set_security_level(&self, value : i32)
}

// SNMPAgentGetUserSecurityLevelEvent defines the signature of the SNMPAgent GetUserSecurityLevel event's handler function.
pub trait SNMPAgentGetUserSecurityLevelEvent {
  fn on_get_user_security_level(&self, sender : SNMPAgent, e : &mut SNMPAgentGetUserSecurityLevelEventArgs);
}

impl <'a> SNMPAgent<'a> {
  pub fn on_get_user_security_level(&self) -> &'a dyn SNMPAgentGetUserSecurityLevelEvent;
  pub fn set_on_get_user_security_level(&mut self, value : &'a dyn SNMPAgentGetUserSecurityLevelEvent);
  ...
}

Remarks

The on_get_user_security_level event is fired after the first inspection of each SNMPv3 request. The SecurityLevel parameter determines the level of security for the message.

On entry, the SecurityLevel parameter contains the default security level for User if the user is located in the internal cache, or if the User is not found in the cache, the SecurityLevel will be -1.

The value of SecurityLevel upon exiting the event, determines how the message will be processed:

on_hash_password event (SNMPAgent Struct)

Fired before and after a password is hashed.

Syntax

// SNMPAgentHashPasswordEventArgs carries the SNMPAgent HashPassword event's parameters.
pub struct SNMPAgentHashPasswordEventArgs {
  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)
}

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

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

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_packet_trace event (SNMPAgent Struct)

Fired for every packet sent or received.

Syntax

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

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

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

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

Fired when the struct is ready to send data.

Syntax

// SNMPAgentReadyToSendEventArgs carries the SNMPAgent ReadyToSend event's parameters.
pub struct SNMPAgentReadyToSendEventArgs {
}

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

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

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

Fired when a Report packet is received.

Syntax

// SNMPAgentReportEventArgs carries the SNMPAgent Report event's parameters.
pub struct SNMPAgentReportEventArgs {
  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
}

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

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

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_set_request event (SNMPAgent Struct)

Fired when a SetRequest packet is received.

Syntax

// SNMPAgentSetRequestEventArgs carries the SNMPAgent SetRequest event's parameters.
pub struct SNMPAgentSetRequestEventArgs {
  fn request_id(&self) -> i32
  fn message_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)
}

// SNMPAgentSetRequestEvent defines the signature of the SNMPAgent SetRequest event's handler function.
pub trait SNMPAgentSetRequestEvent {
  fn on_set_request(&self, sender : SNMPAgent, e : &mut SNMPAgentSetRequestEventArgs);
}

impl <'a> SNMPAgent<'a> {
  pub fn on_set_request(&self) -> &'a dyn SNMPAgentSetRequestEvent;
  pub fn set_on_set_request(&mut self, value : &'a dyn SNMPAgentSetRequestEvent);
  ...
}

Remarks

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:

The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

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

on_ssl_client_authentication event (SNMPAgent Struct)

Fired when the client presents its credentials to the server.

Syntax

// SNMPAgentSSLClientAuthenticationEventArgs carries the SNMPAgent SSLClientAuthentication event's parameters.
pub struct SNMPAgentSSLClientAuthenticationEventArgs {
  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)
}

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

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

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

Fires when connecting to the server.

Syntax

// SNMPAgentSSLServerAuthenticationEventArgs carries the SNMPAgent SSLServerAuthentication event's parameters.
pub struct SNMPAgentSSLServerAuthenticationEventArgs {
  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)
}

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

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

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

Shows the progress of the secure connection.

Syntax

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

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

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

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.

Config Settings (SNMPAgent Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

SNMPAgent Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SNMPAgent Struct)

SNMPAgent Errors

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

UDP Errors

SSL Errors

TCP/IP Errors