<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation"> <title>Simple Network Management Protocol (SNMP) Manager APIs</title> <!-- All rights reserved. Licensed Materials Property of IBM --> <!-- US Government Users Restricted Rights --> <!-- Use, duplication or disclosure restricted by --> <!-- GSA ADP Schedule Contract with IBM Corp. --> <!-- Begin Header Records ========================================= --> <!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at --> <!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 --> <!-- File Edited December 2001 --> <!-- 031112 JETAYLOR replaced API and/or Exit listings with --> <!-- pagegenerator output from javascript array --> <!-- End Header Records --> <link rel="stylesheet" type="text/css" href="../rzahg/ic.css"> </head> <body> <a name="Top_Of_Page"></a> <!-- Java sync-link --> <script language="Javascript" src="../rzahg/synch.js" type="text/javascript"> </script> <h2>Simple Network Management Protocol (SNMP) Manager APIs</h2> <p>The SNMP Manager APIs are:</p> <!-- ***** NOTE ***** Do not manually update text or links in this section. --> <!-- Updates made in this section *will* be overlaid by automated tools --> <!-- Notify User Technologies of needed updates to be made in XML for API finder.--> <!--***************API BEGIN PASTE***************--> <ul> <li><A HREF="snmpget.htm">snmpGet()</A> (Retrieve MIB objects) is used to get one or more management information base (MIB) objects from an SNMP agent or subagent on a local or remote system.</li> <li><A HREF="snmpnext.htm">snmpGetnext()</A> (Retrieve next MIB object) is used to get the value of one or more management information base (MIB) objects from an SNMP agent or subagent on a local or remote system.</li> <li><A HREF="snmpset.htm">snmpSet()</A> (Set MIB objects) is used to set one or more management information base (MIB) objects in an SNMP agent or subagent on a local or remote system.</li> </ul> <!--***************API END PASTE***************--> <p><strong>Note:</strong> These functions use header (include) files from the library QSYSINC, which is optionally installable. Make sure QSYSINC is installed on your system before using any of the functions. All of the SNMP manager APIs use header file <strong>qtomeapi.h</strong>. You can see this source in source file H, member name QTOMEAPI, in the QSYSINC library.</p> <p>For examples that use the SNMP manager APIs, see <a href="snmpexmp.htm"> Using SNMP Manager APIs--Example</a>.</p> <p>For information about trap support, see <a href="trap.htm">SNMP Trap Support</a>.</p> <p>SNMP managing applications typically use APIs to establish communication with local or remote SNMP agents, and then call other APIs to retrieve or modify MIB objects managed by those agents. The i5/OS<SUP>(TM)</SUP> SNMP manager APIs accomplish both of these tasks within the same API. Three manager APIs are provided to perform the SNMP GET, GETNEXT, and SET operations. In general, all three APIs are blocked. That is, when the application calls these APIs, the API constructs a proper SNMP message, delivers it to the proper SNMP agent, waits, decodes the response from the agent, and delivers the information to the application. No processing occurs in the application until the API delivers this information or times out. The communications mechanism between the manager APIs and agents uses sockets. Therefore, both systems need to support sockets.</p> <p>Application programmers who are writing network management applications can use the snmpGet(), snmpGetnext(), and snmpSet() SNMP APIs to retrieve and set management information base (MIB) data so that they can manage their systems and networks. Programmers should have a strong understanding of network management, SNMP, and some transport protocol such as Transmission Control Protocol/Internet Protocol (TCP/IP).</p> <hr> <center> <table cellpadding="2" cellspacing="2"> <tr align="center"> <td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href= "unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by category</a></td> </tr> </table> </center> </body> </html>