SNMPAgent Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksSNMP_SNMPAgent

Procedural Interface

 ipworkssnmp_snmpagent_open();
 ipworkssnmp_snmpagent_close($res);
 ipworkssnmp_snmpagent_register_callback($res, $id, $function);
 ipworkssnmp_snmpagent_get_last_error($res);
 ipworkssnmp_snmpagent_get_last_error_code($res);
 ipworkssnmp_snmpagent_set($res, $id, $index, $value);
 ipworkssnmp_snmpagent_get($res, $id, $index);
 ipworkssnmp_snmpagent_do_activate($res);
 ipworkssnmp_snmpagent_do_adduser($res, $user, $authenticationprotocol, $authenticationpassword, $encryptionalgorithm, $encryptionpassword);
 ipworkssnmp_snmpagent_do_clearcache($res);
 ipworkssnmp_snmpagent_do_config($res, $configurationstring);
 ipworkssnmp_snmpagent_do_deactivate($res);
 ipworkssnmp_snmpagent_do_doevents($res);
 ipworkssnmp_snmpagent_do_hashpasswords($res);
 ipworkssnmp_snmpagent_do_removeuser($res, $user);
 ipworkssnmp_snmpagent_do_reset($res);
 ipworkssnmp_snmpagent_do_sendresponse($res, $remotehost, $remoteport, $requestid, $community, $errorstatus, $errorindex);
 ipworkssnmp_snmpagent_do_sendsecureresponse($res, $remotehost, $remoteport, $requestid, $messageid, $errorstatus, $errorindex, $user, $authenticationprotocol, $authenticationpassword, $encryptionalgorithm, $encryptionpassword);
 ipworkssnmp_snmpagent_do_sendsecuretrap($res, $remotehost, $trapoid, $user, $authenticationprotocol, $authenticationpassword, $encryptionalgorithm, $encryptionpassword);
 ipworkssnmp_snmpagent_do_sendtrap($res, $remotehost, $trapoid);
 ipworkssnmp_snmpagent_do_showcache($res);
 ipworkssnmp_snmpagent_do_value($res, $oid);

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

Enables or disables data reception.

Object Oriented Interface

public function getAcceptData();
public function setAcceptData($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 1 );
ipworkssnmp_snmpagent_set($res, 1, $value );

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

Indicates whether the class is active.

Object Oriented Interface

public function getActive();
public function setActive($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 2 );
ipworkssnmp_snmpagent_set($res, 2, $value );

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

The Engine Id of the SNMP Agent.

Object Oriented Interface

public function getLocalEngineId();
public function setLocalEngineId($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 3 );
ipworkssnmp_snmpagent_set($res, 3, $value );

Default Value

''

Remarks

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

Data Type

Binary String

LocalHost Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 4 );
ipworkssnmp_snmpagent_set($res, 4, $value );

Default Value

''

Remarks

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

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server 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 (IPWorksSNMP_SNMPAgent Class)

The port in the local host where the class listens.

Object Oriented Interface

public function getLocalPort();
public function setLocalPort($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 5 );
ipworkssnmp_snmpagent_set($res, 5, $value );

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

ObjCount Property (IPWorksSNMP_SNMPAgent Class)

The number of records in the Obj arrays.

Object Oriented Interface

public function getObjCount();
public function setObjCount($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 6 );
ipworkssnmp_snmpagent_set($res, 6, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ObjId
• ObjType
• ObjTypeString
• ObjValue

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

This property is not available at design time.

Data Type

Integer

ObjType Property (IPWorksSNMP_SNMPAgent Class)

The current object's type.

Object Oriented Interface

public function getObjType($objindex);
public function setObjType($objindex, $value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 7 , $objindex);
ipworkssnmp_snmpagent_set($res, 7, $value , $objindex);

Default Value

5

Remarks

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

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

Possible object type values include:

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

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

This property is not available at design time.

Data Type

Integer

ObjId Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getObjId($objindex);
public function setObjId($objindex, $value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 8 , $objindex);
ipworkssnmp_snmpagent_set($res, 8, $value , $objindex);

Default Value

''

Remarks

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

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

Example

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

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

This property is not available at design time.

Data Type

String

ObjTypeString Property (IPWorksSNMP_SNMPAgent Class)

A string representation of the current object's ObjectType .

Object Oriented Interface

public function getObjTypeString($objindex);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 9 , $objindex);

Default Value

''

Remarks

A string representation of the current object's ObjectType.

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

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

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

Data Type

String

ObjValue Property (IPWorksSNMP_SNMPAgent Class)

The current object's value.

Object Oriented Interface

public function getObjValue($objindex);
public function setObjValue($objindex, $value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 10 , $objindex);
ipworkssnmp_snmpagent_set($res, 10, $value , $objindex);

Default Value

''

Remarks

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

Example

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

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

This property is not available at design time.

Data Type

Binary String

RequestId Property (IPWorksSNMP_SNMPAgent Class)

The request-id to mark outgoing packets with.

Object Oriented Interface

public function getRequestId();
public function setRequestId($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 11 );
ipworkssnmp_snmpagent_set($res, 11, $value );

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

Version of SNMP used for outgoing requests (traps).

Object Oriented Interface

public function getSNMPVersion();
public function setSNMPVersion($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 12 );
ipworkssnmp_snmpagent_set($res, 12, $value );

Default Value

2

Remarks

This property takes one of the following values:

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (IPWorksSNMP_SNMPAgent Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 13 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorksSNMP_SNMPAgent Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 14 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorksSNMP_SNMPAgent Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 15 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 16 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 17 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 18 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorksSNMP_SNMPAgent Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 19 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorksSNMP_SNMPAgent Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 20 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorksSNMP_SNMPAgent Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 21 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 22 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorksSNMP_SNMPAgent Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 23 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 24 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 25 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorksSNMP_SNMPAgent Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 26 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorksSNMP_SNMPAgent Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 27 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorksSNMP_SNMPAgent Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 28 );
ipworkssnmp_snmpagent_set($res, 28, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 29 );
ipworkssnmp_snmpagent_set($res, 29, $value );

Default Value

''

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (IPWorksSNMP_SNMPAgent Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 30 );
ipworkssnmp_snmpagent_set($res, 30, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 31 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksSNMP_SNMPAgent Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 32 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorksSNMP_SNMPAgent Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 33 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorksSNMP_SNMPAgent Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 34 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorksSNMP_SNMPAgent Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 35 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorksSNMP_SNMPAgent Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 36 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorksSNMP_SNMPAgent Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 37 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorksSNMP_SNMPAgent Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 38 );
ipworkssnmp_snmpagent_set($res, 38, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorksSNMP_SNMPAgent Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 39 );
ipworkssnmp_snmpagent_set($res, 39, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLAuthenticateClients Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLAuthenticateClients();
public function setSSLAuthenticateClients($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 40 );
ipworkssnmp_snmpagent_set($res, 40, $value );

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

SSLCertEffectiveDate Property (IPWorksSNMP_SNMPAgent Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 41 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorksSNMP_SNMPAgent Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 42 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorksSNMP_SNMPAgent Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 43 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 44 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 45 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 46 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorksSNMP_SNMPAgent Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 47 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorksSNMP_SNMPAgent Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 48 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorksSNMP_SNMPAgent Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 49 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 50 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorksSNMP_SNMPAgent Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 51 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 52 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 53 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorksSNMP_SNMPAgent Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 54 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorksSNMP_SNMPAgent Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 55 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorksSNMP_SNMPAgent Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 56 );
ipworkssnmp_snmpagent_set($res, 56, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 57 );
ipworkssnmp_snmpagent_set($res, 57, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (IPWorksSNMP_SNMPAgent Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 58 );
ipworkssnmp_snmpagent_set($res, 58, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 59 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksSNMP_SNMPAgent Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 60 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorksSNMP_SNMPAgent Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 61 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorksSNMP_SNMPAgent Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 62 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorksSNMP_SNMPAgent Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 63 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorksSNMP_SNMPAgent Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 64 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorksSNMP_SNMPAgent Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 65 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorksSNMP_SNMPAgent Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 66 );
ipworkssnmp_snmpagent_set($res, 66, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLCertEncoded Property (IPWorksSNMP_SNMPAgent Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 67 );
ipworkssnmp_snmpagent_set($res, 67, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLEnabled Property (IPWorksSNMP_SNMPAgent Class)

Whether DTLS is enabled.

Object Oriented Interface

public function getSSLEnabled();
public function setSSLEnabled($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 68 );
ipworkssnmp_snmpagent_set($res, 68, $value );

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

SSLServerCertEffectiveDate Property (IPWorksSNMP_SNMPAgent Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 69 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorksSNMP_SNMPAgent Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 70 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorksSNMP_SNMPAgent Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 71 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 72 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 73 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 74 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorksSNMP_SNMPAgent Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 75 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorksSNMP_SNMPAgent Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 76 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorksSNMP_SNMPAgent Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 77 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 78 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorksSNMP_SNMPAgent Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 79 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 80 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 81 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorksSNMP_SNMPAgent Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 82 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorksSNMP_SNMPAgent Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 83 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorksSNMP_SNMPAgent Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 84 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 85 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorksSNMP_SNMPAgent Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 86 );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 87 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksSNMP_SNMPAgent Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 88 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorksSNMP_SNMPAgent Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 89 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorksSNMP_SNMPAgent Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 90 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorksSNMP_SNMPAgent Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 91 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorksSNMP_SNMPAgent Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 92 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorksSNMP_SNMPAgent Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 93 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorksSNMP_SNMPAgent Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 94 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorksSNMP_SNMPAgent Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworkssnmp_snmpagent_get($res, 95 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

SysUpTime Property (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function getSysUpTime();
public function setSysUpTime($value);

Procedural Interface

ipworkssnmp_snmpagent_get($res, 96 );
ipworkssnmp_snmpagent_set($res, 96, $value );

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

Activates the class.

Object Oriented Interface

public function doActivate();

Procedural Interface

ipworkssnmp_snmpagent_do_activate($res);

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.

AddUser Method (IPWorksSNMP_SNMPAgent Class)

Adds a user to the internal authentication cache.

Object Oriented Interface

public function doAddUser($user, $authenticationprotocol, $authenticationpassword, $encryptionalgorithm, $encryptionpassword);

Procedural Interface

ipworkssnmp_snmpagent_do_adduser($res, $user, $authenticationprotocol, $authenticationpassword, $encryptionalgorithm, $encryptionpassword);

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.

ClearCache Method (IPWorksSNMP_SNMPAgent Class)

Clears the internal authentication database.

Object Oriented Interface

public function doClearCache();

Procedural Interface

ipworkssnmp_snmpagent_do_clearcache($res);

Remarks

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

Config Method (IPWorksSNMP_SNMPAgent Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworkssnmp_snmpagent_do_config($res, $configurationstring);

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.

Deactivate Method (IPWorksSNMP_SNMPAgent Class)

Deactivates the class.

Object Oriented Interface

public function doDeactivate();

Procedural Interface

ipworkssnmp_snmpagent_do_deactivate($res);

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.

DoEvents Method (IPWorksSNMP_SNMPAgent Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworkssnmp_snmpagent_do_doevents($res);

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.

HashPasswords Method (IPWorksSNMP_SNMPAgent Class)

Hashes all passwords in the cache.

Object Oriented Interface

public function doHashPasswords();

Procedural Interface

ipworkssnmp_snmpagent_do_hashpasswords($res);

Remarks

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

RemoveUser Method (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function doRemoveUser($user);

Procedural Interface

ipworkssnmp_snmpagent_do_removeuser($res, $user);

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.

Reset Method (IPWorksSNMP_SNMPAgent Class)

Clears the object arrays.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworkssnmp_snmpagent_do_reset($res);

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

SendResponse Method (IPWorksSNMP_SNMPAgent Class)

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

Object Oriented Interface

public function doSendResponse($remotehost, $remoteport, $requestid, $community, $errorstatus, $errorindex);

Procedural Interface

ipworkssnmp_snmpagent_do_sendresponse($res, $remotehost, $remoteport, $requestid, $community, $errorstatus, $errorindex);

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.

SendSecureResponse Method (IPWorksSNMP_SNMPAgent Class)

Sends an authenticated and/or encrypted SNMPv3 response.

Object Oriented Interface

public function doSendSecureResponse($remotehost, $remoteport, $requestid, $messageid, $errorstatus, $errorindex, $user, $authenticationprotocol, $authenticationpassword, $encryptionalgorithm, $encryptionpassword);

Procedural Interface

ipworkssnmp_snmpagent_do_sendsecureresponse($res, $remotehost, $remoteport, $requestid, $messageid, $errorstatus, $errorindex, $user, $authenticationprotocol, $authenticationpassword, $encryptionalgorithm, $encryptionpassword);

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:

SendSecureTrap Method (IPWorksSNMP_SNMPAgent Class)

Sends an authenticated and/or encrypted SNMPv3 trap.

Object Oriented Interface

public function doSendSecureTrap($remotehost, $trapoid, $user, $authenticationprotocol, $authenticationpassword, $encryptionalgorithm, $encryptionpassword);

Procedural Interface

ipworkssnmp_snmpagent_do_sendsecuretrap($res, $remotehost, $trapoid, $user, $authenticationprotocol, $authenticationpassword, $encryptionalgorithm, $encryptionpassword);

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:

SendTrap Method (IPWorksSNMP_SNMPAgent Class)

Sends an SNMP Trap.

Object Oriented Interface

public function doSendTrap($remotehost, $trapoid);

Procedural Interface

ipworkssnmp_snmpagent_do_sendtrap($res, $remotehost, $trapoid);

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:

ShowCache Method (IPWorksSNMP_SNMPAgent Class)

Lists all entries in the internal user authentication cache.

Object Oriented Interface

public function doShowCache();

Procedural Interface

ipworkssnmp_snmpagent_do_showcache($res);

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.

Value Method (IPWorksSNMP_SNMPAgent Class)

Returns the value corresponding to an OID.

Object Oriented Interface

public function doValue($oid);

Procedural Interface

ipworkssnmp_snmpagent_do_value($res, $oid);

Remarks

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

Please refer to the SNMPObject type for more information.

BadPacket Event (IPWorksSNMP_SNMPAgent Class)

Fired for erroneous and/or malformed messages.

Object Oriented Interface

public function fireBadPacket($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 1, array($this, 'fireBadPacket'));

Parameter List

 'packet'
 'sourceaddress'
 'sourceport'
 'errorcode'
 'errordescription'
 'report'

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

Shows in the internal cache.

Object Oriented Interface

public function fireCacheEntry($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 2, array($this, 'fireCacheEntry'));

Parameter List

 'user'
 'authenticationprotocol'
 'authenticationpassword'
 'encryptionalgorithm'
 'encryptionpassword'

Remarks

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

Connected Event (IPWorksSNMP_SNMPAgent Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 3, array($this, 'fireConnected'));

Parameter List

 'remoteaddress'
 'remoteport'
 'statuscode'
 'description'

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

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'remoteaddress'
 'remoteport'
 'statuscode'
 'description'

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

Fired when an SNMPv3 discovery packet is received.

Object Oriented Interface

public function fireDiscoveryRequest($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 5, array($this, 'fireDiscoveryRequest'));

Parameter List

 'engineid'
 'engineboots'
 'enginetime'
 'user'
 'securitylevel'
 'sourceaddress'
 'sourceport'
 'respond'

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

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 6, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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

Fired when a GetBulkRequest packet is received.

Object Oriented Interface

public function fireGetBulkRequest($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 7, array($this, 'fireGetBulkRequest'));

Parameter List

 'requestid'
 'messageid'
 'snmpversion'
 'community'
 'user'
 'securitylevel'
 'sourceaddress'
 'sourceport'
 'nonrepeaters'
 'maxrepetitions'
 'errorindex'
 'errorstatus'
 'errordescription'
 'respond'

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

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

The MessageId parameter identifies the received request.

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

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

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

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

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

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

A GetBulkRequest is very similar to a GetNextRequest, the difference is that Getbulk performs a continuous GetNext operation based on the 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 (IPWorksSNMP_SNMPAgent Class)

Fired when a GetNextRequest packet is received.

Object Oriented Interface

public function fireGetNextRequest($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 8, array($this, 'fireGetNextRequest'));

Parameter List

 'requestid'
 'messageid'
 'snmpversion'
 'community'
 'user'
 'securitylevel'
 'sourceaddress'
 'sourceport'
 'errorindex'
 'errorstatus'
 'errordescription'
 'respond'

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

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

The MessageId parameter identifies the received request.

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

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

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

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

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

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

GetRequest Event (IPWorksSNMP_SNMPAgent Class)

Fired when a GetRequest packet is received.

Object Oriented Interface

public function fireGetRequest($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 9, array($this, 'fireGetRequest'));

Parameter List

 'requestid'
 'messageid'
 'snmpversion'
 'community'
 'user'
 'securitylevel'
 'sourceaddress'
 'sourceport'
 'errorindex'
 'errorstatus'
 'errordescription'
 'respond'

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

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

The MessageId parameter identifies the received request.

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

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

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

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

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

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

GetUserPassword Event (IPWorksSNMP_SNMPAgent Class)

Retrieves a password associated with a user.

Object Oriented Interface

public function fireGetUserPassword($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 10, array($this, 'fireGetUserPassword'));

Parameter List

 'passwordtype'
 'user'
 'password'
 'algorithm'

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 PasswordType parameter is 2 (encryption is used), the Algorithm parameter must also be set. Possible values are:

If the password does not match the signature in the request, a 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 (IPWorksSNMP_SNMPAgent Class)

Sets the security level for an incoming packet.

Object Oriented Interface

public function fireGetUserSecurityLevel($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 11, array($this, 'fireGetUserSecurityLevel'));

Parameter List

 'user'
 'engineid'
 'securitylevel'

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

Fired before and after a password is hashed.

Object Oriented Interface

public function fireHashPassword($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 12, array($this, 'fireHashPassword'));

Parameter List

 'password'
 'authalgorithm'
 'hash'

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

Fired for every packet sent or received.

Object Oriented Interface

public function firePacketTrace($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 13, array($this, 'firePacketTrace'));

Parameter List

 'packet'
 'direction'
 'packetaddress'
 'packetport'

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

Fired when the class is ready to send data.

Object Oriented Interface

public function fireReadyToSend($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 14, array($this, 'fireReadyToSend'));

Parameter List

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

Fired when a Report packet is received.

Object Oriented Interface

public function fireReport($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 15, array($this, 'fireReport'));

Parameter List

 'requestid'
 'snmpversion'
 'community'
 'user'
 'securitylevel'
 'sourceaddress'
 'sourceport'
 'errorindex'
 'errorstatus'
 'errordescription'

Remarks

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

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

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

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

SetRequest Event (IPWorksSNMP_SNMPAgent Class)

Fired when a SetRequest packet is received.

Object Oriented Interface

public function fireSetRequest($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 16, array($this, 'fireSetRequest'));

Parameter List

 'requestid'
 'messageid'
 'snmpversion'
 'community'
 'user'
 'securitylevel'
 'sourceaddress'
 'sourceport'
 'errorindex'
 'errorstatus'
 'errordescription'
 'respond'

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

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

The MessageId parameter identifies the received request.

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

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

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

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

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

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

SSLClientAuthentication Event (IPWorksSNMP_SNMPAgent Class)

Fired when the client presents its credentials to the server.

Object Oriented Interface

public function fireSSLClientAuthentication($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 17, array($this, 'fireSSLClientAuthentication'));

Parameter List

 'remoteaddress'
 'remoteport'
 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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

Fires when connecting to the server.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 18, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'remoteaddress'
 'remoteport'
 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworkssnmp_snmpagent_register_callback($res, 19, array($this, 'fireSSLStatus'));

Parameter List

 'remoteaddress'
 'remoteport'
 'message'

Remarks

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

RemoteAddress is the IP address of the remote machine.

RemotePort is the port of the remote machine.

Message is the log message.

Config Settings (SNMPAgent Class)

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

SNMPAgent Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SNMPAgent Class)

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