Copyright (c) 2001-2005
Fraunhofer Institute for Open Communication Systems (FhG Fokus).
All rights reserved.

Author: Harti Brandt <harti@freebsd.org>

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

$Begemot: bsnmp/gensnmptree/gensnmptree.1,v 1.5 2005/06/15 11:31:25 brandt_h Exp $

.Dd June 14, 2005 .Dt GENSNMPTREE 1 .Os .Sh NAME .Nm gensnmptree .Nd "generate C and header files from a MIB description file" .Sh SYNOPSIS .Nm .Op Fl helt .Op Fl p Ar prefix .Op Ar name Ar ... .Sh DESCRIPTION The .Nm utility is used to either generate C language tables and header files from a MIB description or to numeric OIDs from MIB descriptions. The first form is used only for maintaining the .Xr snmpd 1 daemon or for module writers. The second form may be used by SNMP client program writers.

p If the .Fl e option is not used .Nm reads a MIB description from its standard input and creates two files: a C-file .Ar prefix Ns tree.c containing a table used by .Xr snmpd 1 during PDU processing and a header file .Ar prefix Ns tree.h containing appropriate declarations of the callback functions used in this table and the table itself.

p If the .Fl e option is specified .Nm expects MIB variable names (only the last component) on its command line. It reads a MIB specification from standard input and for each MIB variable name emits two C preprocessor defines on its standard output. One define .Va OID_ Ns Ar name can be used as an array initialized to initialize a .Va struct asn_oid . The other define .Va OIDLEN_ Ns Ar name contains the length of the OID.

p The options are as follows: l -tag -width ".Fl d Ar argument" t Fl h Print a short help page. t Fl e Enter extract mode. t Fl l Generate local preprocessor includes. This is used for bootstrapping .Xr snmpd 1 . t Fl t Instead of normal output print the resulting tree. t Fl p Ar prefix Prefix the file names and the table name with .Ar prefix . .El .Sh MIBS The syntax of the MIB description file can formally be specified as follows: d -unfilled -offset indent file := tree | tree file tree := head elements ')' entry := head ':' index STRING elements ')' leaf := head TYPE STRING ACCESS ')' column := head TYPE ACCESS ')' head := '(' INT STRING elements := EMPTY | elements element element := tree | leaf index := TYPE | index TYPE .Ed

p .Ar TYPE specifies a SNMP data type and may be one of l -bullet -offset indent -compact t NULL t INTEGER t INTEGER32 (same as INTEGER) t UNSIGNED32 (same as GAUGE) t OCTETSTRING t IPADDRESS t OID t TIMETICKS t COUNTER t GAUGE t COUNTER64 .El

p .Ar ACCESS specifies the accessibility of the MIB variable (which operation can be performed) and is one of l -bullet -offset indent -compact t GET t SET .El

p .Ar INT is a decimal integer and .Ar STRING is any string starting with a letter or underscore and consisting of letters, digits and underscores, that is not one of the keywords. .Sh EXAMPLES The following MIB description describes the system group: d -literal -offset indent (1 internet (2 mgmt (1 mibII (1 system (1 sysDescr OCTETSTRING op_system_group GET) (2 sysObjectId OID op_system_group GET) (3 sysUpTime TIMETICKS op_system_group GET) (4 sysContact OCTETSTRING op_system_group GET SET) (5 sysName OCTETSTRING op_system_group GET SET) (6 sysLocation OCTETSTRING op_system_group GET SET) (7 sysServices INTEGER op_system_group GET) (8 sysORLastChange TIMETICKS op_system_group GET) (9 sysORTable (1 sysOREntry : INTEGER op_or_table (1 sysORIndex INTEGER) (2 sysORID OID GET) (3 sysORDescr OCTETSTRING GET) (4 sysORUpTime TIMETICKS GET) )) ) ) ) ) .Ed .Sh SEE ALSO .Xr snmpd 1 .Sh AUTHORS .An Hartmut Brandt Aq harti@freebsd.org