snmpi(8)snmpi(8)NAMEsnmpi - The extensible SNMP subagent data initializer
SYNOPSIS
/usr/sbin/snmpi [-d] [-p] [-n prefix] [-e exclude_file] defs_file {[-r]
subtree}...
OPTIONS
Specifies debug mode. Generates formatted output of the internal tree
of all MIB objects defined in defs_file. This option is useful in
identifying problems in MIB symbol resolution. Specifies a prefix
string to be prepended to each variable generated by the snmpi program.
Specifies the name of a file that contains a list of MIB objects that
are not to be included in the emitted object table initialization code
created by the program. Specifies the name of a MIB object identifier
(OID) that defines the base of the MIB subtree that will be registered
as a unit (with the snmpd daemon) by the subagent. (The snmpd daemon
will subsequently expect the subagent to handle all MIB objects con‐
tained in the subtree.) Several subtrees may be specified, and at least
one is required unless the -p option is used.
If the base MIB object identifier is not unique, its name may be
prefixed by its parents name, separated by an underscore charac‐
ter (_); for example, mn_system.
The subtree parameter may also contain the suffix _tbl.h or
_tbl.c to facilitate the use of snmpi within makefiles.
For each subtree parameter specified, snmpi produces the files
subtree _tbl.h, subtree_tbl.c, and subtree_tbl.txt.
If the optional -r option is specified, the OID that defines the
base of the MIB subtree is the lower bound (OID of the first
leaf object in the MIB subtree) of the range of objects that
make up a MIB subtree row. The upper bound (OID of the last
leaf object in the MIB subtree) is contained in an ESNMP_REG
structure, subtree_reg, in the subtree_tbl.c file. The snmpi
program produces the subtree_reg structure.
If you use the -r option, all objects in the MIB subtree must be
leaf objects occuring at the same level. This means that the
length of the OID for each object defined in the MIB subtree
must be the same and that each object defined in the MIB subtree
must be a leaf object (OID length is the same).
You can register the MIB subtree row by specifying the ESNMP_REG
structure as the parameter to the esnmp_register2() routine.
You can unregister the MIB subtree row by specifying the gener‐
ated ESNMP_REG structure to the esnmp_unregister2() routine.
OPERANDS
Specifies a mosy output file or a concatenation of mosy output files.
DESCRIPTION
The snmpi program emits subtree object table initialization C code to
be compiled and linked with the method routines as part of an extensi‐
ble SNMP subagent.
For a complete description of using snmpi refer to the Network Program‐
mer's Guide.
FILES
Template exclusion file
SEE ALSO
Commands: mosy(8), snmpd(8), snmp_request(8)
Network Programmer's Guide
IDENTIFICATION
Originally, this work was partially supported by the U.S. Defense
Advanced Research Projects Agency and the Rome Air Development Center
of the U.S. Air Force Systems Command under contract number
F30602-88-C-0016. Marshall T. Rose wrote the original (insecure)
4BSD/ISODE SNMP package.
David L. Partain of the Department of Computer and Information Science
at Linkoping University, Sweden added most of the administrative facil‐
ities as a part of his Masters work at the University of Tennessee,
Knoxville. Dr. Jeffrey D. Case of SNMP Research supervised his work,
and Keith McCloghrie of Hughes LAN Systems provided implementation
guidance.
Major modifications to the code were made as part of the extensible
SNMP Agent for Tru64 UNIX.
snmpi(8)
