SNMPMgr Class
Properties Methods Events Config Settings Errors
The SNMPMgr class is used to implement UDP-based SNMP Management Applications.
Class Name
IPWorksSNMP_SNMPMgr
Procedural Interface
ipworkssnmp_snmpmgr_open(); ipworkssnmp_snmpmgr_close($res); ipworkssnmp_snmpmgr_register_callback($res, $id, $function); ipworkssnmp_snmpmgr_get_last_error($res); ipworkssnmp_snmpmgr_get_last_error_code($res); ipworkssnmp_snmpmgr_set($res, $id, $index, $value); ipworkssnmp_snmpmgr_get($res, $id, $index); ipworkssnmp_snmpmgr_do_activate($res); ipworkssnmp_snmpmgr_do_config($res, $configurationstring); ipworkssnmp_snmpmgr_do_deactivate($res); ipworkssnmp_snmpmgr_do_discover($res); ipworkssnmp_snmpmgr_do_doevents($res); ipworkssnmp_snmpmgr_do_hashpasswords($res); ipworkssnmp_snmpmgr_do_interrupt($res); ipworkssnmp_snmpmgr_do_reset($res); ipworkssnmp_snmpmgr_do_sendgetbulkrequest($res, $nonrepeaters, $maxrepetitions); ipworkssnmp_snmpmgr_do_sendgetnextrequest($res); ipworkssnmp_snmpmgr_do_sendgetrequest($res); ipworkssnmp_snmpmgr_do_sendinformrequest($res); ipworkssnmp_snmpmgr_do_sendsetrequest($res); ipworkssnmp_snmpmgr_do_value($res, $oid); ipworkssnmp_snmpmgr_do_walk($res, $tableoid);
Remarks
The SNMPMgr class implements a UDP-based standard SNMP Manager as specified in the SNMP RFCs. The class supports SNMP v1, v2c, and v3.
The class provides both encoding/decoding and transport capabilities, making the task of developing a custom SNMP manager as simple as setting a few key properties and handling a few events. SNMP data, such as for instance SNMP object id-s (OID-s) are exchanged as text strings, thus further simplifying the task of handling them.
The class is activated/deactivated by calling the Activate or Deactivate method. These methods enable or disable sending and receiving. The activation status can be found in the Active property.
Messages are received through events such as Response, Trap, or InformRequest. SNMP Traps are received through the Trap event.
Messages are sent to other agents or managers by using class's methods such as SendGetRequest, SendGetNextRequest, SendGetBulkRequest, SendSetRequest, and SendInformRequest.
SNMP OIDs, types, and values are provided in the Objects collection of SNMP objects for both sent and received packets.
SNMPv3 USM security is enabled by setting properties such as User, AuthenticationPassword, and EncryptionPassword and calling the Discover method to bind to a particular agent (RemoteEngineId). Upon successful discovery, received packets are checked for integrity (authentication) and timeliness. Note that the discovery step is optional, and may be avoided if the values for RemoteEngineId, RemoteEngineBoots, and RemoteEngineTime are known in advance and provided to the class through the respective properties.
By default, the class operates synchronously (except for the Discover method), sending a request and waiting until the corresponding response has been received. This behavior may be overridden by setting Timeout to 0, in which case the class returns control immediately after a send, and responses are received exclusively through the Response event.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AcceptData | Enables or disables data reception. |
Active | Indicates whether the class is active. |
AuthenticationPassword | The password used for SNMPv3 authentication. |
AuthenticationProtocol | The authentication protocol used for SNMPv3 packets. |
Community | The community string used to authenticate SNMP packets. |
EncryptionAlgorithm | The encryption algorithm used for SNMPv3 packets. |
EncryptionPassword | The password used for SNMPv3 privacy. |
ErrorDescription | Description of the status code for the last SNMP packet received by the class. |
ErrorIndex | Index of the first variable (object) that caused an error from the last SNMP response. |
ErrorStatus | Status code for the last SNMP packet received by the class. |
LocalEngineId | The Engine Id of the SNMP Manager. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | The port in the local host where the SNMP Manager is bound to. |
ObjCount | The number of records in the Obj arrays. |
ObjType | The current object's type. |
ObjId | The current object's id which is encoded as a string of numbers separated by periods. |
ObjTypeString | A string representation of the current object's ObjectType . |
ObjValue | The current object's value. |
RemoteEngineBoots | The remote engine boots (SNMPv3). |
RemoteEngineId | The Engine Id of the remote agent. |
RemoteEngineTime | The remote engine time (SNMPv3). |
RemoteHost | The address of the remote host. Domain names are resolved to IP addresses. |
RemotePort | The port where the remote SNMP agent is listening. |
RequestId | The request-id to mark outgoing packets with. |
SNMPVersion | Version of SNMP used for outgoing requests. |
StoreWalkObjects | Tells the class whether or not to store returned objects. |
Timeout | A timeout for the class. |
User | The user name used for SNMPv3 authentication. |
WalkLimit | The limit of oid's returned in a walk. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Activate | Activates the class. |
Config | Sets or retrieves a configuration setting. |
Deactivate | Deactivates the class. |
Discover | Performs SNMPv3 discovery. |
DoEvents | Processes events from the internal message queue. |
HashPasswords | Hashes all passwords in the cache. |
Interrupt | Interrupt the current method. |
Reset | Clears the object arrays. |
SendGetBulkRequest | Send a GetBulkRequest packet. |
SendGetNextRequest | Send GetNextRequest packet. |
SendGetRequest | Send GetRequest packet. |
SendInformRequest | Send an InformRequest packet. |
SendSetRequest | Send Set Request packet. |
Value | Returns the value corresponding to an OID. |
Walk | Does an SNMP walk starting with the specified oid. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
BadPacket | Fired for erroneous and/or malformed messages. |
DiscoveryRequest | Fired when an SNMPv3 discovery packet is received. |
DiscoveryResponse | Fired when an SNMPv3 discovery response is received. |
Error | Information about errors during data delivery. |
HashPassword | Fired before and after a password is hashed. |
InformRequest | Fired when an InformRequest packet is received. |
PacketTrace | Fired for every packet sent or received. |
ReadyToSend | Fired when the class is ready to send data. |
Report | Fired when a Report packet is received. |
Response | Fired when a GetResponse packet is received. |
Trap | Fired when a SNMP trap packet is received. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AllowSingleStepDiscovery | Whether to allow discovery to be completed in a single step. |
CheckMessageOrigin | Whether to match the origin IP address when receiving responses. |
CheckSNMPVersion | Whether to check the version of incoming packets. |
CompatibilityMode | Whether to operate the class in a specific compatibility mode. |
ContextEngineId | Sets the context engine id of the SNMP entity. |
ContextName | Sets the context name of the SNMP entity. |
DecryptLogPackets | Whether to decrypt logged packets. |
ForceLocalPort | Forces the class to bind to a specific port. |
IgnoreDuplicateResponse | Whether to ignore duplicate responses. |
IgnorePortMismatch | Whether to check if the port matches when a response is received. |
IncomingContextEngineId | The engine Id of the received packet. |
IncomingContextName | The context name of the received packet. |
MsgMaxSize | The maximum supported message size. |
SourceAddress | The source address of the received packet. |
SourcePort | The source port of the received packet. |
TimeoutInMilliseconds | The timeout is treated as milliseconds. |
WalkInsideRange | Stops the SNMP walk if the OID value returned from an agent is outside the table. |
WalkStartOID | Specifies the OID to be used when a Walk is performed. |
CaptureIPPacketInfo | Used to capture the packet information. |
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
DestinationAddress | Used to get the destination address from the packet information. |
DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxPacketSize | The maximum length of the packets that can be received. |
QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
ShareLocalPort | If set to True, allows more than one instance of the class to be active on the same local port. |
SourceIPAddress | Used to set the source IP address used when sending a packet. |
SourceMacAddress | Used to set the source MAC address used when sending a packet. |
UseConnection | Determines whether to use a connected socket. |
UseIPv6 | Whether or not to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
AcceptData Property (IPWorksSNMP_SNMPMgr Class)
Enables or disables data reception.
Object Oriented Interface
public function getAcceptData(); public function setAcceptData($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 1 ); ipworkssnmp_snmpmgr_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_SNMPMgr Class)
Indicates whether the class is active.
Object Oriented Interface
public function getActive(); public function setActive($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 2 ); ipworkssnmp_snmpmgr_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.
Note: Use the Activate or Deactivate method to control whether the class is active.
This property is not available at design time.
Data Type
Boolean
AuthenticationPassword Property (IPWorksSNMP_SNMPMgr Class)
The password used for SNMPv3 authentication.
Object Oriented Interface
public function getAuthenticationPassword(); public function setAuthenticationPassword($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 3 ); ipworkssnmp_snmpmgr_set($res, 3, $value );
Default Value
''
Remarks
Every time EncryptionPassword, AuthenticationPassword, or RemoteEngineId are set, a localized key is computed automatically, and cached internally.
Data Type
String
AuthenticationProtocol Property (IPWorksSNMP_SNMPMgr Class)
The authentication protocol used for SNMPv3 packets.
Object Oriented Interface
public function getAuthenticationProtocol(); public function setAuthenticationProtocol($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 4 ); ipworkssnmp_snmpmgr_set($res, 4, $value );
Default Value
1
Remarks
This property defines the authentication protocol used when SNMPVersion is set to snmpverV3. Possible values are:
- 1 (HMAC-MD5-96 - default)
- 2 (HMAC-SHA-96)
- 3 (HMAC-192-SHA-256)
- 4 (HMAC-384-SHA-512)
This property is not available at design time.
Data Type
Integer
Community Property (IPWorksSNMP_SNMPMgr Class)
The community string used to authenticate SNMP packets.
Object Oriented Interface
public function getCommunity(); public function setCommunity($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 5 ); ipworkssnmp_snmpmgr_set($res, 5, $value );
Default Value
'public'
Remarks
Must match the community name that is specified on the agent.
Typical values are "public" or "private".
This property is used for all SNMP packets sent by the class.
Data Type
String
EncryptionAlgorithm Property (IPWorksSNMP_SNMPMgr Class)
The encryption algorithm used for SNMPv3 packets.
Object Oriented Interface
public function getEncryptionAlgorithm(); public function setEncryptionAlgorithm($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 6 ); ipworkssnmp_snmpmgr_set($res, 6, $value );
Default Value
1
Remarks
In order to use encryption, you must set the EncryptionPassword property. The supported algorithms for encryption are:
DES (1) | Data Encryption Standard. |
AES (2) | Advanced Encryption Standard with key length of 128. |
3DES (3) | Triple Data Encryption Standard. |
AES192 (4) | Advanced Encryption Standard with key length of 192. |
AES256 (5) | Advanced Encryption Standard with key length of 256. |
This property is not available at design time.
Data Type
Integer
EncryptionPassword Property (IPWorksSNMP_SNMPMgr Class)
The password used for SNMPv3 privacy.
Object Oriented Interface
public function getEncryptionPassword(); public function setEncryptionPassword($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 7 ); ipworkssnmp_snmpmgr_set($res, 7, $value );
Default Value
''
Remarks
Every time EncryptionPassword, AuthenticationPassword, or RemoteEngineId are set, a localized key is computed automatically, and cached internally.
Data Type
String
ErrorDescription Property (IPWorksSNMP_SNMPMgr Class)
Description of the status code for the last SNMP packet received by the class.
Object Oriented Interface
public function getErrorDescription();
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 8 );
Default Value
'0'
Remarks
Please refer to the ErrorStatus property for more information.
This property is read-only and not available at design time.
Data Type
String
ErrorIndex Property (IPWorksSNMP_SNMPMgr Class)
Index of the first variable (object) that caused an error from the last SNMP response.
Object Oriented Interface
public function getErrorIndex();
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 9 );
Default Value
0
Remarks
This property is used in conjunction with the ErrorStatus property, and refers to the object that caused the error reported in the last SNMP response. This value is parsed directly from the SNMP response, which will be a one-based value, so a value of i here maps to index i-1 in the Objects collection.
The ErrorIndex property has no meaning when the ErrorStatus property is 0 (no error).
This property is read-only and not available at design time.
Data Type
Integer
ErrorStatus Property (IPWorksSNMP_SNMPMgr Class)
Status code for the last SNMP packet received by the class.
Object Oriented Interface
public function getErrorStatus();
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 10 );
Default Value
0
Remarks
This property is used in conjunction with the ErrorIndex property, which denotes the index of the variable in error. The ErrorDescription property provides a textual description of the error.
The following is a list of valid SNMP status code values:
0 (noError) | No error. |
1 (tooBig) | The response cannot fit in a single SNMP message. |
2 (noSuchName) | Variable does not exist. |
3 (badValue) | Invalid value or syntax. |
4 (readOnly) | Variable is read-only. |
5 (genError) | Other error (SNMPv1). |
6 (noAccess) | Access denied. |
7 (wrongType) | Wrong object type. |
8 (wrongLength) | Wrong length. |
9 (wrongEncoding) | Wrong encoding. |
10 (wrongValue) | Wrong value. |
11 (noCreation) | No creation. |
12 (inconsistentValue) | Inconsistent value. |
13 (resourceUnavailable) | Resource unavailable. |
14 (commitFailed) | Commit failed. |
15 (undoFailed) | Undo failed. |
16 (authorizationError) | Authorization error. |
17 (notWritable) | Variable is not writable. |
18 (inconsistentName) | Inconsistent name. |
Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).
The default value is 0 (no error).
This property is read-only and not available at design time.
Data Type
Integer
LocalEngineId Property (IPWorksSNMP_SNMPMgr Class)
The Engine Id of the SNMP Manager.
Object Oriented Interface
public function getLocalEngineId(); public function setLocalEngineId($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 11 ); ipworkssnmp_snmpmgr_set($res, 11, $value );
Default Value
''
Remarks
This property is only used for SNMPv3 packets (when SNMPVersion is 3).
Data Type
Binary String
LocalHost Property (IPWorksSNMP_SNMPMgr 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_snmpmgr_get($res, 12 ); ipworkssnmp_snmpmgr_set($res, 12, $value );
Default Value
''
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
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 multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
LocalPort Property (IPWorksSNMP_SNMPMgr Class)
The port in the local host where the SNMP Manager is bound to.
Object Oriented Interface
public function getLocalPort(); public function setLocalPort($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 13 ); ipworkssnmp_snmpmgr_set($res, 13, $value );
Default Value
0
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. The default port is 0 (random port). If you would like to receive traps, set LocalPort to 162 (standard trap port). However, it is recommended that the SNMPTrapMgr class be used for listening to traps, because SNMPMgr is limited to receiving SNMPv3 traps from a single agent only. SNMPTrapMgr does not have this limitation.
LocalPort cannot be changed once the 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_SNMPMgr Class)
The number of records in the Obj arrays.
Object Oriented Interface
public function getObjCount(); public function setObjCount($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 14 ); ipworkssnmp_snmpmgr_set($res, 14, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
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_SNMPMgr Class)
The current object's type.
Object Oriented Interface
public function getObjType($objindex); public function setObjType($objindex, $value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 15 , $objindex); ipworkssnmp_snmpmgr_set($res, 15, $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:
otInteger (2) | 2 |
otOctetString (4) | 4 |
otNull (5) | 5 |
otObjectID (6) | 6 |
otIPAddress (64) | 64 |
otCounter32 (65) | 65 |
otGauge32 (66) | 66 |
otTimeTicks (67) | 67 |
otOpaque (68) | 68 |
otNSAP (69) | 69 |
otCounter64 (70) | 70 |
otUnsignedInteger32 (71) | 71 |
The class also supports the following artificial object values used to designate error conditions:
otNoSuchObject (128) | No such object error. |
otNoSuchInstance (129) | No such instance error. |
otEndOfMibView (130) | End of MIB View error. |
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_SNMPMgr 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_snmpmgr_get($res, 16 , $objindex); ipworkssnmp_snmpmgr_set($res, 16, $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_SNMPMgr Class)
A string representation of the current object's ObjectType .
Object Oriented Interface
public function getObjTypeString($objindex);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 17 , $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_SNMPMgr Class)
The current object's value.
Object Oriented Interface
public function getObjValue($objindex); public function setObjValue($objindex, $value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 18 , $objindex); ipworkssnmp_snmpmgr_set($res, 18, $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
RemoteEngineBoots Property (IPWorksSNMP_SNMPMgr Class)
The remote engine boots (SNMPv3).
Object Oriented Interface
public function getRemoteEngineBoots(); public function setRemoteEngineBoots($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 19 ); ipworkssnmp_snmpmgr_set($res, 19, $value );
Default Value
0
Remarks
This property is used in conjunction with the RemoteEngineTime property. Please refer to the description of the RemoteEngineTime property, and the Discover method for further information.
Data Type
Integer
RemoteEngineId Property (IPWorksSNMP_SNMPMgr Class)
The Engine Id of the remote agent.
Object Oriented Interface
public function getRemoteEngineId(); public function setRemoteEngineId($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 20 ); ipworkssnmp_snmpmgr_set($res, 20, $value );
Default Value
''
Remarks
This property is only used for SNMPv3 packets (see SNMPVersion), and is reset every time RemoteHost or RemotePort changes.
RemoteEngineId is normally discovered through the Discover method. However, by manually supplying a value for the property, RemoteEngineId discovery step may be eliminated, thus avoiding the extra roundtrip to the agent (RemoteEngineBoots and RemoteEngineTime are also required for User authentication - please refer to the Discover method for more information).
Data Type
Binary String
RemoteEngineTime Property (IPWorksSNMP_SNMPMgr Class)
The remote engine time (SNMPv3).
Object Oriented Interface
public function getRemoteEngineTime(); public function setRemoteEngineTime($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 21 ); ipworkssnmp_snmpmgr_set($res, 21, $value );
Default Value
0
Remarks
RemoteEngineTime is used by SNMPv3 authentication to ensure timeliness of requests, and avoid replay attacks.
The value of RemoteEngineTime is provided as what is expected to be the current value of the remote engine clock based on a cached time differential between the remote engine clock and the local engine time obtained during the discovery process (see Discover).
This property is used in conjunction with RemoteEngineBoots. Please refer to the RemoteEngineBoots property and the Discover method for more information.
Data Type
Integer
RemoteHost Property (IPWorksSNMP_SNMPMgr Class)
The address of the remote host. Domain names are resolved to IP addresses.
Object Oriented Interface
public function getRemoteHost(); public function setRemoteHost($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 22 ); ipworkssnmp_snmpmgr_set($res, 22, $value );
Default Value
''
Remarks
The RemoteHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the host SNMP requests or traps are sent to.
If RemoteHost is set to 255.255.255.255, the class broadcasts data on the local subnet.
If the RemoteHost property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the RemoteHost property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
RemotePort Property (IPWorksSNMP_SNMPMgr Class)
The port where the remote SNMP agent is listening.
Object Oriented Interface
public function getRemotePort(); public function setRemotePort($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 23 ); ipworkssnmp_snmpmgr_set($res, 23, $value );
Default Value
161
Remarks
The RemotePort is the port on the RemoteHost to send SNMP requests to.
A valid port number (a value between 1 and 65535) is required. The default value is 161.
Data Type
Integer
RequestId Property (IPWorksSNMP_SNMPMgr Class)
The request-id to mark outgoing packets with.
Object Oriented Interface
public function getRequestId(); public function setRequestId($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 24 ); ipworkssnmp_snmpmgr_set($res, 24, $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_SNMPMgr Class)
Version of SNMP used for outgoing requests.
Object Oriented Interface
public function getSNMPVersion(); public function setSNMPVersion($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 25 ); ipworkssnmp_snmpmgr_set($res, 25, $value );
Default Value
2
Remarks
This property takes one of the following values:
snmpverV1 (1) | SNMP Version 1. |
snmpverV2c (2) | SNMP Version 2c. |
snmpverV3 (3) | SNMP Version 3. |
Data Type
Integer
StoreWalkObjects Property (IPWorksSNMP_SNMPMgr Class)
Tells the class whether or not to store returned objects.
Object Oriented Interface
public function getStoreWalkObjects(); public function setStoreWalkObjects($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 26 ); ipworkssnmp_snmpmgr_set($res, 26, $value );
Default Value
true
Remarks
When a Walk is performed, this property tells the class whether or not to store the objects that are returned by the server in the Objects collection. If the data is accumulated through the events, and not desired to be saved by the class, set this property to false.
Data Type
Boolean
Timeout Property (IPWorksSNMP_SNMPMgr Class)
A timeout for the class.
Object Oriented Interface
public function getTimeout(); public function setTimeout($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 27 ); ipworkssnmp_snmpmgr_set($res, 27, $value );
Default Value
60
Remarks
If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.
If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the class fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
User Property (IPWorksSNMP_SNMPMgr Class)
The user name used for SNMPv3 authentication.
Object Oriented Interface
public function getUser(); public function setUser($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 28 ); ipworkssnmp_snmpmgr_set($res, 28, $value );
Default Value
''
Remarks
If authentication is desired, this property must be set before the class attempts to connect to an SNMPv3 Agent.
Data Type
String
WalkLimit Property (IPWorksSNMP_SNMPMgr Class)
The limit of oid's returned in a walk.
Object Oriented Interface
public function getWalkLimit(); public function setWalkLimit($value);
Procedural Interface
ipworkssnmp_snmpmgr_get($res, 29 ); ipworkssnmp_snmpmgr_set($res, 29, $value );
Default Value
0
Remarks
This property specifies the limit of how many oid's are to be traversed during an SNMP Walk. If set to 0, the class will traverse all oid's in the specified table that are lexographically greater than the value of the specified table oid.
Data Type
Integer
Activate Method (IPWorksSNMP_SNMPMgr Class)
Activates the class.
Object Oriented Interface
public function doActivate();
Procedural Interface
ipworkssnmp_snmpmgr_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.
Config Method (IPWorksSNMP_SNMPMgr Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
ipworkssnmp_snmpmgr_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_SNMPMgr Class)
Deactivates the class.
Object Oriented Interface
public function doDeactivate();
Procedural Interface
ipworkssnmp_snmpmgr_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.
Discover Method (IPWorksSNMP_SNMPMgr Class)
Performs SNMPv3 discovery.
Object Oriented Interface
public function doDiscover();
Procedural Interface
ipworkssnmp_snmpmgr_do_discover($res);
Remarks
When the method is called an SNMPv3 engine discovery request is sent to RemoteHost.
If an AuthenticationPassword is provided, the engine id discovery request is followed by an engine time discovery request, as required by the SNMPv3 User Security Model (USM). In this case Timeout must be set to a non-zero value before calling Discover and the class will wait until a response is received from RemoteHost.
The DiscoveryResponse event is fired upon receipt of a valid discovery response and the values of RemoteEngineId, RemoteEngineBoots, and RemoteEngineTime will then be updated with the received Engine Id, Time, and Boots.
DoEvents Method (IPWorksSNMP_SNMPMgr Class)
Processes events from the internal message queue.
Object Oriented Interface
public function doEvents();
Procedural Interface
ipworkssnmp_snmpmgr_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_SNMPMgr Class)
Hashes all passwords in the cache.
Object Oriented Interface
public function doHashPasswords();
Procedural Interface
ipworkssnmp_snmpmgr_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.
Interrupt Method (IPWorksSNMP_SNMPMgr Class)
Interrupt the current method.
Object Oriented Interface
public function doInterrupt();
Procedural Interface
ipworkssnmp_snmpmgr_do_interrupt($res);
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Reset Method (IPWorksSNMP_SNMPMgr Class)
Clears the object arrays.
Object Oriented Interface
public function doReset();
Procedural Interface
ipworkssnmp_snmpmgr_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).
SendGetBulkRequest Method (IPWorksSNMP_SNMPMgr Class)
Send a GetBulkRequest packet.
Object Oriented Interface
public function doSendGetBulkRequest($nonrepeaters, $maxrepetitions);
Procedural Interface
ipworkssnmp_snmpmgr_do_sendgetbulkrequest($res, $nonrepeaters, $maxrepetitions);
Remarks
Sends a GetBulkRequest packet. This is only available for SNMP versions 2 and 3.
NonRepeaters specifies the number of variables for which a single lexicographic successor is to be returned.
MaxRepetitions specifies the number of lexicographic successors to be returned for variables other than those in the NonRepeaters list.
The object identifiers, types, and values for the request are taken from the Objects collection.
A GetBulkRequest is very similar to a GetNextRequest, the difference is that Getbulk performs a continuous GetNext operation based on the MaxRepitions value. The NonRepeaters value will determine the number of Objects for which a simple GetNext operation should be performed. For the remaining variables, a continuous GetNext operation is performed based on the MaxRepitions value.
So if you send a request containing X objects, the agent will perform N simple GetNext operations and M continuous GetNext operations X - N times. With X being the number of objects received, N being the number of NonRepeaters, and M being the number of MaxRepitions. Thus the SNMPMgr is expecting to receive N + M x (X - N) objects, assuming that each object has M successors.
Example (Sending a GetBulk Request)
SNMPControl.RemoteHost = "MyAgent"
SNMPControl.ObjCount = 2
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
SNMPControl.objId(1) = "1.3.6.1.2.1.1.3.0"
SNMPControl.SendGetBulkRequest(1,4)
The code sample above will send a GetBulkRequest with 1 non repeater, and a maxrepetitions of 4. Since there is only 1 non repeater, only one ObjID will "not repeat" and will only return one successor. The rest of the ObjID's (in this case, only 1) will return 4 successors. This particular example will return the following ObjID's:
1 | 1.3.6.1.2.1.1.2.0 |
2 | 1.3.6.1.2.1.1.4.0 |
3 | 1.3.6.1.2.1.1.5.0 |
4 | 1.3.6.1.2.1.1.6.0 |
5 | 1.3.6.1.2.1.1.7.0 |
SendGetNextRequest Method (IPWorksSNMP_SNMPMgr Class)
Send GetNextRequest packet.
Object Oriented Interface
public function doSendGetNextRequest();
Procedural Interface
ipworkssnmp_snmpmgr_do_sendgetnextrequest($res);
Remarks
Sends a GetNextRequest packet. The object identifiers, types, and values for the request are taken from the Objects collection.
Example (Sending a GetNext Request)
SNMPControl.ObjCount = 2
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
SNMPControl.SendGetNextRequest()
The agent will respond with the "next" (relative to the ObjID(s) you specify) OID in the table.
SendGetRequest Method (IPWorksSNMP_SNMPMgr Class)
Send GetRequest packet.
Object Oriented Interface
public function doSendGetRequest();
Procedural Interface
ipworkssnmp_snmpmgr_do_sendgetrequest($res);
Remarks
Sends a GetRequest packet. The object identifiers, types, and values for the request are taken from the Objects collection.
Example (Sending a GetRequest)
SNMPControl.RemoteHost = "MyAgent"
SNMPControl.ObjCount = 2
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
SNMPControl.ObjId(1) = "1.3.6.1.2.1.1.2.0"
SNMPControl.SendGetRequest()
SendInformRequest Method (IPWorksSNMP_SNMPMgr Class)
Send an InformRequest packet.
Object Oriented Interface
public function doSendInformRequest();
Procedural Interface
ipworkssnmp_snmpmgr_do_sendinformrequest($res);
Remarks
Sends an InformRequest packet. The object identifiers, types, and values for the request are taken from the Objects collection.
SendSetRequest Method (IPWorksSNMP_SNMPMgr Class)
Send Set Request packet.
Object Oriented Interface
public function doSendSetRequest();
Procedural Interface
ipworkssnmp_snmpmgr_do_sendsetrequest($res);
Remarks
Sends a SetRequest packet. The object identifiers, types, and values for the request are taken from the Objects collection.
Example (Sending a SetRequest)
SNMPControl.RemoteHost = "MyAgent"
SNMPControl.ObjCount = 1
SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"
SNMPControl.ObjValue(0) = "New Value"
SNMPControl.ObjType(0) = otOctetString
SNMPControl.SendSetRequest()
Value Method (IPWorksSNMP_SNMPMgr Class)
Returns the value corresponding to an OID.
Object Oriented Interface
public function doValue($oid);
Procedural Interface
ipworkssnmp_snmpmgr_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.
Walk Method (IPWorksSNMP_SNMPMgr Class)
Does an SNMP walk starting with the specified oid.
Object Oriented Interface
public function doWalk($tableoid);
Procedural Interface
ipworkssnmp_snmpmgr_do_walk($res, $tableoid);
Remarks
A walk will traverse all OIDs in the TableOid that are lexographically greater than the value of the TableOid.
The results of the walk may be obtained through the Response events. During the event, the current returned object will exist inside of the Objects collection. If StoreWalkObjects is set to true, the Objects collection will contain all returned objects when the Walk completes.
Use the WalkLimit property to regulate how many objects the walk will traverse in the table.
NOTE: The collection of objects is cleared before the walk begins.
BadPacket Event (IPWorksSNMP_SNMPMgr Class)
Fired for erroneous and/or malformed messages.
Object Oriented Interface
public function fireBadPacket($param);
Procedural Interface
ipworkssnmp_snmpmgr_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.
DiscoveryRequest Event (IPWorksSNMP_SNMPMgr Class)
Fired when an SNMPv3 discovery packet is received.
Object Oriented Interface
public function fireDiscoveryRequest($param);
Procedural Interface
ipworkssnmp_snmpmgr_register_callback($res, 2, 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).
DiscoveryResponse Event (IPWorksSNMP_SNMPMgr Class)
Fired when an SNMPv3 discovery response is received.
Object Oriented Interface
public function fireDiscoveryResponse($param);
Procedural Interface
ipworkssnmp_snmpmgr_register_callback($res, 3, array($this, 'fireDiscoveryResponse'));
Parameter List
'engineid'
'engineboots'
'enginetime'
'user'
'securitylevel'
'sourceaddress'
'sourceport'
Remarks
EngineId, EngineBoots, EngineTime, and User are the values received from SourceAddress and SourcePort.
The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated request, SecurityLevel is at least 1.
Error Event (IPWorksSNMP_SNMPMgr Class)
Information about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworkssnmp_snmpmgr_register_callback($res, 4, 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.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
HashPassword Event (IPWorksSNMP_SNMPMgr Class)
Fired before and after a password is hashed.
Object Oriented Interface
public function fireHashPassword($param);
Procedural Interface
ipworkssnmp_snmpmgr_register_callback($res, 5, 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
InformRequest Event (IPWorksSNMP_SNMPMgr Class)
Fired when an InformRequest packet is received.
Object Oriented Interface
public function fireInformRequest($param);
Procedural Interface
ipworkssnmp_snmpmgr_register_callback($res, 6, array($this, 'fireInformRequest'));
Parameter List
'requestid'
'snmpversion'
'community'
'user'
'securitylevel'
'sourceaddress'
'sourceport'
'errorindex'
'errorstatus'
'errordescription'
'respond'
Remarks
The user in an InformRequest packet (SNMPv3) must match the user in the User property. If not, the request is rejected, and a BadPacket event is fired before InformRequest is fired.
The list of variables in the SNMP packet, including optional values and types, is provided through the Objects collection. Each object is of type SNMPObject. This type describes the ObjId, ObjType, and ObjValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.
The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.
The MessageId parameter identifies the received request.
For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.
The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.
To send a response, the Respond parameter must be set to true. By default, this value is false, which means no response will be sent. The ErrorStatus parameter may also be set to a valid SNMP status code (the default value is 0, which represents no error).
The following is a list of valid SNMP status code values:
0 (noError) | No error. |
1 (tooBig) | The response cannot fit in a single SNMP message. |
2 (noSuchName) | Variable does not exist. |
3 (badValue) | Invalid value or syntax. |
4 (readOnly) | Variable is read-only. |
5 (genError) | Other error (SNMPv1). |
6 (noAccess) | Access denied. |
7 (wrongType) | Wrong object type. |
8 (wrongLength) | Wrong length. |
9 (wrongEncoding) | Wrong encoding. |
10 (wrongValue) | Wrong value. |
11 (noCreation) | No creation. |
12 (inconsistentValue) | Inconsistent value. |
13 (resourceUnavailable) | Resource unavailable. |
14 (commitFailed) | Commit failed. |
15 (undoFailed) | Undo failed. |
16 (authorizationError) | Authorization error. |
17 (notWritable) | Variable is not writable. |
18 (inconsistentName) | Inconsistent name. |
Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).
PacketTrace Event (IPWorksSNMP_SNMPMgr Class)
Fired for every packet sent or received.
Object Oriented Interface
public function firePacketTrace($param);
Procedural Interface
ipworkssnmp_snmpmgr_register_callback($res, 7, 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_SNMPMgr Class)
Fired when the class is ready to send data.
Object Oriented Interface
public function fireReadyToSend($param);
Procedural Interface
ipworkssnmp_snmpmgr_register_callback($res, 8, 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.
Report Event (IPWorksSNMP_SNMPMgr Class)
Fired when a Report packet is received.
Object Oriented Interface
public function fireReport($param);
Procedural Interface
ipworkssnmp_snmpmgr_register_callback($res, 9, 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.
Response Event (IPWorksSNMP_SNMPMgr Class)
Fired when a GetResponse packet is received.
Object Oriented Interface
public function fireResponse($param);
Procedural Interface
ipworkssnmp_snmpmgr_register_callback($res, 10, array($this, 'fireResponse'));
Parameter List
'requestid'
'snmpversion'
'community'
'user'
'securitylevel'
'sourceaddress'
'sourceport'
'errorindex'
'errorstatus'
'errordescription'
Remarks
The ErrorStatus and ErrorIndex parameters contain information about possible errors. ErrorDescription is a textual description of ErrorStatus. This value is parsed directly from the SNMP response, which will be a one-based value, so a value of i here maps to index i-1 in the Objects collection.
The following is a list of valid SNMP status code values:
0 (noError) | No error. |
1 (tooBig) | The response cannot fit in a single SNMP message. |
2 (noSuchName) | Variable does not exist. |
3 (badValue) | Invalid value or syntax. |
4 (readOnly) | Variable is read-only. |
5 (genError) | Other error (SNMPv1). |
6 (noAccess) | Access denied. |
7 (wrongType) | Wrong object type. |
8 (wrongLength) | Wrong length. |
9 (wrongEncoding) | Wrong encoding. |
10 (wrongValue) | Wrong value. |
11 (noCreation) | No creation. |
12 (inconsistentValue) | Inconsistent value. |
13 (resourceUnavailable) | Resource unavailable. |
14 (commitFailed) | Commit failed. |
15 (undoFailed) | Undo failed. |
16 (authorizationError) | Authorization error. |
17 (notWritable) | Variable is not writable. |
18 (inconsistentName) | Inconsistent name. |
Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).
The list of variables in the SNMP packet, including optional values and types, is provided through the Objects collection. Each object is of type SNMPObject. This type describes the ObjId, ObjType, and ObjValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.
The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.
Trap Event (IPWorksSNMP_SNMPMgr Class)
Fired when a SNMP trap packet is received.
Object Oriented Interface
public function fireTrap($param);
Procedural Interface
ipworkssnmp_snmpmgr_register_callback($res, 11, array($this, 'fireTrap'));
Parameter List
'requestid'
'snmpversion'
'community'
'user'
'securitylevel'
'trapoid'
'timestamp'
'sourceaddress'
'sourceport'
Remarks
The SNMPTrapMgr class should normally be used to receive traps, since it was designed and contains functionality specifically for that purpose. The SNMPMgr component can only receive traps from the agent that it is has most recently discovered with the Discover method.
The TrapOID and TimeStamp parameters contain the Trap OID and TimeStamp. In the case of an SNMPv1 trap, there are two possible scenarios:
First, if the enterprise of the trap is "1.3.6.1.6.3.1.1.5", TrapOID will be a concatenation of TrapEnterprise and GenericTrap + 1. For instance a TrapOID of "1.3.6.1.6.3.1.1.5.5" has a TrapEnterprise of "1.3.6.1.6.3.1.1.5" and a GenericTrap of "4".
Second, In all other cases TrapOID will be a concatenation of the values for TrapEnterprise, GenericTrap, and SpecificTrap, separated by '.'.
For SNMPv2 and above, they are read from the variable-value list (if available).
For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.
The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.
The SNMPMgr class is limited to accepting authenticated traps only for the user specified in User and Password and from the engine specified in RemoteEngineId with time parameters in RemoteEngineBoots and RemoteEngineTime (usually this is the SNMP engine discovered through the last call to Discover). If authenticated traps come from a different engine, or for a different user, they are ignored, and a BadPacket event is fired instead.
The list of variables in the SNMP packet, including optional values and types, is provided through the Objects collection. Each object is of type SNMPObject. This type describes the ObjId, ObjType, and ObjValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.
The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.
Config Settings (SNMPMgr Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.SNMPManager Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AllowSingleStepDiscovery: Whether to allow discovery to be completed in a single step.When making a discovery request in SNMPv3 while this setting is set to False (default), the component will send a second discovery request even if the agent responds to the first request with the EngineBoots and EngineTime. If set to True, the component will skip the second request if all the necessary information is returned in the first response. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CheckMessageOrigin: Whether to match the origin IP address when receiving responses.This setting specifies whether the class matches the source IP address in the response to the destination IP address of the request. When True (default) the class makes sure that response are received from the same IP to which the request was sent. In most cases this does not need to be changed. If there is a specific reason that responses are expected to originate from a different IP from that which the request was sent, this may be set to False. When False the class will not check the origin of received responses. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CheckSNMPVersion: Whether to check the version of incoming packets.By default only packets matching SNMPVersion can be received. Set this to false to ignore the version of incoming packets. The default is true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CompatibilityMode:
Whether to operate the component in a specific compatibility mode.This setting will cause the component to operate in a manner different than normal so that it is
compatible with third-party products and libraries. The following table lists the possible values
for this setting:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ContextEngineId: Sets the context engine id of the SNMP entity. If set, the context engine id included in the PDU will be set. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ContextName: Sets the context name of the SNMP entity. If set, the context name included in the PDU will be set. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DecryptLogPackets: Whether to decrypt logged packets.When set to true this setting will cause the class to decrypt packets logged in PacketTrace. This only applies when using SNMP Version 3. The default is false. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ForceLocalPort: Forces the class to bind to a specific port. The default value is True, which makes the class throw an error if LocalPort is busy. When ForceLocalPort is set to False and the port is busy, the class silently chooses another random port. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IgnoreDuplicateResponse: Whether to ignore duplicate responses.In some scenarios an agent may send a duplicate response (identified by it's RequestID). To prevent processing of a duplicate response set this to true. The default is false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IgnorePortMismatch: Whether to check if the port matches when a response is received.When a response is received, the class will validate that the port in the response is the same as the port in the request. To disable this, set this to True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncomingContextEngineId: The engine Id of the received packet.This setting holds the engine Id of the received packet. This may be queried at any time, including from within an event, and returns the engine Id of the received packet. This is not needed in most cases, but can be used to store the incoming engine Id to send an asynchronous response later. This value is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncomingContextName: The context name of the received packet.This setting holds the context name of the received packet. This may be queried at any time, including from within an event, and returns the context name of the received packet. This is not needed in most cases, but can be used to store the incoming context name to send an asynchronous response later. This value is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MsgMaxSize: The maximum supported message size.This setting specifies the maximum supported message size in bytes. This is only applicable when SNMPVersion is set to 3. This corresponds to the "msgMaxSize" field in the request. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceAddress: The source address of the received packet.This setting holds the source address of the received packet. This may be queried at any time, including from within an event, and returns the source address of the received packet. This value is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourcePort: The source port of the received packet.This setting holds the source port of the received packet. This may be queried at any time, including from within an event, and returns the source port of the received packet. This value is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TimeoutInMilliseconds: The timeout is treated as milliseconds.Setting TimeoutInMilliseconds to true causes the class to use the value in Timeout as milliseconds instead of seconds, which is the default. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WalkInsideRange: Stops the SNMP walk if the OID value returned from an agent is outside the table.When WalkInsideRange is set to true the Walk will continue only while the OID Values returned from the agent are greater than the current OID Value. If an object is returned with an OID value that is out of this range it is not added to the Objects collection, the Error event will fire, and Walk will return. The default value is true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WalkStartOID:
Specifies the OID to be used when a Walk is performed.When this property is set and Walk is called, the first request sent will contain the specified WalkStartOID value.
This feature is particularly useful in the case of errors, such as timeouts, that may occur during a Walk. In such a case, you can set WalkStartOID
to the last OID returned before the Timeout occurred then call Walk again (using the original tableOID parameter value).
This will allow you to continue the Walk where it left off (when the Timeout error occurred).
Note that when StoreWalkObjects is set to true and WalkStartOID is set, the existing entries in Objects will be maintained when Walk is called and new returned objects will be added (just as if no error occurred in the initial Walk call). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UDP Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CaptureIPPacketInfo:
Used to capture the packet information.If this is set to true, the component will capture the IP packet information.
The default value for this setting is False. Note: This setting is only available in Windows. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DelayHostResolution:
Whether the hostname is resolved when RemoteHost is set.This setting specifies whether a hostname is resolved immediately when RemoteHost is set. If true the class will resolve the hostname and the IP address will be present in the RemoteHost property.
If false, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may called to manually resolve the value in RemoteHost at any time.
The default value is false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DestinationAddress:
Used to get the destination address from the packet information.If CaptureIPPacketInfo is set to true, then this will be populated with the packet's destination address when a packet is received.
This information will be accessible in the DataIn event.
Note: This setting is only available in Windows. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DontFragment: Used to set the Don't Fragment flag of outgoing packets.When set to True, packets sent by the class will have the Don't Fragment flag set. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalHost:
The name of the local host through which connections are initiated or accepted.
The LocalHost setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalPort:
The port in the local host where the class binds.
This must be set before a connection is
attempted. It instructs the class to bind to a specific
port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxPacketSize: The maximum length of the packets that can be received.This setting specifies the maximum size of the datagrams that the class will accept without truncation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QOSDSCPValue:
Used to specify an arbitrary QOS/DSCP setting (optional).UseConnection must be True to use this setting. This option allows you to specify an arbitrary DSCP value
between 0 and 63. The default is 0. When set to the default value the component will not set a DSCP value.
Note: This setting uses the qWAVE API is only available on Windows 7, Windows Server 2008 R2, and later. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QOSTrafficType:
Used to specify QOS/DSCP settings (optional).UseConnection must be True to use this setting.
You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).
Note: This setting uses the qWAVE API which is only available on Windows Vista and Windows Server 2008 or above. Note: QOSTrafficType must be set before setting Active to true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShareLocalPort:
If set to True, allows more than one instance of the class to be active on the same local port.This option must be set before the class is activated through
the Active property or it will have no effect.
The default value for this setting is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceIPAddress:
Used to set the source IP address used when sending a packet.This configuration setting can be used to override the source IP address when sending a packet.
Note: This setting is only available in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceMacAddress:
Used to set the source MAC address used when sending a packet.This configuration setting can be used to override the source MAC address when sending a packet.
Note: This setting is only available in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseConnection:
Determines whether to use a connected socket.UseConnection specifies whether the class
should use a connected socket or not. The connection is
defined as an association in between the local address/port
and the remote address/port. As such, this
is not a connection in the traditional TCP sense. What it
means is only that the class will send and receive data
only to and from the specified destination.
The default value for this setting is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6: Whether or not to use IPv6.By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is false.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section. |
Trappable Errors (SNMPMgr Class)
SNMPMgr Errors
201 Timeout. | |
301 Bad Object Index when accessing the Obj* properties. Timeout when performing an operation. Check the error description for details. | |
302 Value exceeds maximum number of objects allowed. | |
303 The value must be an IP address in dotted format. | |
305 Unsupported SNMP version. | |
306 Unknown PDU type. | |
307 The class is busy performing the current action. | |
308 Verification failed. | |
309 Missing password for Verification. | |
310 Missing signature. | |
311 Missing remote time. | |
312 Missing timeout value. | |
313 Decryption Failed. | |
314 Missing password for decryption. | |
315 Not encrypted. | |
316 Security model not supported. | |
317 Defective packet | |
318 Not from bound point. | |
319 Operation not permitted in current role. | |
320 Bad packet. | |
321 Message not authenticated. | |
322 No such oid. | |
323 Missing privacy parameter. | |
324 Bad engine id. | |
325 Bad time frame. | |
326 Bad user name. | |
327 Security level was not accepted. | |
328 Discovery failed. | |
329 Incorrect key length. | |
330 No authentication password supplied. | |
333 Returned OID was out of range. This is applicable only when WalkInsideRange is set to true. |
The class may also return one of the following error codes, which are inherited from other classes.
UDP Errors
104 UDP is already Active. | |
106 You cannot change the LocalPort while the class is Active. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
109 The class must be Active for this operation. | |
112 Cannot change MaxPacketSize while the class is Active. | |
113 Cannot change ShareLocalPort option while the class is Active. | |
114 Cannot change RemoteHost when UseConnection is set and the class Active. | |
115 Cannot change RemotePort when UseConnection is set and the class is Active. | |
116 RemotePort can't be zero when UseConnection is set. Please specify a valid service port number. | |
117 Cannot change UseConnection while the class is Active. | |
118 Message can't be longer than MaxPacketSize. | |
119 Message too short. | |
434 Unable to convert string to selected CodePage |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |