(file) Return to cimmofl.1 CVS log (file) (dir) Up to [Pegasus] / pegasus / rpm / manLinux / man1.Z

  1 aruran.ms 1.4 .\" $Header: /cvs/MSB/pegasus/rpm/manLinux/man1.Z/cimmofl.1,v 1.3 2005/05/01 05:37:43 vijay.eli Exp $
  2 alagaraja 1.1 .\" .TA c \" lowercase initial letter of .TH name
  3               .TH "cimmofl" "1" "" "" ""
  4               .SH "NAME"
  5               cimmofl \- compile MOF files into the CIM Repository 
  6               .SH "SYNOPSIS"
  7 aruran.ms 1.4 \fBcimmofl\fP \fB\-h\fP | \fB\-\-help\fP 
  8               
  9               \fBcimmofl\fP \fB\-\-version\fP 
 10               
 11               \fBcimmofl\fP [ \fB\-w\fP ] [ \fB\-E\fP ] [ \fB\-uc\fP ] [ \fB\-aE | \-aV | \-aEV\fP ] [ \fB\-I\fP path ] 
 12                       [ \fB\-n\fP namespace | \fB\-\-namespace\fP namespace ] [ \fB\-\-xml\fP ] 
 13                       [ \fB\-\-trace\fP ]
 14                       [ \fB\-R\fP repositorydir ] [ \fB\-\-CIMRepository\fP repositorydir ]
 15                       [ \fB\-N\fP repositoryname ] [ \fB\-M\fP repositorymode ] [ mof_file ... ]
 16 alagaraja 1.1 .SS Remarks
 17               .PP 
 18               Only a superuser or user with write access to the default or specified 
 19               namespace can run the 
 20               .B cimmofl
 21               command to compile MOFs in the CIM Repository.
 22               .PP 
 23               Superclasses must be compiled before subclasses, else the compile will fail.
 24               .PP 
 25               It is strongly recommended that MOF files include all necessary subclasses,
 26               so they can compile properly even if certain classes are not in the CIM 
 27               Repository.
 28               .SH "DESCRIPTION"
 29               .PP 
 30               The 
 31               .B cimmofl
 32               command is a command line interface to the Managed
 33               Object Format (MOF) Compiler.  The MOF Compiler is a utility that
 34               compiles MOF files (using the MOF format defined by the DMTF CIM
 35               Specification) into CIM classes and instances that are stored
 36               in the CIM Repository.
 37 alagaraja 1.1 .PP 
 38               The 
 39               .B cimmofl
 40               command can be used to compile MOF files at any time after installation.
 41               If no input file is specified, stdin is used as the input.
 42               .PP 
 43               The MOF Compiler requires that the input MOF files be in the current
 44               directory or that a fully qualified path be given.  To simplify the
 45               specification of multiple MOF files in the 
 46               .B cimmofl
 47               command line, the MOF Compiler allows compiling from files containing a list of
 48               MOF files using the include pragma (as shown below).
 49               .RS
 50               .TP 
 51               .PD 0
 52               .B "#pragma include (""application.mof"")"
 53               .TP 
 54               .B "#pragma include (""server.mof"")"
 55               .PD
 56               .RE
 57               .PP 
 58 alagaraja 1.1 MOF files using the include pragma must be in the current directory
 59               or in a directory specified by the 
 60               .B \-I
 61               command line option.
 62               .PP 
 63               The 
 64               .B \-n
 65               option can be used to specify a 
 66               .I R namespace 
 67               in which the CIM classes and instances will be compiled.  If this option is not
 68               specified, the default 
 69               .I R namespace 
 70               is root/cimv2 (with the exception of provider registration schemas).  
 71               .PP 
 72               For provider registration schemas, if the 
 73               .B \-n
 74               option is not
 75               specified, the default 
 76               .I R namespace 
 77               is root/PG_InterOp.  If 
 78               .B \-n
 79 alagaraja 1.1 option is specified, the 
 80               .I R namespace 
 81               specified must be root/PG_InterOp, otherwise, the error message "The 
 82               requested operation is not supported." is returned.   For provider
 83               MOFs, the 
 84               .I R namespace 
 85               specified must match one of the namespaces specified
 86               in the PG_ProviderCapabilities class schema definition. 
 87               .SS Options
 88               The 
 89               .B cimmofl
 90               command recognizes the following options:
 91               .RS
 92               .TP 15
 93               .B \-aE
 94               Allow Experimental Schema changes.
 95               .TP 
 96               .B \-aEV
 97               Allow both Experimental and Version Schema changes.
 98               .TP 
 99               .B \-aV
100 alagaraja 1.1 Allow both Major and Down Revision Schema changes.
101               .TP 
102               .B \-\-CIMRepository
103               Specify the repository path.
104               .TP 
105               .B \-E
106               Syntax check only
107               .TP 
108               .B \-h, \-\-help
109               Display command usage information.
110               .TP 
111 a.arora   1.2 \fB\-I\fP
112 alagaraja 1.1 Specify the path to included MOF files.  This path may be relative or
113               absolute.
114               .IP 
115               If the input MOF file has include pragmas and the
116               included files do not reside in the current directory,
117               the 
118               .C \-I
119               directive must be used to specify a path to
120               them on the 
121               .B cimmofl
122               command line.
123               .TP 
124               \fB\-n\fP 
125               Override the default CIM Repository namespace. The
126               .I namespace 
127               specified  must be a valid CIM
128               namespace name.  For the definition of a valid CIM
129               namespace name, refer to the Administrator's Guide.
130               For provider registration schemas, the 
131               .I namepace
132               specified must be root/PG_InterOp.
133 alagaraja 1.1 .TP 
134               \fB\-\-namespace\fP 
135               Override the default CIM Repository namespace. The
136               .I namespace 
137               specified  must be a valid CIM
138               namespace name.  For the definition of a valid CIM
139               namespace name, refer to the Administrator's Guide.
140               For provider registration schemas, the 
141               .I namepace
142               specified must be root/PG_InterOp.
143               .TP 
144               .B \-R
145               Specify the repository path.
146               .TP 
147 a.arora   1.2 \fB\-N\fP 
148               Specify the repository name - defaults to "repository"
149               .TP 
150               \fB\-M\fP 
151               Repository mode [XML, BIN] - defaults to "XML"
152               .TP 
153 alagaraja 1.1 \fB\-\-trace\fP 
154               Trace to file (default to stdout).
155               .TP 
156               \fB\-uc\fP 
157               Allow update of an existing class definition.
158               .TP 
159               \fB\-\-version\fP 
160               Display CIM Server version.
161               .TP 
162               .B \-w
163               Suppress warning messages. 
164               .IP 
165               When compiling the MOF files, if there are CIM elements (such as classes,
166               instances, properties, or methods) defined in the MOF files which 
167               already exist in the CIM Repository, the 
168               .B cimmofl
169               command returns warning messages.  The 
170               .B \-w
171               option can be used to suppress these warning messages.
172               .TP 
173               .B \-\-xml
174 alagaraja 1.1 Output XML only, to stdout. Do not update repository.
175               .SH "EXIT STATUS"
176               .PP 
177               The 
178               .B cimmofl
179               command returns one of the following values:
180               .RS
181               .TP 
182               .B 0
183               Successful completion
184               .PD 0
185               .TP 
186               .B 1 
187               Error
188               .PD
189               .RE
190               .PP 
191               When an error occurs, an error message is written to stderr and an
192               error value of 1 is returned.
193               .SH "USAGE NOTE"
194               .PP 
195 alagaraja 1.1 Warning: Use of \fBcimmofl\fP can corrupt the CIM Server Repository.
196                        \fBcimmofl\fP should only be used under very controlled situations.
197                        \fBcimmof\fP is the recommended OpenPegasus MOF compiler.
198               .SH "DIAGNOSTICS"
199               .PP 
200               .B "Error trying to create Repository in path localhost:5988: Cannot connect to: localhost:5988 Failed to set DefaultNamespacePath."
201               .IP 
202               The CIM Server is not running.  Start the CIM Server with the
203               .C cimserver 
204               command and re\-run
205               .B cimmofl .
206               .PP 
207               If the MOF Compiler detects an error in the MOF file while parsing the file, 
208               a parsing error is returned with the line number of the MOF file containing
209               the error.
210               .PP 
211               .B "Operation cannot be carried out since the specified superclass does not exist." 
212               .IP 
213               The MOF Compiler compiled a MOF file with superclasses that were not
214               in the CIM Repository.
215               .PP 
216 alagaraja 1.1 For a list of possible error messages
217               that may be returned, refer to the Chapter on WBEM messages in
218               the Administrator's Guide.
219               .SH "EXAMPLES"
220               .PP 
221               Compile a MOF file into the default namespace in the CIM Repository,
222               issue the 
223               .B cimmofl
224               command with no options.
225               .IP 
226               .B "cimmofl processInfo.mof"
227               .PP 
228               Compile the MOF files into the "root/application" namespace.
229               .IP 
230               .B  "cimmofl \-nroot/application test1.mof test2.mof"
231               .PP 
232               Compile the MOF file defined in the directory ./MOF with the name
233               CIMSchema25.mof, and containing include pragmas for other MOF files also
234               in the ./MOF directory.
235               .IP 
236               .B "cimmofl \-w \-I./MOF MOF/CIMSchema25.mof"
237 alagaraja 1.1 .PP 
238               Display Usage Info for the 
239               .B cimmofl
240               command.  
241               .IP 
242               .B "cimmofl \-h"
243               .SH "SEE ALSO"
244               .PP 
245               cimserver(1), cimmof(1).

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2