uconf-export: Text-based Configuration Export Utility
The Text-based Configuration Export Utility. uconf-export, provides a command line interface for reading the Urchin configuration database and exporting it in a human-readable text format. The exported data is an XML-type record format, which is directly compatible with the format expected by the uconf-import utility. Each record in the exported data corresponds to a configuration record in the Urchin configuration database.
The uconf-export utility is located in the util directory of the Urchin 5 distribution.
Usage of the utility is as follows:
uconf-export [-h] (prints usage message and exits) uconf-export [-v] (prints version and exits) uconf-export [-f file]where:
-f specifies a filename within the same(/util) directory that uconf-export will write toIf no command line arguments are given, uconf-export will write to the standard output.
Output format for uconf-export
The utility exports configuration records in an XML-style format. Each record begins with a <Table Name="RecordName"> line and ends with a </Table> line. The list of configuration directives associated with the record are printed, one per line, between the record begin/end lines. For instance, a Profile record would look something like this:
<Profile Name="help.example.com"> ct_name=help.example.com ct_website=http://help.example.com ct_reportdomains=help.example.com,www.help.example.com cs_llist="help.example.com daily log" ct_defaultpage=index.html cs_referrallevel=3 cs_timeoffset=localtime cr_logtracking=on cr_processpath=on cs_pathlevel=3 cs_vmethod=0 cs_visitortimeout=1800 cr_sessionpageview=on cs_ulist="webmaster" ct_affiliation=(NONE) cr_profiletype=Standard_Website cs_reportset=Basic_All </Profile>The valid list of Table names is:
Global Machine Filter Logfile Profile Task Affiliation Group User
- The uconf-export utility provides no ability to export a certain subset of the configuration data. If you wish to extract only certain records from the output of uconf-export, you should use an external script to parse this output or use the uconf-driver utility to extract single records.
- The output of uconf-export is carefully constructed so that it can be directly imported into the Urchin configuration using the uconf-import utility. This allows you to use uconf-export to create a text-based backup of your Urchin configuration which can then be easily restored using uconf-import.
- Script-based Configuration Management provides a general overview of using a script-based, unattended/automated approach to managing Urchin's configuration
- Configuration Table and Directive List has a complete list of all the valid tables and parameters that may appear in the output of the uconf-export utility.