SNMPAgent Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

IPWorksSNMP.Snmpagent

Remarks

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

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 module with short descriptions. Click on the links for further details.

AcceptDataEnables or disables data reception.
ActiveIndicates whether the module is active.
LocalEngineIdThe Engine Id of the SNMP Agent.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe port in the local host where the module listens.
ObjectsThe objects in the current request.
RequestIdThe request-id to mark outgoing packets with.
SNMPVersionVersion of SNMP used for outgoing requests (traps).
SysUpTimeTime passed since the agent was initialized (in hundredths of a second).

Method List


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

ActivateActivates the module.
AddUserAdds a user to the internal authentication cache.
ClearCacheClears the internal authentication database.
ConfigSets or retrieves a configuration setting.
DeactivateDeactivates the module.
DoEventsProcesses events from the internal message queue.
HashPasswordsHashes all passwords in the cache.
RemoveUserRemoves the user specified by User from the internal authentication cache.
ResetClears the object arrays.
SendResponseSends a response packet to a Get, Get-Next, Get-Bulk, or Set request.
SendSecureResponseSends an authenticated and/or encrypted SNMPv3 response.
SendSecureTrapSends an authenticated and/or encrypted SNMPv3 trap.
SendTrapSends an SNMP Trap.
ShowCacheLists all entries in the internal user authentication cache.
ValueReturns the value corresponding to an OID.

Event List


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

BadPacketFired for erroneous and/or malformed messages.
CacheEntryShows in the internal cache.
DiscoveryRequestFired when an SNMPv3 discovery packet is received.
ErrorFired when information is available about errors during data delivery.
GetBulkRequestFired when a GetBulkRequest packet is received.
GetNextRequestFired when a GetNextRequest packet is received.
GetRequestFired when a GetRequest packet is received.
GetUserPasswordRetrieves a password associated with a user.
GetUserSecurityLevelSets the security level for an incoming packet.
HashPasswordFired before and after a password is hashed.
PacketTraceFired for every packet sent or received.
ReadyToSendFired when the module is ready to send data.
ReportFired when a Report packet is received.
SetRequestFired when a SetRequest packet is received.

Config Settings


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

AuthenticationKeyThe key to use for authentication.
CompatibilityModeWhether to operate the module in a specific compatibility mode.
ContextEngineIdSets the context engine id of the SNMP entity.
ContextNameSets the context name of the SNMP entity.
DataToSendSends a raw packet.
DecryptLogPacketsWhether to decrypt logged packets.
EncryptionKeyThe key to use for encryption.
ForceLocalPortForces the module to bind to a specific port.
IgnoreDiscoveryRequestTypeTreats other request types as discovery requests.
IncomingContextEngineIdThe engine Id of the received packet.
IncomingContextNameThe context name of the received packet.
MsgMaxSizeThe maximum supported message size.
RespondFromDestIPWhether to respond from the IP address that the request was sent to.
SourceAddressThe source address of the received packet.
SourcePortThe source port of the received packet.
TimeWindowThe time window used for SNMPv3 timeliness checking (authentication).
TrapAgentAddressThe address of the object generating the trap.
TrapCommunityThe value of the Community parameter for SNMP traps.
TrapEnterpriseThe type of the object generating the trap.
TrapPortThe port where SNMP traps are sent.
CaptureIPPacketInfoUsed to capture the packet information.
DelayHostResolutionWhether the hostname is resolved when RemoteHost is set.
DestinationAddressUsed to get the destination address from the packet information.
DontFragmentUsed to set the Don't Fragment flag of outgoing packets.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the module binds.
MaxPacketSizeThe maximum length of the packets that can be received.
QOSDSCPValueUsed to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficTypeUsed to specify QOS/DSCP settings (optional).
ShareLocalPortIf set to True, allows more than one instance of the module to be active on the same local port.
UseConnectionDetermines whether to use a connected socket.
UseIPv6Whether or not to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

AcceptData Property (SNMPAgent Module)

Enables or disables data reception.

Syntax

public var acceptData: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=acceptData,setter=setAcceptData:) BOOL acceptData;

- (BOOL)acceptData;
- (void)setAcceptData :(BOOL)newAcceptData;

Default Value

True

Remarks

Setting the property to False temporarily disables data reception. Setting the property to True re-enables data reception.

Active Property (SNMPAgent Module)

Indicates whether the module is active.

Syntax

public var active: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=active,setter=setActive:) BOOL active;

- (BOOL)active;
- (void)setActive :(BOOL)newActive;

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.

LocalEngineId Property (SNMPAgent Module)

The Engine Id of the SNMP Agent.

Syntax

public var localEngineId: String {
  get {...}
  set {...}
}

public var localEngineIdB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=localEngineId,setter=setLocalEngineId:) NSString* localEngineId;

- (NSString*)localEngineId;
- (void)setLocalEngineId :(NSString*)newLocalEngineId;

@property (nonatomic,readwrite,assign,getter=localEngineIdB,setter=setLocalEngineIdB:) NSData* localEngineIdB;

- (NSData*)localEngineIdB;
- (void)setLocalEngineIdB :(NSData*)newLocalEngineId;

Default Value

""

Remarks

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

LocalHost Property (SNMPAgent Module)

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

Syntax

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

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.

LocalPort Property (SNMPAgent Module)

The port in the local host where the module listens.

Syntax

public var localPort: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localPort,setter=setLocalPort:) int localPort;

- (int)localPort;
- (void)setLocalPort :(int)newLocalPort;

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.

Objects Property (SNMPAgent Module)

The objects in the current request.

Syntax

public var objects: Array<SNMPObject> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=objCount,setter=setObjCount:) int objCount;

- (int)objCount;
- (void)setObjCount :(int)newObjCount;

- (int)objType:(int)objIndex;
- (void)setObjType:(int)objIndex :(int)newObjType;

- (NSString*)objId:(int)objIndex;
- (void)setObjId:(int)objIndex :(NSString*)newObjId;

- (NSString*)objTypeString:(int)objIndex;

- (NSString*)objValue:(int)objIndex;
- (void)setObjValue:(int)objIndex :(NSString*)newObjValue;

- (NSData*)objValueB:(int)objIndex;
- (void)setObjValueB:(int)objIndex :(NSData*)newObjValue;

Default Value

0

Remarks

The SNMP objects being sent or received in the current request. The collection is first cleared, then populated every time an SNMP packet is received. It is also used to create outgoing SNMP packets.

RequestId Property (SNMPAgent Module)

The request-id to mark outgoing packets with.

Syntax

public var requestId: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=requestId,setter=setRequestId:) int requestId;

- (int)requestId;
- (void)setRequestId :(int)newRequestId;

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.

SNMPVersion Property (SNMPAgent Module)

Version of SNMP used for outgoing requests (traps).

Syntax

public var snmpVersion: SnmpagentSNMPVersions {
  get {...}
  set {...}
}

public enum SnmpagentSNMPVersions: Int32 { case snmpverV1 = 1 case snmpverV2c = 2 case snmpverV3 = 3 }

@property (nonatomic,readwrite,assign,getter=SNMPVersion,setter=setSNMPVersion:) int SNMPVersion;

- (int)SNMPVersion;
- (void)setSNMPVersion :(int)newSNMPVersion;

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.

SysUpTime Property (SNMPAgent Module)

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

Syntax

public var sysUpTime: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=sysUpTime,setter=setSysUpTime:) long long sysUpTime;

- (long long)sysUpTime;
- (void)setSysUpTime :(long long)newSysUpTime;

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.

Activate Method (SNMPAgent Module)

Activates the component.

Syntax

public func activate() throws -> Void
- (void)activate;

Remarks

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

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

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

AddUser Method (SNMPAgent Module)

Adds a user to the internal authentication cache.

Syntax

public func addUser(user: String, authenticationProtocol: Int32, authenticationPassword: String, encryptionAlgorithm: Int32, encryptionPassword: String) throws -> Void
- (void)addUser:(NSString*)user :(int)authenticationProtocol :(NSString*)authenticationPassword :(int)encryptionAlgorithm :(NSString*)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:

HMAC-MD5-96 (1)Message-Digest algorithm 5.
HMAC-SHA-96 (2)Secure Hash Algorithm.
HMAC-192-SHA-256 (3)Secure Hash Algorithm.
HMAC-384-SHA-512 (4)Secure Hash Algorithm.

Valid Encryption Algorithms 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.

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

Clears the internal authentication database.

Syntax

public func clearCache() throws -> Void
- (void)clearCache;

Remarks

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

Config Method (SNMPAgent Module)

Sets or retrieves a configuration setting.

Syntax

public func config(configurationString: String) throws -> String
- (NSString*)config:(NSString*)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 (SNMPAgent Module)

Deactivates the component.

Syntax

public func deactivate() throws -> Void
- (void)deactivate;

Remarks

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

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

DoEvents Method (SNMPAgent Module)

Processes events from the internal message queue.

Syntax

public func doEvents() throws -> Void
- (void)doEvents;

Remarks

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

HashPasswords Method (SNMPAgent Module)

Hashes all passwords in the cache.

Syntax

public func hashPasswords() throws -> Void
- (void)hashPasswords;

Remarks

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

RemoveUser Method (SNMPAgent Module)

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

Syntax

public func removeUser(user: String) throws -> Void
- (void)removeUser:(NSString*)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 (SNMPAgent Module)

Clears the object arrays.

Syntax

public func reset() throws -> Void
- (void)reset;

Remarks

Clears the object arrays, and sets the trap and error properties to their default values. This is useful for reinitializing all the properties that are used to create outgoing packets before building a new packet.

Note: SNMPVersion will be reset to snmpverV2c (2).

SendResponse Method (SNMPAgent Module)

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

Syntax

public func sendResponse(remoteHost: String, remotePort: Int32, requestId: Int32, community: String, errorStatus: Int32, errorIndex: Int32) throws -> Void
- (void)sendResponse:(NSString*)remoteHost :(int)remotePort :(int)requestId :(NSString*)community :(int)errorStatus :(int)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 (SNMPAgent Module)

Sends an authenticated and/or encrypted SNMPv3 response.

Syntax

public func sendSecureResponse(remoteHost: String, remotePort: Int32, requestId: Int32, messageId: Int32, errorStatus: Int32, errorIndex: Int32, user: String, authenticationProtocol: Int32, authenticationPassword: String, encryptionAlgorithm: Int32, encryptionPassword: String) throws -> Void
- (void)sendSecureResponse:(NSString*)remoteHost :(int)remotePort :(int)requestId :(int)messageId :(int)errorStatus :(int)errorIndex :(NSString*)user :(int)authenticationProtocol :(NSString*)authenticationPassword :(int)encryptionAlgorithm :(NSString*)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:

HMAC-MD5-96 (1)Message-Digest algorithm 5.
HMAC-SHA-96 (2)Secure Hash Algorithm.
HMAC-192-SHA-256 (3)Secure Hash Algorithm.
HMAC-384-SHA-512 (4)Secure Hash Algorithm.

Valid Encryption Algorithms 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.

SendSecureTrap Method (SNMPAgent Module)

Sends an authenticated and/or encrypted SNMPv3 trap.

Syntax

public func sendSecureTrap(remoteHost: String, trapOID: String, user: String, authenticationProtocol: Int32, authenticationPassword: String, encryptionAlgorithm: Int32, encryptionPassword: String) throws -> Void
- (void)sendSecureTrap:(NSString*)remoteHost :(NSString*)trapOID :(NSString*)user :(int)authenticationProtocol :(NSString*)authenticationPassword :(int)encryptionAlgorithm :(NSString*)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:

HMAC-MD5-96 (1)Message-Digest algorithm 5.
HMAC-SHA-96 (2)Secure Hash Algorithm.
HMAC-192-SHA-256 (3)Secure Hash Algorithm.
HMAC-384-SHA-512 (4)Secure Hash Algorithm.

Valid Encryption Algorithms 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.

SendTrap Method (SNMPAgent Module)

Sends an SNMP Trap.

Syntax

public func sendTrap(remoteHost: String, trapOID: String) throws -> Void
- (void)sendTrap:(NSString*)remoteHost :(NSString*)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:

Trap Name OID (SNMPv2 and above) SNMPv1 GenericType
coldStart 1.3.6.1.6.3.1.1.5.1 0
warmStart 1.3.6.1.6.3.1.1.5.2 1
linkDown 1.3.6.1.6.3.1.1.5.3 2
linkUp 1.3.6.1.6.3.1.1.5.4 3
authenticationFailure 1.3.6.1.6.3.1.1.5.5 4
egpNeighborLoss 1.3.6.1.6.3.1.1.5.6 5
enterpriseSpecific 1.3.6.1.6.3.1.1.5.7 6

ShowCache Method (SNMPAgent Module)

Lists all entries in the internal user authentication cache.

Syntax

public func showCache() throws -> Void
- (void)showCache;

Remarks

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

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

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

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

Value Method (SNMPAgent Module)

Returns the value corresponding to an OID.

Syntax

public func value(oid: String) throws -> String
- (NSString*)value:(NSString*)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 (SNMPAgent Module)

Fired for erroneous and/or malformed messages.

Syntax

func onBadPacket(packet: Data, sourceAddress: String, sourcePort: Int32, errorCode: Int32, errorDescription: String, report: inout Bool)
- (void)onBadPacket:(NSData*)packet :(NSString*)sourceAddress :(int)sourcePort :(int)errorCode :(NSString*)errorDescription :(int*)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 (SNMPAgent Module)

Shows in the internal cache.

Syntax

func onCacheEntry(user: String, authenticationProtocol: String, authenticationPassword: String, encryptionAlgorithm: String, encryptionPassword: String)
- (void)onCacheEntry:(NSString*)user :(NSString*)authenticationProtocol :(NSString*)authenticationPassword :(NSString*)encryptionAlgorithm :(NSString*)encryptionPassword;

Remarks

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

DiscoveryRequest Event (SNMPAgent Module)

Fired when an SNMPv3 discovery packet is received.

Syntax

func onDiscoveryRequest(engineId: Data, engineBoots: Int32, engineTime: Int32, user: String, securityLevel: Int32, sourceAddress: String, sourcePort: Int32, respond: inout Bool)
- (void)onDiscoveryRequest:(NSData*)engineId :(int)engineBoots :(int)engineTime :(NSString*)user :(int)securityLevel :(NSString*)sourceAddress :(int)sourcePort :(int*)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 (SNMPAgent Module)

Fired when information is available about errors during data delivery.

Syntax

func onError(errorCode: Int32, description: String)
- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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

GetBulkRequest Event (SNMPAgent Module)

Fired when a GetBulkRequest packet is received.

Syntax

func onGetBulkRequest(requestId: Int32, messageId: Int32, snmpVersion: Int32, community: String, user: String, securityLevel: Int32, sourceAddress: String, sourcePort: Int32, nonRepeaters: Int32, maxRepetitions: Int32, errorIndex: inout Int32, errorStatus: inout Int32, errorDescription: String, respond: inout Bool)
- (void)onGetBulkRequest:(int)requestId :(int)messageId :(int)SNMPVersion :(NSString*)community :(NSString*)user :(int)securityLevel :(NSString*)sourceAddress :(int)sourcePort :(int)nonRepeaters :(int)maxRepetitions :(int*)errorIndex :(int*)errorStatus :(NSString*)errorDescription :(int*)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 ObjectsOid, ObjectsObjectType, and ObjectsValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

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

The MessageId parameter identifies the received request.

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

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

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

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

0 (noError) No error.
1 (tooBig) The response cannot fit in a single SNMP message.
2 (noSuchName) Variable does not exist.
3 (badValue) Invalid value or syntax.
4 (readOnly) Variable is read-only.
5 (genError) Other error (SNMPv1).
6 (noAccess) Access denied.
7 (wrongType) Wrong object type.
8 (wrongLength) Wrong length.
9 (wrongEncoding) Wrong encoding.
10 (wrongValue) Wrong value.
11 (noCreation) No creation.
12 (inconsistentValue) Inconsistent value.
13 (resourceUnavailable) Resource unavailable.
14 (commitFailed) Commit failed.
15 (undoFailed) Undo failed.
16 (authorizationError) Authorization error.
17 (notWritable) Variable is not writable.
18 (inconsistentName) Inconsistent name.
The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

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

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

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

GetNextRequest Event (SNMPAgent Module)

Fired when a GetNextRequest packet is received.

Syntax

func onGetNextRequest(requestId: Int32, messageId: Int32, snmpVersion: Int32, community: String, user: String, securityLevel: Int32, sourceAddress: String, sourcePort: Int32, errorIndex: inout Int32, errorStatus: inout Int32, errorDescription: String, respond: inout Bool)
- (void)onGetNextRequest:(int)requestId :(int)messageId :(int)SNMPVersion :(NSString*)community :(NSString*)user :(int)securityLevel :(NSString*)sourceAddress :(int)sourcePort :(int*)errorIndex :(int*)errorStatus :(NSString*)errorDescription :(int*)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 ObjectsOid, ObjectsObjectType, and ObjectsValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

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

The MessageId parameter identifies the received request.

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

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

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

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

0 (noError) No error.
1 (tooBig) The response cannot fit in a single SNMP message.
2 (noSuchName) Variable does not exist.
3 (badValue) Invalid value or syntax.
4 (readOnly) Variable is read-only.
5 (genError) Other error (SNMPv1).
6 (noAccess) Access denied.
7 (wrongType) Wrong object type.
8 (wrongLength) Wrong length.
9 (wrongEncoding) Wrong encoding.
10 (wrongValue) Wrong value.
11 (noCreation) No creation.
12 (inconsistentValue) Inconsistent value.
13 (resourceUnavailable) Resource unavailable.
14 (commitFailed) Commit failed.
15 (undoFailed) Undo failed.
16 (authorizationError) Authorization error.
17 (notWritable) Variable is not writable.
18 (inconsistentName) Inconsistent name.
The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

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

GetRequest Event (SNMPAgent Module)

Fired when a GetRequest packet is received.

Syntax

func onGetRequest(requestId: Int32, messageId: Int32, snmpVersion: Int32, community: String, user: String, securityLevel: Int32, sourceAddress: String, sourcePort: Int32, errorIndex: inout Int32, errorStatus: inout Int32, errorDescription: String, respond: inout Bool)
- (void)onGetRequest:(int)requestId :(int)messageId :(int)SNMPVersion :(NSString*)community :(NSString*)user :(int)securityLevel :(NSString*)sourceAddress :(int)sourcePort :(int*)errorIndex :(int*)errorStatus :(NSString*)errorDescription :(int*)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 ObjectsOid, ObjectsObjectType, and ObjectsValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

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

The MessageId parameter identifies the received request.

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

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

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

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

0 (noError) No error.
1 (tooBig) The response cannot fit in a single SNMP message.
2 (noSuchName) Variable does not exist.
3 (badValue) Invalid value or syntax.
4 (readOnly) Variable is read-only.
5 (genError) Other error (SNMPv1).
6 (noAccess) Access denied.
7 (wrongType) Wrong object type.
8 (wrongLength) Wrong length.
9 (wrongEncoding) Wrong encoding.
10 (wrongValue) Wrong value.
11 (noCreation) No creation.
12 (inconsistentValue) Inconsistent value.
13 (resourceUnavailable) Resource unavailable.
14 (commitFailed) Commit failed.
15 (undoFailed) Undo failed.
16 (authorizationError) Authorization error.
17 (notWritable) Variable is not writable.
18 (inconsistentName) Inconsistent name.
The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

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

GetUserPassword Event (SNMPAgent Module)

Retrieves a password associated with a user.

Syntax

func onGetUserPassword(passwordType: Int32, user: String, password: inout String, algorithm: inout Int32)
- (void)onGetUserPassword:(int)passwordType :(NSString*)user :(NSString**)password :(int*)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:

ValueAuthentication Algorithm
0 (default)Any
1MD5
2SHA1
3SHA256
4SHA512
If the PasswordType parameter is 2 (encryption is used), the Algorithm parameter must also be set. Possible values are:
ValueEncryption Algorithm
1 (default)DES
2AES
33DES
4AES192
5AES256

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

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

GetUserSecurityLevel Event (SNMPAgent Module)

Sets the security level for an incoming packet.

Syntax

func onGetUserSecurityLevel(user: String, engineId: Data, securityLevel: inout Int32)
- (void)onGetUserSecurityLevel:(NSString*)user :(NSData*)engineId :(int*)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:

-1The message will be ignored and a BadPacket event will be fired.
0No security. The message will be processed without any authentication and/or encryption.
1Authentication only. The message will be checked for a valid signature and the GetUserPassword event will be fired to verify the authentication password.
2Authentication and Privacy. The message will be checked for a valid signature and the GetUserPassword event will be fired twice: first to verify the authentication password, and then to verify the privacy password.

HashPassword Event (SNMPAgent Module)

Fired before and after a password is hashed.

Syntax

func onHashPassword(password: String, authAlgorithm: Int32, hash: inout String)
- (void)onHashPassword:(NSString*)password :(int)authAlgorithm :(NSString**)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 (SNMPAgent Module)

Fired for every packet sent or received.

Syntax

func onPacketTrace(packet: Data, direction: Int32, packetAddress: String, packetPort: Int32)
- (void)onPacketTrace:(NSData*)packet :(int)direction :(NSString*)packetAddress :(int)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 (SNMPAgent Module)

Fired when the component is ready to send data.

Syntax

func onReadyToSend()
- (void)onReadyToSend;

Remarks

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

Report Event (SNMPAgent Module)

Fired when a Report packet is received.

Syntax

func onReport(requestId: Int32, snmpVersion: Int32, community: String, user: String, securityLevel: Int32, sourceAddress: String, sourcePort: Int32, errorIndex: Int32, errorStatus: Int32, errorDescription: String)
- (void)onReport:(int)requestId :(int)SNMPVersion :(NSString*)community :(NSString*)user :(int)securityLevel :(NSString*)sourceAddress :(int)sourcePort :(int)errorIndex :(int)errorStatus :(NSString*)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 ObjectsOid, ObjectsObjectType, and ObjectsValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

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

SetRequest Event (SNMPAgent Module)

Fired when a SetRequest packet is received.

Syntax

func onSetRequest(requestId: Int32, messageId: Int32, snmpVersion: Int32, community: String, user: String, securityLevel: Int32, sourceAddress: String, sourcePort: Int32, errorIndex: inout Int32, errorStatus: inout Int32, errorDescription: String, respond: inout Bool)
- (void)onSetRequest:(int)requestId :(int)messageId :(int)SNMPVersion :(NSString*)community :(NSString*)user :(int)securityLevel :(NSString*)sourceAddress :(int)sourcePort :(int*)errorIndex :(int*)errorStatus :(NSString*)errorDescription :(int*)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 ObjectsOid, ObjectsObjectType, and ObjectsValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

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

The MessageId parameter identifies the received request.

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

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

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

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

0 (noError) No error.
1 (tooBig) The response cannot fit in a single SNMP message.
2 (noSuchName) Variable does not exist.
3 (badValue) Invalid value or syntax.
4 (readOnly) Variable is read-only.
5 (genError) Other error (SNMPv1).
6 (noAccess) Access denied.
7 (wrongType) Wrong object type.
8 (wrongLength) Wrong length.
9 (wrongEncoding) Wrong encoding.
10 (wrongValue) Wrong value.
11 (noCreation) No creation.
12 (inconsistentValue) Inconsistent value.
13 (resourceUnavailable) Resource unavailable.
14 (commitFailed) Commit failed.
15 (undoFailed) Undo failed.
16 (authorizationError) Authorization error.
17 (notWritable) Variable is not writable.
18 (inconsistentName) Inconsistent name.
The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

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

SNMPObject Type

The current SNMP object.

Remarks

This type defines an SNMP object. Each object has an , , and . These values are populated by the class when incoming packets are received. You may use these fields to define objects to be used in outgoing packets.

Fields

objectType
SNMPObjectTypes

Default Value: 5

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

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

Possible object type values include:

otInteger (2) 2
otOctetString (4) 4
otNull (5) 5
otObjectID (6) 6
otIPAddress (64)64
otCounter32 (65)65
otGauge32 (66)66
otTimeTicks (67)67
otOpaque (68)68
otNSAP (69)69
otCounter64 (70)70
otUnsignedInteger32 (71)71

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

otNoSuchObject (128)No such object error.
otNoSuchInstance (129)No such instance error.
otEndOfMibView (130)End of MIB View error.

oid
String

Default Value: ""

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

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

Example

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

typeString
String (read-only)

Default Value: ""

A string representation of the current object's .

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

valueB
Data

Default Value: ""

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

Example

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

value
String

Default Value: ""

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

Example

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

Constructors

public init()
public init(oid: )
public init(oid: , value: )

Config Settings (SNMPAgent Module)

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

AuthenticationKey:   The key to use for authentication.

This setting takes the hex-encoded key for authentication and may be set before calling SendSecureTrap.

CompatibilityMode:   Whether to operate the component in a specific compatibility mode.

This setting will cause the component to operate in a manner different than normal so that it is compatible with third-party products and libraries. The following table lists the possible values for this setting:

0 (default)Component operates normally for greatest compatibility.
1Component uses SNMP4j-compatible encryption (AES192 and AES256).
2Component automatically detects whether to use SNMP4j-compatible encryption (AES192 and AES256). Note: This option is only applicable when receiving packets. If you are using SNMPMgr or sending secure traps, you will need to select either 0 or 1.
ContextEngineId:   Sets the context engine id of the SNMP entity.

If set, the context engine id included in the PDU will be set.

ContextName:   Sets the context name of the SNMP entity.

If set, the context name included in the PDU will be set.

DataToSend:   Sends a raw packet.

This should be set to the hexadecimal representation of a packet. When set the represented packet is sent.

DecryptLogPackets:   Whether to decrypt logged packets.

When set to this setting will cause the class to decrypt packets logged in PacketTrace. This only applies when using SNMP Version 3. The default is .

EncryptionKey:   The key to use for encryption.

This setting takes the hex-encoded key for encryption and may be set before calling SendSecureTrap.

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.

IgnoreDiscoveryRequestType:   Treats other request types as discovery requests.

When tells the class to treat any request with an empty EngineID and varBindList as a discovery request. The default is .

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.

RespondFromDestIP:   Whether to respond from the IP address that the request was sent to.

By default the class will always respond from the interface defined by LocalHost. In the case where aliases have been defined on the system, incoming traffic may have a different value for the destination. This setting tells the class to respond using a source address that matches the destination address of the received packet. This setting should only be set to True if there is a specific reason to do so.

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.

TimeWindow:   The time window used for SNMPv3 timeliness checking (authentication).

The default value is 150 (seconds).

TrapAgentAddress:   The address of the object generating the trap.

This setting is used to specify the agent-addr field when sending V1 Traps. The default value is the address of the localhost. This value must be an IPv4 address.

TrapCommunity:   The value of the Community parameter for SNMP traps.

Typical values are "public" or "private". The default value is "public".

TrapEnterprise:   The type of the object generating the trap.

This setting specifies the type of object generating the SNMP Trap. The default value is "1.3.6.1.6.3.1.1.5" (i.e. SNMPv2-MIB::snmpTraps).

TrapPort:   The port where SNMP traps are sent.

The TrapPort is the UDP port where SNMP traps are sent.

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

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 the class will resolve the hostname and the IP address will be present in the RemoteHost property. If , 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 .

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.

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:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
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 to mask sensitive data. The default is .

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.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to , the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (SNMPAgent Module)

SNMPAgent Errors

201   Timeout.
301   Bad Object Index.
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.

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