Manual Pages for UNIX Darwin command on man print

Manual Pages for UNIX Darwin command on man print_objid

MIBAPI(3) Net-SNMP MIBAPI(3)

NAME

initmib, addmibdir, initmibinternals, addmodulereplacement, readmodule, readmib, readallmibs, readobjid, readmodulenode, getmodulenode, snmpsetmibwarnings, snmpsetsavedescriptions,

shutdownmib, printmib, printvariable, fprintvariable, snprintvari-

able, sprintreallocvariable, printvalue, fprintvalue, snprintvalue, sprintreallocvalue, printobjid, fprintobjid,

snprintobjid, sprintreallocobjid, printdescription, fprintdescrip-

tion - mibapi functions

SYNOPSIS

##iinncclluuddee <>

vvooiidd iinniittmmiibb((vvooiidd));; iinntt aaddddmmiibbddiirr((cchhaarr **dirname));; iinntt aaddddmmoodduulleerreeppllaacceemmeenntt((cchhaarr **oldmodule,, cchhaarr **newmodule,, cchhaarr **tag,, iinntt len));; vvooiidd iinniittmmiibbiinntteerrnnaallss((vvooiidd));; ssttrruucctt ttrreeee **rreeaaddmmoodduullee((cchhaarr **name));; ssttrruucctt ttrreeee **rreeaaddmmiibb((cchhaarr **filename));; ssttrruucctt ttrreeee **rreeaaddaallllmmiibbss((vvooiidd));; vvooiidd sshhuuttddoowwnnmmiibb((vvooiidd));; vvooiidd pprriinnttmmiibb((FFIILLEE **fp));; iinntt rreeaaddoobbjjiidd((cchhaarr **input,, ooiidd **output,, ssiizzeett **outlen));; iinntt ggeettmmoodduulleennooddee((ccoonnsstt cchhaarr **name,, ccoonnsstt cchhaarr **module,, ooiidd **objid,, ssiizzeett **objidlen));;

vvooiidd pprriinnttvvaarriiaabbllee((ccoonnsstt ooiidd **objid,, ssiizzeett objidlen,, ccoonnsstt nneett-

ssnnmmppvvaarriiaabblleelliisstt **variable));; vvooiidd ffpprriinnttvvaarriiaabbllee((FFIILLEE **fp,, ccoonnsstt ooiidd **objid,, ssiizzeett objidlen,, ccoonnsstt nneettssnnmmppvvaarriiaabblleelliisstt **variable));; iinntt ssnnpprriinnttvvaarriiaabbllee((cchhaarr **buf,, ssiizzeett len,, ccoonnsstt ooiidd **objid,, ssiizzeett objidlen,, ccoonnsstt nneettssnnmmppvvaarriiaabblleelliisstt **variable));; iinntt sspprriinnttrreeaallllooccvvaarriiaabbllee((uucchhaarr ****buf,, ssiizzeett **buflen,, ssiizzeett **outlen,, iinntt allowrealloc,, ccoonnsstt ooiidd **objid,, ssiizzeett objidlen,, ccoonnsstt nneettssnnmmppvvaarriiaabblleelliisstt **variable));;

vvooiidd pprriinnttvvaalluuee((ooiidd **oobbjjiidd,, ssiizzeett oobbjjiiddlleenn,, ccoonnsstt nneettssnnmmppvvaarrii-

aabblleelliisstt **vvaarriiaabbllee)) vvooiidd ffpprriinnttvvaalluuee((FFIILLEE **fp,, ccoonnsstt ooiidd **objid,, ssiizzeett objidlen,, ccoonnsstt nneettssnnmmppvvaarriiaabblleelliisstt **variable));;

iinntt ssnnpprriinnttvvaalluuee((cchhaarr **buf,, ssiizzeett len,, ccoonnsstt ooiidd **objid,, ssiizzeett obji-

dlen,, ccoonnsstt nneettssnnmmppvvaarriiaabblleelliisstt **variable));; iinntt sspprriinnttrreeaallllooccvvaalluuee((uucchhaarr ****buf,, ssiizzeett **buflen,, ssiizzeett **outlen,, iinntt allowrealloc,, ccoonnsstt ooiidd **objid,, ssiizzeett objidlen,, ccoonnsstt nneettssnnmmppvvaarriiaabblleelliisstt **variable));; vvooiidd pprriinnttoobbjjiidd((ccoonnsstt ooiidd **objid,, ssiizzeett objidlen));; vvooiidd ffpprriinnttoobbjjiidd((FFIILLEE **fp,, ccoonnsstt ooiidd **objid,, ssiizzeett objidlen));;

iinntt ssnnpprriinnttoobbjjiidd((cchhaarr **buf,, ssiizzeett len,, ccoonnsstt ooiidd **objid,, ssiizzeett obji-

dlen));; iinntt sspprriinnttrreeaallllooccoobbjjiidd((uucchhaarr ****buf,, ssiizzeett **buflen,, ssiizzeett **outlen,, iinntt allowrealloc,, ccoonnsstt ooiidd **objid,, ssiizzeett objidlen));; vvooiidd pprriinnttddeessccrriippttiioonn((ooiidd **objid,, ssiizzeett objidlen,, iinntt width));; vvooiidd ffpprriinnttddeessccrriippttiioonn((FFIILLEE **fp,, ccoonnsstt ooiidd **objid,, ssiizzeett objidlen,, iinntt width));; vvooiidd ssnnmmppsseettmmiibbwwaarrnniinnggss((iinntt level));; vvooiidd ssnnmmppsseettssaavveeddeessccrriippttiioonnss((iinntt save));;

DESCRIPTION

The functions dealing with MIB modules fall into four groups. Those dealing with initialisation and shutdown, those that read in and parse MIB files, those that search the MIB tree, and various output routines. IInniittiiaalliissaattiioonn aanndd SShhuuttddoowwnn

iinniittmmiibb is a convenience function that handles all calls to aaddddmmiibb-

ddiirr, rreeaaddmmoodduullee and rreeaaddmmiibb for standard applications. It should be called before any other routine that manipulates or accesses the MIB tree. This routine sets up various internal structures, as well as reading in the default MIB modules, as detailed below. aaddddmmiibbddiirr is used to define the range of directory locations which are searched for files containing MIB modules (one module per file). By default, this will be set to the directory /usr/share/mibs but this can

be overridden by setting the environment variable MIBDIRS to a (colon-

separated) list of directories to search. Note that this does not

actually load the MIB modules located in that directory, but is an ini-

tialisation step to make them available. This function returns a count

of files found in the directory, or a -1 if there is an error.

iinniittmmiibbiinntteerrnnaallss sets up the internal structures, preparatory to reading in MIB modules. It should be called after all calls to

aaddddmmiibbddiirr, and before and calls to rreeaaddmmoodduullee. This is called auto-

matically if iinniittmmiibb is used.

sshhuuttddoowwnnmmiibb will clear the information that was gathered by rreeaaddmmoodd-

uullee, aaddddmmiibbddiirr and aaddddmmoodduulleerreeppllaacceemmeenntt. It is strongly recommended that one does not invoke sshhuuttddoowwnnmmiibb while there are SNMP sessions being actively managed. RReeaaddiinngg aanndd PPaarrssiinngg MMIIBBss aaddddmmoodduulleerreeppllaacceemmeenntt can be used to allow new MIB modules to obsolete

older ones, without needing to amend the imports clauses of other mod-

ules. It takes the names of the old and new modules, together with an indication of which portions of the old module are affected. ttaagg lleenn llooaadd tthhee nneeww mmoodduullee wwhheenn:: NULL 0 always (the old module is a strict subset of the new) name 0 for the given tag only

name non-0 for any identifier with this prefix

It can also be used to handle errors in the module identifiers used in MIB import clauses (such as referring to RFC1213 instead of

RFC1213-MIB).

rreeaaddmmoodduullee locates and parses the module specified, together with any modules that it imports from, and adds the contents of these modules to the active MIB tree. Note that aaddddmmiibbddiirr must first be called to add the directory containing the file with the module definition, if this is not in the standard path.

By default, the following MIB modules will be loaded: IP-MIB, IF-MIB,

TCP-MIB, UDP-MIB, SNMPv2-MIB, RFC1213-MIB, UCD-SNMP-MIB. This can be

overridden by setting the environment variable MIBS to a (colon-sepa-

rated) list of modules to load. If this variable starts with a plus character, then the specified modules are added to the default list.

Otherwise only those modules listed are loaded (together with any oth-

ers they import from). If MIBS is set to ALL, rreeaaddaallllmmiibbss is called to load all the MIB files found in all the specified MIBDIRS. rreeaaddmmiibb parses the file specified, together with any modules that it imports from, and adds the contents to the active MIB tree. Such a file can contain more then one module, though care must be taken that any imports occur earlier in the file, if they are not to be read from the installed modules. Note that the file specified does not need to be in any of the directories initialised by aaddddmmiibbddiirr (or the default setup), though any imported modules do.

The environment variable MIBFILES can be set to a (colon-separated)

list of files containing MIBs to load. rreeaaddoobbjjiidd takes a string containing a textual version of an object identifier (in either numeric or descriptor form), and transforms this

into the corresponding list of sub-identifiers. This is returned in

the output parameter, with the number of sub-identifiers returned via

outlen. When called, outlen must hold the maximum length of the out-

put array. This function returns a value of 1 if it succeeds in pars-

ing the string and 0 otherwise. SSeeaarrcchhiinngg tthhee MMIIBB TTrreeee ggeettmmoodduulleennooddee takes a descriptor and the name of a module, and returns the corresponding oid list, in the same way as rreeaaddoobbjjiidd above. If the module name is specified as "ANY", then this routine will assume that the descriptor given is unique within the tree, and will return the matching entry. If this assumption is invalid, then the behaviour as to which variable is returned is implementation dependent. OOuuttppuutt pprriinnttmmiibb will print out a representation of the currently active MIB tree to the specified FILE pointer. pprriinnttvvaarriiaabbllee will take an object identifier (as returned by rreeaaddoobbjjiidd or ggeettmmoodduulleennooddee) and an instance of such a variable, and prints to the standard output the textual form of the object identifier together with the value of the variable. ffpprriinnttvvaarriiaabbllee does the

same, but prints to the FILE pointer specified by the initial parame-

ter. ssnnpprriinnttvvaarriiaabbllee prints the same information into the buffer pointed to

by buf which is of length len and returns either the number of charac-

ters printed, or -1 if the buffer was not large enough. In the latter

case, buf will typically contained a truncated version of the informa-

tion (but this behaviour is not guaranteed). This function replaces the obsolete function sspprriinnttvvaarriiaabbllee.

sspprriinnttrreeaallllooccvvaarriiaabbllee is the low-level function used to implement all

these functions. It prints to a specified offset in a string buffer. The buf parameter points to a pointer to that buffer; buflen points to a variable holding the current size of that buffer, and outlen points to a variable holding the offset to which to print. outlen will be updated to hold the offset of the character following the last one

added to the buffer. If allowrealloc is 1, the buffer will be dynami-

cally expanded, as necessary, to hold the output; the variables pointed to by buf and buflen will be updated. If allowrealloc is 0, the buffer will not be dynamically expanded. sspprriinnttrreeaallllooccvvaarriiaabbllee returns 0 if allowrealloc is 1 and an attempt to allocate memory to expand the buffer fails, or if allowrealloc is 0 and the output wouldn't fit in the buffer. Otherwise it returns 1. When using this function you should be careful to call ffrreeee(3) on *buf when you have finished with it. pprriinnttvvaalluuee, ffpprriinnttvvaalluuee, ssnnpprriinnttvvaalluuee and sspprriinnttrreeaallllooccvvaalluuee do the same as the equivalent pprriinnttvvaarriiaabbllee routines, but only displaying the value of the variable, without the corresponding object identifier. pprriinnttoobbjjiidd, ffpprriinnttoobbjjiidd, ssnnpprriinnttoobbjjiidd, and sspprriinnttrreeaallllooccoobbjjiidd take an object identifier (without an accompanying variable instance) and print out the textual representation. pprriinnttddeessccrriippttiioonn and ffpprriinnttddeessccrriippttiioonn take an object identifier (as

for pprriinnttoobbjjiidd above) and print out the associated DESCRIPTION clause.

The width argument gives the number of subidentifiers of an OID, e.g., .1.3.6 is composed of 3 subidentifiers. Note that there are no corresponding routines ssnnpprriinnttddeessccrriippttiioonn or sspprriinnttrreeaallllooccddeessccrriippttiioonn. By default the parser does not save descriptions since they may be huge. In order to be able to print them, you must call ssnnmmppsseettssaavveeddeessccrriippttiioonnss((11)). In general the parser is silent about what strangenesses it sees in the MIB files. To get warnings reported, call ssnnmmppsseettmmiibbwwaarrnniinnggss with a level of 1 (or 2 for even more warnings). ENVIRONMENT VARIABLES

MIBDIRS A colon separated list of directories to search for MIB mod-

ules. Default: /usr/share/snmp/mibs MIBFILES A colon separated list of files to load. Default: (none)

MIBS A colon separated list of MIB modules to load. Default: IP-

MIB:IF-MIB:TCP-MIB:UDP-MIB:SNMPv2-MIB:RFC1213-MIB:UCD-SNMP-

MIB.