Clixon documentation

Clixon is a YANG-based configuration manager, with interactive CLI, NETCONF and RESTCONF interfaces, an embedded database and a transaction mechanism.

Table of contents

• 1 Overview
  • 1.1 System Architecture
  • 1.2 Platforms
  • 1.3 Standards
  • 1.4 How to get Clixon
  • 1.5 Support
  • 1.6 Bug reports
  • 1.7 Reference docs
• 2 Installation
  • 2.1 Ubuntu Linux
  • 2.2 FreeBSD
  • 2.3 Systemd
  • 2.4 Docker
  • 2.5 Vagrant
  • 2.6 OpenWRT
  • 2.7 Prereqs from source
  • 2.8 SSH subsystem
  • 2.9 Configure options
  • 2.10 macOS
• 3 Quick start
  • 3.1 Host native
  • 3.2 Using the CLI
  • 3.3 Netconf
  • 3.4 Restconf
  • 3.5 Docker container
  • 3.6 Next steps
• 4 Standards
  • 4.1 YANG
  • 4.2 NETCONF
  • 4.3 RESTCONF
  • 4.4 SNMP
  • 4.5 XML and XPath
  • 4.6 Pagination
  • 4.7 Unicode
  • 4.8 JSON
  • 4.9 gRPC/gNMI
• 5 Configuration
  • 5.1 Example
  • 5.2 Loading the configuration
  • 5.3 Runtime modification
  • 5.4 Features
  • 5.5 Finding YANG files
  • 5.6 Standard YANG files
  • 5.7 Extending the configuration
• 6 Plugins
  • 6.1 Clixon_plugin_init
  • 6.2 Registered callbacks
  • 6.3 Reporting RPC errors
  • 6.4 Plugin callback guidelines
• 7 Backend
  • 7.1 Command-line options
  • 7.2 Startup
  • 7.3 IPC Socket
  • 7.4 Backend files
  • 7.5 Backend plugins
  • 7.6 Writing a state callback
  • 7.7 Transactions
  • 7.8 Privileges
• 8 Datastore
  • 8.1 Datastore files
  • 8.2 File formats
  • 8.3 Caching
  • 8.4 Candidate
  • 8.5 Module library support
  • 8.6 System-only config
• 9 CLI
  • 9.1 Overview
  • 9.2 Configure options
  • 9.3 Autocli
  • 9.4 CLI callbacks
  • 9.5 Show commands
  • 9.6 Load and save commands
  • 9.7 Output pipes
  • 9.8 CLI aliases
  • 9.9 Advanced
• 10 NETCONF
  • 10.1 Overview
  • 10.2 Starting
  • 10.3 NACM
  • 10.4 Confirm-commit
  • 10.5 Callhome
  • 10.6 Internal NETCONF
• 11 RESTCONF
  • 11.1 Architecture
  • 11.2 Installation
  • 11.3 Command-line options
  • 11.4 Configuration options
  • 11.5 Advanced config
  • 11.6 Starting
  • 11.7 Plugin callbacks
  • 11.8 FCGI
  • 11.9 Callhome
  • 11.10 HTTP data
  • 11.11 RESTCONF stream notifications
• 12 SNMP
  • 12.1 Architecture
  • 12.2 Configuration
  • 12.3 MIB mapping
• 13 gNMI/gRPC
  • 13.1 Architecture
  • 13.2 Build and Install
  • 13.3 Starting clixon_grpc
  • 13.4 Supported RPCs
  • 13.5 Encodings
  • 13.6 Limitations
• 14 YANG
  • 14.1 Leafrefs
  • 14.2 YANG Library
  • 14.3 Extensions
  • 14.4 Unique
  • 14.5 If-feature and anydata
  • 14.6 Schema mounts
• 15 Event notifications
  • 15.1 Overview
  • 15.2 Components
  • 15.3 Main example
• 16 Usecases
  • 16.1 CLI read
  • 16.2 CLI write
  • 16.3 Commit
  • 16.4 RESTCONF RPC
• 17 XML
  • 17.1 XML trees
  • 17.2 Creating XML
  • 17.3 Modifying XML
  • 17.4 Searching in XML
  • 17.5 Internal representation
  • 17.6 Character encoding
• 18 Paths
  • 18.1 XPaths
  • 18.2 XPath API
  • 18.3 Instance-identifier
  • 18.4 Api-path
• 19 Pagination
  • 19.1 Overview
  • 19.2 Locked pagination
  • 19.3 Pagination protocol
  • 19.4 CLI scrolling
  • 19.5 Backend pagination API
• 20 Upgrade
  • 20.1 Options
  • 20.2 General-purpose
  • 20.3 Module-specific upgrade
  • 20.4 Extra XML
  • 20.5 Failsafe mode
  • 20.6 Repair
  • 20.7 Automatic upgrades
• 22 C API Migration Guide
  • 22.1 7.9.0
• 21 Errors and debug
  • 21.1 Error reporting
  • 21.2 Debugging
  • 21.3 Customization
• 22 Misc
  • 22.1 High availability
  • 22.2 Process handling
  • 22.3 Formats
  • 22.4 Event handling