Clixon is an automatic configuration manager where you generate interactive CLI, NETCONF, RESTCONF and embedded databases with transaction support from a YANG specification.
- Background
- Frequently asked questions
- Installation
- Licenses
- Support
- Dependencies
- Extending
- Yang
- Netconf
- Restconf
- Datastore
- Authentication and Authorization
- Example
- Changelog
- Runtime
- Clixon project page
- Tests
- Reference manual (Note: the link may not be up-to-date. It is better to build your own:
cd doc; make doc)
Clixon was implemented to provide an open-source generic configuration tool. The existing CLIgen tool was for command-lines only, whilke clixon is a system with config-db, xml and rest interfaces. Most of the projects using clixon are for embedded network and measuring devices. But Clixon is more generic than that.
Users of clixon currently include:
- Netgate
- CloudMon360
- Grideye
- Netclean # only CLIgen
- Prosilient's PTAnalyzer # only CLIgen
See also Clicon project page.
A typical installation is as follows:
configure # Configure clixon to platform
make # Compile
sudo make install # Install libs, binaries, and config-files
sudo make install-include # Install include files (for compiling)
One example application is provided, a IETF IP YANG datamodel with generated CLI, Netconf and restconf interface.
Clixon is open-source and dual licensed. Either Apache License, Version 2.0 or GNU General Public License Version 2; you choose.
See LICENSE.md for the license.
Clixon depends on the following software packages, which need to exist on the target machine.
- CLIgen If you need to build and install CLIgen:
git clone https://github.com/olofhagsand/cligen.git
cd cligen; configure; make; make install
- Yacc/bison
- Lex/Flex
- Fcgi (if restconf is enabled)
There is no yum/apt/ostree package for Clixon (please help?)
Clixon interaction is best done posting issues, pull requests, or joining the slack channel. Slack invite.
Clixon provides a core system and can be used as-is using available Yang specifications. However, an application very quickly needs to specialize functions. Clixon is extended by writing plugins for cli and backend. Extensions for netconf and restconf are also available.
Plugins are written in C and easiest is to look at example or consulting the FAQ.
YANG and XML is at the heart of Clixon. Yang modules are used as a specification for handling XML configuration data. The YANG spec is used to generate an interactive CLI, netconf and restconf clients. It also manages an XML datastore.
Clixon mainly follows YANG 1.0 RFC 6020 with some exceptions:
- conformance: feature, if-feature, deviation
- identity, base, identityref
- list features: min/max-elements, unique
The aim is also to cover new features in YANG 1.1 YANG RFC 7950
Clixon has its own XML library designed for performance.
Clixon implements the following NETCONF proposals or standards:
- NETCONF Configuration Protocol
- Using the NETCONF Configuration Protocol over Secure Shell (SSH)
- NETCONF Event Notifications
Some updates are being made to RFC 6241 and RFC 6242.
Clixon does not yet support the following netconf features:
- :url capability
- copy-config source config
- edit-config testopts
- edit-config erropts
- edit-config config-text
Clixon restconf is a daemon based on FASTCGI. Instructions are available to run with NGINX. The implementatation is based on RFC 8040: RESTCONF Protocol. The following features are supported:
- OPTIONS, HEAD, GET, POST, PUT, DELETE The following are not implemented
- PATCH
- query parameters (section 4.9)
- notifications (sec 6)
- schema resource
See more detailed instructions.
The Clixon datastore is a stand-alone XML based datastore. The idea is to be able to use different datastores backends with the same API.
Update: There used to be a key-value plugin based on qdbm but isnow obsoleted. Only a text datastore is implemented.
The datastore is primarily designed to be used by Clixon but can be used separately.
See more detailed instructions.
Authentication is managed outside Clixon using SSH, SSL, Oauth2, etc.
For CLI, login is typically made via SSH. For netconf, SSH netconf subsystem can be used.
Restconf however needs credentials. This is done by writing a credentials callback in a restconf plugin. See:
- FAQ.
- Example has an example how to do this with HTTP basic auth.
- I have done this for another project using Oauth2 or (https://github.com/CESNET/Netopeer2/tree/master/server/configuration)
The clients send the ID of the user using a "username" attribute with the RPC calls to the backend. Note that the backend trusts the clients so the clients can in principle fake a username.
There is an ongoing effort to implement authorization for Clixon according to RFC8341(NACM), at least a subset of the functionality. See more information here: NACM.
The figure shows the SDK runtime of Clixon.