SNMPMgr Class

Properties   Methods   Events   Configuration Settings   Errors  

The SNMPMgr class is used to implement UDP-based SNMP Management Applications.

Class Name

IPWorksSNMP_SNMPMgr

Procedural Interface

 ipworkssnmp_snmpmgr_open();
 ipworkssnmp_snmpmgr_close($res);
 ipworkssnmp_snmpmgr_register_callback($res, $id, $function);
 ipworkssnmp_snmpmgr_get_last_error($res);
 ipworkssnmp_snmpmgr_get_last_error_code($res);
 ipworkssnmp_snmpmgr_set($res, $id, $index, $value);
 ipworkssnmp_snmpmgr_get($res, $id, $index);
 ipworkssnmp_snmpmgr_do_config($res, $configurationstring);
 ipworkssnmp_snmpmgr_do_discover($res);
 ipworkssnmp_snmpmgr_do_doevents($res);
 ipworkssnmp_snmpmgr_do_hashpasswords($res);
 ipworkssnmp_snmpmgr_do_interrupt($res);
 ipworkssnmp_snmpmgr_do_reset($res);
 ipworkssnmp_snmpmgr_do_sendgetbulkrequest($res, $nonrepeaters, $maxrepetitions);
 ipworkssnmp_snmpmgr_do_sendgetnextrequest($res);
 ipworkssnmp_snmpmgr_do_sendgetrequest($res);
 ipworkssnmp_snmpmgr_do_sendinformrequest($res);
 ipworkssnmp_snmpmgr_do_sendsetrequest($res);
 ipworkssnmp_snmpmgr_do_value($res, $oid);
 ipworkssnmp_snmpmgr_do_walk($res, $tableoid);

Remarks

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

The class provides both encoding/decoding and transport capabilities, making the task of developing a custom SNMP manager as simple as setting a few key properties and handling a few events. SNMP data, such as for instance SNMP object id-s (OID-s) are exchanged as text strings, thus further simplifying the task of handling them.

The class is activated/deactivated by setting the Active property. This property enables or disables sending and receiving.

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.

AcceptDataEnables or disables data reception.
ActiveEnables or disables sending and receiving of SNMP packets.
AuthenticationPasswordThe password used for SNMPv3 authentication.
AuthenticationProtocolThe authentication protocol used for SNMPv3 packets.
CommunityThe community string used to authenticate SNMP packets.
EncryptionAlgorithmThe encryption algorithm used for SNMPv3 packets.
EncryptionPasswordThe password used for SNMPv3 privacy.
ErrorDescriptionDescription of the status code for the last SNMP packet received by the class.
ErrorIndexIndex of the first variable (object) that caused an error from the last SNMP response.
ErrorStatusStatus code for the last SNMP packet received by the class.
LocalEngineIdThe Engine Id of the SNMP Manager.
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 SNMP Manager is bound to.
ObjCountThe number of records in the Obj arrays.
ObjTypeThe current object's type.
ObjIdThe current object's id which is encoded as a string of numbers separated by periods.
ObjTypeStringA string representation of the current object's ObjectType .
ObjValueThe current object's value.
RemoteEngineBootsThe remote engine boots (SNMPv3).
RemoteEngineIdThe Engine Id of the remote agent.
RemoteEngineTimeThe remote engine time (SNMPv3).
RemoteHostThe address of the remote host. Domain names are resolved to IP addresses.
RemotePortThe port where the remote SNMP agent is listening.
RequestIdThe request-id to mark outgoing packets with.
SNMPVersionVersion of SNMP used for outgoing requests.
StoreWalkObjectsTells the class whether or not to store returned objects.
TimeoutA timeout for the class.
UserThe user name used for SNMPv3 authentication.
WalkLimitThe limit of oid's returned in a walk.

Method List


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

ConfigSets or retrieves a configuration setting.
DiscoverPerforms SNMPv3 discovery.
DoEventsProcesses events from the internal message queue.
HashPasswordsHashes all passwords in the cache.
InterruptInterrupt the current method.
ResetClears the object arrays.
SendGetBulkRequestSend a GetBulkRequest packet.
SendGetNextRequestSend GetNextRequest packet.
SendGetRequestSend GetRequest packet.
SendInformRequestSend an InformRequest packet.
SendSetRequestSend Set Request packet.
ValueReturns the value corresponding to an OID.
WalkDoes an SNMP walk starting with the specified oid.

Event List


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

BadPacketFired for erroneous and/or malformed messages.
DiscoveryRequestFired when an SNMPv3 discovery packet is received.
DiscoveryResponseFired when an SNMPv3 discovery response is received.
ErrorInformation about errors during data delivery.
HashPasswordFired before and after a password is hashed.
InformRequestFired when an InformRequest packet is received.
PacketTraceFired for every packet sent or received.
ReadyToSendFired when the class is ready to send data.
ReportFired when a Report packet is received.
ResponseFired when a GetResponse packet is received.
TrapFired when a SNMP trap packet is received.

Configuration Settings


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

AllowSingleStepDiscoveryWhether to allow discovery to be completed in a single step.
CheckMessageOriginWhether to match the origin IP address when receiving responses.
CompatibilityModeWhether to operate the class in a specific compatibility mode.
ContextEngineIdSets the context engine id of the SNMP entity.
ContextNameSets the context name of the SNMP entity.
ForceLocalPortForces the class to bind to a specific port.
MsgMaxSizeThe maximum supported message size.
SourceAddressThe source address of the received packet.
SourcePortThe source port of the received packet.
TimeoutInMillisecondsThe timeout is treated as milliseconds.
WalkInsideRangeStops the SNMP walk if the OID value returned from an agent is outside the table.
WalkStartOIDSpecifies the OID to be used when a Walk is performed.
CaptureIPPacketInfoUsed to capture the packet information.
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 class 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 class to be active on the same local port.
SourceIPAddressUsed to set the source IP address used when sending a packet.
SourceMacAddressUsed to set the source MAC address used when sending a packet.
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.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks SNMP 2020 PHP Edition - Version 20.0 [Build 7941]