.. _controller_configuration:
.. sectnum::
   :start: 8
   :depth: 3

*************
Configuration
*************

The controller extends the clixon configuration file as follows:

``CLICON_CONFIG_EXTEND``
   The value should be `clixon-controller-config` making the controller-specific

``CONTROLLER_ACTION_COMMAND``
   Should be set to the PyAPI binary with correct arguments
   The namespace is ="http://clicon.org/controller-config"

``CLICON_BACKEND_USER``
   Set to the user which the action binary (above) is used. Normally `clicon`

``CLICON_SOCK_GROUP``
   Set to user group, ususally `clicon`

``CLICON_YANG_DOMAIN_DIR``
   Virtual directory where mounted device YANGs are stored locally. Both for RFC 6022 get-schema retrieval as well as local module-set YANGs. Typically ``/usr/local/shared/controller/mounts``

``CONTROLLER_PYAPI_MODULE_PATH``
   Path to Python code for PyAPI

``CONTROLLER_PYAPI_MODULE_FILTER``
   Comma separated list of services modules that should be ignored and not loaded.

``CONTROLLER_PYAPI_PIDFILE``
   Path to the pidfile for the controller. Typically ``/usr/local/var/run/controller/clixon_server.pid``

``CONTROLLER_SSH_IDENTITYFILE``
   SSH Identityfile if not default

Example
=======
The following configuration file examplifies the configure options described above::

  <clixon-config xmlns="http://clicon.org/config">
  <CLICON_CONFIGFILE>/usr/local/etc/controller.xml</CLICON_CONFIGFILE>
  <CLICON_FEATURE>ietf-netconf:startup</CLICON_FEATURE>
  <CLICON_FEATURE>clixon-restconf:allow-auth-none</CLICON_FEATURE>
  <CLICON_CONFIG_EXTEND>clixon-controller-config</CLICON_CONFIG_EXTEND>
  <CONTROLLER_ACTION_COMMAND xmlns="http://clicon.org/controller-config">
        /usr/local/bin/clixon_server.py -f /usr/local/etc/controller.xml -F
  </CONTROLLER_ACTION_COMMAND>
  <CONTROLLER_PYAPI_MODULE_PATH xmlns="http://clicon.org/controller-config">
        /usr/local/share/controller/modules/
  </CONTROLLER_PYAPI_MODULE_PATH>
  <CONTROLLER_PYAPI_MODULE_FILTER xmlns="http://clicon.org/controller-config"></CONTROLLER_PYAPI_MODULE_FILTER>
  <CONTROLLER_PYAPI_PIDFILE xmlns="http://clicon.org/controller-config">
        /tmp/clixon_server.pid
  </CONTROLLER_PYAPI_PIDFILE>
  <CLICON_BACKEND_USER>clicon</CLICON_BACKEND_USER>
  <CLICON_SOCK_GROUP>clicon</CLICON_SOCK_GROUP>

Adaptations
===========
You may need to adapt the controller configuration to devices. Known issues are:

1) YANG features
2) Autocli rules

Features
--------
Device features are not supported, you need to install them explicitly in controller.xml or in a separate config file.

For example, assume a device needs YANG feature `foo` in module `mymodule` to run correctly. You then need to add the following entry in the controller config file::

   <clixon-config xmlns="http://clicon.org/config">
      ...
      <CLICON_FEATURE>mymodule:foo</CLICON_FEATURE>

Autocli
-------
The autocli may need to be adapted to devices. By default the autocli
is open for openconfig and junos, CLI for other YANGs need to be
explicitly added by editing the file `autocli.xml`.

For example, assume a device with Yangs starting with `myyang-`. Then the following rule needs to be added to `autocli.xml`::

  <clixon-config xmlns="http://clicon.org/config">
     <autocli>
        ...
        <rule>
           <name>Include myyang</name>
           <module-name>myyang-*</module-name>
           <operation>enable</operation>
        </rule>