SNMPTCPMgr Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworkssnmp.Snmptcpmgr

Remarks

The SNMPTCPMgr class implements a TCP-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.

Method List

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

Event List

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

Config Settings

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

AcceptData Property (SNMPTCPMgr Class)

Enables or disables data reception.

Syntax

public boolean isAcceptData();


public void setAcceptData(boolean acceptData);

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.

Active Property (SNMPTCPMgr Class)

Indicates whether the class is active.

Syntax

public boolean isActive();


public void setActive(boolean active);

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.

AuthenticationPassword Property (SNMPTCPMgr Class)

The password used for SNMPv3 authentication.

Syntax

public String getAuthenticationPassword();


public void setAuthenticationPassword(String authenticationPassword);

Default Value

""

Remarks

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

AuthenticationProtocol Property (SNMPTCPMgr Class)

The authentication protocol used for SNMPv3 packets.

Syntax

public int getAuthenticationProtocol();


public void setAuthenticationProtocol(int authenticationProtocol);


Enumerated values:
  public final static int authpHMACMD596 = 1;
  public final static int authpHMACSHA96 = 2;
  public final static int authpHMAC192SHA256 = 3;
  public final static int authpHMAC384SHA512 = 4;

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.

Community Property (SNMPTCPMgr Class)

The community string used to authenticate SNMP packets.

Syntax

public String getCommunity();


public void setCommunity(String community);

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.

EncryptionAlgorithm Property (SNMPTCPMgr Class)

The encryption algorithm used for SNMPv3 packets.

Syntax

public int getEncryptionAlgorithm();


public void setEncryptionAlgorithm(int encryptionAlgorithm);


Enumerated values:
  public final static int encraDES = 1;
  public final static int encraAES = 2;
  public final static int encra3DES = 3;
  public final static int encraAES192 = 4;
  public final static int encraAES256 = 5;

Default Value

1

Remarks

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

This property is not available at design time.

EncryptionPassword Property (SNMPTCPMgr Class)

The password used for SNMPv3 privacy.

Syntax

public String getEncryptionPassword();


public void setEncryptionPassword(String encryptionPassword);

Default Value

""

Remarks

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

ErrorDescription Property (SNMPTCPMgr Class)

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

Syntax

public String getErrorDescription();

Default Value

"0"

Remarks

Please refer to the ErrorStatus property for more information.

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

ErrorIndex Property (SNMPTCPMgr Class)

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

Syntax

public int getErrorIndex();

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.

ErrorStatus Property (SNMPTCPMgr Class)

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

Syntax

public int getErrorStatus();

Default Value

0

Remarks

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

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

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

The default value is 0 (no error).

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

LocalEngineId Property (SNMPTCPMgr Class)

The Engine Id of the SNMP Manager.

Syntax

public byte[] getLocalEngineId();


public void setLocalEngineId(byte[] localEngineId);

Default Value

""

Remarks

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

LocalHost Property (SNMPTCPMgr Class)

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

Syntax

public String getLocalHost();


public void setLocalHost(String localHost);

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

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

Syntax

public int getLocalPort();


public void setLocalPort(int localPort);

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.

Objects Property (SNMPTCPMgr Class)

The objects in the current request.

Syntax

public SNMPObjectList getObjects();


public void setObjects(SNMPObjectList objects);

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.

This collection is indexed from 0 to size -1.

RemoteEngineBoots Property (SNMPTCPMgr Class)

The remote engine boots (SNMPv3).

Syntax

public int getRemoteEngineBoots();


public void setRemoteEngineBoots(int remoteEngineBoots);

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.

RemoteEngineId Property (SNMPTCPMgr Class)

The Engine Id of the remote agent.

Syntax

public byte[] getRemoteEngineId();


public void setRemoteEngineId(byte[] remoteEngineId);

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

RemoteEngineTime Property (SNMPTCPMgr Class)

The remote engine time (SNMPv3).

Syntax

public int getRemoteEngineTime();


public void setRemoteEngineTime(int remoteEngineTime);

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.

RemoteHost Property (SNMPTCPMgr Class)

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

Syntax

public String getRemoteHost();


public void setRemoteHost(String remoteHost);

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.

RemotePort Property (SNMPTCPMgr Class)

The port where the remote SNMP agent is listening.

Syntax

public int getRemotePort();


public void setRemotePort(int remotePort);

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.

RequestId Property (SNMPTCPMgr Class)

The request-id to mark outgoing packets with.

Syntax

public int getRequestId();


public void setRequestId(int requestId);

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.

SNMPVersion Property (SNMPTCPMgr Class)

Version of SNMP used for outgoing requests.

Syntax

public int getSNMPVersion();


public void setSNMPVersion(int SNMPVersion);


Enumerated values:
  public final static int snmpverV1 = 1;
  public final static int snmpverV2c = 2;
  public final static int snmpverV3 = 3;

Default Value

2

Remarks

This property takes one of the following values:

SSLAcceptServerCert Property (SNMPTCPMgr Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

public Certificate getSSLAcceptServerCert();


public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLAuthenticateClients Property (SNMPTCPMgr Class)

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

Syntax

public boolean isSSLAuthenticateClients();


public void setSSLAuthenticateClients(boolean SSLAuthenticateClients);

Default Value

False

Remarks

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

SSLCert Property (SNMPTCPMgr Class)

The certificate to be used during SSL negotiation.

Syntax

public Certificate getSSLCert();


public void setSSLCert(Certificate SSLCert);

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLEnabled Property (SNMPTCPMgr Class)

Whether TLS/SSL is enabled.

Syntax

public boolean isSSLEnabled();


public void setSSLEnabled(boolean SSLEnabled);

Default Value

False

Remarks

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

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

This property is not available at design time.

SSLServerCert Property (SNMPTCPMgr Class)

The server certificate for the last established connection.

Syntax

public Certificate getSSLServerCert();

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

StoreWalkObjects Property (SNMPTCPMgr Class)

Tells the class whether or not to store returned objects.

Syntax

public boolean isStoreWalkObjects();


public void setStoreWalkObjects(boolean storeWalkObjects);

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.

Timeout Property (SNMPTCPMgr Class)

A timeout for the class.

Syntax

public int getTimeout();


public void setTimeout(int timeout);

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 throws an exception.

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

The default value for the Timeout property is 60 seconds.

User Property (SNMPTCPMgr Class)

The user name used for SNMPv3 authentication.

Syntax

public String getUser();


public void setUser(String user);

Default Value

""

Remarks

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

WalkLimit Property (SNMPTCPMgr Class)

The limit of oid's returned in a walk.

Syntax

public int getWalkLimit();


public void setWalkLimit(int walkLimit);

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.

Activate Method (Snmptcpmgr Class)

Activates the class.

Syntax

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

Config Method (Snmptcpmgr Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String 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 (Snmptcpmgr Class)

Deactivates the class.

Syntax

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

Discover Method (Snmptcpmgr Class)

Performs SNMPv3 discovery.

Syntax

public void discover();

Remarks

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

If an AuthenticationPassword is provided, the engine id discovery request is followed by an engine time discovery request, as required by the SNMPv3 User Security Model (USM). In this case Timeout must be set to a non-zero value before calling Discover and the 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 (Snmptcpmgr Class)

Processes events from the internal message queue.

Syntax

public 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 (Snmptcpmgr Class)

Hashes all passwords in the cache.

Syntax

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

Interrupt Method (Snmptcpmgr Class)

Interrupt the current method.

Syntax

public void interrupt();

Remarks

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

Reset Method (Snmptcpmgr Class)

Clears the object arrays.

Syntax

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

SendGetBulkRequest Method (Snmptcpmgr Class)

Send a GetBulkRequest packet.

Syntax

public void sendGetBulkRequest(int nonRepeaters, int maxRepetitions);

Remarks

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

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

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

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

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

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

Example (Sending a GetBulk Request)

SNMPControl.RemoteHost = "MyAgent" SNMPControl.Objects.Add(New SNMPObject("1.3.6.1.2.1.1.1.0")) SNMPControl.Objects.Add(New SNMPObject("1.3.6.1.2.1.1.3.0")) SNMPControl.SendGetBulkRequest(1,4)

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

SendGetNextRequest Method (Snmptcpmgr Class)

Send GetNextRequest packet.

Syntax

public void sendGetNextRequest();

Remarks

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

Example (Sending a GetNext Request)

SNMPControl.Objects.Add(New SNMPObject("1.3.6.1.2.1.1.1.0")) SNMPControl.SendGetNextRequest() The agent will respond with the "next" (relative to the ObjID(s) you specify) OID in the table.

SendGetRequest Method (Snmptcpmgr Class)

Send GetRequest packet.

Syntax

public void sendGetRequest();

Remarks

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

Example (Sending a GetRequest)

SNMPControl.RemoteHost = "MyAgent" SNMPControl.Objects.Add(New SNMPObject("1.3.6.1.2.1.1.1.0")) SNMPControl.Objects.Add(New SNMPObject("1.3.6.1.2.1.1.2.0")) SNMPControl.SendGetRequest()

SendInformRequest Method (Snmptcpmgr Class)

Send an InformRequest packet.

Syntax

public void sendInformRequest();

Remarks

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

SendSetRequest Method (Snmptcpmgr Class)

Send Set Request packet.

Syntax

public void sendSetRequest();

Remarks

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

Example (Sending a SetRequest)

SNMPControl.RemoteHost = "MyAgent"; SNMPControl.Objects.Add(New SNMPObject("1.3.6.1.2.1.1.1.0")); SNMPControl.Objects[0].Value = "New Value"; SNMPControl.Objects[0].ObjectType = SNMPObjectTypes.otOctetString); SNMPControl.SendSetRequest();

Value Method (Snmptcpmgr Class)

Returns the value corresponding to an OID.

Syntax

public String value(String OID);

Remarks

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

Please refer to the SNMPObject type for more information.

Walk Method (Snmptcpmgr Class)

Does an SNMP walk starting with the specified oid.

Syntax

public void walk(String tableOid);

Remarks

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

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

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

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

BadPacket Event (Snmptcpmgr Class)

Fired for erroneous and/or malformed messages.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void badPacket(SnmptcpmgrBadPacketEvent e) {}
  ...
}

public class SnmptcpmgrBadPacketEvent {
  public byte[] packet;
  public String sourceAddress;
  public int sourcePort;
  public int errorCode;
  public String errorDescription;
  public boolean 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.

Connected Event (Snmptcpmgr Class)

Fired immediately after a connection completes (or fails).

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void connected(SnmptcpmgrConnectedEvent e) {}
  ...
}

public class SnmptcpmgrConnectedEvent {
  public String remoteAddress;
  public int remotePort;
  public int statusCode;
  public String description;
}

Remarks

This event fires after a connection completes or fails.

StatusCode is the value returned by the system TCP/IP stack. This will be 0 if the connection was successful.

Description contains a human readable description of the status. This will be "OK" if the connection was successful.

RemoteAddress is the IP address of the remote host.

RemotePort is the port on the remote host.

ConnectionStatus Event (Snmptcpmgr Class)

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

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void connectionStatus(SnmptcpmgrConnectionStatusEvent e) {}
  ...
}

public class SnmptcpmgrConnectionStatusEvent {
  public String connectionEvent;
  public int statusCode;
  public String description;
}

Remarks

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

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

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

Disconnected Event (Snmptcpmgr Class)

Fired when a connection is closed.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void disconnected(SnmptcpmgrDisconnectedEvent e) {}
  ...
}

public class SnmptcpmgrDisconnectedEvent {
  public String remoteAddress;
  public int remotePort;
  public int statusCode;
  public String description;
}

Remarks

This event fires after a connection is broken.

StatusCode is the value returned by the system TCP/IP stack. This will be 0 if the connection was broken normally.

Description contains a human readable description of the status. This will be "OK" if the connection was broken normally.

RemoteAddress is the IP address of the remote host.

RemotePort is the port on the remote host.

DiscoveryRequest Event (Snmptcpmgr Class)

Fired when an SNMPv3 discovery packet is received.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void discoveryRequest(SnmptcpmgrDiscoveryRequestEvent e) {}
  ...
}

public class SnmptcpmgrDiscoveryRequestEvent {
  public byte[] engineId;
  public int engineBoots;
  public int engineTime;
  public String user;
  public int securityLevel;
  public String sourceAddress;
  public int sourcePort;
  public boolean 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 (Snmptcpmgr Class)

Fired when an SNMPv3 discovery response is received.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void discoveryResponse(SnmptcpmgrDiscoveryResponseEvent e) {}
  ...
}

public class SnmptcpmgrDiscoveryResponseEvent {
  public byte[] engineId;
  public int engineBoots;
  public int engineTime;
  public String user;
  public int securityLevel;
  public String sourceAddress;
  public int 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 (Snmptcpmgr Class)

Information about errors during data delivery.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void error(SnmptcpmgrErrorEvent e) {}
  ...
}

public class SnmptcpmgrErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

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

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

Fired before and after a password is hashed.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void hashPassword(SnmptcpmgrHashPasswordEvent e) {}
  ...
}

public class SnmptcpmgrHashPasswordEvent {
  public String password;
  public int authAlgorithm;
  public String 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 (Snmptcpmgr Class)

Fired when an InformRequest packet is received.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void informRequest(SnmptcpmgrInformRequestEvent e) {}
  ...
}

public class SnmptcpmgrInformRequestEvent {
  public int requestId;
  public int SNMPVersion;
  public String community;
  public String user;
  public int securityLevel;
  public String sourceAddress;
  public int sourcePort;
  public int errorIndex;
  public int errorStatus;
  public String errorDescription;
  public boolean 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 Oid, ObjectType, and Value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

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

The MessageId parameter identifies the received request.

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

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

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

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

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

PacketTrace Event (Snmptcpmgr Class)

Fired for every packet sent or received.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void packetTrace(SnmptcpmgrPacketTraceEvent e) {}
  ...
}

public class SnmptcpmgrPacketTraceEvent {
  public byte[] packet;
  public int direction;
  public String packetAddress;
  public 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 (Snmptcpmgr Class)

Fired when the class is ready to send data.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void readyToSend(SnmptcpmgrReadyToSendEvent e) {}
  ...
}

public class SnmptcpmgrReadyToSendEvent {
}

Remarks

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

Report Event (Snmptcpmgr Class)

Fired when a Report packet is received.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void report(SnmptcpmgrReportEvent e) {}
  ...
}

public class SnmptcpmgrReportEvent {
  public int requestId;
  public int SNMPVersion;
  public String community;
  public String user;
  public int securityLevel;
  public String sourceAddress;
  public int sourcePort;
  public int errorIndex;
  public int errorStatus;
  public String 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 Oid, ObjectType, and Value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

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

Response Event (Snmptcpmgr Class)

Fired when a GetResponse packet is received.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void response(SnmptcpmgrResponseEvent e) {}
  ...
}

public class SnmptcpmgrResponseEvent {
  public int requestId;
  public int SNMPVersion;
  public String community;
  public String user;
  public int securityLevel;
  public String sourceAddress;
  public int sourcePort;
  public int errorIndex;
  public int errorStatus;
  public String 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:

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

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

SSLClientAuthentication Event (Snmptcpmgr Class)

Fired when the client presents its credentials to the server.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void SSLClientAuthentication(SnmptcpmgrSSLClientAuthenticationEvent e) {}
  ...
}

public class SnmptcpmgrSSLClientAuthenticationEvent {
  public String remoteAddress;
  public int remotePort;
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept;
}

Remarks

This event fires when a client connects to the class and presents a certificate for authentication. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

RemoteAddress is the IP address of the connecting client.

RemotePort is the source port of the connecting client.

CertEncoded is the base64 encoded certificate presented by the client.

CertSubject is the subject of the certificate presented by the client.

CertIssuer is the subject of the issuer of the certificate presented by the client.

Status is the stauts of the certificate.

Accept defines whether the certificate is accepted.

SSLServerAuthentication Event (Snmptcpmgr Class)

Fires when connecting to the server.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void SSLServerAuthentication(SnmptcpmgrSSLServerAuthenticationEvent e) {}
  ...
}

public class SnmptcpmgrSSLServerAuthenticationEvent {
  public String remoteAddress;
  public int remotePort;
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept;
}

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

RemoteAddress is the IP address of the server.

RemotePort is the source port of the server.

CertEncoded is the base64 encoded certificate presented by the server.

CertSubject is the subject of the certificate presented by the server.

CertIssuer is the subject of the issuer of the certificate presented by the server.

Status is the stauts of the certificate.

Accept defines whether the certificate is accepted.

SSLStatus Event (Snmptcpmgr Class)

Shows the progress of the secure connection.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void SSLStatus(SnmptcpmgrSSLStatusEvent e) {}
  ...
}

public class SnmptcpmgrSSLStatusEvent {
  public String remoteAddress;
  public int remotePort;
  public String message;
}

Remarks

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

RemoteAddress is the IP address of the remote machine.

RemotePort is the port of the remote machine.

Message is the log message.

Trap Event (Snmptcpmgr Class)

Fired when a SNMP trap packet is received.

Syntax

public class DefaultSnmptcpmgrEventListener implements SnmptcpmgrEventListener {
  ...
  public void trap(SnmptcpmgrTrapEvent e) {}
  ...
}

public class SnmptcpmgrTrapEvent {
  public int requestId;
  public int SNMPVersion;
  public String community;
  public String user;
  public int securityLevel;
  public String trapOID;
  public long timeStamp;
  public String sourceAddress;
  public int 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 Oid, ObjectType, and Value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

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

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public Certificate();

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

public Certificate( certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate( certificateData);

Parses CertificateData as an X509 public key.

public Certificate( certStoreType,  store,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

SNMPObject Type

The current SNMP object.

Remarks

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

Fields

Constructors

public SNMPObject();

public SNMPObject( oid);

public SNMPObject( oid,  value);

public SNMPObject( oid,  value,  SNMPObjectType);

Config Settings (Snmptcpmgr Class)

SNMPTCPManager Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (Snmptcpmgr Class)

SNMPTCPMgr Errors

TCPClient Errors

SSL Errors

TCP/IP Errors