Clixon configuration files are encoded in XML and modeled by YANG. By
default, the main config file is installed as
/usr/local/etc/clixon.xml, but can be changed by the
-f <file> command-line option.
The YANG specification for Clixon configuration is clixon-config.yang. This configuration file is updated regularly.
Normally, all Clixon processes (backend, cli, netconf, restconf) use
the same configuration, although some options are not valid for all
processes. You can however have different configuration files for different clients by using the
Please consult the clixon-config YANG spec directly if you want detailed description of config options.
The following is the configuration file of a simple example:
<clixon-config xmlns="http://clicon.org/config"> <CLICON_CONFIGFILE>/usr/local/etc/clixon.xml</CLICON_CONFIGFILE> <CLICON_CONFIGDIR>/usr/local/etc/clixon.d</CLICON_CONFIGDIR> <CLICON_FEATURE>*:*</CLICON_FEATURE> <CLICON_YANG_DIR>/usr/local/share/clixon</CLICON_YANG_DIR> <CLICON_YANG_MODULE_MAIN>clixon-hello</CLICON_YANG_MODULE_MAIN> <CLICON_CLI_MODE>hello</CLICON_CLI_MODE> <CLICON_CLISPEC_DIR>/usr/local/lib/hello/clispec</CLICON_CLISPEC_DIR> <CLICON_SOCK>/usr/local/var/hello.sock</CLICON_SOCK> <CLICON_BACKEND_PIDFILE>/usr/local/var/hello.pidfile</CLICON_BACKEND_PIDFILE> <CLICON_XMLDB_DIR>/usr/local/var/hello</CLICON_XMLDB_DIR> <CLICON_STARTUP_MODE>init</CLICON_STARTUP_MODE> <CLICON_MODULE_LIBRARY_RFC7895>false</CLICON_MODULE_LIBRARY_RFC7895> <restconf> <enable>true</enable> </restconf> </clixon-config>
CLICON_CONFIGFILE is special, it must be available before
the configuration file is found (see Loading the configuration),
which means that the value in the file is a no-op.
restconf clause defines RESTCONF configuration options as described in the restconf section section.
5.2 Loading the configuration¶
Clixon finds its configuration files, according to the following method:
Start a clixon program with the
-f <FILE>option. For example:clixon_backend -f FILE
At install time, Use the
--with-configfile=FILEoption to configure a default location:./configure --with-configfile=FILE
At install time:
./configure --with-sysconfig=<dir>when configuring. Then FILE is
At install time:
./configure --sysconfig=<dir>when configuring. Then FILE is
If none of the above: FILE is
The following options control the Clixon configuration:
- The configure file itself. Due to bootstrapping reasons, its value is meaningless in a file but can be useful for documentation purposes.
A directory of extra configuration files loaded after the main configuration. It can also be specified using the
-E <dir>command-line option. These extra configuration files are read in alphabetical order after the main configuration as follows:
- leaf values are overwritten
- leaf-list values are appended
5.3 Runtime modification¶
You can modify clixon options at runtime by using the
-o option to
modify the configuration specified in the configuration file. For
usr/local/share/ietf to the list of directories where yang files are searched for:
clixon_cli -o CLICON_YANG_DIR=/usr/local/share/ietf
CLICON_FEATURE is a list of values, describing how Clixon supports features.
A value is specified as one of the following:
<module>:<feature>: enable a specific feature in a specific module
*:*: enable all features in all modules
<module>:*: enable all features in the specified module
*:<feature>: enable the specific feature in all modules.
<CLICON_FEATURE>ietf-netconf:startup</CLICON_FEATURE> <CLICON_FEATURE>ietf-netconf:*</CLICON_FEATURE> <CLICON_FEATURE>*:*</CLICON_FEATURE>
-o option adds a value to the feature list.
Clixon have three hardcoded features:
- ietf-netconf:candidate (RFC6241 8.3)
- ietf-netconf:validate (RFC6241 8.6)
- ietf-netconf:xpath (RFC6241 8.9)
5.5 Finding YANG files¶
The example have two options for finding Yang files:
which means that Yang files are searched for in
/usr/local/share/clixon and that module
clixon-hello is loaded. Note:
clixon-hello.yangmust be present in
- Clixon itself may load several YANG files as part of the system startup, such as
clixon-config.yang. These must all reside in the list of
- When a Yang file is loaded, it may contain references to other Yang files (eg using
include). They must also be found in the list of
The following configuration file options control the loading of Yang files:
- A list of directories (yang dir path) where Clixon searches for module and submodules recursively.
- Load a specific Yang module given by a file.
- Specifies a single module to load. The module is searched for in the yang dir path.
- Specifies a revision to the main module.
- Load all yang modules in this directory, not recursively.
Note that the special
YANG_INSTALLDIR autoconf configure option, by default
/usr/local/share/clixon should be included in the yang dir path for Clixon system files to be found.
You can combine the options, however, if there are different variants of the same module, more specific options override less specific. The precedence of the options are as follows:
Note that using
CLICON_YANG_MAIN_DIR Clixon may find several files
containing the same Yang module. Clixon will prefer the one without a
revision date if such a file exists. If no file has a revision date,
Clixon will prefer the newest.
5.6 Standard YANG files¶
The main examples and tests require IETF RFC standard YANGs. If you
want to run the main example or run tests, you need to make them locally
available by checking out
https://github.com/YangModels/yang which has subdir
By default this directory is
You can change this location by:
Note that you do not need this for the clixon runtime.