SNMPTCPMgr Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TipnSNMPTCPMgr

Remarks

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

The component 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 component is activated/deactivated by calling the Activate or Deactivate method. These methods enable or disable sending and receiving. The activation status can be found in the Active property.

Messages are received through events such as Response, Trap, or InformRequest. SNMP Traps are received through the Trap event.

Messages are sent to other agents or managers by using component's methods such as SendGetRequest, SendGetNextRequest, SendGetBulkRequest, SendSetRequest, and SendInformRequest.

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

SNMPv3 USM security is enabled by setting properties such as User, AuthenticationPassword, and EncryptionPassword and calling the Discover method to bind to a particular agent (RemoteEngineId). 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, RemoteEngineBoots, and RemoteEngineTime are known in advance and provided to the component through the respective properties.

By default, the component operates synchronously (except for the Discover method), sending a request and waiting until the corresponding response has been received. This behavior may be overridden by setting Timeout to 0, in which case the component returns control immediately after a send, and responses are received exclusively through the Response event.

Property List

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

Method List

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

Event List

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

Config Settings

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

AcceptData Property (SNMPTCPMgr Component)

Enables or disables data reception.

Syntax

__property bool AcceptData = { read=FAcceptData, write=FSetAcceptData };

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 not available at design time.

Data Type

Boolean

Active Property (SNMPTCPMgr Component)

Indicates whether the component is active.

Syntax

__property bool Active = { read=FActive, write=FSetActive };

Default Value

False

Remarks

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

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

Note: Use the Activate or Deactivate method to control whether the component is active.

This property is not available at design time.

Data Type

Boolean

AuthenticationPassword Property (SNMPTCPMgr Component)

The password used for SNMPv3 authentication.

Syntax

__property String AuthenticationPassword = { read=FAuthenticationPassword, write=FSetAuthenticationPassword };

Default Value

""

Remarks

Every time EncryptionPassword, AuthenticationPassword, or RemoteEngineId are set, a localized key is computed automatically, and cached internally.

Data Type

String

AuthenticationProtocol Property (SNMPTCPMgr Component)

The authentication protocol used for SNMPv3 packets.

Syntax

__property TipnSNMPTCPMgrAuthenticationProtocols AuthenticationProtocol = { read=FAuthenticationProtocol, write=FSetAuthenticationProtocol };

enum TipnSNMPTCPMgrAuthenticationProtocols {
  authpHMACMD596=1,
  authpHMACSHA96=2,
  authpHMAC192SHA256=3,
  authpHMAC384SHA512=4
};

Default Value

authpHMACMD596

Remarks

This property defines the authentication protocol used when SNMPVersion 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)

This property is not available at design time.

Data Type

Integer

Community Property (SNMPTCPMgr Component)

The community string used to authenticate SNMP packets.

Syntax

__property String Community = { read=FCommunity, write=FSetCommunity };

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

Data Type

String

EncryptionAlgorithm Property (SNMPTCPMgr Component)

The encryption algorithm used for SNMPv3 packets.

Syntax

__property TipnSNMPTCPMgrEncryptionAlgorithms EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };

enum TipnSNMPTCPMgrEncryptionAlgorithms {
  encraDES=1,
  encraAES=2,
  encra3DES=3,
  encraAES192=4,
  encraAES256=5
};

Default Value

encraDES

Remarks

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

This property is not available at design time.

Data Type

Integer

EncryptionPassword Property (SNMPTCPMgr Component)

The password used for SNMPv3 privacy.

Syntax

__property String EncryptionPassword = { read=FEncryptionPassword, write=FSetEncryptionPassword };

Default Value

""

Remarks

Every time EncryptionPassword, AuthenticationPassword, or RemoteEngineId are set, a localized key is computed automatically, and cached internally.

Data Type

String

ErrorDescription Property (SNMPTCPMgr Component)

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

Syntax

__property String ErrorDescription = { read=FErrorDescription };

Default Value

"0"

Remarks

Please refer to the ErrorStatus property for more information.

This property is read-only and not available at design time.

Data Type

String

ErrorIndex Property (SNMPTCPMgr Component)

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

Syntax

__property int ErrorIndex = { read=FErrorIndex };

Default Value

0

Remarks

This property is used in conjunction with the ErrorStatus property, and refers to the object that caused the error reported in the last SNMP response. This value is parsed directly from the SNMP response, which will be a one-based value, so a value of i here maps to index i-1 in the Objects collection.

The ErrorIndex property has no meaning when the ErrorStatus property is 0 (no error).

This property is read-only and not available at design time.

Data Type

Integer

ErrorStatus Property (SNMPTCPMgr Component)

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

Syntax

__property int ErrorStatus = { read=FErrorStatus };

Default Value

0

Remarks

This property is used in conjunction with the ErrorIndex property, which denotes the index of the variable in error. The ErrorDescription property provides a textual description of the error.

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

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

The default value is 0 (no error).

This property is read-only and not available at design time.

Data Type

Integer

LocalEngineId Property (SNMPTCPMgr Component)

The Engine Id of the SNMP Manager.

Syntax

__property String LocalEngineId = { read=FLocalEngineId, write=FSetLocalEngineId };
__property DynamicArray<Byte> LocalEngineIdB = { read=FLocalEngineIdB, write=FSetLocalEngineIdB };

Default Value

""

Remarks

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

Data Type

Byte Array

LocalHost Property (SNMPTCPMgr Component)

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

Syntax

__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component 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 multi-homed 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.

Data Type

String

LocalPort Property (SNMPTCPMgr Component)

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

Syntax

__property int LocalPort = { read=FLocalPort, write=FSetLocalPort };

Default Value

0

Remarks

The LocalPort property must be set before the component is activated (Active is set to True). It instructs the component 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 component be used for listening to traps, because SNMPMgr is limited to receiving SNMPv3 traps from a single agent only. SNMPTrapMgr does not have this limitation.

LocalPort cannot be changed once the component is Active. Any attempt to set the LocalPort property when the component is Active will generate an error.

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

Data Type

Integer

ObjCount Property (SNMPTCPMgr Component)

The number of records in the Obj arrays.

Syntax

__property int ObjCount = { read=FObjCount, write=FSetObjCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ObjId
• ObjType
• ObjTypeString
• ObjValue

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

This property is not available at design time.

Data Type

Integer

ObjType Property (SNMPTCPMgr Component)

The current object's type.

Syntax

__property TipnSNMPTCPMgrObjTypes ObjType[int ObjIndex] = { read=FObjType, write=FSetObjType };

enum TipnSNMPTCPMgrObjTypes {
  otInteger=2,
  otOctetString=4,
  otNull=5,
  otObjectId=6,
  otIPAddress=64,
  otCounter32=65,
  otGauge32=66,
  otTimeTicks=67,
  otOpaque=68,
  otNSAP=69,
  otCounter64=70,
  otUnsignedInteger32=71,
  otNoSuchObject=128,
  otNoSuchInstance=129,
  otEndOfMibView=130
};

Default Value

otNull

Remarks

The current object's type. The default type is NULL (5).

The corresponding object id and value are specified by the ObjOid and ObjValue properties.

Possible object type values include:

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

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

This property is not available at design time.

Data Type

Integer

ObjId Property (SNMPTCPMgr Component)

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

Syntax

__property String ObjId[int ObjIndex] = { read=FObjId, write=FSetObjId };

Default Value

""

Remarks

The current object's id which is encoded as a string of numbers separated by periods. For instance: "1.3.6.1.2.1.1.1.0" (OID for "system description").

The corresponding object type and value (if any) are specified by the ObjectType and ObjValue properties.

Example

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

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

This property is not available at design time.

Data Type

String

ObjTypeString Property (SNMPTCPMgr Component)

A string representation of the current object's ObjectType .

Syntax

__property String ObjTypeString[int ObjIndex] = { read=FObjTypeString };

Default Value

""

Remarks

A string representation of the current object's ObjectType.

The corresponding object id and value are specified by the ObjOid and ObjValue properties.

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

This property is read-only and not available at design time.

Data Type

String

ObjValue Property (SNMPTCPMgr Component)

The current object's value.

Syntax

__property String ObjValue[int ObjIndex] = { read=FObjValue, write=FSetObjValue };
__property DynamicArray<Byte> ObjValueB[int ObjIndex] = { read=FObjValueB, write=FSetObjValueB };

Default Value

""

Remarks

The current object's value. The corresponding object id and type are specified by the ObjOid and ObjectType properties.

Example

SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjValue(0) = "New Value"

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

This property is not available at design time.

Data Type

Byte Array

RemoteEngineBoots Property (SNMPTCPMgr Component)

The remote engine boots (SNMPv3).

Syntax

__property int RemoteEngineBoots = { read=FRemoteEngineBoots, write=FSetRemoteEngineBoots };

Default Value

0

Remarks

This property is used in conjunction with the RemoteEngineTime property. Please refer to the description of the RemoteEngineTime property, and the Discover method for further information.

Data Type

Integer

RemoteEngineId Property (SNMPTCPMgr Component)

The Engine Id of the remote agent.

Syntax

__property String RemoteEngineId = { read=FRemoteEngineId, write=FSetRemoteEngineId };
__property DynamicArray<Byte> RemoteEngineIdB = { read=FRemoteEngineIdB, write=FSetRemoteEngineIdB };

Default Value

""

Remarks

This property is only used for SNMPv3 packets (see SNMPVersion), and is reset every time RemoteHost or RemotePort changes.

RemoteEngineId is normally discovered through the Discover 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 and RemoteEngineTime are also required for User authentication - please refer to the Discover method for more information).

Data Type

Byte Array

RemoteEngineTime Property (SNMPTCPMgr Component)

The remote engine time (SNMPv3).

Syntax

__property int RemoteEngineTime = { read=FRemoteEngineTime, write=FSetRemoteEngineTime };

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

This property is used in conjunction with RemoteEngineBoots. Please refer to the RemoteEngineBoots property and the Discover method for more information.

Data Type

Integer

RemoteHost Property (SNMPTCPMgr Component)

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

Syntax

__property String RemoteHost = { read=FRemoteHost, write=FSetRemoteHost };

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

Data Type

String

RemotePort Property (SNMPTCPMgr Component)

The port where the remote SNMP agent is listening.

Syntax

__property int RemotePort = { read=FRemotePort, write=FSetRemotePort };

Default Value

161

Remarks

The RemotePort is the port on the RemoteHost to send SNMP requests to.

A valid port number (a value between 1 and 65535) is required. The default value is 161.

Data Type

Integer

RequestId Property (SNMPTCPMgr Component)

The request-id to mark outgoing packets with.

Syntax

__property int RequestId = { read=FRequestId, write=FSetRequestId };

Default Value

1

Remarks

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

This property is not available at design time.

Data Type

Integer

SNMPVersion Property (SNMPTCPMgr Component)

Version of SNMP used for outgoing requests.

Syntax

__property TipnSNMPTCPMgrSNMPVersions SNMPVersion = { read=FSNMPVersion, write=FSetSNMPVersion };

enum TipnSNMPTCPMgrSNMPVersions {
  snmpverV1=1,
  snmpverV2c=2,
  snmpverV3=3
};

Default Value

snmpverV2c

Remarks

This property takes one of the following values:

Data Type

Integer

SSLAcceptServerCertEncoded Property (SNMPTCPMgr Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLAuthenticateClients Property (SNMPTCPMgr Component)

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

Syntax

__property bool SSLAuthenticateClients = { read=FSSLAuthenticateClients, write=FSetSSLAuthenticateClients };

Default Value

false

Remarks

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

Data Type

Boolean

SSLCertEncoded Property (SNMPTCPMgr Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (SNMPTCPMgr Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Byte Array

SSLCertStorePassword Property (SNMPTCPMgr Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (SNMPTCPMgr Component)

This is the type of certificate store for this certificate.

Syntax

__property TipnSNMPTCPMgrSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TipnSNMPTCPMgrSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (SNMPTCPMgr Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

This is 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=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLEnabled Property (SNMPTCPMgr Component)

Whether TLS/SSL is enabled.

Syntax

__property bool SSLEnabled = { read=FSSLEnabled, write=FSetSSLEnabled };

Default Value

False

Remarks

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

Note: SSL is not currently supported in this product. This setting is reserved for future user.

This property is not available at design time.

Data Type

Boolean

SSLServerCertEncoded Property (SNMPTCPMgr Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Byte Array

StoreWalkObjects Property (SNMPTCPMgr Component)

Tells the component whether or not to store returned objects.

Syntax

__property bool StoreWalkObjects = { read=FStoreWalkObjects, write=FSetStoreWalkObjects };

Default Value

True

Remarks

When a Walk is performed, this property tells the component whether or not to store the objects that are returned by the server in the Objects collection. If the data is accumulated through the events, and not desired to be saved by the component, set this property to false.

Data Type

Boolean

Timeout Property (SNMPTCPMgr Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

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

The component will use DoEvents 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 component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

User Property (SNMPTCPMgr Component)

The user name used for SNMPv3 authentication.

Syntax

__property String User = { read=FUser, write=FSetUser };

Default Value

""

Remarks

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

Data Type

String

WalkLimit Property (SNMPTCPMgr Component)

The limit of oid's returned in a walk.

Syntax

__property int WalkLimit = { read=FWalkLimit, write=FSetWalkLimit };

Default Value

0

Remarks

This property specifies the limit of how many oid's are to be traversed during an SNMP Walk. If set to 0, the component will traverse all oid's in the specified table that are lexographically greater than the value of the specified table oid.

Data Type

Integer

Activate Method (SNMPTCPMgr Component)

Activates the component.

Syntax

void __fastcall Activate();

Remarks

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

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

Note: Use the Active property to check whether the component is active.

Config Method (SNMPTCPMgr Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Deactivate Method (SNMPTCPMgr Component)

Deactivates the component.

Syntax

void __fastcall Deactivate();

Remarks

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

Note: Use the Active property to check whether the component is active.

Discover Method (SNMPTCPMgr Component)

Performs SNMPv3 discovery.

Syntax

void __fastcall Discover();

Remarks

When the method is called an SNMPv3 engine discovery request is sent to RemoteHost.

If an AuthenticationPassword is provided, the engine id discovery request is followed by an engine time discovery request, as required by the SNMPv3 User Security Model (USM). In this case Timeout must be set to a non-zero value before calling Discover and the component will wait until a response is received from RemoteHost.

The DiscoveryResponse event is fired upon receipt of a valid discovery response and the values of RemoteEngineId, RemoteEngineBoots, and RemoteEngineTime will then be updated with the received Engine Id, Time, and Boots.

DoEvents Method (SNMPTCPMgr Component)

Processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

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

HashPasswords Method (SNMPTCPMgr Component)

Hashes all passwords in the cache.

Syntax

void __fastcall HashPasswords();

Remarks

Forces computation of all passwords hashes in the cache. Used together with the HashPassword event to enable implementations of external password hash storage.

Interrupt Method (SNMPTCPMgr Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

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

Reset Method (SNMPTCPMgr Component)

Clears the object arrays.

Syntax

void __fastcall Reset();

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 will be reset to snmpverV2c (2).

SendGetBulkRequest Method (SNMPTCPMgr Component)

Send a GetBulkRequest packet.

Syntax

void __fastcall SendGetBulkRequest(int NonRepeaters, int MaxRepetitions);

Remarks

Sends a GetBulkRequest packet. This is only available for SNMP versions 2 and 3.

NonRepeaters specifies the number of variables for which a single lexicographic successor is to be returned.

MaxRepetitions specifies the number of lexicographic successors to be returned for variables other than those in the NonRepeaters list.

The object identifiers, types, and values for the request are taken from the Objects collection.

A GetBulkRequest is very similar to a GetNextRequest, the difference is that Getbulk performs a continuous GetNext operation based on the MaxRepitions value. The NonRepeaters value will determine the number of Objects for which a simple GetNext operation should be performed. For the remaining variables, a continuous GetNext operation is performed based on the MaxRepitions value.

So if you send a request containing X objects, the agent will perform N simple GetNext operations and M continuous GetNext operations X - N times. With X being the number of objects received, N being the number of NonRepeaters, and M being the number of MaxRepitions. Thus the SNMPMgr is expecting to receive N + M x (X - N) objects, assuming that each object has M successors.

Example (Sending a GetBulk Request)

SNMPControl.RemoteHost = "MyAgent" SNMPControl.ObjCount = 2 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.objId(1) = "1.3.6.1.2.1.1.3.0" SNMPControl.SendGetBulkRequest(1,4)

The code sample above will send a GetBulkRequest with 1 non repeater, and a maxrepetitions of 4. Since there is only 1 non repeater, only one ObjID will "not repeat" and will only return one successor. The rest of the ObjID's (in this case, only 1) will return 4 successors. This particular example will return the following ObjID's:

SendGetNextRequest Method (SNMPTCPMgr Component)

Send GetNextRequest packet.

Syntax

void __fastcall SendGetNextRequest();

Remarks

Sends a GetNextRequest packet. The object identifiers, types, and values for the request are taken from the Objects collection.

Example (Sending a GetNext Request)

SNMPControl.ObjCount = 2 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.SendGetNextRequest() The agent will respond with the "next" (relative to the ObjID(s) you specify) OID in the table.

SendGetRequest Method (SNMPTCPMgr Component)

Send GetRequest packet.

Syntax

void __fastcall SendGetRequest();

Remarks

Sends a GetRequest packet. The object identifiers, types, and values for the request are taken from the Objects collection.

Example (Sending a GetRequest)

SNMPControl.RemoteHost = "MyAgent" SNMPControl.ObjCount = 2 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjId(1) = "1.3.6.1.2.1.1.2.0" SNMPControl.SendGetRequest()

SendInformRequest Method (SNMPTCPMgr Component)

Send an InformRequest packet.

Syntax

void __fastcall SendInformRequest();

Remarks

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

SendSetRequest Method (SNMPTCPMgr Component)

Send Set Request packet.

Syntax

void __fastcall SendSetRequest();

Remarks

Sends a SetRequest packet. The object identifiers, types, and values for the request are taken from the Objects collection.

Example (Sending a SetRequest)

SNMPControl.RemoteHost = "MyAgent" SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjValue(0) = "New Value" SNMPControl.ObjType(0) = otOctetString SNMPControl.SendSetRequest()

Value Method (SNMPTCPMgr Component)

Returns the value corresponding to an OID.

Syntax

String __fastcall Value(String OID);

Remarks

If the OID does not exist in the Objects collection, a trappable error is generated.

Please refer to the SNMPObject type for more information.

Walk Method (SNMPTCPMgr Component)

Does an SNMP walk starting with the specified oid.

Syntax

void __fastcall Walk(String TableOid);

Remarks

A walk will traverse all OIDs in the TableOid that are lexographically greater than the value of the TableOid.

The results of the walk may be obtained through the Response events. During the event, the current returned object will exist inside of the Objects collection. If StoreWalkObjects is set to true, the Objects collection will contain all returned objects when the Walk completes.

Use the WalkLimit property to regulate how many objects the walk will traverse in the table.

NOTE: The collection of objects is cleared before the walk begins.

BadPacket Event (SNMPTCPMgr Component)

Fired for erroneous and/or malformed messages.

Syntax

typedef struct {
  String Packet;
  DynamicArray<Byte> PacketB;
  String SourceAddress;
  int SourcePort;
  int ErrorCode;
  String ErrorDescription;
  bool Report;
} TipnSNMPTCPMgrBadPacketEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrBadPacketEvent)(System::TObject* Sender, TipnSNMPTCPMgrBadPacketEventParams *e);
__property TipnSNMPTCPMgrBadPacketEvent OnBadPacket = { read=FOnBadPacket, write=FOnBadPacket };

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.

Connected Event (SNMPTCPMgr Component)

Fired immediately after a connection completes (or fails).

Syntax

typedef struct {
  String RemoteAddress;
  int RemotePort;
  int StatusCode;
  String Description;
} TipnSNMPTCPMgrConnectedEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrConnectedEvent)(System::TObject* Sender, TipnSNMPTCPMgrConnectedEventParams *e);
__property TipnSNMPTCPMgrConnectedEvent OnConnected = { read=FOnConnected, write=FOnConnected };

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.

ConnectionStatus Event (SNMPTCPMgr Component)

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

Syntax

typedef struct {
  String ConnectionEvent;
  int StatusCode;
  String Description;
} TipnSNMPTCPMgrConnectionStatusEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrConnectionStatusEvent)(System::TObject* Sender, TipnSNMPTCPMgrConnectionStatusEventParams *e);
__property TipnSNMPTCPMgrConnectionStatusEvent OnConnectionStatus = { read=FOnConnectionStatus, write=FOnConnectionStatus };

Remarks

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

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

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

Disconnected Event (SNMPTCPMgr Component)

Fired when a connection is closed.

Syntax

typedef struct {
  String RemoteAddress;
  int RemotePort;
  int StatusCode;
  String Description;
} TipnSNMPTCPMgrDisconnectedEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrDisconnectedEvent)(System::TObject* Sender, TipnSNMPTCPMgrDisconnectedEventParams *e);
__property TipnSNMPTCPMgrDisconnectedEvent OnDisconnected = { read=FOnDisconnected, write=FOnDisconnected };

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.

DiscoveryRequest Event (SNMPTCPMgr Component)

Fired when an SNMPv3 discovery packet is received.

Syntax

typedef struct {
  String EngineId;
  DynamicArray<Byte> EngineIdB;
  int EngineBoots;
  int EngineTime;
  String User;
  int SecurityLevel;
  String SourceAddress;
  int SourcePort;
  bool Respond;
} TipnSNMPTCPMgrDiscoveryRequestEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrDiscoveryRequestEvent)(System::TObject* Sender, TipnSNMPTCPMgrDiscoveryRequestEventParams *e);
__property TipnSNMPTCPMgrDiscoveryRequestEvent OnDiscoveryRequest = { read=FOnDiscoveryRequest, write=FOnDiscoveryRequest };

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

DiscoveryResponse Event (SNMPTCPMgr Component)

Fired when an SNMPv3 discovery response is received.

Syntax

typedef struct {
  String EngineId;
  DynamicArray<Byte> EngineIdB;
  int EngineBoots;
  int EngineTime;
  String User;
  int SecurityLevel;
  String SourceAddress;
  int SourcePort;
} TipnSNMPTCPMgrDiscoveryResponseEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrDiscoveryResponseEvent)(System::TObject* Sender, TipnSNMPTCPMgrDiscoveryResponseEventParams *e);
__property TipnSNMPTCPMgrDiscoveryResponseEvent OnDiscoveryResponse = { read=FOnDiscoveryResponse, write=FOnDiscoveryResponse };

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.

Error Event (SNMPTCPMgr Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TipnSNMPTCPMgrErrorEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrErrorEvent)(System::TObject* Sender, TipnSNMPTCPMgrErrorEventParams *e);
__property TipnSNMPTCPMgrErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

HashPassword Event (SNMPTCPMgr Component)

Fired before and after a password is hashed.

Syntax

typedef struct {
  String Password;
  int AuthAlgorithm;
  String Hash;
} TipnSNMPTCPMgrHashPasswordEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrHashPasswordEvent)(System::TObject* Sender, TipnSNMPTCPMgrHashPasswordEventParams *e);
__property TipnSNMPTCPMgrHashPasswordEvent OnHashPassword = { read=FOnHashPassword, write=FOnHashPassword };

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 component 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

InformRequest Event (SNMPTCPMgr Component)

Fired when an InformRequest packet is received.

Syntax

typedef struct {
  int RequestId;
  int SNMPVersion;
  String Community;
  String User;
  int SecurityLevel;
  String SourceAddress;
  int SourcePort;
  int ErrorIndex;
  int ErrorStatus;
  String ErrorDescription;
  bool Respond;
} TipnSNMPTCPMgrInformRequestEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrInformRequestEvent)(System::TObject* Sender, TipnSNMPTCPMgrInformRequestEventParams *e);
__property TipnSNMPTCPMgrInformRequestEvent OnInformRequest = { read=FOnInformRequest, write=FOnInformRequest };

Remarks

The user in an InformRequest packet (SNMPv3) must match the user in the User property. If not, the request is rejected, and a BadPacket 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 collection. Each object is of type SNMPObject. This type describes the ObjId, ObjType, and ObjValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

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

The MessageId parameter identifies the received request.

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

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

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

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

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

PacketTrace Event (SNMPTCPMgr Component)

Fired for every packet sent or received.

Syntax

typedef struct {
  String Packet;
  DynamicArray<Byte> PacketB;
  int Direction;
  String PacketAddress;
  int PacketPort;
} TipnSNMPTCPMgrPacketTraceEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrPacketTraceEvent)(System::TObject* Sender, TipnSNMPTCPMgrPacketTraceEventParams *e);
__property TipnSNMPTCPMgrPacketTraceEvent OnPacketTrace = { read=FOnPacketTrace, write=FOnPacketTrace };

Remarks

The PacketTrace event shows all the packets sent or received by the component.

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.

ReadyToSend Event (SNMPTCPMgr Component)

Fired when the component is ready to send data.

Syntax

typedef struct {
} TipnSNMPTCPMgrReadyToSendEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrReadyToSendEvent)(System::TObject* Sender, TipnSNMPTCPMgrReadyToSendEventParams *e);
__property TipnSNMPTCPMgrReadyToSendEvent OnReadyToSend = { read=FOnReadyToSend, write=FOnReadyToSend };

Remarks

The ReadyToSend event indicates that the underlying TCP/IP subsystem is ready to accept data after a failed DataToSend.

Report Event (SNMPTCPMgr Component)

Fired when a Report packet is received.

Syntax

typedef struct {
  int RequestId;
  int SNMPVersion;
  String Community;
  String User;
  int SecurityLevel;
  String SourceAddress;
  int SourcePort;
  int ErrorIndex;
  int ErrorStatus;
  String ErrorDescription;
} TipnSNMPTCPMgrReportEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrReportEvent)(System::TObject* Sender, TipnSNMPTCPMgrReportEventParams *e);
__property TipnSNMPTCPMgrReportEvent OnReport = { read=FOnReport, write=FOnReport };

Remarks

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

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

The list of variables in the SNMP packet, including optional values and types, is provided through the Objects collection. Each object is of type SNMPObject. This type describes the ObjId, ObjType, and ObjValue 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.

Response Event (SNMPTCPMgr Component)

Fired when a GetResponse packet is received.

Syntax

typedef struct {
  int RequestId;
  int SNMPVersion;
  String Community;
  String User;
  int SecurityLevel;
  String SourceAddress;
  int SourcePort;
  int ErrorIndex;
  int ErrorStatus;
  String ErrorDescription;
} TipnSNMPTCPMgrResponseEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrResponseEvent)(System::TObject* Sender, TipnSNMPTCPMgrResponseEventParams *e);
__property TipnSNMPTCPMgrResponseEvent OnResponse = { read=FOnResponse, write=FOnResponse };

Remarks

The ErrorStatus and ErrorIndex parameters contain information about possible errors. ErrorDescription is a textual description of ErrorStatus. This value is parsed directly from the SNMP response, which will be a one-based value, so a value of i here maps to index i-1 in the Objects collection.

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

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

The list of variables in the SNMP packet, including optional values and types, is provided through the Objects collection. Each object is of type SNMPObject. This type describes the ObjId, ObjType, and ObjValue 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.

SSLClientAuthentication Event (SNMPTCPMgr Component)

Fired when the client presents its credentials to the server.

Syntax

typedef struct {
  String RemoteAddress;
  int RemotePort;
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TipnSNMPTCPMgrSSLClientAuthenticationEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrSSLClientAuthenticationEvent)(System::TObject* Sender, TipnSNMPTCPMgrSSLClientAuthenticationEventParams *e);
__property TipnSNMPTCPMgrSSLClientAuthenticationEvent OnSSLClientAuthentication = { read=FOnSSLClientAuthentication, write=FOnSSLClientAuthentication };

Remarks

This event fires when a client connects to the component 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 stauts of the certificate.

Accept defines whether the certificate is accepted.

SSLServerAuthentication Event (SNMPTCPMgr Component)

Fires when connecting to the server.

Syntax

typedef struct {
  String RemoteAddress;
  int RemotePort;
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TipnSNMPTCPMgrSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrSSLServerAuthenticationEvent)(System::TObject* Sender, TipnSNMPTCPMgrSSLServerAuthenticationEventParams *e);
__property TipnSNMPTCPMgrSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

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 stauts of the certificate.

Accept defines whether the certificate is accepted.

SSLStatus Event (SNMPTCPMgr Component)

Shows the progress of the secure connection.

Syntax

typedef struct {
  String RemoteAddress;
  int RemotePort;
  String Message;
} TipnSNMPTCPMgrSSLStatusEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrSSLStatusEvent)(System::TObject* Sender, TipnSNMPTCPMgrSSLStatusEventParams *e);
__property TipnSNMPTCPMgrSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

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.

Trap Event (SNMPTCPMgr Component)

Fired when a SNMP trap packet is received.

Syntax

typedef struct {
  int RequestId;
  int SNMPVersion;
  String Community;
  String User;
  int SecurityLevel;
  String TrapOID;
  __int64 TimeStamp;
  String SourceAddress;
  int SourcePort;
} TipnSNMPTCPMgrTrapEventParams;
typedef void __fastcall (__closure *TipnSNMPTCPMgrTrapEvent)(System::TObject* Sender, TipnSNMPTCPMgrTrapEventParams *e);
__property TipnSNMPTCPMgrTrapEvent OnTrap = { read=FOnTrap, write=FOnTrap };

Remarks

The SNMPTrapMgr component should normally be used to receive traps, since it was designed and contains functionality specifically for that purpose. The SNMPMgr component can only receive traps from the agent that it is has most recently discovered with the Discover method.

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

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

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

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

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

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

The SNMPMgr component is limited to accepting authenticated traps only for the user specified in User and Password and from the engine specified in RemoteEngineId with time parameters in RemoteEngineBoots and RemoteEngineTime (usually this is the SNMP engine discovered through the last call to Discover). If authenticated traps come from a different engine, or for a different user, they are ignored, and a BadPacket event is fired instead.

The list of variables in the SNMP packet, including optional values and types, is provided through the Objects collection. Each object is of type SNMPObject. This type describes the ObjId, ObjType, and ObjValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

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

Config Settings (SNMPTCPMgr Component)

SNMPTCPManager Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (SNMPTCPMgr Component)

SNMPTCPMgr Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors