# SNMPMgr Class The SNMPMgr class is used to implement UDP-based SNMP Management Applications. ## Syntax **ipworkssnmp.snmpmgr()** ## Remarks The SNMPMgr class implements a UDP-based standard SNMP Manager as specified in the SNMP RFCs. The class supports SNMP v1, v2c, and v3. SNMP over DTLS is also supported when [SSLEnabled](#snmpmgrsslenabled-property) is set to True. When acting as a client, the [SSLServerAuthentication](#snmpmgrsslserverauthentication-event) event allows you to check the server identity and other security attributes. The [SSLStatus](#snmpmgrsslstatus-event) event provides information about the DTLS handshake. Additional SSL-related settings are also supported through the [Config](#snmpmgrconfig-method) method. When acting as a server, the **SSLCert** properties are used to select a certificate for the server. When client authentication is required, the [SSLAuthenticateClients](#snmpmgrsslauthenticateclients-property) property can be set to True and the [SSLClientAuthentication](#snmpmgrsslclientauthentication-event) event can be used to examine client credentials. The class provides both encoding/decoding and transport capabilities, making the task of developing a custom SNMP manager as simple as setting a few key properties and handling a few events. SNMP data, such as for instance SNMP object id-s (OID-s) are exchanged as text strings, thus further simplifying the task of handling them. The class is activated/deactivated by calling the [Activate](#snmpmgractivate-method) or [Deactivate](#snmpmgrdeactivate-method) method. These methods enable or disable sending and receiving. The activation status can be found in the [Active](#snmpmgractive-property) property. Messages are received through events such as [Response](#snmpmgrresponse-event), [Trap](#snmpmgrtrap-event), or [InformRequest](#snmpmgrinformrequest-event). SNMP Traps are received through the [Trap](#snmpmgrtrap-event) event. Messages are sent to other agents or managers by using class's methods such as [SendGetRequest](#snmpmgrsendgetrequest-method), [SendGetNextRequest](#snmpmgrsendgetnextrequest-method), [SendGetBulkRequest](#snmpmgrsendgetbulkrequest-method), [SendSetRequest](#snmpmgrsendsetrequest-method), and [SendInformRequest](#snmpmgrsendinformrequest-method). SNMP OIDs, types, and values are provided in the [Objects](#snmpmgrobjects-property) collection of SNMP objects for both sent and received packets. SNMPv3 USM security is enabled by setting properties such as [User](#snmpmgruser-property), [AuthenticationPassword](#snmpmgrauthenticationpassword-property), and [EncryptionPassword](#snmpmgrencryptionpassword-property) and calling the [Discover](#snmpmgrdiscover-method) method to bind to a particular agent ([RemoteEngineId](#snmpmgrremoteengineid-property)). Upon successful discovery, received packets are checked for integrity (authentication) and timeliness. Note that the discovery step is optional, and may be avoided if the values for [RemoteEngineId](#snmpmgrremoteengineid-property), [RemoteEngineBoots](#snmpmgrremoteengineboots-property), and [RemoteEngineTime](#snmpmgrremoteenginetime-property) are known in advance and provided to the class through the respective properties. By default, the class operates synchronously (except for the [Discover](#snmpmgrdiscover-method) method), sending a request and waiting until the corresponding response has been received. This behavior may be overridden by setting [Timeout](#snmpmgrtimeout-property) to 0, in which case the class returns control immediately after a send, and responses are received exclusively through the [Response](#snmpmgrresponse-event) event. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AcceptData](#snmpmgracceptdata-property) | Enables or disables data reception. | | [Active](#snmpmgractive-property) | Indicates whether the class is active. | | [AuthenticationPassword](#snmpmgrauthenticationpassword-property) | The password used for SNMPv3 authentication. | | [AuthenticationProtocol](#snmpmgrauthenticationprotocol-property) | The authentication protocol used for SNMPv3 packets. | | [Community](#snmpmgrcommunity-property) | The community string used to authenticate SNMP packets. | | [EncryptionAlgorithm](#snmpmgrencryptionalgorithm-property) | The encryption algorithm used for SNMPv3 packets. | | [EncryptionPassword](#snmpmgrencryptionpassword-property) | The password used for SNMPv3 privacy. | | [ErrorDescription](#snmpmgrerrordescription-property) | Description of the status code for the last SNMP packet received by the class. | | [ErrorIndex](#snmpmgrerrorindex-property) | Index of the first variable (object) that caused an error from the last SNMP response. | | [ErrorStatus](#snmpmgrerrorstatus-property) | Status code for the last SNMP packet received by the class. | | [LocalEngineId](#snmpmgrlocalengineid-property) | The Engine Id of the SNMP Manager. | | [LocalHost](#snmpmgrlocalhost-property) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [LocalPort](#snmpmgrlocalport-property) | The port in the local host where the SNMP Manager is bound to. | | [Objects](#snmpmgrobjects-property) | The objects in the current request. | | [RemoteEngineBoots](#snmpmgrremoteengineboots-property) | The remote engine boots (SNMPv3). | | [RemoteEngineId](#snmpmgrremoteengineid-property) | The Engine Id of the remote agent. | | [RemoteEngineTime](#snmpmgrremoteenginetime-property) | The remote engine time (SNMPv3). | | [RemoteHost](#snmpmgrremotehost-property) | The address of the remote host. Domain names are resolved to IP addresses. | | [RemotePort](#snmpmgrremoteport-property) | The port where the remote SNMP agent is listening. | | [RequestId](#snmpmgrrequestid-property) | The request-id to mark outgoing packets with. | | [SNMPVersion](#snmpmgrsnmpversion-property) | Version of SNMP used for outgoing requests. | | [SSLAcceptServerCert](#snmpmgrsslacceptservercert-property) | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLAuthenticateClients](#snmpmgrsslauthenticateclients-property) | If set to True, the server asks the client(s) for a certificate. | | [SSLCert](#snmpmgrsslcert-property) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLEnabled](#snmpmgrsslenabled-property) | Whether DTLS is enabled. | | [SSLServerCert](#snmpmgrsslservercert-property) | The server certificate for the last established connection. | | [StoreWalkObjects](#snmpmgrstorewalkobjects-property) | Tells the class whether or not to store returned objects. | | [Timeout](#snmpmgrtimeout-property) | This property includes the timeout for the class. | | [User](#snmpmgruser-property) | The user name used for SNMPv3 authentication. | | [WalkLimit](#snmpmgrwalklimit-property) | The limit of oid's returned in a walk. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Activate](#snmpmgractivate-method) | Activates the class. | | [Config](#snmpmgrconfig-method) | Sets or retrieves a configuration setting. | | [Deactivate](#snmpmgrdeactivate-method) | Deactivates the class. | | [Discover](#snmpmgrdiscover-method) | Performs SNMPv3 discovery. | | [DoEvents](#snmpmgrdoevents-method) | This method processes events from the internal message queue. | | [HashPasswords](#snmpmgrhashpasswords-method) | Hashes all passwords in the cache. | | [Interrupt](#snmpmgrinterrupt-method) | This method interrupts the current method. | | [PauseData](#snmpmgrpausedata-method) | This method pauses data reception. | | [ProcessData](#snmpmgrprocessdata-method) | This method reenables data reception after a call to PauseData . | | [Reset](#snmpmgrreset-method) | Clears the object arrays. | | [SendGetBulkRequest](#snmpmgrsendgetbulkrequest-method) | Send a GetBulkRequest packet. | | [SendGetNextRequest](#snmpmgrsendgetnextrequest-method) | Send GetNextRequest packet. | | [SendGetRequest](#snmpmgrsendgetrequest-method) | Send GetRequest packet. | | [SendInformRequest](#snmpmgrsendinformrequest-method) | Send an InformRequest packet. | | [SendSetRequest](#snmpmgrsendsetrequest-method) | Send Set Request packet. | | [Value](#snmpmgrvalue-method) | Returns the value corresponding to an OID. | | [Walk](#snmpmgrwalk-method) | Does an SNMP walk starting with the specified oid. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BadPacket](#snmpmgrbadpacket-event) | Fired for erroneous and/or malformed messages. | | [Connected](#snmpmgrconnected-event) | Fired immediately after a connection completes (or fails). | | [Disconnected](#snmpmgrdisconnected-event) | Fired when a connection is closed. | | [DiscoveryRequest](#snmpmgrdiscoveryrequest-event) | Fired when an SNMPv3 discovery packet is received. | | [DiscoveryResponse](#snmpmgrdiscoveryresponse-event) | Fired when an SNMPv3 discovery response is received. | | [Error](#snmpmgrerror-event) | Fired when information is available about errors during data delivery. | | [HashPassword](#snmpmgrhashpassword-event) | Fired before and after a password is hashed. | | [InformRequest](#snmpmgrinformrequest-event) | Fired when an InformRequest packet is received. | | [PacketTrace](#snmpmgrpackettrace-event) | Fired for every packet sent or received. | | [ReadyToSend](#snmpmgrreadytosend-event) | Fired when the class is ready to send data. | | [Report](#snmpmgrreport-event) | Fired when a Report packet is received. | | [Response](#snmpmgrresponse-event) | Fired when a GetResponse packet is received. | | [SSLClientAuthentication](#snmpmgrsslclientauthentication-event) | Fired when the client presents its credentials to the server. | | [SSLServerAuthentication](#snmpmgrsslserverauthentication-event) | Fires when connecting to the server. | | [SSLStatus](#snmpmgrsslstatus-event) | Shows the progress of the secure connection. | | [Trap](#snmpmgrtrap-event) | Fired when a SNMP trap packet is received. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AllowSingleStepDiscovery](#AllowSingleStepDiscovery) | Whether to allow discovery to be completed in a single step. | | [CheckMessageOrigin](#CheckMessageOrigin) | Whether to match the origin IP address when receiving responses. | | [CheckSNMPVersion](#CheckSNMPVersion) | Whether to check the version of incoming packets. | | [CompatibilityMode](#CompatibilityMode) | Whether to operate the class 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. | | [ForceLocalPort](#ForceLocalPort) | Forces the class to bind to a specific port. | | [IgnoreDuplicateResponse](#IgnoreDuplicateResponse) | Whether to ignore duplicate responses. | | [IgnorePortMismatch](#IgnorePortMismatch) | Whether to check if the port matches when a response is received. | | [IncomingContextEngineId](#IncomingContextEngineId) | The engine Id of the received packet. | | [IncomingContextName](#IncomingContextName) | The context name of the received packet. | | [MsgMaxSize](#MsgMaxSize) | The maximum supported message size. | | [SourceAddress](#SourceAddress) | The source address of the received packet. | | [SourcePort](#SourcePort) | The source port of the received packet. | | [TimeoutInMilliseconds](#TimeoutInMilliseconds) | The timeout is treated as milliseconds. | | [WalkInsideRange](#WalkInsideRange) | Stops the SNMP walk if the OID value returned from an agent is outside the table. | | [WalkStartOID](#WalkStartOID) | Specifies the OID to be used when a Walk is performed. | | [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 class 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 class 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. | # [SNMPMgr](#snmpmgr-class).AcceptData Property Enables or disables data reception. ## Syntax ```text isAcceptData(): boolean; ``` ## 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 and not available at design time. # [SNMPMgr](#snmpmgr-class).Active Property Indicates whether the class is active. ## Syntax ```text isActive(): boolean; ``` ## Default Value FALSE ## Remarks This property indicates whether the class is currently active and can send or receive data. The class will be automatically activated if it is not already and you attempt to perform an operation which requires the class to be active. Use the [Activate](#snmpmgractivate-method) and [Deactivate](#snmpmgrdeactivate-method) methods to control whether the class is active. This property is read-only and not available at design time. # [SNMPMgr](#snmpmgr-class).AuthenticationPassword Property The password used for SNMPv3 authentication. ## Syntax ```text getAuthenticationPassword(): string; setAuthenticationPassword(authenticationPassword: string): void; ``` ## Default Value "" ## Remarks Every time [EncryptionPassword](#snmpmgrencryptionpassword-property), AuthenticationPassword, or [RemoteEngineId](#snmpmgrremoteengineid-property) are set, a localized key is computed automatically, and cached internally. # [SNMPMgr](#snmpmgr-class).AuthenticationProtocol Property The authentication protocol used for SNMPv3 packets. ## Syntax ```text getAuthenticationProtocol(): SNMPMgrAuthenticationProtocols; setAuthenticationProtocol(authenticationProtocol: SNMPMgrAuthenticationProtocols): void; enum SNMPMgrAuthenticationProtocols { authpHMACMD596, authpHMACSHA96, authpHMAC192SHA256, authpHMAC384SHA512, authpHMAC128SHA224, authpHMAC256SHA384 } ``` ## Default Value 1 ## Remarks This property defines the authentication protocol used when [SNMPVersion](#snmpmgrsnmpversion-property) is set to snmpverV3. Possible values are: - 1 (HMAC-MD5-96 - default) - 2 (HMAC-SHA-96) - 3 (HMAC-192-SHA-256) - 4 (HMAC-384-SHA-512) - 5 (HMAC-128-SHA-224) - 6 (HMAC-256-SHA-384) This property is not available at design time. # [SNMPMgr](#snmpmgr-class).Community Property The community string used to authenticate SNMP packets. ## Syntax ```text getCommunity(): string; setCommunity(community: string): void; ``` ## Default Value "public" ## Remarks Must match the community name that is specified on the agent. Typical values are "public" or "private". This property is used for all SNMP packets sent by the class. # [SNMPMgr](#snmpmgr-class).EncryptionAlgorithm Property The encryption algorithm used for SNMPv3 packets. ## Syntax ```text getEncryptionAlgorithm(): SNMPMgrEncryptionAlgorithms; setEncryptionAlgorithm(encryptionAlgorithm: SNMPMgrEncryptionAlgorithms): void; enum SNMPMgrEncryptionAlgorithms { encraDES, encraAES, encra3DES, encraAES192, encraAES256 } ``` ## Default Value 1 ## Remarks In order to use encryption, you must set the [EncryptionPassword](#snmpmgrencryptionpassword-property) property. The supported algorithms for encryption are: | | | | --- | --- | | DES (1) | Data Encryption Standard. | | AES (2) | Advanced Encryption Standard with key length of 128. | | 3DES (3) | Triple Data Encryption Standard. | | AES192 (4) | Advanced Encryption Standard with key length of 192. | | AES256 (5) | Advanced Encryption Standard with key length of 256. | This property is not available at design time. # [SNMPMgr](#snmpmgr-class).EncryptionPassword Property The password used for SNMPv3 privacy. ## Syntax ```text getEncryptionPassword(): string; setEncryptionPassword(encryptionPassword: string): void; ``` ## Default Value "" ## Remarks Every time EncryptionPassword, [AuthenticationPassword](#snmpmgrauthenticationpassword-property), or [RemoteEngineId](#snmpmgrremoteengineid-property) are set, a localized key is computed automatically, and cached internally. # [SNMPMgr](#snmpmgr-class).ErrorDescription Property Description of the status code for the last SNMP packet received by the class. ## Syntax ```text getErrorDescription(): string; ``` ## Default Value "0" ## Remarks Please refer to the [ErrorStatus](#snmpmgrerrorstatus-property) property for more information. This property is read-only and not available at design time. # [SNMPMgr](#snmpmgr-class).ErrorIndex Property Index of the first variable (object) that caused an error from the last SNMP response. ## Syntax ```text getErrorIndex(): number; ``` ## Default Value 0 ## Remarks This property is used in conjunction with the [ErrorStatus](#snmpmgrerrorstatus-property) property, and refers to the object that caused the error reported in the last SNMP response. This value is parsed directly from the SNMP response, which will be a one-based value, so a value of i here maps to index i-1 in the [Objects](#snmpmgrobjects-property) collection. The ErrorIndex property has no meaning when the [ErrorStatus](#snmpmgrerrorstatus-property) property is 0 (no error). This property is read-only and not available at design time. # [SNMPMgr](#snmpmgr-class).ErrorStatus Property Status code for the last SNMP packet received by the class. ## Syntax ```text getErrorStatus(): number; ``` ## Default Value 0 ## Remarks This property is used in conjunction with the [ErrorIndex](#snmpmgrerrorindex-property) property, which denotes the index of the variable in error. The [ErrorDescription](#snmpmgrerrordescription-property) property provides a textual description of the error. The following is a list of valid SNMP status code values: | | | | --- | --- | | 0 (noError) | No error. | | 1 (tooBig) | The response cannot fit in a single SNMP message. | | 2 (noSuchName) | Variable does not exist. | | 3 (badValue) | Invalid value or syntax. | | 4 (readOnly) | Variable is read-only. | | 5 (genError) | Other error (SNMPv1). | | 6 (noAccess) | Access denied. | | 7 (wrongType) | Wrong object type. | | 8 (wrongLength) | Wrong length. | | 9 (wrongEncoding) | Wrong encoding. | | 10 (wrongValue) | Wrong value. | | 11 (noCreation) | No creation. | | 12 (inconsistentValue) | Inconsistent value. | | 13 (resourceUnavailable) | Resource unavailable. | | 14 (commitFailed) | Commit failed. | | 15 (undoFailed) | Undo failed. | | 16 (authorizationError) | Authorization error. | | 17 (notWritable) | Variable is not writable. | | 18 (inconsistentName) | Inconsistent name. | 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). The default value is 0 (no error). This property is read-only and not available at design time. # [SNMPMgr](#snmpmgr-class).LocalEngineId Property The Engine Id of the SNMP Manager. ## Syntax ```text getLocalEngineId(): Uint8Array; setLocalEngineId(localEngineId: Uint8Array): void; ``` ## Default Value "" ## Remarks This property is only used for SNMPv3 packets (when [SNMPVersion](#snmpmgrsnmpversion-property) is 3). # [SNMPMgr](#snmpmgr-class).LocalHost Property The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text getLocalHost(): string; setLocalHost(localHost: string): void; ``` ## 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 class initiate connections (or accept in the case of server classes) 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 class is connected, the LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window. # [SNMPMgr](#snmpmgr-class).LocalPort Property The port in the local host where the SNMP Manager is bound to. ## Syntax ```text getLocalPort(): number; setLocalPort(localPort: number): void; ``` ## Default Value 0 ## Remarks The LocalPort property must be set before the class is activated ([Active](#snmpmgractive-property) is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine. The default port is 0 (random port). If you would like to receive traps, set LocalPort to 162 (standard trap port). However, it is recommended that the [SNMPTrapMgr](SNMPTrapMgr.md#SNMPTrapMgr) class be used for listening to traps, because [SNMPMgr](#snmpmgr-class) is limited to receiving SNMPv3 traps from a single agent only. [SNMPTrapMgr](SNMPTrapMgr.md#SNMPTrapMgr) does not have this limitation. LocalPort cannot be changed once the class is [Active](#snmpmgractive-property). Any attempt to set the LocalPort property when the class is [Active](#snmpmgractive-property) will generate an error. NOTE: on macOS and iOS, root permissions are required to set LocalPort to any value below 1024. # [SNMPMgr](#snmpmgr-class).Objects Property The objects in the current request. ## Syntax ```text getObjects(): SNMPObjectList; ``` ## Default Value ## Remarks The SNMP objects being sent or received in the current request. The collection is first cleared, then populated every time an SNMP packet is received. It is also used to create outgoing SNMP packets. Please refer to the [SNMPObject](#snmpobject-type) type for a complete list of fields. # [SNMPMgr](#snmpmgr-class).RemoteEngineBoots Property The remote engine boots (SNMPv3). ## Syntax ```text getRemoteEngineBoots(): number; setRemoteEngineBoots(remoteEngineBoots: number): void; ``` ## Default Value 0 ## Remarks This property is used in conjunction with the [RemoteEngineTime](#snmpmgrremoteenginetime-property) property. Please refer to the description of the [RemoteEngineTime](#snmpmgrremoteenginetime-property) property, and the [Discover](#snmpmgrdiscover-method) method for further information. # [SNMPMgr](#snmpmgr-class).RemoteEngineId Property The Engine Id of the remote agent. ## Syntax ```text getRemoteEngineId(): Uint8Array; setRemoteEngineId(remoteEngineId: Uint8Array): void; ``` ## Default Value "" ## Remarks This property is only used for SNMPv3 packets (see [SNMPVersion](#snmpmgrsnmpversion-property)), and is reset every time [RemoteHost](#snmpmgrremotehost-property) or [RemotePort](#snmpmgrremoteport-property) changes. RemoteEngineId is normally discovered through the [Discover](#snmpmgrdiscover-method) method. However, by manually supplying a value for the property, RemoteEngineId discovery step may be eliminated, thus avoiding the extra roundtrip to the agent ([RemoteEngineBoots](#snmpmgrremoteengineboots-property) and [RemoteEngineTime](#snmpmgrremoteenginetime-property) are also required for [User](#snmpmgruser-property) authentication - please refer to the [Discover](#snmpmgrdiscover-method) method for more information). # [SNMPMgr](#snmpmgr-class).RemoteEngineTime Property The remote engine time (SNMPv3). ## Syntax ```text getRemoteEngineTime(): number; setRemoteEngineTime(remoteEngineTime: number): void; ``` ## Default Value 0 ## Remarks RemoteEngineTime is used by SNMPv3 authentication to ensure timeliness of requests, and avoid replay attacks. The value of RemoteEngineTime is provided as what is expected to be the current value of the remote engine clock based on a cached time differential between the remote engine clock and the local engine time obtained during the discovery process (see [Discover](#snmpmgrdiscover-method)). This property is used in conjunction with [RemoteEngineBoots](#snmpmgrremoteengineboots-property). Please refer to the [RemoteEngineBoots](#snmpmgrremoteengineboots-property) property and the [Discover](#snmpmgrdiscover-method) method for more information. # [SNMPMgr](#snmpmgr-class).RemoteHost Property The address of the remote host. Domain names are resolved to IP addresses. ## Syntax ```text getRemoteHost(): string; async setRemoteHost(remoteHost: string): Promise; ``` ## Default Value "" ## Remarks The RemoteHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the host SNMP requests or traps are sent to. If RemoteHost is set to 255.255.255.255, the class broadcasts data on the local subnet. If the RemoteHost property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the RemoteHost property is set to the corresponding address. If the search is not successful, an error is returned. # [SNMPMgr](#snmpmgr-class).RemotePort Property The port where the remote SNMP agent is listening. ## Syntax ```text getRemotePort(): number; setRemotePort(remotePort: number): void; ``` ## Default Value 161 ## Remarks The RemotePort is the port on the [RemoteHost](#snmpmgrremotehost-property) to send SNMP requests to. A valid port number (a value between 1 and 65535) is required. The default value is 161. # [SNMPMgr](#snmpmgr-class).RequestId Property The request-id to mark outgoing packets with. ## Syntax ```text getRequestId(): number; setRequestId(requestId: number): void; ``` ## Default Value 1 ## Remarks If a custom value is needed for RequestId, the property must be set before sending the request. The class increments RequestId automatically after sending each packet. This property is not available at design time. # [SNMPMgr](#snmpmgr-class).SNMPVersion Property Version of SNMP used for outgoing requests. ## Syntax ```text getSNMPVersion(): SNMPMgrSNMPVersions; setSNMPVersion(SNMPVersion: SNMPMgrSNMPVersions): void; enum SNMPMgrSNMPVersions { snmpverV1, snmpverV2c, snmpverV3 } ``` ## Default Value 2 ## Remarks This property takes one of the following values: | | | | --- | --- | | snmpverV1 (1) | SNMP Version 1. | | snmpverV2c (2) | SNMP Version 2c. | | snmpverV3 (3) | SNMP Version 3. | # [SNMPMgr](#snmpmgr-class).SSLAcceptServerCert Property Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax ```text getSSLAcceptServerCert(): Certificate; setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void; ``` ## Default Value ## Remarks If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally. NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [SNMPMgr](#snmpmgr-class).SSLAuthenticateClients Property If set to True, the server asks the client(s) for a certificate. ## Syntax ```text isSSLAuthenticateClients(): boolean; setSSLAuthenticateClients(SSLAuthenticateClients: boolean): void; ``` ## Default Value FALSE ## Remarks This property is used in conjunction with the [SSLClientAuthentication](#snmpmgrsslclientauthentication-event) event. Please refer to the documentation of the [SSLClientAuthentication](#snmpmgrsslclientauthentication-event) event for details. # [SNMPMgr](#snmpmgr-class).SSLCert Property The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text getSSLCert(): Certificate; setSSLCert(SSLCert: Certificate): void; ``` ## Default Value ## Remarks This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [SNMPMgr](#snmpmgr-class).SSLEnabled Property Whether DTLS is enabled. ## Syntax ```text isSSLEnabled(): boolean; setSSLEnabled(SSLEnabled: boolean): void; ``` ## Default Value FALSE ## Remarks This setting specifies whether DTLS is enabled in the class. When False (default) the class operates in plaintext mode. When True DTLS is enabled. This property is not available at design time. # [SNMPMgr](#snmpmgr-class).SSLServerCert Property The server certificate for the last established connection. ## Syntax ```text getSSLServerCert(): Certificate; ``` ## Default Value ## Remarks This property contains the server certificate for the last established connection. SSLServerCert is reset every time a new connection is attempted. This property is read-only. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [SNMPMgr](#snmpmgr-class).StoreWalkObjects Property Tells the class whether or not to store returned objects. ## Syntax ```text isStoreWalkObjects(): boolean; setStoreWalkObjects(storeWalkObjects: boolean): void; ``` ## Default Value TRUE ## Remarks When a [Walk](#snmpmgrwalk-method) is performed, this property tells the class whether or not to store the objects that are returned by the server in the [Objects](#snmpmgrobjects-property) collection. If the data is accumulated through the events, and not desired to be saved by the class, set this property to false. # [SNMPMgr](#snmpmgr-class).Timeout Property This property includes the timeout for the class. ## Syntax ```text getTimeout(): number; setTimeout(timeout: number): void; ``` ## Default Value 60 ## Remarks If the Timeout property is set to 0, all operations return immediately, potentially failing with a *WOULDBLOCK* error if data cannot be sent immediately. If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of Timeout seconds. The class will use [DoEvents](#snmpmgrdoevents-method) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If Timeout expires, and the operation is not yet complete, the class . NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. # [SNMPMgr](#snmpmgr-class).User Property The user name used for SNMPv3 authentication. ## Syntax ```text getUser(): string; setUser(user: string): void; ``` ## Default Value "" ## Remarks If authentication is desired, this property must be set before the class attempts to connect to an SNMPv3 Agent. # [SNMPMgr](#snmpmgr-class).WalkLimit Property The limit of oid's returned in a walk. ## Syntax ```text getWalkLimit(): number; setWalkLimit(walkLimit: number): void; ``` ## Default Value 0 ## Remarks This property specifies the limit of how many oid's are to be traversed during an SNMP [Walk](#snmpmgrwalk-method). If set to 0, the class will traverse all oid's in the specified table that are lexicographically greater than the value of the specified table oid. # [SNMPMgr](#snmpmgr-class).activate Method Activates the class. ## Syntax ```text async snmpmgr.activate(): Promise< void> ``` ## Remarks This method activates the component and will allow it to send or receive data. The class will be automatically activated if it is not already and you attempt to perform an operation which requires the class to be active. NOTE: Use the [Active](#snmpmgractive-property) property to check whether the component is active. # [SNMPMgr](#snmpmgr-class).config Method Sets or retrieves a configuration setting. ## Syntax ```text async snmpmgr.config(configurationString : string): Promise< string> ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-class-ipworkssnmpsnmpmgr) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-class-ipworkssnmpsnmpmgr), you must call *Config("PROPERTY")*. The value will be returned as a string. # [SNMPMgr](#snmpmgr-class).deactivate Method Deactivates the class. ## Syntax ```text async snmpmgr.deactivate(): Promise< void> ``` ## Remarks This method deactivates the component and will prohibit it from sending and receiving data. NOTE: Use the [Active](#snmpmgractive-property) property to check whether the component is active. # [SNMPMgr](#snmpmgr-class).discover Method Performs SNMPv3 discovery. ## Syntax ```text async snmpmgr.discover(): Promise< void> ``` ## Remarks When the method is called an SNMPv3 engine discovery request is sent to [RemoteHost](#snmpmgrremotehost-property). If an [AuthenticationPassword](#snmpmgrauthenticationpassword-property) is provided, the engine id discovery request is followed by an engine time discovery request, as required by the SNMPv3 User Security Model (USM). In this case [Timeout](#snmpmgrtimeout-property) must be set to a non-zero value before calling **Discover** and the class will wait until a response is received from [RemoteHost](#snmpmgrremotehost-property). The [DiscoveryResponse](#snmpmgrdiscoveryresponse-event) event is fired upon receipt of a valid discovery response and the values of [RemoteEngineId](#snmpmgrremoteengineid-property), [RemoteEngineBoots](#snmpmgrremoteengineboots-property), and [RemoteEngineTime](#snmpmgrremoteenginetime-property) will then be updated with the received Engine Id, Time, and Boots. # [SNMPMgr](#snmpmgr-class).doEvents Method This method processes events from the internal message queue. ## Syntax ```text async snmpmgr.doEvents(): Promise< void> ``` ## Remarks When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns. # [SNMPMgr](#snmpmgr-class).hashPasswords Method Hashes all passwords in the cache. ## Syntax ```text async snmpmgr.hashPasswords(): Promise< void> ``` ## Remarks Forces computation of all passwords hashes in the cache. Used together with the [HashPassword](#snmpmgrhashpassword-event) event to enable implementations of external password hash storage. # [SNMPMgr](#snmpmgr-class).interrupt Method This method interrupts the current method. ## Syntax ```text async snmpmgr.interrupt(): Promise< void> ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # [SNMPMgr](#snmpmgr-class).pauseData Method This method pauses data reception. ## Syntax ```text async snmpmgr.pauseData(): Promise< void> ``` ## Remarks This method pauses data reception when called. While data reception is paused, the DataIn event will not fire. Call [ProcessData](#snmpmgrprocessdata-method) to reenable data reception. # [SNMPMgr](#snmpmgr-class).processData Method This method reenables data reception after a call to PauseData . ## Syntax ```text async snmpmgr.processData(): Promise< void> ``` ## Remarks This method reenables data reception after a previous call to [PauseData](#snmpmgrpausedata-method). When [PauseData](#snmpmgrpausedata-method) is called, the DataIn event will not fire. To reenable data reception and allow DataIn to fire, call this method. NOTE: This method is used only after previously calling [PauseData](#snmpmgrpausedata-method). It does not need to be called to process incoming data by default. # [SNMPMgr](#snmpmgr-class).reset Method Clears the object arrays. ## Syntax ```text async snmpmgr.reset(): Promise< void> ``` ## 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: [SNMPVersion](#snmpmgrsnmpversion-property) will be reset to **snmpverV2c (2)**. # [SNMPMgr](#snmpmgr-class).sendGetBulkRequest Method Send a GetBulkRequest packet. ## Syntax ```text async snmpmgr.sendGetBulkRequest(nonRepeaters : number, maxRepetitions : number): Promise< void> ``` ## Remarks Sends a GetBulkRequest packet. This is only available for SNMP versions 2 and 3. *NonRepeaters* specifies the number of variables for which a single lexicographic successor is to be returned. *MaxRepetitions* specifies the number of lexicographic successors to be returned for variables other than those in the *NonRepeaters* list. The object identifiers, types, and values for the request are taken from the [Objects](#snmpmgrobjects-property) collection. A GetBulkRequest is very similar to a GetNextRequest, the difference is that Getbulk performs a continuous GetNext operation based on the *MaxRepetitions* value. The *NonRepeaters* value will determine the number of [Objects](#snmpmgrobjects-property) for which a simple GetNext operation should be performed. For the remaining variables, a continuous GetNext operation is performed based on the *MaxRepetitions* value. So if you send a request containing X objects, the agent will perform N simple GetNext operations and M continuous GetNext operations X - N times. With X being the number of objects received, N being the number of *NonRepeaters*, and M being the number of *MaxRepetitions*. Thus the SNMPMgr is expecting to receive N + M x (X - N) objects, assuming that each object has M successors. **Example (Sending a GetBulk Request)** ```text SNMPControl.RemoteHost = "MyAgent" SNMPControl.ObjCount = 2 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.objId(1) = "1.3.6.1.2.1.1.3.0" SNMPControl.SendGetBulkRequest(1,4) ``` The code sample above will send a GetBulkRequest with 1 non repeater, and a maxrepetitions of 4. Since there is only 1 non repeater, only one ObjID will "not repeat" and will only return one successor. The rest of the ObjID's (in this case, only 1) will return 4 successors. This particular example will return the following ObjID's: | | | | --- | --- | | 1 | 1.3.6.1.2.1.1.2.0 | | 2 | 1.3.6.1.2.1.1.4.0 | | 3 | 1.3.6.1.2.1.1.5.0 | | 4 | 1.3.6.1.2.1.1.6.0 | | 5 | 1.3.6.1.2.1.1.7.0 | # [SNMPMgr](#snmpmgr-class).sendGetNextRequest Method Send GetNextRequest packet. ## Syntax ```text async snmpmgr.sendGetNextRequest(): Promise< void> ``` ## Remarks Sends a GetNextRequest packet. The object identifiers, types, and values for the request are taken from the [Objects](#snmpmgrobjects-property) collection. **Example (Sending a GetNext Request)** ```text SNMPControl.ObjCount = 2 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.SendGetNextRequest() ``` The agent will respond with the "next" (relative to the ObjID(s) you specify) OID in the table. # [SNMPMgr](#snmpmgr-class).sendGetRequest Method Send GetRequest packet. ## Syntax ```text async snmpmgr.sendGetRequest(): Promise< void> ``` ## Remarks Sends a GetRequest packet. The object identifiers, types, and values for the request are taken from the [Objects](#snmpmgrobjects-property) collection. **Example (Sending a GetRequest)** ```text SNMPControl.RemoteHost = "MyAgent" SNMPControl.ObjCount = 2 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjId(1) = "1.3.6.1.2.1.1.2.0" SNMPControl.SendGetRequest() ``` # [SNMPMgr](#snmpmgr-class).sendInformRequest Method Send an InformRequest packet. ## Syntax ```text async snmpmgr.sendInformRequest(): Promise< void> ``` ## Remarks Sends an InformRequest packet. The object identifiers, types, and values for the request are taken from the [Objects](#snmpmgrobjects-property) collection. # [SNMPMgr](#snmpmgr-class).sendSetRequest Method Send Set Request packet. ## Syntax ```text async snmpmgr.sendSetRequest(): Promise< void> ``` ## Remarks Sends a SetRequest packet. The object identifiers, types, and values for the request are taken from the [Objects](#snmpmgrobjects-property) collection. **Example (Sending a SetRequest)** ```text SNMPControl.RemoteHost = "MyAgent" SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjValue(0) = "New Value" SNMPControl.ObjType(0) = otOctetString SNMPControl.SendSetRequest() ``` # [SNMPMgr](#snmpmgr-class).value Method Returns the value corresponding to an OID. ## Syntax ```text async snmpmgr.value(OID : string): Promise< string> ``` ## Remarks If the OID does not exist in the [Objects](#snmpmgrobjects-property) collection, a trappable error is generated. Please refer to the [SNMPObject](#snmpobject-type) type for more information. # [SNMPMgr](#snmpmgr-class).walk Method Does an SNMP walk starting with the specified oid. ## Syntax ```text async snmpmgr.walk(tableOid : string): Promise< void> ``` ## Remarks A walk will traverse all OIDs in the *TableOid* that are lexicographically greater than the value of the *TableOid*. The results of the walk may be obtained through the Response events. During the event, the current returned object will exist inside of the [Objects](#snmpmgrobjects-property) collection. If [StoreWalkObjects](#snmpmgrstorewalkobjects-property) is set to true, the [Objects](#snmpmgrobjects-property) collection will contain all returned objects when the Walk completes. Use the [WalkLimit](#snmpmgrwalklimit-property) property to regulate how many objects the walk will traverse in the table. NOTE: The collection of objects is cleared before the walk begins. # [SNMPMgr](#snmpmgr-class).BadPacket Event Fired for erroneous and/or malformed messages. ## Syntax ```text snmpmgr.on('BadPacket', listener: (e: {readonly packet: string, readonly packetB: Uint8Array, readonly sourceAddress: string, readonly sourcePort: number, readonly errorCode: number, readonly errorDescription: string, report: boolean}) => void ) ``` ## Remarks The full message is provided in the *Packet* parameter. The BadPacket 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. # [SNMPMgr](#snmpmgr-class).Connected Event Fired immediately after a connection completes (or fails). ## Syntax ```text snmpmgr.on('Connected', listener: (e: {readonly remoteAddress: string, readonly remotePort: number, readonly statusCode: number, readonly description: string}) => void ) ``` ## 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. # [SNMPMgr](#snmpmgr-class).Disconnected Event Fired when a connection is closed. ## Syntax ```text snmpmgr.on('Disconnected', listener: (e: {readonly remoteAddress: string, readonly remotePort: number, readonly statusCode: number, readonly description: string}) => void ) ``` ## 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. # [SNMPMgr](#snmpmgr-class).DiscoveryRequest Event Fired when an SNMPv3 discovery packet is received. ## Syntax ```text snmpmgr.on('DiscoveryRequest', listener: (e: {readonly engineId: string, readonly engineIdB: Uint8Array, readonly engineBoots: number, readonly engineTime: number, readonly user: string, readonly securityLevel: number, readonly sourceAddress: string, readonly sourcePort: number, respond: boolean}) => void ) ``` ## 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 [LocalEngineId](#snmpmgrlocalengineid-property). 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). # [SNMPMgr](#snmpmgr-class).DiscoveryResponse Event Fired when an SNMPv3 discovery response is received. ## Syntax ```text snmpmgr.on('DiscoveryResponse', listener: (e: {readonly engineId: string, readonly engineIdB: Uint8Array, readonly engineBoots: number, readonly engineTime: number, readonly user: string, readonly securityLevel: number, readonly sourceAddress: string, readonly sourcePort: number}) => void ) ``` ## Remarks *EngineId*, *EngineBoots*, *EngineTime*, and *User* are the values received from *SourceAddress* and *SourcePort*. The *SecurityLevel* parameter shows whether the request has been authenticated. If *SecurityLevel* is 0, the request has *NOT* been authenticated (i.e. the packet signature has not been verified). For an authenticated request, *SecurityLevel* is at least 1. # [SNMPMgr](#snmpmgr-class).Error Event Fired when information is available about errors during data delivery. ## Syntax ```text snmpmgr.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void ) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class . The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-class-ipworkssnmpsnmpmgr) section. # [SNMPMgr](#snmpmgr-class).HashPassword Event Fired before and after a password is hashed. ## Syntax ```text snmpmgr.on('HashPassword', listener: (e: {readonly password: string, readonly authAlgorithm: number, hash: string}) => void ) ``` ## Remarks SNMPv3 passwords are hashed in order to obtain authentication and encryption keys. This is an expensive operation, and in certain situations it may be preferable to store the hashed passwords externally and supply them on demand. If a hash is required, the event fires with an empty string in the *Hash* parameter. In this case, you can choose to supply a value for the hash and stop the class from computing the hash. The event also fires every time a hash is computed. In this case, the *Hash* parameter contains the value of the computed hash. *AuthAlgorithm* contains either 1 for HMAC-MD5-96, 2 for HMAC-SHA-96 or 3 for HMAC-192-SHA-256 # [SNMPMgr](#snmpmgr-class).InformRequest Event Fired when an InformRequest packet is received. ## Syntax ```text snmpmgr.on('InformRequest', listener: (e: {readonly requestId: number, readonly SNMPVersion: number, readonly community: string, readonly user: string, readonly securityLevel: number, readonly sourceAddress: string, readonly sourcePort: number, errorIndex: number, errorStatus: number, readonly errorDescription: string, respond: boolean}) => void ) ``` ## Remarks The user in an InformRequest packet (SNMPv3) must match the user in the [User](#snmpmgruser-property) property. If not, the request is rejected, and a [BadPacket](#snmpmgrbadpacket-event) event is fired before InformRequest is fired. The list of variables in the SNMP packet, including optional values and types, is provided through the [Objects](#snmpmgrobjects-property) collection. Each object is of type [SNMPObject](#snmpobject-type). This type describes the ObjectsOid, ObjectsObjectType, and ObjectsValue 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). # [SNMPMgr](#snmpmgr-class).PacketTrace Event Fired for every packet sent or received. ## Syntax ```text snmpmgr.on('PacketTrace', listener: (e: {readonly packet: string, readonly packetB: Uint8Array, readonly direction: number, readonly packetAddress: string, readonly packetPort: number}) => void ) ``` ## Remarks The PacketTrace event shows all the packets sent or received by the class. *Packet* contains the full contents of the datagram. *Direction* shows the direction of the packet: 1 for incoming packets, and 2 for outgoing packets. In the case of an incoming packet, *PacketAddress* and *PacketPort* identify the source of the packet. In the case of an outgoing packet, *PacketAddress* and *PacketPort* identify the destination of the packet. # [SNMPMgr](#snmpmgr-class).ReadyToSend Event Fired when the class is ready to send data. ## Syntax ```text snmpmgr.on('ReadyToSend', listener: (e: {}) => void ) ``` ## Remarks The ReadyToSend event indicates that the underlying TCP/IP subsystem is ready to accept data after a failed DataToSend(TBD. DataToSend is removed). # [SNMPMgr](#snmpmgr-class).Report Event Fired when a Report packet is received. ## Syntax ```text snmpmgr.on('Report', listener: (e: {readonly requestId: number, readonly SNMPVersion: number, readonly community: string, readonly user: string, readonly securityLevel: number, readonly sourceAddress: string, readonly sourcePort: number, readonly errorIndex: number, readonly errorStatus: number, readonly errorDescription: string}) => void ) ``` ## Remarks For SNMPv3, the *User* parameter shows the user that was supplied with the packet. This parameter *MUST* be used together with the *SecurityLevel* parameter which shows the level of security in the message. The *SecurityLevel* parameter shows whether the request has been authenticated. If *SecurityLevel* is 0, the request has *NOT* been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, *SecurityLevel* is 1. For an authenticated and encrypted request, *SecurityLevel* is 2. The list of variables in the SNMP packet, including optional values and types, is provided through the [Objects](#snmpmgrobjects-property) collection. Each object is of type [SNMPObject](#snmpobject-type). This type describes the ObjectsOid, ObjectsObjectType, and ObjectsValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events. The *SourceAddress* and *SourcePort* parameters show the address and port of the sender as reported by the TCP/IP stack. # [SNMPMgr](#snmpmgr-class).Response Event Fired when a GetResponse packet is received. ## Syntax ```text snmpmgr.on('Response', listener: (e: {readonly requestId: number, readonly SNMPVersion: number, readonly community: string, readonly user: string, readonly securityLevel: number, readonly sourceAddress: string, readonly sourcePort: number, readonly errorIndex: number, readonly errorStatus: number, readonly errorDescription: string}) => void ) ``` ## Remarks The *ErrorStatus* and *ErrorIndex* parameters contain information about possible errors. *ErrorDescription* is a textual description of *ErrorStatus*. This value is parsed directly from the SNMP response, which will be a one-based value, so a value of i here maps to index i-1 in the [Objects](#snmpmgrobjects-property) collection. The following is a list of valid SNMP status code values: | | | | --- | --- | | 0 (noError) | No error. | | 1 (tooBig) | The response cannot fit in a single SNMP message. | | 2 (noSuchName) | Variable does not exist. | | 3 (badValue) | Invalid value or syntax. | | 4 (readOnly) | Variable is read-only. | | 5 (genError) | Other error (SNMPv1). | | 6 (noAccess) | Access denied. | | 7 (wrongType) | Wrong object type. | | 8 (wrongLength) | Wrong length. | | 9 (wrongEncoding) | Wrong encoding. | | 10 (wrongValue) | Wrong value. | | 11 (noCreation) | No creation. | | 12 (inconsistentValue) | Inconsistent value. | | 13 (resourceUnavailable) | Resource unavailable. | | 14 (commitFailed) | Commit failed. | | 15 (undoFailed) | Undo failed. | | 16 (authorizationError) | Authorization error. | | 17 (notWritable) | Variable is not writable. | | 18 (inconsistentName) | Inconsistent name. | 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). The list of variables in the SNMP packet, including optional values and types, is provided through the [Objects](#snmpmgrobjects-property) collection. Each object is of type [SNMPObject](#snmpobject-type). This type describes the ObjectsOid, ObjectsObjectType, and ObjectsValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events. The *SourceAddress* and *SourcePort* parameters show the address and port of the sender as reported by the TCP/IP stack. # [SNMPMgr](#snmpmgr-class).SSLClientAuthentication Event Fired when the client presents its credentials to the server. ## Syntax ```text snmpmgr.on('SSLClientAuthentication', listener: (e: {readonly remoteAddress: string, readonly remotePort: number, readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void ) ``` ## Remarks This event fires when a client connects to the class 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. # [SNMPMgr](#snmpmgr-class).SSLServerAuthentication Event Fires when connecting to the server. ## Syntax ```text snmpmgr.on('SSLServerAuthentication', listener: (e: {readonly remoteAddress: string, readonly remotePort: number, readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void ) ``` ## Remarks This event is where the client can decide whether to continue with the connection process or not. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not. When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the *Accept* parameter to True. *RemoteAddress* is the IP address of the server. *RemotePort* is the source port of the server. *CertEncoded* is the base64 encoded certificate presented by the server. *CertSubject* is the subject of the certificate presented by the server. *CertIssuer* is the subject of the issuer of the certificate presented by the server. *Status* is the status of the certificate. *Accept* defines whether the certificate is accepted. # [SNMPMgr](#snmpmgr-class).SSLStatus Event Shows the progress of the secure connection. ## Syntax ```text snmpmgr.on('SSLStatus', listener: (e: {readonly remoteAddress: string, readonly remotePort: number, readonly message: string}) => void ) ``` ## 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. # [SNMPMgr](#snmpmgr-class).Trap Event Fired when a SNMP trap packet is received. ## Syntax ```text snmpmgr.on('Trap', listener: (e: {readonly requestId: number, readonly SNMPVersion: number, readonly community: string, readonly user: string, readonly securityLevel: number, readonly trapOID: string, readonly timeStamp: number, readonly sourceAddress: string, readonly sourcePort: number}) => void ) ``` ## Remarks The **SNMPTrapMgr** class should normally be used to receive traps, since it was designed and contains functionality specifically for that purpose. The SNMPMgr component can only receive traps from the agent that it is has most recently discovered with the [Discover](#snmpmgrdiscover-method) method. The *TrapOID* and *TimeStamp* parameters contain the Trap OID and TimeStamp. In the case of an SNMPv1 trap, there are two possible scenarios: First, if the enterprise of the trap is "1.3.6.1.6.3.1.1.5", *TrapOID* will be a concatenation of TrapEnterprise and GenericTrap + 1. For instance a TrapOID of "1.3.6.1.6.3.1.1.5.5" has a TrapEnterprise of "1.3.6.1.6.3.1.1.5" and a GenericTrap of "4". Second, In all other cases *TrapOID* will be a concatenation of the values for TrapEnterprise, GenericTrap, and SpecificTrap, separated by '.'. For SNMPv2 and above, they are read from the variable-value list (if available). For SNMPv3, the *User* parameter shows the user that was supplied with the packet. This parameter *MUST* be used together with the *SecurityLevel* parameter which shows the level of security in the message. The *SecurityLevel* parameter shows whether the request has been authenticated. If *SecurityLevel* is 0, the request has *NOT* been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, *SecurityLevel* is 1. For an authenticated and encrypted request, *SecurityLevel* is 2. The SNMPMgr class is limited to accepting authenticated traps only for the user specified in [User](#snmpmgruser-property) and Password and from the engine specified in [RemoteEngineId](#snmpmgrremoteengineid-property) with time parameters in [RemoteEngineBoots](#snmpmgrremoteengineboots-property) and [RemoteEngineTime](#snmpmgrremoteenginetime-property) (usually this is the SNMP engine discovered through the last call to [Discover](#snmpmgrdiscover-method)). If authenticated traps come from a different engine, or for a different user, they are ignored, and a [BadPacket](#snmpmgrbadpacket-event) event is fired instead. The list of variables in the SNMP packet, including optional values and types, is provided through the [Objects](#snmpmgrobjects-property) collection. Each object is of type [SNMPObject](#snmpobject-type). This type describes the ObjectsOid, ObjectsObjectType, and ObjectsValue 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. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [KeyPassword](#Certificate_f_KeyPassword) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *string (read-only)* *Default Value: ""* 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. **ExpirationDate** *string (read-only)* *Default Value: ""* 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. **ExtendedKeyUsage** *string (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *string (read-only)* *Default Value: ""* 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* **FingerprintSHA1** *string (read-only)* *Default Value: ""* 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* **FingerprintSHA256** *string (read-only)* *Default Value: ""* 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* **Issuer** *string (read-only)* *Default Value: ""* The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. **KeyPassword** *string* *Default Value: ""* The password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . This property can be used to read such password-protected private keys. NOTE: This property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling . **PrivateKey** *string (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The may be available but not exportable. In this case, returns an empty string. **PrivateKeyAvailable** *boolean (read-only)* *Default Value: False* Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *string (read-only)* *Default Value: ""* The name of the container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *string (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *string (read-only)* *Default Value: ""* 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. **PublicKeyLength** *number (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *string (read-only)* *Default Value: ""* 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. **SignatureAlgorithm** *string (read-only)* *Default Value: ""* 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. **Store** *string* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the 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). **StoreB** *Uint8Array* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the 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). **StorePassword** *string* *Default Value: ""* If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. **StoreType** *CertStoreTypes* *Default Value: 0* The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class 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](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#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 [](#f_Store) and set [](#f_StorePassword) 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. | **SubjectAltNames** *string (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *string (read-only)* *Default Value: ""* 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. **ThumbprintSHA1** *string (read-only)* *Default Value: ""* 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. **ThumbprintSHA256** *string (read-only)* *Default Value: ""* 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. **Usage** *string (read-only)* *Default Value: ""* The text description of . 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. **UsageFlags** *number (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of 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 property for a text representation of . This functionality currently is not available when the provider is OpenSSL. **Version** *string (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *string* *Default Value: ""* 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. **Encoded** *string* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. **EncodedB** *Uint8Array* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(String certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(int storeType, String store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. # SNMPObject Type The current SNMP object. ## Remarks This type defines an SNMP object. Each object has an , , and . These values are populated by the class when incoming packets are received. You may use these fields to define objects to be used in outgoing packets. The following fields are available: - [ObjectType](#SNMPObject_f_ObjectType) - [Oid](#SNMPObject_f_Oid) - [TypeString](#SNMPObject_f_TypeString) - [Value](#SNMPObject_f_Value) ## Fields **ObjectType** *SNMPObjectTypes* *Default Value: 5* The current object's type. The default type is NULL (5). The corresponding object id and value are specified by the and properties. Possible object type values include: | | | | --- | --- | | otInteger (2) | 2 | | otOctetString (4) | 4 | | otNull (5) | 5 | | otObjectID (6) | 6 | | otIPAddress (64) | 64 | | otCounter32 (65) | 65 | | otGauge32 (66) | 66 | | otTimeTicks (67) | 67 | | otOpaque (68) | 68 | | otNSAP (69) | 69 | | otCounter64 (70) | 70 | | otUnsignedInteger32 (71) | 71 | The class also supports the following artificial object values used to designate error conditions: | | | | --- | --- | | otNoSuchObject (128) | No such object error. | | otNoSuchInstance (129) | No such instance error. | | otEndOfMibView (130) | End of MIB View error. | **Oid** *string* *Default Value: ""* 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 and properties. **Example** ```text SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" ``` **TypeString** *string (read-only)* *Default Value: ""* A string representation of the current object's . The corresponding object id and value are specified by the and properties. **Value** *string* *Default Value: ""* The current object's value. The corresponding object id and type are specified by the and properties. **Example** ```text SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjValue(0) = "New Value" ``` **ValueB** *Uint8Array* *Default Value: ""* The current object's value. The corresponding object id and type are specified by the and properties. **Example** ```text SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjValue(0) = "New Value" ``` ## Constructors ```text public SNMPObject(); ``` ```text public SNMPObject(String oid); ``` ```text public SNMPObject(String oid, byte[] value); ``` ```text public SNMPObject(String oid, byte[] value, int objectType); ``` # Config Settings (*class *ipworkssnmp.[snmpmgr](#snmpmgr-class)) The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#snmpmgrconfig-method) method. ### SNMPManager Config Settings **AllowSingleStepDiscovery**: Whether to allow discovery to be completed in a single step.When making a discovery request in SNMPv3 while this setting is set to False (default), the component will send a second discovery request even if the agent responds to the first request with the EngineBoots and EngineTime. If set to True, the component will skip the second request if all the necessary information is returned in the first response. **CheckMessageOrigin**: Whether to match the origin IP address when receiving responses.This setting specifies whether the class matches the source IP address in the response to the destination IP address of the request. When True (default) the class makes sure that response are received from the same IP to which the request was sent. In most cases this does not need to be changed. If there is a specific reason that responses are expected to originate from a different IP from that which the request was sent, this may be set to False. When False the class will not check the origin of received responses. **CheckSNMPVersion**: Whether to check the version of incoming packets.By default only packets matching [SNMPVersion](#snmpmgrsnmpversion-property) can be received. Set this to *false* to ignore the version of incoming packets. The default is *true*. **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-class) 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 class to decrypt packets logged in [PacketTrace](#snmpmgrpackettrace-event). This only applies when using SNMP Version 3. The default is *false*. **ForceLocalPort**: Forces the class to bind to a specific port. The default value is True, which makes the class throw an error if [LocalPort](#snmpmgrlocalport-property) is busy. When [ForceLocalPort](#ForceLocalPort) is set to False and the port is busy, the class silently chooses another random port. **IgnoreDuplicateResponse**: Whether to ignore duplicate responses.In some scenarios an agent may send a duplicate response (identified by it's *RequestID*). To prevent processing of a duplicate response set this to *true*. The default is *false* **IgnorePortMismatch**: Whether to check if the port matches when a response is received.When a response is received, the class will validate that the port in the response is the same as the port in the request. To disable this, set this to True. **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. **MsgMaxSize**: The maximum supported message size.This setting specifies the maximum supported message size in bytes. This is only applicable when [SNMPVersion](#snmpmgrsnmpversion-property) is set to 3. This corresponds to the "msgMaxSize" field in the request. The default maximum message size is *16384* bytes. **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. **TimeoutInMilliseconds**: The timeout is treated as milliseconds.Setting **TimeoutInMilliseconds** to true causes the class to use the value in [Timeout](#snmpmgrtimeout-property) as milliseconds instead of seconds, which is the default. **WalkInsideRange**: Stops the SNMP walk if the OID value returned from an agent is outside the table.When **WalkInsideRange** is set to true the Walk will continue only while the OID Values returned from the agent are greater than the current OID Value. If an object is returned with an OID value that is out of this range it is not added to the [Objects](#snmpmgrobjects-property) collection, the [Error](#snmpmgrerror-event) event will fire, and [Walk](#snmpmgrwalk-method) will return. The default value is true. **WalkStartOID**: Specifies the OID to be used when a Walk is performed.When this property is set and [Walk](#snmpmgrwalk-method) is called, the first request sent will contain the specified **WalkStartOID** value. This feature is particularly useful in the case of errors, such as timeouts, that may occur during a Walk. In such a case, you can set **WalkStartOID** to the last OID returned before the Timeout occurred then call [Walk](#snmpmgrwalk-method) again (using the original tableOID parameter value). This will allow you to continue the Walk where it left off (when the Timeout error occurred). Note that when [StoreWalkObjects](#snmpmgrstorewalkobjects-property) is set to true and **WalkStartOID** is set, the existing entries in [Objects](#snmpmgrobjects-property) will be maintained when [Walk](#snmpmgrwalk-method) is called and new returned objects will be added (just as if no error occurred in the initial [Walk](#snmpmgrwalk-method) call). ### 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 [RemoteHost](#snmpmgrremotehost-property) is set. If *true* the class will resolve the hostname and the IP address will be present in the [RemoteHost](#snmpmgrremotehost-property) 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, ResolveRemoteHost may be called to manually resolve the value in [RemoteHost](#snmpmgrremotehost-property) 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 class 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 [LocalHost](#snmpmgrlocalhost-property) 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 class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the [LocalHost](#snmpmgrlocalhost-property) 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 class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by [LocalPort](#snmpmgrlocalport-property) after the connection is established. [LocalPort](#snmpmgrlocalport-property) 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 class 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](#snmpmgractive-property) to True. **ShareLocalPort**: If set to True, allows more than one instance of the class to be active on the same local port.This option must be set before the class is activated through the [Active](#snmpmgractive-property) 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 class 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 class 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](#snmpmgrtimeout-property) 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 class 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 class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **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 class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **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 class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. # Trappable Errors (*class *ipworkssnmp.[snmpmgr](#snmpmgr-class)) ### SNMPMgr Errors | | | | --- | --- | | 201 | Timeout. | | 301 | Bad Object Index when accessing the Obj* properties. Timeout when performing an operation. Check the error description for details. | | 302 | Value exceeds maximum number of objects allowed. | | 303 | The value must be an IP address in dotted format. | | 305 | Unsupported SNMP version. | | 306 | Unknown PDU type. | | 307 | The class is busy performing the current action. | | 308 | Verification failed. | | 309 | Missing password for Verification. | | 310 | Missing signature. | | 311 | Missing remote time. | | 312 | Missing timeout value. | | 313 | Decryption Failed. | | 314 | Missing password for decryption. | | 315 | Not encrypted. | | 316 | Security model not supported. | | 317 | Defective packet | | 318 | Not from bound point. | | 319 | Operation not permitted in current role. | | 320 | Bad packet. | | 321 | Message not authenticated. | | 322 | No such oid. | | 323 | Missing privacy parameter. | | 324 | Bad engine id. | | 325 | Bad time frame. | | 326 | Bad user name. | | 327 | Security level was not accepted. | | 328 | Discovery failed. | | 329 | Incorrect key length. | | 330 | No authentication password supplied. | | 333 | Returned OID was out of range. This is applicable only when [WalkInsideRange](#WalkInsideRange) is set to true. | ### UDP Errors | | | | --- | --- | | 104 | UDP is already [Active](#snmpmgractive-property). | | 106 | You cannot change the [LocalPort](#snmpmgrlocalport-property) while the class is [Active](#snmpmgractive-property). | | 107 | You cannot change the [LocalHost](#snmpmgrlocalhost-property) at this time. A connection is in progress. | | 109 | The class must be [Active](#snmpmgractive-property) for this operation. | | 112 | You cannot change [MaxPacketSize](#MaxPacketSize) while the class is [Active](#snmpmgractive-property). | | 113 | You cannot change [ShareLocalPort](#ShareLocalPort) option while the class is [Active](#snmpmgractive-property). | | 114 | You cannot change [RemoteHost](#snmpmgrremotehost-property) when [UseConnection](#UseConnection) is set and the class [Active](#snmpmgractive-property). | | 115 | You cannot change [RemotePort](#snmpmgrremoteport-property) when [UseConnection](#UseConnection) is set and the class is [Active](#snmpmgractive-property). | | 116 | [RemotePort](#snmpmgrremoteport-property) cannot be zero when [UseConnection](#UseConnection) is set. Please specify a valid service port number. | | 117 | You cannot change [UseConnection](#UseConnection) while the class is [Active](#snmpmgractive-property). | | 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). |