# Struct ipworkssnmp::SNMPTrapMgr

The SNMPTrapMgr struct provides a UDP-based listening point for SNMP traps.

## Syntax

```text
ipworkssnmp::SNMPTrapMgr
```

## Remarks

The SNMPTrapMgr struct provides a UDP-based listening point for SNMP traps and informs as specified by the SNMP RFCs. The struct supports v1, v2c, and v3 traps.

SNMP over DTLS is also supported when [ssl_enabled](#ssl_enabled-property-snmptrapmgr-struct) is set to True. The **SSLCert** properties are used to select a certificate for the server. The [on_ssl_status](#on_ssl_status-event-snmptrapmgr-struct) event provides information about the DTLS handshake. When client authentication is required, the [ssl_authenticate_clients](#ssl_authenticate_clients-property-snmptrapmgr-struct) property can be set to True and the [on_ssl_client_authentication](#on_ssl_client_authentication-event-snmptrapmgr-struct) 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 Trap manager as simple as setting a few key properties and handling a few events. SNMP data, such as for instance SNMP object id-s (OID-s) are exchanged as text strings, thus further simplifying the task of handling them.

The struct is activated/deactivated by calling the [activate](#activate-method-snmptrapmgr-struct) or [deactivate](#deactivate-method-snmptrapmgr-struct) method. These methods enable or disable sending and receiving. The activation status can be found in the [active](#active-property-snmptrapmgr-struct) property.

Messages are received through events such as [on_trap](#on_trap-event-snmptrapmgr-struct), [on_inform_request](#on_inform_request-event-snmptrapmgr-struct), or [on_discovery_request](#on_discovery_request-event-snmptrapmgr-struct).

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

SNMPv3 USM security passwords are requested through the [on_get_user_password](#on_get_user_password-event-snmptrapmgr-struct) 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 [add_user](#add_user-method-snmptrapmgr-struct), [remove_user](#remove_user-method-snmptrapmgr-struct), [show_cache](#show_cache-method-snmptrapmgr-struct), [clear_cache](#clear_cache-method-snmptrapmgr-struct), [add_engine](#add_engine-method-snmptrapmgr-struct), and [remove_engine](#remove_engine-method-snmptrapmgr-struct) methods are used to manage an internal authentication cache. This internal cache can be used as an alternative to the [on_get_user_password](#on_get_user_password-event-snmptrapmgr-struct) event, automatically checking the cache against the security parameters provided in the request signature.

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

|  |  |
| --- | --- |
| [accept_data](#accept_data-property-snmptrapmgr-struct) | Enables or disables data reception. |
| [active](#active-property-snmptrapmgr-struct) | Indicates whether the struct is active. |
| [local_engine_id](#local_engine_id-property-snmptrapmgr-struct) | The Engine Id (for SNMPv3). |
| [local_host](#local_host-property-snmptrapmgr-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [local_port](#local_port-property-snmptrapmgr-struct) | The port in the local host where the struct is bound to. |
| [obj_count](#obj_count-property-snmptrapmgr-struct) | The number of records in the Obj arrays. |
| [obj_type](#obj_type-property-snmptrapmgr-struct) | The current object's type. |
| [obj_id](#obj_id-property-snmptrapmgr-struct) | The current object's id which is encoded as a string of numbers separated by periods. |
| [obj_type_string](#obj_type_string-property-snmptrapmgr-struct) | A string representation of the current object's ObjectType . |
| [obj_value](#obj_value-property-snmptrapmgr-struct) | The current object's value. |
| [request_id](#request_id-property-snmptrapmgr-struct) | The request-id to mark outgoing packets with. |
| [ssl_authenticate_clients](#ssl_authenticate_clients-property-snmptrapmgr-struct) | If set to True, the server asks the client(s) for a certificate. |
| [ssl_cert_effective_date](#ssl_cert_effective_date-property-snmptrapmgr-struct) | The date on which this certificate becomes valid. |
| [ssl_cert_expiration_date](#ssl_cert_expiration_date-property-snmptrapmgr-struct) | The date on which the certificate expires. |
| [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property-snmptrapmgr-struct) | A comma-delimited list of extended key usage identifiers. |
| [ssl_cert_fingerprint](#ssl_cert_fingerprint-property-snmptrapmgr-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property-snmptrapmgr-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property-snmptrapmgr-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [ssl_cert_issuer](#ssl_cert_issuer-property-snmptrapmgr-struct) | The issuer of the certificate. |
| [ssl_cert_private_key](#ssl_cert_private_key-property-snmptrapmgr-struct) | The private key of the certificate (if available). |
| [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-snmptrapmgr-struct) | Whether a PrivateKey is available for the selected certificate. |
| [ssl_cert_private_key_container](#ssl_cert_private_key_container-property-snmptrapmgr-struct) | The name of the PrivateKey container for the certificate (if available). |
| [ssl_cert_public_key](#ssl_cert_public_key-property-snmptrapmgr-struct) | The public key of the certificate. |
| [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property-snmptrapmgr-struct) | The textual description of the certificate's public key algorithm. |
| [ssl_cert_public_key_length](#ssl_cert_public_key_length-property-snmptrapmgr-struct) | The length of the certificate's public key (in bits). |
| [ssl_cert_serial_number](#ssl_cert_serial_number-property-snmptrapmgr-struct) | The serial number of the certificate encoded as a string. |
| [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property-snmptrapmgr-struct) | The text description of the certificate's signature algorithm. |
| [ssl_cert_store](#ssl_cert_store-property-snmptrapmgr-struct) | The name of the certificate store for the client certificate. |
| [ssl_cert_store_password](#ssl_cert_store_password-property-snmptrapmgr-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [ssl_cert_store_type](#ssl_cert_store_type-property-snmptrapmgr-struct) | The type of certificate store for this certificate. |
| [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property-snmptrapmgr-struct) | Comma-separated lists of alternative subject names for the certificate. |
| [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property-snmptrapmgr-struct) | The MD5 hash of the certificate. |
| [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property-snmptrapmgr-struct) | The SHA-1 hash of the certificate. |
| [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property-snmptrapmgr-struct) | The SHA-256 hash of the certificate. |
| [ssl_cert_usage](#ssl_cert_usage-property-snmptrapmgr-struct) | The text description of UsageFlags . |
| [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-snmptrapmgr-struct) | The flags that show intended use for the certificate. |
| [ssl_cert_version](#ssl_cert_version-property-snmptrapmgr-struct) | The certificate's version number. |
| [ssl_cert_subject](#ssl_cert_subject-property-snmptrapmgr-struct) | The subject of the certificate used for client authentication. |
| [ssl_cert_encoded](#ssl_cert_encoded-property-snmptrapmgr-struct) | The certificate (PEM/Base64 encoded). |
| [ssl_enabled](#ssl_enabled-property-snmptrapmgr-struct) | Whether DTLS is enabled. |

## Method List

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

|  |  |
| --- | --- |
| [activate](#activate-method-snmptrapmgr-struct) | Activates the struct. |
| [add_engine](#add_engine-method-snmptrapmgr-struct) | Adds the engine specified by EngineId to the internal authentication cache. |
| [add_user](#add_user-method-snmptrapmgr-struct) | Adds a user for the engine specified by EngineId to the internal authentication cache. |
| [clear_cache](#clear_cache-method-snmptrapmgr-struct) | Clears the internal authentication database. |
| [config](#config-method-snmptrapmgr-struct) | Sets or retrieves a configuration setting. |
| [deactivate](#deactivate-method-snmptrapmgr-struct) | Deactivates the struct. |
| [do_events](#do_events-method-snmptrapmgr-struct) | This method processes events from the internal message queue. |
| [hash_passwords](#hash_passwords-method-snmptrapmgr-struct) | Hashes all passwords in the cache. |
| [pause_data](#pause_data-method-snmptrapmgr-struct) | This method pauses data reception. |
| [process_data](#process_data-method-snmptrapmgr-struct) | This method reenables data reception after a call to PauseData . |
| [remove_engine](#remove_engine-method-snmptrapmgr-struct) | Removes the engine specified by EngineId from the internal authentication cache. |
| [remove_user](#remove_user-method-snmptrapmgr-struct) | Removes the user specified by User of the engine specified by EngineId from the internal authentication cache. |
| [reset](#reset-method-snmptrapmgr-struct) | Clears the object arrays. |
| [show_cache](#show_cache-method-snmptrapmgr-struct) | Lists all entries in the internal user and engine database. |
| [value](#value-method-snmptrapmgr-struct) | Returns the value corresponding to an OID. |

## 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.*

|  |  |
| --- | --- |
| [on_bad_packet](#on_bad_packet-event-snmptrapmgr-struct) | Fired for erroneous and/or malformed messages. |
| [on_cache_entry](#on_cache_entry-event-snmptrapmgr-struct) | Shows engines and users in the internal cache. |
| [on_check_engine](#on_check_engine-event-snmptrapmgr-struct) | Fired to check engine parameters (timeliness, etc.). |
| [on_connected](#on_connected-event-snmptrapmgr-struct) | Fired immediately after a connection completes (or fails). |
| [on_disconnected](#on_disconnected-event-snmptrapmgr-struct) | Fired when a connection is closed. |
| [on_discovery_request](#on_discovery_request-event-snmptrapmgr-struct) | Fired when an SNMPv3 discovery packet is received. |
| [on_error](#on_error-event-snmptrapmgr-struct) | Fired when information is available about errors during data delivery. |
| [on_get_user_password](#on_get_user_password-event-snmptrapmgr-struct) | Retrieves a password associated with a user. |
| [on_get_user_security_level](#on_get_user_security_level-event-snmptrapmgr-struct) | Sets the security level for an incoming packet. |
| [on_hash_password](#on_hash_password-event-snmptrapmgr-struct) | Fired before and after a password is hashed. |
| [on_inform_request](#on_inform_request-event-snmptrapmgr-struct) | Fired when an InformRequest packet is received. |
| [on_packet_trace](#on_packet_trace-event-snmptrapmgr-struct) | Fired for every packet sent or received. |
| [on_ssl_client_authentication](#on_ssl_client_authentication-event-snmptrapmgr-struct) | Fired when the client presents its credentials to the server. |
| [on_ssl_status](#on_ssl_status-event-snmptrapmgr-struct) | Shows the progress of the secure connection. |
| [on_trap](#on_trap-event-snmptrapmgr-struct) | Fired when a SNMP trap packet is received. |

## Config Settings

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

|  |  |
| --- | --- |
| [AuthenticationKey](#AuthenticationKey) | The key to use for authentication. |
| [CompatibilityMode](#CompatibilityMode) | Whether to operate the struct in a specific compatibility mode. |
| [ContextEngineId](#ContextEngineId) | Sets the context engine id of the SNMP entity. |
| [ContextName](#ContextName) | Sets the context name of the SNMP entity. |
| [DecryptLogPackets](#DecryptLogPackets) | Whether to decrypt logged packets. |
| [EncryptionKey](#EncryptionKey) | The key to use for encryption. |
| [ForceLocalPort](#ForceLocalPort) | Forces the struct to bind to a specific port. |
| [IncomingContextEngineId](#IncomingContextEngineId) | The engine Id of the received packet. |
| [IncomingContextName](#IncomingContextName) | The context name of the received packet. |
| [ShowCacheForUser](#ShowCacheForUser) | Shows the cache entry for a single user. |
| [SourceAddress](#SourceAddress) | The source address of the received packet. |
| [SourcePort](#SourcePort) | The source port of the received packet. |
| [TimeWindow](#TimeWindow) | The time window used for SNMPv3 timeliness checking (authentication). |
| [CaptureIPPacketInfo](#CaptureIPPacketInfo) | Used to capture the packet information. |
| [DelayHostResolution](#DelayHostResolution) | Whether the hostname is resolved when RemoteHost is set. |
| [DestinationAddress](#DestinationAddress) | Used to get the destination address from the packet information. |
| [DontFragment](#DontFragment) | Used to set the Don't Fragment flag of outgoing packets. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the struct binds. |
| [MaxPacketSize](#MaxPacketSize) | The maximum length of the packets that can be received. |
| [QOSDSCPValue](#QOSDSCPValue) | Used to specify an arbitrary QOS/DSCP setting (optional). |
| [QOSTrafficType](#QOSTrafficType) | Used to specify QOS/DSCP settings (optional). |
| [ShareLocalPort](#ShareLocalPort) | If set to True, allows more than one instance of the struct to be active on the same local port. |
| [UseConnection](#UseConnection) | Determines whether to use a connected socket. |
| [UseIPv6](#UseIPv6) | Whether or not to use IPv6. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# accept_data property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Enables or disables data reception.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Indicates whether the struct is active.

## Syntax

*Rust Syntax*

```text
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](#activate-method-snmptrapmgr-struct) and [deactivate](#deactivate-method-snmptrapmgr-struct) methods to control whether the struct is active.

This property is read-only.

## Data Type

bool

# local_engine_id property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The Engine Id (for SNMPv3).

## Syntax

*Rust Syntax*

```text
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 necessary for properly handling [on_inform_request](#on_inform_request-event-snmptrapmgr-struct) packets.

## Data Type

Vec

# local_host property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

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

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The port in the local host where the struct is bound to.

## Syntax

*Rust Syntax*

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

## Default Value

162

## Remarks

The local_port property must be set before the struct is activated ([active](#active-property-snmptrapmgr-struct) is set to True). It instructs the struct to bind to a specific port (or communication endpoint) in the local machine.

The default port is 162 (standard trap port). If that port is busy, an error will be returned, unless the [ForceLocalPort](#ForceLocalPort) configuration setting is set to False, in which case a random port will be chosen.

local_port cannot be changed once the struct is [active](#active-property-snmptrapmgr-struct). Any attempt to set the local_port property when the struct is [active](#active-property-snmptrapmgr-struct) 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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The number of records in the Obj arrays.

## Syntax

*Rust Syntax*

```text
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_id-property-snmptrapmgr-struct)
- [obj_type](#obj_type-property-snmptrapmgr-struct)
- [obj_type_string](#obj_type_string-property-snmptrapmgr-struct)
- [obj_value](#obj_value-property-snmptrapmgr-struct)

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

## Data Type

i32

# obj_type property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The current object's type.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
2   // Integer4   // OctetString5   // Null6   // ObjectId64   // IPAddress65   // Counter3266   // Gauge3267   // TimeTicks68   // Opaque69   // NSAP70   // Counter6471   // UnsignedInteger32128   // NoSuchObject129   // NoSuchInstance130   // 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](#SNMPTrapMgr_p_ObjOid) and [obj_value](#obj_value-property-snmptrapmgr-struct) properties.

Possible object type values include:

|  |  |
| --- | --- |
| otInteger (2) | 2 |
| otOctetString (4) | 4 |
| otNull (5) | 5 |
| otObjectID (6) | 6 |
| otIPAddress (64) | 64 |
| otCounter32 (65) | 65 |
| otGauge32 (66) | 66 |
| otTimeTicks (67) | 67 |
| otOpaque (68) | 68 |
| otNSAP (69) | 69 |
| otCounter64 (70) | 70 |
| otUnsignedInteger32 (71) | 71 |

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

|  |  |
| --- | --- |
| otNoSuchObject (128) | No such object error. |
| otNoSuchInstance (129) | No such instance error. |
| otEndOfMibView (130) | End of MIB View error. |

The *ObjIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ObjCount](#obj_count-property-snmptrapmgr-struct) property.

## Data Type

i32

# obj_id property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#SNMPTrapMgr_p_ObjObjectType) and [obj_value](#obj_value-property-snmptrapmgr-struct) properties.

**Example**

```text
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](#obj_count-property-snmptrapmgr-struct) property.

## Data Type

String

# obj_type_string property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

A string representation of the current object's ObjectType .

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

A string representation of the current object's [obj_object_type](#SNMPTrapMgr_p_ObjObjectType).

The corresponding object id and value are specified by the [obj_oid](#SNMPTrapMgr_p_ObjOid) and [obj_value](#obj_value-property-snmptrapmgr-struct) properties.

The *ObjIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ObjCount](#obj_count-property-snmptrapmgr-struct) property.

This property is read-only.

## Data Type

String

# obj_value property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The current object's value.

## Syntax

*Rust Syntax*

```text
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](#SNMPTrapMgr_p_ObjOid) and [obj_object_type](#SNMPTrapMgr_p_ObjObjectType) properties.

**Example**

```text
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](#obj_count-property-snmptrapmgr-struct) property.

## Data Type

Vec

# request_id property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The request-id to mark outgoing packets with.

## Syntax

*Rust Syntax*

```text
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

# ssl_authenticate_clients property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

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

## Syntax

*Rust Syntax*

```text
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](#on_ssl_client_authentication-event-snmptrapmgr-struct) event. Please refer to the documentation of the [on_ssl_client_authentication](#on_ssl_client_authentication-event-snmptrapmgr-struct) event for details.

## Data Type

bool

# ssl_cert_effective_date property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The date on which this certificate becomes valid.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The date on which the certificate expires.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

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

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

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

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

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

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The issuer of the certificate.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The private key of the certificate (if available).

## Syntax

*Rust Syntax*

```text
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](#ssl_cert_private_key-property-snmptrapmgr-struct) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property-snmptrapmgr-struct) returns an empty string.

This property is read-only.

## Data Type

String

# ssl_cert_private_key_available property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Rust Syntax*

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

## Default Value

false

## Remarks

Whether a [ssl_cert_private_key](#ssl_cert_private_key-property-snmptrapmgr-struct) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-snmptrapmgr-struct) 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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

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

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

The name of the [ssl_cert_private_key](#ssl_cert_private_key-property-snmptrapmgr-struct) 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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The public key of the certificate.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

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

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

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

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The serial number of the certificate encoded as a string.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The text description of the certificate's signature algorithm.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The name of the certificate store for the client certificate.

## Syntax

*Rust Syntax*

```text
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](#ssl_cert_store_type-property-snmptrapmgr-struct) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property-snmptrapmgr-struct). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property-snmptrapmgr-struct).

[ssl_cert_store](#ssl_cert_store-property-snmptrapmgr-struct) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property-snmptrapmgr-struct) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property-snmptrapmgr-struct) has a value, and [ssl_cert_subject](#ssl_cert_subject-property-snmptrapmgr-struct) or [ssl_cert_encoded](#ssl_cert_encoded-property-snmptrapmgr-struct) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property-snmptrapmgr-struct) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) 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

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The type of certificate store for this certificate.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // 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:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_cert_store_type](#ssl_cert_store_type-property-snmptrapmgr-struct), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property-snmptrapmgr-struct), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property-snmptrapmgr-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_cert_store](#ssl_cert_store-property-snmptrapmgr-struct) and set [ssl_cert_store_password](#ssl_cert_store_password-property-snmptrapmgr-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

## Data Type

i32

# ssl_cert_subject_alt_names property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

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

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The MD5 hash of the certificate.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The SHA-1 hash of the certificate.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The SHA-256 hash of the certificate.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The text description of UsageFlags .

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

The text description of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-snmptrapmgr-struct).

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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The flags that show intended use for the certificate.

## Syntax

*Rust Syntax*

```text
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](#ssl_cert_usage_flags-property-snmptrapmgr-struct) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [ssl_cert_usage](#ssl_cert_usage-property-snmptrapmgr-struct) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-snmptrapmgr-struct).

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

This property is read-only.

## Data Type

i32

# ssl_cert_version property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The certificate's version number.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The subject of the certificate used for client authentication.

## Syntax

*Rust Syntax*

```text
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:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

## Data Type

String

# ssl_cert_encoded property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

The certificate (PEM/Base64 encoded).

## Syntax

*Rust Syntax*

```text
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](#ssl_cert_store-property-snmptrapmgr-struct) and [ssl_cert_subject](#ssl_cert_subject-property-snmptrapmgr-struct) properties also may be used to specify a certificate.

When [ssl_cert_encoded](#ssl_cert_encoded-property-snmptrapmgr-struct) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property-snmptrapmgr-struct) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property-snmptrapmgr-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property-snmptrapmgr-struct) is set to an empty string.

## Data Type

Vec

# ssl_enabled property ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Whether DTLS is enabled.

## Syntax

*Rust Syntax*

```text
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

# activate method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Activates the struct.

## Syntax

*Rust Syntax*

```text
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](#active-property-snmptrapmgr-struct) property to check whether the component is active.

# add_engine method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Adds the engine specified by EngineId to the internal authentication cache.

## Syntax

*Rust Syntax*

```text
fn add_engine(&self, engine_id : &[u8], engine_boots : i32, engine_time : i32) -> Result<(), IPWorksSNMPError>
```

## Remarks

The internal authentication cache can be used as an alternative to the [on_get_user_password](#on_get_user_password-event-snmptrapmgr-struct) event, automatically checking the cache against the security parameters provided in the request signature.

The [show_cache](#show_cache-method-snmptrapmgr-struct) method is used to show the contents of the internal authentication cache.

The [clear_cache](#clear_cache-method-snmptrapmgr-struct) method can be used to completely clear the cache.

If the engine parameters are unknown, the [SNMPMgr](SNMPMgr.md#SNMPMgr) struct's Discover method can be used to perform a discovery with the agent. The RemoteEngineId, RemoteEngineTime, and RemoteEngineBoots properties will hold the values that can then be passed to this method.

# add_user method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Adds a user for the engine specified by EngineId to the internal authentication cache.

## Syntax

*Rust Syntax*

```text
fn add_user(&self, user : &str, engine_id : &[u8], 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](#on_get_user_password-event-snmptrapmgr-struct) event, automatically checking the cache against the security parameters provided in the request signature.

The [show_cache](#show_cache-method-snmptrapmgr-struct) method is used to show the contents of the internal authentication cache.

The [clear_cache](#clear_cache-method-snmptrapmgr-struct) method can be used to completely clear the cache.

Valid Authentication Protocols are:

|  |  |
| --- | --- |
| HMAC-MD5-96 (1) | Message-Digest algorithm 5. |
| HMAC-SHA-96 (2) | Secure Hash Algorithm. |
| HMAC-192-SHA-256 (3) | Secure Hash Algorithm. |
| HMAC-384-SHA-512 (4) | Secure Hash Algorithm. |
| HMAC-128-SHA-224 (5) | Secure Hash Algorithm. |
| HMAC-256-SHA-384 (6) | Secure Hash Algorithm. |

Valid Encryption Algorithms are:

|  |  |
| --- | --- |
| DES (1) | Data Encryption Standard. |
| AES (2) | Advanced Encryption Standard with key length of 128. |
| 3DES (3) | Triple Data Encryption Standard. |
| AES192 (4) | Advanced Encryption Standard with key length of 192. |
| AES256 (5) | Advanced Encryption Standard with key length of 256. |

# clear_cache method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Clears the internal authentication database.

## Syntax

*Rust Syntax*

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

## Remarks

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

# config method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
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](#config-settings-snmptrapmgr-struct) 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](#config-settings-snmptrapmgr-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# deactivate method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Deactivates the struct.

## Syntax

*Rust Syntax*

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

## Remarks

This method deactivates the component and will prohibit it from sending and receiving data.

NOTE: Use the [active](#active-property-snmptrapmgr-struct) property to check whether the component is active.

# do_events method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

This method processes events from the internal message queue.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Hashes all passwords in the cache.

## Syntax

*Rust Syntax*

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

## Remarks

Forces computation of all passwords hashes in the cache. Used together with the [on_hash_password](#on_hash_password-event-snmptrapmgr-struct) event to enable implementations of external password hash storage.

# pause_data method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

This method pauses data reception.

## Syntax

*Rust Syntax*

```text
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](#process_data-method-snmptrapmgr-struct) to reenable data reception.

# process_data method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

This method reenables data reception after a call to PauseData .

## Syntax

*Rust Syntax*

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

## Remarks

This method reenables data reception after a previous call to [pause_data](#pause_data-method-snmptrapmgr-struct). When [pause_data](#pause_data-method-snmptrapmgr-struct) 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](#pause_data-method-snmptrapmgr-struct). It does not need to be called to process incoming data by default.

# remove_engine method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Removes the engine specified by EngineId from the internal authentication cache.

## Syntax

*Rust Syntax*

```text
fn remove_engine(&self, engine_id : &[u8]) -> Result<(), IPWorksSNMPError>
```

## Remarks

The internal authentication cache can be used as an alternative to the [on_get_user_password](#on_get_user_password-event-snmptrapmgr-struct) event, automatically checking the cache against the security parameters provided in the request signature.

The [show_cache](#show_cache-method-snmptrapmgr-struct) method is used to show the contents of the internal authentication cache.

The [clear_cache](#clear_cache-method-snmptrapmgr-struct) method can be used to completely clear the cache.

# remove_user method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Removes the user specified by User of the engine specified by EngineId from the internal authentication cache.

## Syntax

*Rust Syntax*

```text
fn remove_user(&self, user : &str, engine_id : &[u8]) -> Result<(), IPWorksSNMPError>
```

## Remarks

The internal authentication cache can be used as an alternative to the [on_get_user_password](#on_get_user_password-event-snmptrapmgr-struct) event, automatically checking the cache against the security parameters provided in the request signature.

The [show_cache](#show_cache-method-snmptrapmgr-struct) method is used to show the contents of the internal authentication cache.

The [clear_cache](#clear_cache-method-snmptrapmgr-struct) method can be used to completely clear the cache.

# reset method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Clears the object arrays.

## Syntax

*Rust Syntax*

```text
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)**.

# show_cache method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Lists all entries in the internal user and engine database.

## Syntax

*Rust Syntax*

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

## Remarks

A [on_cache_entry](#on_cache_entry-event-snmptrapmgr-struct) event is fired for every record in the database.

# value method ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Returns the value corresponding to an OID.

## Syntax

*Rust Syntax*

```text
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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Fired for erroneous and/or malformed messages.

## Syntax

*Rust Syntax*

```text
// SNMPTrapMgrBadPacketEventArgs carries the SNMPTrapMgr BadPacket event's parameters.
pub struct SNMPTrapMgrBadPacketEventArgs {
  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)
}

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

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

## 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](#on_get_user_password-event-snmptrapmgr-struct) event for more information concerning SNMPv3 authentication.

# on_cache_entry event ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Shows engines and users in the internal cache.

## Syntax

*Rust Syntax*

```text
// SNMPTrapMgrCacheEntryEventArgs carries the SNMPTrapMgr CacheEntry event's parameters.
pub struct SNMPTrapMgrCacheEntryEventArgs {
  fn engine_id(&self) -> &[u8]
  fn engine_boots(&self) -> i32
  fn engine_time(&self) -> i32
  fn user(&self) -> &String
  fn authentication_protocol(&self) -> &String
  fn authentication_password(&self) -> &String
  fn encryption_algorithm(&self) -> &String
  fn encryption_password(&self) -> &String
}

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

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

## Remarks

on_cache_entry events are triggered by a call to [show_cache](#show_cache-method-snmptrapmgr-struct). One event is fired for each user and engine. If there are no users for a particular engine, a single event is fired with the engine information, but empty values for user information.

# on_check_engine event ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Fired to check engine parameters (timeliness, etc.).

## Syntax

*Rust Syntax*

```text
// SNMPTrapMgrCheckEngineEventArgs carries the SNMPTrapMgr CheckEngine event's parameters.
pub struct SNMPTrapMgrCheckEngineEventArgs {
  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 remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn is_new(&self) -> bool
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SNMPTrapMgrCheckEngineEvent defines the signature of the SNMPTrapMgr CheckEngine event's handler function.
pub trait SNMPTrapMgrCheckEngineEvent {
  fn on_check_engine(&self, sender : SNMPTrapMgr, e : &mut SNMPTrapMgrCheckEngineEventArgs);
}

impl <'a> SNMPTrapMgr<'a> {
  pub fn on_check_engine(&self) -> &'a dyn SNMPTrapMgrCheckEngineEvent;
  pub fn set_on_check_engine(&mut self, value : &'a dyn SNMPTrapMgrCheckEngineEvent);
  ...
}
```

## Remarks

The *Accept* parameter determines if the engine will be accepted or not. If you set *Accept* to False prior to exiting the event, the processing on the message will stop and a [on_bad_packet](#on_bad_packet-event-snmptrapmgr-struct) event will be fired.

The default value of *Accept* is True if and only if:

a) the engine already exists in the internal authentication cache (the *IsNew* parameter is False) and the timeliness has been verified;

b) the engine does not exist in the internal authentication cache (the *IsNew* parameter is True), but the packet has been authenticated by the struct (*SecurityLevel* >= 1).

 In all other cases, the default value for *Accept* is False, and you are responsible for accepting or not accepting the engine based on other considerations.

 If *Accept* is true upon event exit, then:

a) if the engine already exists in the internal authentication cache, its time is updated to reflect the new time and the processing of the packet continues;

b) if the engine does not exist in the internal authentication cache, it is added there and if *User* is authenticated, the *User* will be added too.

# on_connected event ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Fired immediately after a connection completes (or fails).

## Syntax

*Rust Syntax*

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

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

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

## 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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Fired when a connection is closed.

## Syntax

*Rust Syntax*

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

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

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

## 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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Fired when an SNMPv3 discovery packet is received.

## Syntax

*Rust Syntax*

```text
// SNMPTrapMgrDiscoveryRequestEventArgs carries the SNMPTrapMgr DiscoveryRequest event's parameters.
pub struct SNMPTrapMgrDiscoveryRequestEventArgs {
  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)
}

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

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

## 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](#local_engine_id-property-snmptrapmgr-struct). 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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

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

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

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

## 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](#trappable-errors-snmptrapmgr-struct) section.

# on_get_user_password event ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Retrieves a password associated with a user.

## Syntax

*Rust Syntax*

```text
// SNMPTrapMgrGetUserPasswordEventArgs carries the SNMPTrapMgr GetUserPassword event's parameters.
pub struct SNMPTrapMgrGetUserPasswordEventArgs {
  fn password_type(&self) -> i32
  fn user(&self) -> &String
  fn engine_id(&self) -> &[u8]
  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)
}

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

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

## 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* and *EngineId* 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:

|  |  |
| --- | --- |
| Value | Authentication Algorithm |
| 0 (default) | Any |
| 1 | MD5 |
| 2 | SHA1 |
| 3 | SHA256 |
| 4 | SHA512 |

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

|  |  |
| --- | --- |
| Value | Encryption Algorithm |
| 1 (default) | DES |
| 2 | AES |
| 3 | 3DES |
| 4 | AES192 |
| 5 | AES256 |

If the password does not match the signature in the request, a [on_bad_packet](#on_bad_packet-event-snmptrapmgr-struct) 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](#on_bad_packet-event-snmptrapmgr-struct) 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](#on_bad_packet-event-snmptrapmgr-struct) 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 ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Sets the security level for an incoming packet.

## Syntax

*Rust Syntax*

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

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

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

## 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:

|  |  |
| --- | --- |
| -1 | The message will be ignored and a [on_bad_packet](#on_bad_packet-event-snmptrapmgr-struct) event will be fired. |
| 0 | No security. The message will be processed without any authentication and/or encryption. |
| 1 | Authentication only. The message will be checked for a valid signature and the [on_get_user_password](#on_get_user_password-event-snmptrapmgr-struct) event will be fired to verify the authentication password. |
| 2 | Authentication and Privacy. The message will be checked for a valid signature and the [on_get_user_password](#on_get_user_password-event-snmptrapmgr-struct) event will be fired twice: first to verify the authentication password, and then to verify the privacy password. |

# on_hash_password event ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Fired before and after a password is hashed.

## Syntax

*Rust Syntax*

```text
// SNMPTrapMgrHashPasswordEventArgs carries the SNMPTrapMgr HashPassword event's parameters.
pub struct SNMPTrapMgrHashPasswordEventArgs {
  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)
}

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

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

## Remarks

SNMPv3 passwords are hashed in order to obtain authentication and encryption keys. This is an expensive operation, and in certain situations it may be preferable to store the hashed passwords externally and supply them on demand.

If a hash is required, the event fires with an empty string in the *Hash* parameter. In this case, you can choose to supply a value for the hash and stop the struct from computing the hash.

The event also fires every time a hash is computed. In this case, the *Hash* parameter contains the value of the computed hash.

*AuthAlgorithm* contains either 1 for HMAC-MD5-96, 2 for HMAC-SHA-96 or 3 for HMAC-192-SHA-256

# on_inform_request event ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Fired when an InformRequest packet is received.

## Syntax

*Rust Syntax*

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

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

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

## 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 user in an InformRequest packet (SNMPv3) must be a valid user in the internal authentication cache (see the [add_user](#add_user-method-snmptrapmgr-struct) method and the [on_check_engine](#on_check_engine-event-snmptrapmgr-struct) event for more information). If not, the request is rejected, and a [on_bad_packet](#on_bad_packet-event-snmptrapmgr-struct) event is fired before on_inform_request is fired.

The list of variables in the SNMP packet, including optional values and types, is provided through the objects collection. Each object is of type SNMPObject. This type describes the [obj_id](#obj_id-property-snmptrapmgr-struct), [obj_type](#obj_type-property-snmptrapmgr-struct), and [obj_value](#obj_value-property-snmptrapmgr-struct) of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

 The *SourceAddress* and *SourcePort* parameters show the address and port of the sender as reported by the TCP/IP stack.

The *MessageId* parameter identifies the received request.

For SNMPv3, the *User* parameter shows the user that was supplied with the packet. This parameter *MUST* be used together with the *SecurityLevel* parameter which shows the level of security in the message.

The *SecurityLevel* parameter shows whether the request has been authenticated. If *SecurityLevel* is 0, the request has *NOT* been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, *SecurityLevel* is 1. For an authenticated and encrypted request, *SecurityLevel* is 2.

To send a response, the *Respond* parameter must be set to true. By default, this value is false, which means no response will be sent. The *ErrorStatus* parameter may also be set to a valid SNMP status code (the default value is 0, which represents no error).

The following is a list of valid SNMP status code values:

|  |  |
| --- | --- |
| 0 (noError) | No error. |
| 1 (tooBig) | The response cannot fit in a single SNMP message. |
| 2 (noSuchName) | Variable does not exist. |
| 3 (badValue) | Invalid value or syntax. |
| 4 (readOnly) | Variable is read-only. |
| 5 (genError) | Other error (SNMPv1). |
| 6 (noAccess) | Access denied. |
| 7 (wrongType) | Wrong object type. |
| 8 (wrongLength) | Wrong length. |
| 9 (wrongEncoding) | Wrong encoding. |
| 10 (wrongValue) | Wrong value. |
| 11 (noCreation) | No creation. |
| 12 (inconsistentValue) | Inconsistent value. |
| 13 (resourceUnavailable) | Resource unavailable. |
| 14 (commitFailed) | Commit failed. |
| 15 (undoFailed) | Undo failed. |
| 16 (authorizationError) | Authorization error. |
| 17 (notWritable) | Variable is not writable. |
| 18 (inconsistentName) | Inconsistent name. |

 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_packet_trace event ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Fired for every packet sent or received.

## Syntax

*Rust Syntax*

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

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

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

## 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_ssl_client_authentication event ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Fired when the client presents its credentials to the server.

## Syntax

*Rust Syntax*

```text
// SNMPTrapMgrSSLClientAuthenticationEventArgs carries the SNMPTrapMgr SSLClientAuthentication event's parameters.
pub struct SNMPTrapMgrSSLClientAuthenticationEventArgs {
  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)
}

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

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

## 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_status event ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Shows the progress of the secure connection.

## Syntax

*Rust Syntax*

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

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

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

## Remarks

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

*RemoteAddress* is the IP address of the remote machine.

*RemotePort* is the port of the remote machine.

*Message* is the log message.

# on_trap event ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

Fired when a SNMP trap packet is received.

## Syntax

*Rust Syntax*

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

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

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

## Remarks

The *TrapOID* and *TimeStamp* parameters contain the Trap OID and TimeStamp. In the case of an SNMPv1 trap, there are two possible scenarios:

First, if the enterprise of the trap is "1.3.6.1.6.3.1.1.5", *TrapOID* will be a concatenation of TrapEnterprise and GenericTrap + 1. For instance a TrapOID of "1.3.6.1.6.3.1.1.5.5" has a TrapEnterprise of "1.3.6.1.6.3.1.1.5" and a GenericTrap of "4".

Second, In all other cases *TrapOID* will be a concatenation of the values for TrapEnterprise, GenericTrap, and SpecificTrap, separated by '.'.

For SNMPv2 and above, they are read from the variable-value list (if available).

For SNMPv3, the *User* parameter shows the user that was supplied with the packet. This parameter *MUST* be used together with the *SecurityLevel* parameter which shows the level of security in the message.

The *SecurityLevel* parameter shows whether the request has been authenticated. If *SecurityLevel* is 0, the request has *NOT* been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, *SecurityLevel* is 1. For an authenticated and encrypted request, *SecurityLevel* is 2.

The 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_id-property-snmptrapmgr-struct), [obj_type](#obj_type-property-snmptrapmgr-struct), and [obj_value](#obj_value-property-snmptrapmgr-struct) 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.

Some parameters are only applicable depending on the SNMPVersion value. The table below shows which parameters are applicable to which SNMP versions.

|  |  |  |  |
| --- | --- | --- | --- |
|  | SNMPv1 | SNMPv2 | SNMPv3 |
| AgentAddress | X |  |  |
| Community | X | X |  |
| RequestId |  | X | X |
| SecurityLevel |  |  | X |
| User |  |  | X |
| SNMPVersion | X | X | X |
| SourceAddress | X | X | X |
| SourcePort | X | X | X |
| TimeStamp | X | X | X |
| TrapOID | X | X | X |

# Config Settings ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) 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](#config-method-snmptrapmgr-struct) method.

### SNMPTrapMgr Config Settings

**AuthenticationKey**: The key to use for authentication.This setting takes the hex-encoded key for authentication and may be set inside [on_get_user_password](#on_get_user_password-event-snmptrapmgr-struct).

**CompatibilityMode**: Whether to operate the component in a specific compatibility mode.This setting will cause the component to operate in a manner different than normal so that it is compatible with third-party products and libraries. The following table lists the possible values for this setting:

|  |  |
| --- | --- |
| 0 (default) | Component operates normally for greatest compatibility. |
| 1 | Component uses SNMP4j-compatible encryption (AES192 and AES256). |
| 2 | Component automatically detects whether to use SNMP4j-compatible encryption (AES192 and AES256). Note: This option is only applicable when receiving packets. If you are using [SNMPMgr](SNMPMgr.md#SNMPMgr) or sending secure traps, you will need to select either 0 or 1. |

**ContextEngineId**: Sets the context engine id of the SNMP entity. If set, the context engine id included in the PDU will be set.

**ContextName**: Sets the context name of the SNMP entity. If set, the context name included in the PDU will be set.

**DecryptLogPackets**: Whether to decrypt logged packets.When set to *true* this setting will cause the struct to decrypt packets logged in [on_packet_trace](#on_packet_trace-event-snmptrapmgr-struct). This only applies when using SNMP Version 3. The default is *false*.

**EncryptionKey**: The key to use for encryption.This setting takes the hex-encoded key for encryption and may be set inside [on_get_user_password](#on_get_user_password-event-snmptrapmgr-struct).

**ForceLocalPort**: Forces the struct to bind to a specific port. The default value is True, which makes the struct throw an error if [local_port](#local_port-property-snmptrapmgr-struct) is busy. When [ForceLocalPort](#ForceLocalPort) is set to False and the port is busy, the struct silently chooses another random port.

**IncomingContextEngineId**: The engine Id of the received packet.This setting holds the engine Id of the received packet. This may be queried at any time, including from within an event, and returns the engine Id of the received packet. This is not needed in most cases, but can be used to store the incoming engine Id to send an asynchronous response later. This value is read-only.

**IncomingContextName**: The context name of the received packet.This setting holds the context name of the received packet. This may be queried at any time, including from within an event, and returns the context name of the received packet. This is not needed in most cases, but can be used to store the incoming context name to send an asynchronous response later. This value is read-only.

**ShowCacheForUser**: Shows the cache entry for a single user.This configuration setting causes the struct to call ShowCache internally, and only fire the CacheEntry event for the user specified.

**SourceAddress**: The source address of the received packet.This setting holds the source address of the received packet. This may be queried at any time, including from within an event, and returns the source address of the received packet. This value is read-only.

**SourcePort**: The source port of the received packet.This setting holds the source port of the received packet. This may be queried at any time, including from within an event, and returns the source port of the received packet. This value is read-only.

**TimeWindow**: The time window used for SNMPv3 timeliness checking (authentication).The default value is 150 (seconds).

### UDP Config Settings

**CaptureIPPacketInfo**: Used to capture the packet information.If this is set to True, the component will capture the IP packet information.

The default value for this setting is False.

NOTE: This configuration setting is available only in Windows.

**DelayHostResolution**: Whether the hostname is resolved when RemoteHost is set.This configuration setting specifies whether a hostname is resolved immediately when remote_host is set. If *true* the struct will resolve the hostname and the IP address will be present in the remote_host property. If *false*, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, resolve_remote_host may be called to manually resolve the value in remote_host at any time.

The default value is *false*.

**DestinationAddress**: Used to get the destination address from the packet information.If [CaptureIPPacketInfo](#CaptureIPPacketInfo) is set to True, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event.

NOTE: This configuration setting is available only in Windows.

**DontFragment**: Used to set the Don't Fragment flag of outgoing packets.When set to True, packets sent by the struct will have the Don't Fragment flag set. The default value is False.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [local_host](#local_host-property-snmptrapmgr-struct) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface.

If the struct is connected, the [local_host](#local_host-property-snmptrapmgr-struct) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

**LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by [local_port](#local_port-property-snmptrapmgr-struct) after the connection is established.

[local_port](#local_port-property-snmptrapmgr-struct) cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxPacketSize**: The maximum length of the packets that can be received.This configuration setting specifies the maximum size of the datagrams that the struct will accept without truncation.

**QOSDSCPValue**: Used to specify an arbitrary QOS/DSCP setting (optional).[UseConnection](#UseConnection) must be True to use this configuration setting. This option allows you to specify an arbitrary DSCP value between 0 and 63. The default is 0. When set to the default value, the component will not set a DSCP value.

NOTE: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later.

**QOSTrafficType**: Used to specify QOS/DSCP settings (optional).[UseConnection](#UseConnection) must be True to use this setting. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).

NOTE: This configuration setting uses the qWAVE API and is available only on Windows Vista and Windows Server 2008 or above.

NOTE: QOSTrafficType must be set before setting [active](#active-property-snmptrapmgr-struct) to True.

**ShareLocalPort**: If set to True, allows more than one instance of the struct to be active on the same local port.This option must be set before the struct is activated through the [active](#active-property-snmptrapmgr-struct) property or it will have no effect.

The default value for this setting is False.

**UseConnection**: Determines whether to use a connected socket.[UseConnection](#UseConnection) specifies whether or not the struct should use a connected socket. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional Transmission Control Protocol (TCP) sense. It means only that the struct will send and receive data to and from the specified destination.

The default value for this setting is False.

**UseIPv6**: Whether or not to use IPv6.By default, the component expects an IPv4 address for local and remote host properties, and it will create an IPv4 socket. To use IPv6 instead, set this to True.

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within timeout seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([SNMPTrapMgr](#struct-ipworkssnmpsnmptrapmgr) Struct)

### SNMPTrapMgr Errors

|  |  |
| --- | --- |
| 301 | Bad Object Index. |
| 302 | Value exceeds maximum number of objects allowed. |
| 303 | The value must be an IP address in dotted format. |
| 305 | Unsupported SNMP version. |
| 306 | Unknown PDU type. |
| 307 | The struct is busy performing the current action. |
| 308 | Verification failed. |
| 309 | Missing password for Verification. |
| 310 | Missing signature. |
| 311 | Missing remote time. |
| 312 | Missing timeout value. |
| 313 | Decryption Failed. |
| 314 | Missing password for decryption. |
| 315 | Not encrypted. |
| 316 | Security model not supported. |
| 317 | Defective packet |
| 318 | Not from bound point. |
| 319 | Operation not permitted in current role. |
| 320 | Bad packet. |
| 321 | Message not authenticated. |
| 322 | No such oid. |
| 323 | Missing privacy parameter. |
| 324 | Bad engine id. |
| 325 | Bad time frame. |
| 326 | Bad user name. |
| 327 | Security level was not accepted. |
| 328 | Discovery failed. |
| 329 | Incorrect key length. |

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

### UDP Errors

|  |  |
| --- | --- |
| 104 | UDP is already [active](#active-property-snmptrapmgr-struct). |
| 106 | You cannot change the [local_port](#local_port-property-snmptrapmgr-struct) while the struct is [active](#active-property-snmptrapmgr-struct). |
| 107 | You cannot change the [local_host](#local_host-property-snmptrapmgr-struct) at this time. A connection is in progress. |
| 109 | The struct must be [active](#active-property-snmptrapmgr-struct) for this operation. |
| 112 | You cannot change [MaxPacketSize](#MaxPacketSize) while the struct is [active](#active-property-snmptrapmgr-struct). |
| 113 | You cannot change [ShareLocalPort](#ShareLocalPort) option while the struct is [active](#active-property-snmptrapmgr-struct). |
| 114 | You cannot change remote_host when [UseConnection](#UseConnection) is set and the struct [active](#active-property-snmptrapmgr-struct). |
| 115 | You cannot change remote_port when [UseConnection](#UseConnection) is set and the struct is [active](#active-property-snmptrapmgr-struct). |
| 116 | remote_port cannot be zero when [UseConnection](#UseConnection) is set. Please specify a valid service port number. |
| 117 | You cannot change [UseConnection](#UseConnection) while the struct is [active](#active-property-snmptrapmgr-struct). |
| 118 | Message cannot be longer than [MaxPacketSize](#MaxPacketSize). |
| 119 | Message too short. |
| 434 | Unable to convert string to selected CodePage. |

### SSL Errors

|  |  |
| --- | --- |
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |

### TCP/IP Errors

|  |  |
| --- | --- |
| 10004 | [10004] Interrupted system call. |
| 10009 | [10009] Bad file number. |
| 10013 | [10013] Access denied. |
| 10014 | [10014] Bad address. |
| 10022 | [10022] Invalid argument. |
| 10024 | [10024] Too many open files. |
| 10035 | [10035] Operation would block. |
| 10036 | [10036] Operation now in progress. |
| 10037 | [10037] Operation already in progress. |
| 10038 | [10038] Socket operation on nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot assign requested address. |
| 10050 | [10050] Network is down. |
| 10051 | [10051] Network is unreachable. |
| 10052 | [10052] Net dropped connection or reset. |
| 10053 | [10053] Software caused connection abort. |
| 10054 | [10054] Connection reset by peer. |
| 10055 | [10055] No buffer space available. |
| 10056 | [10056] Socket is already connected. |
| 10057 | [10057] Socket is not connected. |
| 10058 | [10058] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is not empty |
| 10067 | [10067] Too many processes. |
| 10068 | [10068] Too many users. |
| 10069 | [10069] Disc Quota Exceeded. |
| 10070 | [10070] Stale NFS file handle. |
| 10071 | [10071] Too many levels of remote in path. |
| 10091 | [10091] Network subsystem is unavailable. |
| 10092 | [10092] WINSOCK DLL Version out of range. |
| 10093 | [10093] Winsock is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |