1smidump(1) SMI Tools smidump(1)
2
6 smidump - dump SMI or SPPI modules in various formats
7
9 smidump [ -Vhqusmk ] [ -c file ] [ -o name ] [ -p module ] [ -l level ]
10 [ -f format ] module(s)
11
13 The smidump program is used to dump the contents of a single MIB or PIB
14 module or a collection of modules to stdout in a selectable output for‐
15 mat. This format may be a simple tree of nodes, types or imported mod‐
16 ules, but also a format fully compliant to SMIv1, SMIv2, SPPI or SMIng
17 or CORBA IDL or C source code. Smidump can thus be used to convert mod‐
18 ules from SMIv2 to SMIng and from SMIng to SMIv2, or to develop tem‐
19 plate based agent code.
20
22 -V, --version
23 Show the smidump version and exit.
24 -h, --help
26 Show a help text and exit. The help text contains a list of all
27 supported output formats.
28 -c file, --config=file
30 Read file instead of any other (global and user) configuration
31 file.
32 -f format, --format=format
34 Use format when dumping a module. Supported output formats are
35 described below. The default output format is SMIng. The format
36 argument is case insensitive.
37 -l level, --level=level
39 Report errors and warnings up to the given severity level. See
40 the smilint(1) manual page for a description of the error lev‐
41 els. The default error level is 3.
42 -s, --severity
44 Show the error severity in brackets before error messages.
45 -m, --error-names
47 Show the error names in braces before error messages.
48 -o name, --output=name
50 Write the output in one or multiple files instead of stdout. The
51 file name(s) are derived from the name argument. Not all format
52 support this option.
53 -p module, --preload=module
55 Preload the module module before reading the main module(s).
56 This may be helpful if an incomplete main module misses to
57 import some definitions.
58 -q, --quiet
60 Suppress comments from dumped modules. What kind of information
61 gets suppressed depends on the output format.
62 -u, --unified
64 Dump a unified output in case of multiple module(s) instead of
65 multiple concatenated output sections. This is not supported for
66 all output formats.
67 -k, --keep-going
69 Continue as much as possible after serious parse errors. Note
70 that the output generated after serious parse errors may be
71 incomplete and should be used with care.
72 module(s)
74 These are the module(s) to be dumped. If a module argument rep‐
75 resents a path name (identified by containing at least one dot
76 or slash character), this is assumed to be the exact file to
77 read. Otherwise, if a module is identified by its plain module
78 name, it is searched according to libsmi internal rules. See
79 smi_config(3) for more details.
80
82 The smidump program supports the following output formats:
83 sming SMIng compliant format as defined in the SMIng Internet-
85 Draft.
86 smiv2 SMIv2 compliant format as defined in RFC 2578, RFC 2579,
88 RFC 2580.
89 smiv1 SMIv2 compliant format as defined in RFC 1155, RFC 1212,
91 RFC 1215.
92 sppi SPPI compliant format as defined in RFC 3159. If the under‐
94 lying module is not SPPI, there might be some mandatory
95 information missing.
96 mosy Format generated by the mosy compiler.
98 imports Import hierarchy of a module.
100 types Types defined in a module.
102 tree OID registration tree structure of a module.
104 metrics Metrics derived from a module (experimental).
106 identifiers List of identifiers defined in a module.
108 compliances Compliance definitions with all included objects and noti‐
110 fications.
111 corba CORBA IDL and OID definitions following the JIDM specifica‐
113 tion translation rules.
114 netsnmp C source code files for usage within the net-snmp package
116 (experimental).
117 scli ANSI C manager stubs for usage within the scli package
119 (experimental).
120 cm Reverse engineered conceptual model in DIA XML file format
122 (experimental).
123 svg SVG diagram of a module (experimental). Use with -u when
125 dumping multiple modules.
126 jax Java AgentX sub-agent classes in separate files (experimen‐
128 tal).
129 perl Perl represention of the MIB module (contributed by Martin
131 Schulz <schulz@videotron.ca>).
132 python Python dictionaries represention of the MIB module (con‐
134 tributed by Pat Knight <pat@ktgroup.co.uk>).
135 xml SMI in XML format (experimental).
137 xsd SMI in XML schema format (experimental).
139 sizes SNMP best case / worst case RFC 3416 PDU sizes for typical
141 PDUs excluding SNMP message and transport headers (experi‐
142 mental).
143
146 This example converts the SMIv2 module IF-MIB in the current directory
147 to IF-MIB.sming in SMIng format. Note that the ./ prefix is used to
148 ensure reading the module from the current directory and not from a
149 place that libsmi guesses on its own.
150 $ smidump -f sming ./IF-MIB > IF-MIB.sming
152
154 The libsmi(3) project is documented at http://www.ibr.cs.tu-
155 bs.de/projects/libsmi/.
156 smilint(1)
158
160 (C) 1999-2004 F. Strauss, TU Braunschweig, Germany <strauss@ibr.cs.tu-
161 bs.de>
162 (C) 1999-2002 J. Schoenwaelder, TU Braunschweig, Germany
163 <schoenw@ibr.cs.tu-bs.de>
164 (C) 2002-2003 J. Schoenwaelder, University of Osnabrueck, Germany
165 (C) 2003-2004 J. Schoenwaelder, International University Bremen, Ger‐
166 many
167 (C) 2001-2002 T. Klie, TU Braunschweig, Germany <tklie@ibr.cs.tu-bs.de>
168 (C) 2002 M. Bunkus, TU Braunschweig, Germany <bunkus@ibr.cs.tu-bs.de>
169 and contributions by many other people.
170IBR August 10, 2004 smidump(1)