summaryrefslogtreecommitdiffstats
path: root/tools/gendoc/doc/config.rst
blob: 0c286097f3b6b9b9b847126d1ba5c9f6401fc70c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
Configuration
=============

Configuration files
-------------------

``/etc/openlmi/openlmi.conf`` is OpenLMI master configuration file.

Each provider may introduce additional configuration files, see their
documentation. If a provider uses its own configuration file, the
provider-specific one is parsed first and all missing options are
then read from OpenLMI master configuration file.

Using this approach, administators can set e.g. one namespace for all
providers in ``/etc/openlmi/openlmi.conf`` and different log levels
for some providers in their configuration files.

File format
-----------
Configuration files has simple .ini syntax, with ``#`` or ``;`` used for
comments.

Default configuration::

     [CIM]
     Namespace=root/cimv2
     SystemClassName=PG_ComputerSystem

     [Log]
     Level=ERROR
     Stderr=false

======= =================== ==================== ===========
Section Option name         Default value        Desciption
======= =================== ==================== ===========
``CIM`` ``Namespace``       root/cimv2           Namespace where OpenLMI providers are registered.
``CIM`` ``SystemClassName`` PG_ComputerSystem    Name of CIM_ComputerSystem class, which is used to represent the computer system. It will be used as ``SystemClassName`` property value of various classes.
``Log`` ``Level``           ERROR                Chooses which messages are logged, either to CIMOM and (if configured) to standard error output. Available levels (sorted by severity) are:

                                                    * CRITICAL
                                                    * ERROR
                                                    * WARNING
                                                    * INFO
                                                    * DEBUG
                                                    * TRACE_WARNING
                                                    * TRACE_INFO
                                                    * TRACE_VERBOSE

                                                 Levels below INFO (= TRACE_WARNING, TRACE_INFO and DEBUG) are useful mainly for debugging and bug reporting.
``Log`` ``Stderr``          false                Toggles sending of log messages to standard error output of the CIMOM.
======= =================== ==================== ===========

Logging
=======

If logging is enabled, all log messages with level INFO and above are sent to
CIMOM using standard CMPI ``CMLogMessage`` function. Consult documentation of
your CIMOM how to enable output of these messages into CIMOM logs.

Messages with TRACE_WARNING and below are sent to CIMOM using ``CMTraceMessage``
and should be visible in CIMOM tracing log. Again, please consult your CIMOM
documentation how to enable tracing logs.

With ``Stderr`` configuration option enabled, all logs are sent both to CIMOM
and to the standard error output of the CIMOM.