smidump(1)

1smidump(1)                         SMI Tools                        smidump(1)
2
3
4

NAME

6       smidump - dump SMI or SPPI modules in various formats
7

SYNOPSIS

9       smidump  [ -Vhqusm ] [ -c file ] [ -o name ] [ -p module ] [ -l level ]
10       [ -f format ] module(s)
11

DESCRIPTION

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

OPTIONS

22       -V, --version
23              Show the smidump version and exit.
24
25       -h, --help
26              Show a help text and exit. The help text contains a list of  all
27              supported output formats.
28
29       -c file, --config=file
30              Read  file  instead of any other (global and user) configuration
31              file.
32
33       -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
38       -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
43       -s, --severity
44              Show the error severity in brackets before error messages.
45
46       -m, --error-names
47              Show the error names in braces before error messages.
48
49       -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
54       -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
59       -q, --quiet
60              Suppress comments from dumped modules. What kind of  information
61              gets suppressed depends on the output format.
62
63       -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
68       module(s)
69              These  are the module(s) to be dumped. If a module argument rep‐
70              resents a path name (identified by containing at least  one  dot
71              or  slash  character),  this  is assumed to be the exact file to
72              read. Otherwise, if a module is identified by its  plain  module
73              name,  it  is  searched  according to libsmi internal rules. See
74              smi_config(3) for more details.
75

OUTPUT FORMATS

77       The smidump program supports the following output formats:
78
79       sming       SMIng compliant format as defined in  the  SMIng  Internet-
80                   Draft.
81
82       smiv2       SMIv2  compliant  format  as defined in RFC 2578, RFC 2579,
83                   RFC 2580.
84
85       smiv1       SMIv2 compliant format as defined in RFC  1155,  RFC  1212,
86                   RFC 1215.
87
88       sppi        SPPI compliant format as defined in RFC 3159. If the under‐
89                   lying module is not SPPI, there  might  be  some  mandatory
90                   information missing.
91
92       mosy        Format generated by the mosy compiler.
93
94       imports     Import hierarchy of a module.
95
96       types       Types defined in a module.
97
98       tree        OID registration tree structure of a module.
99
100       metrics     Metrics derived from a module (experimental).
101
102       identifiers List of identifiers defined in a module.
103
104       compliances Compliance  definitions with all included objects and noti‐
105                   fications.
106
107       corba       CORBA IDL and OID definitions following the JIDM specifica‐
108                   tion translation rules.
109
110       netsnmp     C  source  code files for usage within the net-snmp package
111                   (experimental).
112
113       scli        ANSI C manager stubs for  usage  within  the  scli  package
114                   (experimental).
115
116       cm          Reverse  engineered conceptual model in DIA XML file format
117                   (experimental).
118
119       svg         SVG diagram of a module (experimental). Use  with  -u  when
120                   dumping multiple modules.
121
122       jax         Java AgentX sub-agent classes in separate files (experimen‐
123                   tal).
124
125       perl        Perl represention of the MIB module (contributed by  Martin
126                   Schulz <schulz@videotron.ca>).
127
128       python      Python  dictionaries  represention  of the MIB module (con‐
129                   tributed by Pat Knight <pat@ktgroup.co.uk>).
130
131       xml         SMI in XML format (experimental).
132
133       xsd         SMI in XML schema format (experimental).
134
135       sizes       SNMP best case / worst case  PDU  sizes  for  typical  PDUs
136                   (experimental).
137
138

EXAMPLE

140       This  example converts the SMIv2 module IF-MIB in the current directory
141       to IF-MIB.sming in SMIng format. Note that the ./  prefix  is  used  to
142       ensure  reading  the  module  from the current directory and not from a
143       place that libsmi guesses on its own.
144
145         $ smidump -f sming ./IF-MIB > IF-MIB.sming
146

AUTHORS

154       (C)  1999-2004 F. Strauss, TU Braunschweig, Germany <strauss@ibr.cs.tu-
155       bs.de>
156       (C)   1999-2002   J.   Schoenwaelder,    TU    Braunschweig,    Germany
157       <schoenw@ibr.cs.tu-bs.de>
158       (C) 2002-2003 J. Schoenwaelder, University of Osnabrueck, Germany
159       (C)  2003-2004  J. Schoenwaelder, International University Bremen, Ger‐
160       many
161       (C) 2001-2002 T. Klie, TU Braunschweig, Germany <tklie@ibr.cs.tu-bs.de>
162       (C) 2002 M. Bunkus, TU Braunschweig, Germany <bunkus@ibr.cs.tu-bs.de>
163       and contributions by many other people.
164
165
166
167IBR                             August 10, 2004                     smidump(1)