snmp_sess_init, snmp_open, snmp_send, snmp_async_send, snmp_select_info, snmp_read, snmp_timeout, snmp_synch_response, snmp_close, snmp_perror, snmp_sess_perror, snmp_error, snmp_api_errstring − netsnmp_session_api functions


#include <net-snmp/session_api.h>

void snmp_sess_init ( netsnmp_session*sess);

netsnmp_session* snmp_open ( netsnmp_session *sess);

/* Input parameter not used in active sessions */

int snmp_send ( netsnmp_session *session,

netsnmp_pdu *pdu);

int snmp_async_send ( netsnmp_session *session,

netsnmp_pdu *pdu,
void *

int snmp_select_info ( int * numfds,fd_set *fdset,

struct timeval *timeout,int *block);

void snmp_read ( fd_set *fdset);

void snmp_timeout ( void );

int snmp_synch_response ( netsnmp_session *session,

netsnmp_pdu *pdu,
netsnmp_pdu **

int snmp_close ( netsnmp_session *session);
int snmp_close_sessions ( void );

Error Reporting
(Move to output_api(3))

void snmp_error ( netsnmp_session *session,

int *pcliberr,int *psnmperr,char **pperrstring);

char *snmp_api_errstring ( intsnmperr);

void snmp_perror ( char *msg);

/* for parsing errors only */

void snmp_sess_perror (char *msg,netsnmp_session *sess);

/* all other SNMP library errors */


Snmp_sess_init prepares a netsnmp_session that sources transport characteristics and common information that will be used for a set of SNMP transactions. After this structure is passed to snmp_open to create an SNMP session, the structure is not used.

Snmp_open returns a pointer to a newly-formed netsnmp_session object, which the application must use to reference the active SNMP session.

snmp_send and snmp_async_send() each take as input a pointer to a netsnmp_pdu object. This structure contains information that describes a transaction that will be performed over an open session.

Consult snmp_api.h for the definitions of these structures.

With the snmp_async_send() call, snmp_read will invoke the specified callback when the response is received.

Snmp_read, snmp_select_info, and snmp_timeout provide an interface for the use of the select(2) system call so that SNMP transactions can occur asynchronously.

Snmp_select_info is given the information that would have been passed to select in the absence of SNMP. For example, this might include window update information. This information is modified so that SNMP will get the service it requires from the call to select. In this case, numfds, fdset, and timeout correspond to the nfds, readfds, and timeout arguments to select, respectively. The only exception is that timeout must always point to an allocated (but perhaps uninitialized) struct timeval. If timeout would have been passed as NULL, block is set to true, and timeout is treated as undefined. This same rule applies upon return from snmp_select_info.

After calling snmp_select_info, select is called with the returned data. When select returns, snmp_read should be called with the fd_set returned from select to read each SNMP socket that has input. If select times out, snmp_timeout should be called to see if the timeout was intended for SNMP.

snmp_synch_response is a convenience routine that will send the request, wait for the response and process it before returning. See the descriptions of snmp_send , snmp_read etc for details.


Previous versions of the library used snmp_get_errno to read the global variable snmp_errno which may have held the error status within the SNMP library. The existing method snmp_perror should be used to log ASN.1 coding errors only.

The new method snmp_sess_perror is provided to capture errors that occur during the processing of a particular SNMP session. Snmp_sess_perror calls snmp_error function to obtain the "C" library error errno , the SNMP library error snmperr , and the SNMP library detailed error message that is associated with an error that occurred during a given session.

Note that in all cases except one, snmp_sess_perror should be handed the netsnmp_session * pointer returned from snmp_open. If snmp_open returns a null pointer, pass the INPUT netsnmp_session * pointer used to call snmp_open.

Error return status from snmp_close and snmp_send is indicated by return of 0. A successful status will return a 1 for snmp_close and the request id of the packet for snmp_send. Upon successful return from snmp_send the pdu will be freed by the library.

Consult snmp_api.h for the complete set of SNMP library error values. The SNMP library error value snmperr can be one of the following values:


A generic error occurred.


The local port was bad because it had already been allocated or permission was denied.


The host name or address given was not useable.


The specified session was not open.















A string representation of the error code can be obtained with snmp_api_errstring, and a standard error message may be printed using snmp_perror that functions like the perror standard routine.


select(2), snmp_api.h

More Linux Commands

in.tftpd(8) - Trivial File Transfer Protocol server.........
tftpd is a server for the Trivial File Transfer Protocol. The TFTP protocol is extensively used to support remote booting of diskless devices. The server is nor

rstartd.real(1) - a sample implementation of a Remote Start
Rstartd is an implementation of a Remote Start helper as defined in A Flexible Remote Execution Protocol Based on rsh. This document describes the peculiarities

intel_panel_fitter(1) Change the panel fitter settings......
intel_panel_fitter is a tool that allows you to change the panel fitter settings, so you can change the size of the screen being displayed on your monitor witho

git-merge-one-file(1) - The standard helper program to use w
This is the standard helper program to use with git merge-index to resolve a merge after the trivial merge done with git read-tree -m. GIT Part of the git(1) su

snmp_alarm(3) - alarm functions (Library - Linux man page)
These functions implement support for a generic timer handling mechanism for multiple parts of an application to register function callbacks to happen at a part

audispd.conf(5) the audit event dispatcher configuration fil
audispd.conf is the file that controls the configuration of the audit event dispatcher. Each line should contain one configuration keyword, an equal sign, and t

gluPerspective(3gl) - set up a perspective projection matrix
gluPerspective specifies a viewing frustum into the world coordinate system. In general, the aspect ratio in gluPerspective should match the aspect ratio of the

Tcl_GetSlave(3) - manage multiple Tcl interpreters, aliases
These procedures are intended for access to the multiple interpreter facility from inside C programs. They enable managing multiple interpreters in a hierarchic

ttk_labelframe(n) Container widget with optional label......
A ttk::labelframe widget is a container used to group other widgets together. It has an optional label, which may be a plain text string or another widget. STAN

CPU_COUNT(3) - macros for manipulating CPU sets (Man Page)
The cpu_set_t data structure represents a set of CPUs. CPU sets are used by sched_setaffinity(2) and similar interfaces. The cpu_set_t data type is implemented

I18N::Collate(3pm) - compare 8-bit scalar data according to
*** WARNING: starting from the Perl version 5.003_06 the I18N::Collate interface for comparing 8-bit scalar data according to the current locale HAS BEEN DEPREC

delay_output_sp(3ncurses) - curses screen-pointer extension
This implementation can be configured to provide a set of functions which improve the ability to manage multiple screens. This feature can be added to any of th

We can't live, work or learn in freedom unless the software we use is free.