IPA_ST_SDB(8)                                                    IPA_ST_SDB(8)



NAME
       ipa_st_sdb -- IPA simple database module (statistics part)

DESCRIPTION
       ipa_st_sdb is an IPA statistics module with the following features:

       -      The module reads data from the ipa_sdb(5) database;

       -      The module completely supports rules, limits and thresholds.

       The name of the statistics system is sdb.

CONFIGURATION FILE FORMAT
       Configuration  for  the  module  is integrated to the ipa.conf(5) file.
       The configuration prefix of this module is ``sdb''.

       The sdb:db_dir parameter allows to define the main  database  directory
       (the default value is /var/ipa_sdb):

           sdb:db_dir = "/path/to/directory";

       This parameter can be placed in global or rule section.

       Static  and  dynamic  rules inherit this parameter from the global sec-
       tion.  Since it can be placed in the rule section, then  any  rule  can
       have own main directory for its database files and directories.

       Next parameters can be placed only in the sdb: module's section:

           sdb: {
               /* Parameters. */
           }

       By  default the module disallows using of symlinks in the database.  To
       allow symlinks in the database  set  the  allow_symlinks  parameter  to
       ``yes'' (the default value is ``no''):

           sdb: {
               allow_symlinks = <boolean>;
           }

       The  main  database directory has a special file containing the version
       number of the database format and the module checks  version  saved  in
       this file.  To speedup the module startup in case if many main database
       directories are used it is possible to turn off database format version
       checking  in  the  check_version parameter by setting it to ``no'' (the
       default value is ``yes''):

           sdb: {
               check_version = <boolean>;
           }

       It is not recommended to turn off database format version checking.

       By default the module is very quiet and does not send any log  messages
       until  any  error  occurs.  To see all messages from the module set the
       quiet parameter to ``no'' (the default value is ``yes''):

           sdb: {
               quiet = <boolean>;
           }

       Example:

           st_mod "ipa_st_sdb.so";

           global {
               /* ... */
               st_list = sdb;
               sdb:db_dir = "/var/db/ipa_sdb";
           }

           rule 1 {
               /* ... */
           }

           rule 2 {
               /* ... */
               sdb:db_dir = "/home/my/ipa_sdb";
           }

       First rule inherits value of the sdb:db_dir parameter from  the  global
       section.   Second  rule  has own value for this parameter.  All dynamic
       rules will inherit the value  of  the  sdb:db_dir  parameter  from  the
       global section.

SEE ALSO
       ipa_sdb(5), ipa_db_sdb(8), ipa_sdb_dump(8)

AUTHOR
       Andrey Simonenko <simon@comsys.ntu-kpi.kiev.ua>

BUGS
       If you find any, please send email me.



                                 July 19, 2007                   IPA_ST_SDB(8)