SNMPAgent Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

SNMPAgent

Remarks

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

SNMP over DTLS is also supported when SSLEnabled is set to True. When acting as a client, the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the DTLS handshake. Additional SSL-related settings are also supported through the Config method. When acting as a server, the SSLCert properties are used to select a certificate for the server. When client authentication is required, the SSLAuthenticateClients property can be set to True and the SSLClientAuthentication 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 agent as simple as setting a few key properties and handling a few events. SNMP data such as SNMP object id-s (OID-s) are exchanged as text strings, thus further simplifying the task of handling them.

The class is activated/deactivated by calling the Activate or Deactivate method. These methods enable or disable sending and receiving. The activation status can be found in the Active property.

The class operates asynchronously. Requests are received through events such as GetRequest, GetBulkRequest, GetNextRequest, etc. and the corresponding responses are automatically sent when the events return. Traps are sent through the SendTrap method.

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

The AddUser, RemoveUser, ShowCache, and ClearCache methods are used to manage an internal authentication cache. This internal cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.

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

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

Property List

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

Method List

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

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.

Config Settings

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

AcceptData Property (SNMPAgent Class)

Enables or disables data reception.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAcceptData();
int SetAcceptData(int bAcceptData);

Unicode (Windows)
BOOL GetAcceptData();
INT SetAcceptData(BOOL bAcceptData);

int ipworkssnmp_snmpagent_getacceptdata(void* lpObj);
int ipworkssnmp_snmpagent_setacceptdata(void* lpObj, int bAcceptData);

bool GetAcceptData();
int SetAcceptData(bool bAcceptData);

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

Indicates whether the class is active.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetActive();
int SetActive(int bActive);

Unicode (Windows)
BOOL GetActive();
INT SetActive(BOOL bActive);

int ipworkssnmp_snmpagent_getactive(void* lpObj);
int ipworkssnmp_snmpagent_setactive(void* lpObj, int bActive);

bool GetActive();
int SetActive(bool bActive);

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 and Deactivate methods to control whether the class is active.

This property is not available at design time.

Data Type

Boolean

LocalEngineId Property (SNMPAgent Class)

The Engine Id of the SNMP Agent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalEngineId(char* &lpLocalEngineId, int &lenLocalEngineId);
int SetLocalEngineId(const char* lpLocalEngineId, int lenLocalEngineId);

Unicode (Windows)
INT GetLocalEngineId(LPSTR &lpLocalEngineId, INT &lenLocalEngineId);
INT SetLocalEngineId(LPCSTR lpLocalEngineId, INT lenLocalEngineId);

int ipworkssnmp_snmpagent_getlocalengineid(void* lpObj, char** lpLocalEngineId, int* lenLocalEngineId);
int ipworkssnmp_snmpagent_setlocalengineid(void* lpObj, const char* lpLocalEngineId, int lenLocalEngineId);

QByteArray GetLocalEngineId();
int SetLocalEngineId(QByteArray qbaLocalEngineId);

Default Value

""

Remarks

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

Data Type

Binary String

LocalHost Property (SNMPAgent Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworkssnmp_snmpagent_getlocalhost(void* lpObj);
int ipworkssnmp_snmpagent_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

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

Data Type

String

LocalPort Property (SNMPAgent Class)

The port in the local host where the class listens.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int ipworkssnmp_snmpagent_getlocalport(void* lpObj);
int ipworkssnmp_snmpagent_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

161

Remarks

The LocalPort property must be set before the class is activated (Active is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine (default 161).

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

LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class 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

Objects Property (SNMPAgent Class)

The objects in the current request.

Syntax

• C++
• C
• Qt

IPWorksSNMPList<IPWorksSNMPSNMPObject>* GetObjects();
int SetObjects(IPWorksSNMPList<IPWorksSNMPSNMPObject>* val);

int ipworkssnmp_snmpagent_getobjcount(void* lpObj);
int ipworkssnmp_snmpagent_setobjcount(void* lpObj, int iObjCount);

int ipworkssnmp_snmpagent_getobjtype(void* lpObj, int objindex);
int ipworkssnmp_snmpagent_setobjtype(void* lpObj, int objindex, int iObjType);

char* ipworkssnmp_snmpagent_getobjid(void* lpObj, int objindex);
int ipworkssnmp_snmpagent_setobjid(void* lpObj, int objindex, const char* lpszObjId);

char* ipworkssnmp_snmpagent_getobjtypestring(void* lpObj, int objindex);

int ipworkssnmp_snmpagent_getobjvalue(void* lpObj, int objindex, char** lpObjValue, int* lenObjValue);
int ipworkssnmp_snmpagent_setobjvalue(void* lpObj, int objindex, const char* lpObjValue, int lenObjValue);

int GetObjCount();
int SetObjCount(int iObjCount);

int GetObjType(int iObjIndex);
int SetObjType(int iObjIndex, int iObjType);

QString GetObjId(int iObjIndex);
int SetObjId(int iObjIndex, QString qsObjId);

QString GetObjTypeString(int iObjIndex);

QByteArray GetObjValue(int iObjIndex);
int SetObjValue(int iObjIndex, QByteArray qbaObjValue);

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.

Data Type

IPWorksSNMPSNMPObject

RequestId Property (SNMPAgent Class)

The request-id to mark outgoing packets with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequestId();
int SetRequestId(int iRequestId);

Unicode (Windows)
INT GetRequestId();
INT SetRequestId(INT iRequestId);

int ipworkssnmp_snmpagent_getrequestid(void* lpObj);
int ipworkssnmp_snmpagent_setrequestid(void* lpObj, int iRequestId);

int GetRequestId();
int SetRequestId(int iRequestId);

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.

Data Type

Integer

SNMPVersion Property (SNMPAgent Class)

Version of SNMP used for outgoing requests (traps).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSNMPVersion();
int SetSNMPVersion(int iSNMPVersion);

Unicode (Windows)
INT GetSNMPVersion();
INT SetSNMPVersion(INT iSNMPVersion);

SNMPVER_V1(1), 
SNMPVER_V2C(2), 
SNMPVER_V3(3)

int ipworkssnmp_snmpagent_getsnmpversion(void* lpObj);
int ipworkssnmp_snmpagent_setsnmpversion(void* lpObj, int iSNMPVersion);

int GetSNMPVersion();
int SetSNMPVersion(int iSNMPVersion);

Default Value

2

Remarks

This property takes one of the following values:

Data Type

Integer

SSLAcceptServerCert Property (SNMPAgent Class)

This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

IPWorksSNMPCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksSNMPCertificate* val);

char* ipworkssnmp_snmpagent_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertfingerprint(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertissuer(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertprivatekey(void* lpObj);

int ipworkssnmp_snmpagent_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertpublickey(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworkssnmp_snmpagent_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertserialnumber(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworkssnmp_snmpagent_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworkssnmp_snmpagent_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworkssnmp_snmpagent_getsslacceptservercertstorepassword(void* lpObj);
int ipworkssnmp_snmpagent_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworkssnmp_snmpagent_getsslacceptservercertstoretype(void* lpObj);
int ipworkssnmp_snmpagent_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworkssnmp_snmpagent_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertusage(void* lpObj);

int ipworkssnmp_snmpagent_getsslacceptservercertusageflags(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertversion(void* lpObj);

char* ipworkssnmp_snmpagent_getsslacceptservercertsubject(void* lpObj);
int ipworkssnmp_snmpagent_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworkssnmp_snmpagent_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworkssnmp_snmpagent_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

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.

Data Type

IPWorksSNMPCertificate

SSLAuthenticateClients Property (SNMPAgent Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(int bSSLAuthenticateClients);

Unicode (Windows)
BOOL GetSSLAuthenticateClients();
INT SetSSLAuthenticateClients(BOOL bSSLAuthenticateClients);

int ipworkssnmp_snmpagent_getsslauthenticateclients(void* lpObj);
int ipworkssnmp_snmpagent_setsslauthenticateclients(void* lpObj, int bSSLAuthenticateClients);

bool GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(bool bSSLAuthenticateClients);

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

SSLCert Property (SNMPAgent Class)

This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorksSNMPCertificate* GetSSLCert();
int SetSSLCert(IPWorksSNMPCertificate* val);

char* ipworkssnmp_snmpagent_getsslcerteffectivedate(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertexpirationdate(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertextendedkeyusage(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertfingerprint(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertfingerprintsha1(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertfingerprintsha256(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertissuer(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertprivatekey(void* lpObj);

int ipworkssnmp_snmpagent_getsslcertprivatekeyavailable(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertprivatekeycontainer(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertpublickey(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertpublickeyalgorithm(void* lpObj);

int ipworkssnmp_snmpagent_getsslcertpublickeylength(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertserialnumber(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertsignaturealgorithm(void* lpObj);

int ipworkssnmp_snmpagent_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworkssnmp_snmpagent_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworkssnmp_snmpagent_getsslcertstorepassword(void* lpObj);
int ipworkssnmp_snmpagent_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworkssnmp_snmpagent_getsslcertstoretype(void* lpObj);
int ipworkssnmp_snmpagent_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworkssnmp_snmpagent_getsslcertsubjectaltnames(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertthumbprintmd5(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertthumbprintsha1(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertthumbprintsha256(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertusage(void* lpObj);

int ipworkssnmp_snmpagent_getsslcertusageflags(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertversion(void* lpObj);

char* ipworkssnmp_snmpagent_getsslcertsubject(void* lpObj);
int ipworkssnmp_snmpagent_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworkssnmp_snmpagent_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworkssnmp_snmpagent_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

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 Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksSNMPCertificate

SSLEnabled Property (SNMPAgent Class)

Whether DTLS is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);

int ipworkssnmp_snmpagent_getsslenabled(void* lpObj);
int ipworkssnmp_snmpagent_setsslenabled(void* lpObj, int bSSLEnabled);

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

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.

Data Type

Boolean

SSLServerCert Property (SNMPAgent Class)

This property includes the server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksSNMPCertificate* GetSSLServerCert();

char* ipworkssnmp_snmpagent_getsslservercerteffectivedate(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertexpirationdate(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertextendedkeyusage(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertfingerprint(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertfingerprintsha1(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertfingerprintsha256(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertissuer(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertprivatekey(void* lpObj);

int ipworkssnmp_snmpagent_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertpublickey(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworkssnmp_snmpagent_getsslservercertpublickeylength(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertserialnumber(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertsignaturealgorithm(void* lpObj);

int ipworkssnmp_snmpagent_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworkssnmp_snmpagent_getsslservercertstorepassword(void* lpObj);

int ipworkssnmp_snmpagent_getsslservercertstoretype(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertsubjectaltnames(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertthumbprintmd5(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertthumbprintsha1(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertthumbprintsha256(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertusage(void* lpObj);

int ipworkssnmp_snmpagent_getsslservercertusageflags(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertversion(void* lpObj);

char* ipworkssnmp_snmpagent_getsslservercertsubject(void* lpObj);

int ipworkssnmp_snmpagent_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksSNMPCertificate

SysUpTime Property (SNMPAgent Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetSysUpTime();
int SetSysUpTime(int64 lSysUpTime);

Unicode (Windows)
LONG64 GetSysUpTime();
INT SetSysUpTime(LONG64 lSysUpTime);

int64 ipworkssnmp_snmpagent_getsysuptime(void* lpObj);
int ipworkssnmp_snmpagent_setsysuptime(void* lpObj, int64 lSysUpTime);

qint64 GetSysUpTime();
int SetSysUpTime(qint64 lSysUpTime);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

Activate Method (SNMPAgent Class)

Activates the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Activate();

Unicode (Windows)
INT Activate();

int ipworkssnmp_snmpagent_activate(void* lpObj);

int Activate();

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 property to check whether the component is active.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddUser Method (SNMPAgent Class)

Adds a user to the internal authentication cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddUser(const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);

Unicode (Windows)
INT AddUser(LPCWSTR lpszUser, INT iAuthenticationProtocol, LPCWSTR lpszAuthenticationPassword, INT iEncryptionAlgorithm, LPCWSTR lpszEncryptionPassword);

int ipworkssnmp_snmpagent_adduser(void* lpObj, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);

int AddUser(const QString& qsUser, int iAuthenticationProtocol, const QString& qsAuthenticationPassword, int iEncryptionAlgorithm, const QString& qsEncryptionPassword);

Remarks

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

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

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

Valid Authentication Protocols are:

Valid Encryption Algorithms are:

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ClearCache Method (SNMPAgent Class)

Clears the internal authentication database.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ClearCache();

Unicode (Windows)
INT ClearCache();

int ipworkssnmp_snmpagent_clearcache(void* lpObj);

int ClearCache();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (SNMPAgent Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworkssnmp_snmpagent_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Deactivate Method (SNMPAgent Class)

Deactivates the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Deactivate();

Unicode (Windows)
INT Deactivate();

int ipworkssnmp_snmpagent_deactivate(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (SNMPAgent Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworkssnmp_snmpagent_doevents(void* lpObj);

int DoEvents();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

HashPasswords Method (SNMPAgent Class)

Hashes all passwords in the cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int HashPasswords();

Unicode (Windows)
INT HashPasswords();

int ipworkssnmp_snmpagent_hashpasswords(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RemoveUser Method (SNMPAgent Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveUser(const char* lpszUser);

Unicode (Windows)
INT RemoveUser(LPCWSTR lpszUser);

int ipworkssnmp_snmpagent_removeuser(void* lpObj, const char* lpszUser);

int RemoveUser(const QString& qsUser);

Remarks

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

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (SNMPAgent Class)

Clears the object arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworkssnmp_snmpagent_reset(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendResponse Method (SNMPAgent Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendResponse(const char* lpszRemoteHost, int iRemotePort, int iRequestId, const char* lpszCommunity, int iErrorStatus, int iErrorIndex);

Unicode (Windows)
INT SendResponse(LPCWSTR lpszRemoteHost, INT iRemotePort, INT iRequestId, LPCWSTR lpszCommunity, INT iErrorStatus, INT iErrorIndex);

int ipworkssnmp_snmpagent_sendresponse(void* lpObj, const char* lpszRemoteHost, int iRemotePort, int iRequestId, const char* lpszCommunity, int iErrorStatus, int iErrorIndex);

int SendResponse(const QString& qsRemoteHost, int iRemotePort, int iRequestId, const QString& qsCommunity, int iErrorStatus, int iErrorIndex);

Remarks

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendSecureResponse Method (SNMPAgent Class)

Sends an authenticated and/or encrypted SNMPv3 response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendSecureResponse(const char* lpszRemoteHost, int iRemotePort, int iRequestId, int iMessageId, int iErrorStatus, int iErrorIndex, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);

Unicode (Windows)
INT SendSecureResponse(LPCWSTR lpszRemoteHost, INT iRemotePort, INT iRequestId, INT iMessageId, INT iErrorStatus, INT iErrorIndex, LPCWSTR lpszUser, INT iAuthenticationProtocol, LPCWSTR lpszAuthenticationPassword, INT iEncryptionAlgorithm, LPCWSTR lpszEncryptionPassword);

int ipworkssnmp_snmpagent_sendsecureresponse(void* lpObj, const char* lpszRemoteHost, int iRemotePort, int iRequestId, int iMessageId, int iErrorStatus, int iErrorIndex, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);

int SendSecureResponse(const QString& qsRemoteHost, int iRemotePort, int iRequestId, int iMessageId, int iErrorStatus, int iErrorIndex, const QString& qsUser, int iAuthenticationProtocol, const QString& qsAuthenticationPassword, int iEncryptionAlgorithm, const QString& qsEncryptionPassword);

Remarks

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

The MessageId argument must match the MessageId parameter obtained from the GetRequest, GetNextRequest, SetRequest, or GetBulkRequest event.

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

Valid Authentication Protocols are:

Valid Encryption Algorithms are:

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendSecureTrap Method (SNMPAgent Class)

Sends an authenticated and/or encrypted SNMPv3 trap.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendSecureTrap(const char* lpszRemoteHost, const char* lpszTrapOID, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);

Unicode (Windows)
INT SendSecureTrap(LPCWSTR lpszRemoteHost, LPCWSTR lpszTrapOID, LPCWSTR lpszUser, INT iAuthenticationProtocol, LPCWSTR lpszAuthenticationPassword, INT iEncryptionAlgorithm, LPCWSTR lpszEncryptionPassword);

int ipworkssnmp_snmpagent_sendsecuretrap(void* lpObj, const char* lpszRemoteHost, const char* lpszTrapOID, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);

int SendSecureTrap(const QString& qsRemoteHost, const QString& qsTrapOID, const QString& qsUser, int iAuthenticationProtocol, const QString& qsAuthenticationPassword, int iEncryptionAlgorithm, const QString& qsEncryptionPassword);

Remarks

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

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

Valid Authentication Protocols are:

Valid Encryption Algorithms are:

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendTrap Method (SNMPAgent Class)

Sends an SNMP Trap.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendTrap(const char* lpszRemoteHost, const char* lpszTrapOID);

Unicode (Windows)
INT SendTrap(LPCWSTR lpszRemoteHost, LPCWSTR lpszTrapOID);

int ipworkssnmp_snmpagent_sendtrap(void* lpObj, const char* lpszRemoteHost, const char* lpszTrapOID);

int SendTrap(const QString& qsRemoteHost, const QString& qsTrapOID);

Remarks

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

SendTrap sends an unauthenticated trap. The SendSecureTrap method is used to send authenticated SNMPv3 traps.

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

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

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ShowCache Method (SNMPAgent Class)

Lists all entries in the internal user authentication cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ShowCache();

Unicode (Windows)
INT ShowCache();

int ipworkssnmp_snmpagent_showcache(void* lpObj);

int ShowCache();

Remarks

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

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

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Value Method (SNMPAgent Class)

Returns the value corresponding to an OID.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Value(const char* lpszOID);

Unicode (Windows)
LPWSTR Value(LPCWSTR lpszOID);

char* ipworkssnmp_snmpagent_value(void* lpObj, const char* lpszOID);

QString Value(const QString& qsOID);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

BadPacket Event (SNMPAgent Class)

Fired for erroneous and/or malformed messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireBadPacket(SNMPAgentBadPacketEventParams *e);

typedef struct {
  const char *Packet;
  int lenPacket;
  const char *SourceAddress;
  int SourcePort;
  int ErrorCode;
  const char *ErrorDescription;
  int Report;
  int reserved;
} SNMPAgentBadPacketEventParams;


Unicode (Windows)
virtual INT FireBadPacket(SNMPAgentBadPacketEventParams *e);

typedef struct {
  LPCSTR Packet;
  INT lenPacket;
  LPCWSTR SourceAddress;
  INT SourcePort;
  INT ErrorCode;
  LPCWSTR ErrorDescription;
  BOOL Report;
  INT reserved;
} SNMPAgentBadPacketEventParams;

#define EID_SNMPAGENT_BADPACKET 1

virtual INT IPWORKSSNMP_CALL FireBadPacket(LPSTR &lpPacket, INT &lenPacket, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iErrorCode, LPSTR &lpszErrorDescription, BOOL &bReport);

class SNMPAgentBadPacketEventParams {
public:
  const QByteArray &Packet();

  const QString &SourceAddress();

  int SourcePort();

  int ErrorCode();

  const QString &ErrorDescription();

  bool Report();
  void SetReport(bool bReport);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void BadPacket(SNMPAgentBadPacketEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireBadPacket(SNMPAgentBadPacketEventParams *e) {...}

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.

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

CacheEntry Event (SNMPAgent Class)

Shows in the internal cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCacheEntry(SNMPAgentCacheEntryEventParams *e);

typedef struct {
  const char *User;
  const char *AuthenticationProtocol;
  const char *AuthenticationPassword;
  const char *EncryptionAlgorithm;
  const char *EncryptionPassword;
  int reserved;
} SNMPAgentCacheEntryEventParams;


Unicode (Windows)
virtual INT FireCacheEntry(SNMPAgentCacheEntryEventParams *e);

typedef struct {
  LPCWSTR User;
  LPCWSTR AuthenticationProtocol;
  LPCWSTR AuthenticationPassword;
  LPCWSTR EncryptionAlgorithm;
  LPCWSTR EncryptionPassword;
  INT reserved;
} SNMPAgentCacheEntryEventParams;

#define EID_SNMPAGENT_CACHEENTRY 2

virtual INT IPWORKSSNMP_CALL FireCacheEntry(LPSTR &lpszUser, LPSTR &lpszAuthenticationProtocol, LPSTR &lpszAuthenticationPassword, LPSTR &lpszEncryptionAlgorithm, LPSTR &lpszEncryptionPassword);

class SNMPAgentCacheEntryEventParams {
public:
  const QString &User();

  const QString &AuthenticationProtocol();

  const QString &AuthenticationPassword();

  const QString &EncryptionAlgorithm();

  const QString &EncryptionPassword();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CacheEntry(SNMPAgentCacheEntryEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireCacheEntry(SNMPAgentCacheEntryEventParams *e) {...}

Remarks

CacheEntry events are triggered by a call to ShowCache. One event is fired for each user.

Connected Event (SNMPAgent Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(SNMPAgentConnectedEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  int StatusCode;
  const char *Description;
  int reserved;
} SNMPAgentConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(SNMPAgentConnectedEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SNMPAgentConnectedEventParams;

#define EID_SNMPAGENT_CONNECTED 3

virtual INT IPWORKSSNMP_CALL FireConnected(LPSTR &lpszRemoteAddress, INT &iRemotePort, INT &iStatusCode, LPSTR &lpszDescription);

class SNMPAgentConnectedEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(SNMPAgentConnectedEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireConnected(SNMPAgentConnectedEventParams *e) {...}

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.

Disconnected Event (SNMPAgent Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(SNMPAgentDisconnectedEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  int StatusCode;
  const char *Description;
  int reserved;
} SNMPAgentDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(SNMPAgentDisconnectedEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SNMPAgentDisconnectedEventParams;

#define EID_SNMPAGENT_DISCONNECTED 4

virtual INT IPWORKSSNMP_CALL FireDisconnected(LPSTR &lpszRemoteAddress, INT &iRemotePort, INT &iStatusCode, LPSTR &lpszDescription);

class SNMPAgentDisconnectedEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(SNMPAgentDisconnectedEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireDisconnected(SNMPAgentDisconnectedEventParams *e) {...}

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

Fired when an SNMPv3 discovery packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDiscoveryRequest(SNMPAgentDiscoveryRequestEventParams *e);

typedef struct {
  const char *EngineId;
  int lenEngineId;
  int EngineBoots;
  int EngineTime;
  const char *User;
  int SecurityLevel;
  const char *SourceAddress;
  int SourcePort;
  int Respond;
  int reserved;
} SNMPAgentDiscoveryRequestEventParams;


Unicode (Windows)
virtual INT FireDiscoveryRequest(SNMPAgentDiscoveryRequestEventParams *e);

typedef struct {
  LPCSTR EngineId;
  INT lenEngineId;
  INT EngineBoots;
  INT EngineTime;
  LPCWSTR User;
  INT SecurityLevel;
  LPCWSTR SourceAddress;
  INT SourcePort;
  BOOL Respond;
  INT reserved;
} SNMPAgentDiscoveryRequestEventParams;

#define EID_SNMPAGENT_DISCOVERYREQUEST 5

virtual INT IPWORKSSNMP_CALL FireDiscoveryRequest(LPSTR &lpEngineId, INT &lenEngineId, INT &iEngineBoots, INT &iEngineTime, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, BOOL &bRespond);

class SNMPAgentDiscoveryRequestEventParams {
public:
  const QByteArray &EngineId();

  int EngineBoots();

  int EngineTime();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

  bool Respond();
  void SetRespond(bool bRespond);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DiscoveryRequest(SNMPAgentDiscoveryRequestEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireDiscoveryRequest(SNMPAgentDiscoveryRequestEventParams *e) {...}

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

Error Event (SNMPAgent Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(SNMPAgentErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} SNMPAgentErrorEventParams;


Unicode (Windows)
virtual INT FireError(SNMPAgentErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} SNMPAgentErrorEventParams;

#define EID_SNMPAGENT_ERROR 6

virtual INT IPWORKSSNMP_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class SNMPAgentErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(SNMPAgentErrorEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireError(SNMPAgentErrorEventParams *e) {...}

Remarks

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

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.

GetBulkRequest Event (SNMPAgent Class)

Fired when a GetBulkRequest packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGetBulkRequest(SNMPAgentGetBulkRequestEventParams *e);

typedef struct {
  int RequestId;
  int MessageId;
  int SNMPVersion;
  const char *Community;
  const char *User;
  int SecurityLevel;
  const char *SourceAddress;
  int SourcePort;
  int NonRepeaters;
  int MaxRepetitions;
  int ErrorIndex;
  int ErrorStatus;
  const char *ErrorDescription;
  int Respond;
  int reserved;
} SNMPAgentGetBulkRequestEventParams;


Unicode (Windows)
virtual INT FireGetBulkRequest(SNMPAgentGetBulkRequestEventParams *e);

typedef struct {
  INT RequestId;
  INT MessageId;
  INT SNMPVersion;
  LPCWSTR Community;
  LPCWSTR User;
  INT SecurityLevel;
  LPCWSTR SourceAddress;
  INT SourcePort;
  INT NonRepeaters;
  INT MaxRepetitions;
  INT ErrorIndex;
  INT ErrorStatus;
  LPCWSTR ErrorDescription;
  BOOL Respond;
  INT reserved;
} SNMPAgentGetBulkRequestEventParams;

#define EID_SNMPAGENT_GETBULKREQUEST 7

virtual INT IPWORKSSNMP_CALL FireGetBulkRequest(INT &iRequestId, INT &iMessageId, INT &iSNMPVersion, LPSTR &lpszCommunity, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iNonRepeaters, INT &iMaxRepetitions, INT &iErrorIndex, INT &iErrorStatus, LPSTR &lpszErrorDescription, BOOL &bRespond);

class SNMPAgentGetBulkRequestEventParams {
public:
  int RequestId();

  int MessageId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

  int NonRepeaters();

  int MaxRepetitions();

  int ErrorIndex();
  void SetErrorIndex(int iErrorIndex);

  int ErrorStatus();
  void SetErrorStatus(int iErrorStatus);

  const QString &ErrorDescription();

  bool Respond();
  void SetRespond(bool bRespond);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void GetBulkRequest(SNMPAgentGetBulkRequestEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireGetBulkRequest(SNMPAgentGetBulkRequestEventParams *e) {...}

Remarks

This is only available for SNMP versions 2 and 3.

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

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

The MessageId parameter identifies the received request.

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

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

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

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

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

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.

GetNextRequest Event (SNMPAgent Class)

Fired when a GetNextRequest packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGetNextRequest(SNMPAgentGetNextRequestEventParams *e);

typedef struct {
  int RequestId;
  int MessageId;
  int SNMPVersion;
  const char *Community;
  const char *User;
  int SecurityLevel;
  const char *SourceAddress;
  int SourcePort;
  int ErrorIndex;
  int ErrorStatus;
  const char *ErrorDescription;
  int Respond;
  int reserved;
} SNMPAgentGetNextRequestEventParams;


Unicode (Windows)
virtual INT FireGetNextRequest(SNMPAgentGetNextRequestEventParams *e);

typedef struct {
  INT RequestId;
  INT MessageId;
  INT SNMPVersion;
  LPCWSTR Community;
  LPCWSTR User;
  INT SecurityLevel;
  LPCWSTR SourceAddress;
  INT SourcePort;
  INT ErrorIndex;
  INT ErrorStatus;
  LPCWSTR ErrorDescription;
  BOOL Respond;
  INT reserved;
} SNMPAgentGetNextRequestEventParams;

#define EID_SNMPAGENT_GETNEXTREQUEST 8

virtual INT IPWORKSSNMP_CALL FireGetNextRequest(INT &iRequestId, INT &iMessageId, INT &iSNMPVersion, LPSTR &lpszCommunity, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iErrorIndex, INT &iErrorStatus, LPSTR &lpszErrorDescription, BOOL &bRespond);

class SNMPAgentGetNextRequestEventParams {
public:
  int RequestId();

  int MessageId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

  int ErrorIndex();
  void SetErrorIndex(int iErrorIndex);

  int ErrorStatus();
  void SetErrorStatus(int iErrorStatus);

  const QString &ErrorDescription();

  bool Respond();
  void SetRespond(bool bRespond);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void GetNextRequest(SNMPAgentGetNextRequestEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireGetNextRequest(SNMPAgentGetNextRequestEventParams *e) {...}

Remarks

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

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

The MessageId parameter identifies the received request.

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

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

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

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

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

GetRequest Event (SNMPAgent Class)

Fired when a GetRequest packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGetRequest(SNMPAgentGetRequestEventParams *e);

typedef struct {
  int RequestId;
  int MessageId;
  int SNMPVersion;
  const char *Community;
  const char *User;
  int SecurityLevel;
  const char *SourceAddress;
  int SourcePort;
  int ErrorIndex;
  int ErrorStatus;
  const char *ErrorDescription;
  int Respond;
  int reserved;
} SNMPAgentGetRequestEventParams;


Unicode (Windows)
virtual INT FireGetRequest(SNMPAgentGetRequestEventParams *e);

typedef struct {
  INT RequestId;
  INT MessageId;
  INT SNMPVersion;
  LPCWSTR Community;
  LPCWSTR User;
  INT SecurityLevel;
  LPCWSTR SourceAddress;
  INT SourcePort;
  INT ErrorIndex;
  INT ErrorStatus;
  LPCWSTR ErrorDescription;
  BOOL Respond;
  INT reserved;
} SNMPAgentGetRequestEventParams;

#define EID_SNMPAGENT_GETREQUEST 9

virtual INT IPWORKSSNMP_CALL FireGetRequest(INT &iRequestId, INT &iMessageId, INT &iSNMPVersion, LPSTR &lpszCommunity, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iErrorIndex, INT &iErrorStatus, LPSTR &lpszErrorDescription, BOOL &bRespond);

class SNMPAgentGetRequestEventParams {
public:
  int RequestId();

  int MessageId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

  int ErrorIndex();
  void SetErrorIndex(int iErrorIndex);

  int ErrorStatus();
  void SetErrorStatus(int iErrorStatus);

  const QString &ErrorDescription();

  bool Respond();
  void SetRespond(bool bRespond);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void GetRequest(SNMPAgentGetRequestEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireGetRequest(SNMPAgentGetRequestEventParams *e) {...}

Remarks

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

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

The MessageId parameter identifies the received request.

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

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

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

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

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

GetUserPassword Event (SNMPAgent Class)

Retrieves a password associated with a user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGetUserPassword(SNMPAgentGetUserPasswordEventParams *e);

typedef struct {
  int PasswordType;
  const char *User;
  char *Password;
  int Algorithm;
  int reserved;
} SNMPAgentGetUserPasswordEventParams;


Unicode (Windows)
virtual INT FireGetUserPassword(SNMPAgentGetUserPasswordEventParams *e);

typedef struct {
  INT PasswordType;
  LPCWSTR User;
  LPWSTR Password;
  INT Algorithm;
  INT reserved;
} SNMPAgentGetUserPasswordEventParams;

#define EID_SNMPAGENT_GETUSERPASSWORD 10

virtual INT IPWORKSSNMP_CALL FireGetUserPassword(INT &iPasswordType, LPSTR &lpszUser, LPSTR &lpszPassword, INT &iAlgorithm);

class SNMPAgentGetUserPasswordEventParams {
public:
  int PasswordType();

  const QString &User();

  const QString &Password();
  void SetPassword(const QString &qsPassword);

  int Algorithm();
  void SetAlgorithm(int iAlgorithm);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void GetUserPassword(SNMPAgentGetUserPasswordEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireGetUserPassword(SNMPAgentGetUserPasswordEventParams *e) {...}

Remarks

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

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

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

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

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

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

GetUserSecurityLevel Event (SNMPAgent Class)

Sets the security level for an incoming packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGetUserSecurityLevel(SNMPAgentGetUserSecurityLevelEventParams *e);

typedef struct {
  const char *User;
  const char *EngineId;
  int lenEngineId;
  int SecurityLevel;
  int reserved;
} SNMPAgentGetUserSecurityLevelEventParams;


Unicode (Windows)
virtual INT FireGetUserSecurityLevel(SNMPAgentGetUserSecurityLevelEventParams *e);

typedef struct {
  LPCWSTR User;
  LPCSTR EngineId;
  INT lenEngineId;
  INT SecurityLevel;
  INT reserved;
} SNMPAgentGetUserSecurityLevelEventParams;

#define EID_SNMPAGENT_GETUSERSECURITYLEVEL 11

virtual INT IPWORKSSNMP_CALL FireGetUserSecurityLevel(LPSTR &lpszUser, LPSTR &lpEngineId, INT &lenEngineId, INT &iSecurityLevel);

class SNMPAgentGetUserSecurityLevelEventParams {
public:
  const QString &User();

  const QByteArray &EngineId();

  int SecurityLevel();
  void SetSecurityLevel(int iSecurityLevel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void GetUserSecurityLevel(SNMPAgentGetUserSecurityLevelEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireGetUserSecurityLevel(SNMPAgentGetUserSecurityLevelEventParams *e) {...}

Remarks

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

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

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

HashPassword Event (SNMPAgent Class)

Fired before and after a password is hashed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHashPassword(SNMPAgentHashPasswordEventParams *e);

typedef struct {
  const char *Password;
  int AuthAlgorithm;
  char *Hash;
  int reserved;
} SNMPAgentHashPasswordEventParams;


Unicode (Windows)
virtual INT FireHashPassword(SNMPAgentHashPasswordEventParams *e);

typedef struct {
  LPCWSTR Password;
  INT AuthAlgorithm;
  LPWSTR Hash;
  INT reserved;
} SNMPAgentHashPasswordEventParams;

#define EID_SNMPAGENT_HASHPASSWORD 12

virtual INT IPWORKSSNMP_CALL FireHashPassword(LPSTR &lpszPassword, INT &iAuthAlgorithm, LPSTR &lpszHash);

class SNMPAgentHashPasswordEventParams {
public:
  const QString &Password();

  int AuthAlgorithm();

  const QString &Hash();
  void SetHash(const QString &qsHash);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void HashPassword(SNMPAgentHashPasswordEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireHashPassword(SNMPAgentHashPasswordEventParams *e) {...}

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

PacketTrace Event (SNMPAgent Class)

Fired for every packet sent or received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePacketTrace(SNMPAgentPacketTraceEventParams *e);

typedef struct {
  const char *Packet;
  int lenPacket;
  int Direction;
  const char *PacketAddress;
  int PacketPort;
  int reserved;
} SNMPAgentPacketTraceEventParams;


Unicode (Windows)
virtual INT FirePacketTrace(SNMPAgentPacketTraceEventParams *e);

typedef struct {
  LPCSTR Packet;
  INT lenPacket;
  INT Direction;
  LPCWSTR PacketAddress;
  INT PacketPort;
  INT reserved;
} SNMPAgentPacketTraceEventParams;

#define EID_SNMPAGENT_PACKETTRACE 13

virtual INT IPWORKSSNMP_CALL FirePacketTrace(LPSTR &lpPacket, INT &lenPacket, INT &iDirection, LPSTR &lpszPacketAddress, INT &iPacketPort);

class SNMPAgentPacketTraceEventParams {
public:
  const QByteArray &Packet();

  int Direction();

  const QString &PacketAddress();

  int PacketPort();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PacketTrace(SNMPAgentPacketTraceEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FirePacketTrace(SNMPAgentPacketTraceEventParams *e) {...}

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.

ReadyToSend Event (SNMPAgent Class)

Fired when the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReadyToSend(SNMPAgentReadyToSendEventParams *e);

typedef struct {
  int reserved;
} SNMPAgentReadyToSendEventParams;


Unicode (Windows)
virtual INT FireReadyToSend(SNMPAgentReadyToSendEventParams *e);

typedef struct {
  INT reserved;
} SNMPAgentReadyToSendEventParams;

#define EID_SNMPAGENT_READYTOSEND 14

virtual INT IPWORKSSNMP_CALL FireReadyToSend();

class SNMPAgentReadyToSendEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ReadyToSend(SNMPAgentReadyToSendEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireReadyToSend(SNMPAgentReadyToSendEventParams *e) {...}

Remarks

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

Report Event (SNMPAgent Class)

Fired when a Report packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReport(SNMPAgentReportEventParams *e);

typedef struct {
  int RequestId;
  int SNMPVersion;
  const char *Community;
  const char *User;
  int SecurityLevel;
  const char *SourceAddress;
  int SourcePort;
  int ErrorIndex;
  int ErrorStatus;
  const char *ErrorDescription;
  int reserved;
} SNMPAgentReportEventParams;


Unicode (Windows)
virtual INT FireReport(SNMPAgentReportEventParams *e);

typedef struct {
  INT RequestId;
  INT SNMPVersion;
  LPCWSTR Community;
  LPCWSTR User;
  INT SecurityLevel;
  LPCWSTR SourceAddress;
  INT SourcePort;
  INT ErrorIndex;
  INT ErrorStatus;
  LPCWSTR ErrorDescription;
  INT reserved;
} SNMPAgentReportEventParams;

#define EID_SNMPAGENT_REPORT 15

virtual INT IPWORKSSNMP_CALL FireReport(INT &iRequestId, INT &iSNMPVersion, LPSTR &lpszCommunity, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iErrorIndex, INT &iErrorStatus, LPSTR &lpszErrorDescription);

class SNMPAgentReportEventParams {
public:
  int RequestId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

  int ErrorIndex();

  int ErrorStatus();

  const QString &ErrorDescription();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Report(SNMPAgentReportEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireReport(SNMPAgentReportEventParams *e) {...}

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 Oid, ObjectType, and Value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

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

SetRequest Event (SNMPAgent Class)

Fired when a SetRequest packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSetRequest(SNMPAgentSetRequestEventParams *e);

typedef struct {
  int RequestId;
  int MessageId;
  int SNMPVersion;
  const char *Community;
  const char *User;
  int SecurityLevel;
  const char *SourceAddress;
  int SourcePort;
  int ErrorIndex;
  int ErrorStatus;
  const char *ErrorDescription;
  int Respond;
  int reserved;
} SNMPAgentSetRequestEventParams;


Unicode (Windows)
virtual INT FireSetRequest(SNMPAgentSetRequestEventParams *e);

typedef struct {
  INT RequestId;
  INT MessageId;
  INT SNMPVersion;
  LPCWSTR Community;
  LPCWSTR User;
  INT SecurityLevel;
  LPCWSTR SourceAddress;
  INT SourcePort;
  INT ErrorIndex;
  INT ErrorStatus;
  LPCWSTR ErrorDescription;
  BOOL Respond;
  INT reserved;
} SNMPAgentSetRequestEventParams;

#define EID_SNMPAGENT_SETREQUEST 16

virtual INT IPWORKSSNMP_CALL FireSetRequest(INT &iRequestId, INT &iMessageId, INT &iSNMPVersion, LPSTR &lpszCommunity, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iErrorIndex, INT &iErrorStatus, LPSTR &lpszErrorDescription, BOOL &bRespond);

class SNMPAgentSetRequestEventParams {
public:
  int RequestId();

  int MessageId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

  int ErrorIndex();
  void SetErrorIndex(int iErrorIndex);

  int ErrorStatus();
  void SetErrorStatus(int iErrorStatus);

  const QString &ErrorDescription();

  bool Respond();
  void SetRespond(bool bRespond);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SetRequest(SNMPAgentSetRequestEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireSetRequest(SNMPAgentSetRequestEventParams *e) {...}

Remarks

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

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

The MessageId parameter identifies the received request.

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

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

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

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

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

SSLClientAuthentication Event (SNMPAgent Class)

Fired when the client presents its credentials to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLClientAuthentication(SNMPAgentSSLClientAuthenticationEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} SNMPAgentSSLClientAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLClientAuthentication(SNMPAgentSSLClientAuthenticationEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} SNMPAgentSSLClientAuthenticationEventParams;

#define EID_SNMPAGENT_SSLCLIENTAUTHENTICATION 17

virtual INT IPWORKSSNMP_CALL FireSSLClientAuthentication(LPSTR &lpszRemoteAddress, INT &iRemotePort, LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class SNMPAgentSSLClientAuthenticationEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLClientAuthentication(SNMPAgentSSLClientAuthenticationEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireSSLClientAuthentication(SNMPAgentSSLClientAuthenticationEventParams *e) {...}

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

Accept defines whether the certificate is accepted.

SSLServerAuthentication Event (SNMPAgent Class)

Fires when connecting to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(SNMPAgentSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} SNMPAgentSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(SNMPAgentSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} SNMPAgentSSLServerAuthenticationEventParams;

#define EID_SNMPAGENT_SSLSERVERAUTHENTICATION 18

virtual INT IPWORKSSNMP_CALL FireSSLServerAuthentication(LPSTR &lpszRemoteAddress, INT &iRemotePort, LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class SNMPAgentSSLServerAuthenticationEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(SNMPAgentSSLServerAuthenticationEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireSSLServerAuthentication(SNMPAgentSSLServerAuthenticationEventParams *e) {...}

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

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(SNMPAgentSSLStatusEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  const char *Message;
  int reserved;
} SNMPAgentSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(SNMPAgentSSLStatusEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  LPCWSTR Message;
  INT reserved;
} SNMPAgentSSLStatusEventParams;

#define EID_SNMPAGENT_SSLSTATUS 19

virtual INT IPWORKSSNMP_CALL FireSSLStatus(LPSTR &lpszRemoteAddress, INT &iRemotePort, LPSTR &lpszMessage);

class SNMPAgentSSLStatusEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(SNMPAgentSSLStatusEventParams *e);

// Or, subclass SNMPAgent and override this emitter function.
virtual int FireSSLStatus(SNMPAgentSSLStatusEventParams *e) {...}

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.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksSNMPCertificate (declared in ipworkssnmp.h)

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.

Fields

Constructors

Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component 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.

SNMPObject Type

The current SNMP object.

Syntax

IPWorksSNMPSNMPObject (declared in ipworkssnmp.h)

Remarks

This type defines an SNMP object. Each object has an Oid, ObjectType, and Value. 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.

Fields

Constructors

SNMPObject()

SNMPObject(const char* lpszOid)

SNMPObject(const char* lpszOid, const char* lpValue, int lenValue)

SNMPObject(const char* lpszOid, const char* lpValue, int lenValue, int iObjectType)

IPWorksSNMPList Type

Syntax

IPWorksSNMPList<T> (declared in ipworkssnmp.h)

Remarks

IPWorksSNMPList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SNMPAgent class.

int GetCount() {}

int SetCount() {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (SNMPAgent Class)

SNMPAgent Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SNMPAgent Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SNMPAgent Errors

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

UDP Errors

SSL Errors

TCP/IP Errors