Clixon controller documentation

Clixon network controller is an open-source manager of network devices based on NETCONF and YANG. This document has three parts: Sections 1-3 are introduction, 4-6 are tutorials, and the remaining are reference sections.

Table of contents

• 1 Overview
  • 1.1 Goals
  • 1.2 Architecture
  • 1.3 APIs
• 2 Installation
  • 2.1 Packages
  • 2.2 Source
  • 2.3 Building
  • 2.4 Configure options
  • 2.5 Python install
  • 2.6 Devices
  • 2.7 Install script
• 3 Quick start
  • 3.1 Docker compose
  • 3.2 CLI setup
• 4 Setup tutorial
  • 4.1 Prerequisites
  • 4.2 SSH key generation
  • 4.3 Docker setup
  • 4.4 Login
  • 4.5 Connect to devices
  • 4.6 Next step
• 5 CLI tutorial
  • 5.1 Prerequisites
  • 5.2 General
  • 5.3 Modes
  • 5.4 Devices
  • 5.5 Syncing from devices
  • 5.6 Services
  • 5.7 Editing
  • 5.8 Commits
  • 5.9 Explicit push
  • 5.10 Templates
• 6 Service tutorial
  • 6.1 Prerequisites
  • 6.2 Device config
  • 6.3 Service model
  • 6.4 Running the service model
  • 6.5 Service code
  • 6.6 Running the Service code
  • 6.7 Summary
• 7 Configuration
  • 7.1 Example
  • 7.2 Adaptations
• 8 Transactions
  • 8.1 Device connect
  • 8.2 Config push
• 9 YANG
  • 9.1 Directory structure
  • 9.2 Device YANGs
  • 9.3 Module structure
  • 9.4 Isolate YANG models
• 10 Service API
  • 10.1 Overview
  • 10.2 Service model
  • 10.3 Device config
  • 10.4 Attributes
  • 10.5 Creator tags
  • 10.6 Algorithm
  • 10.7 Protocol
  • 10.8 Restrictions
• 11 Python API
  • 11.1 Overview
  • 11.2 Overview
  • 11.3 Installation
  • 11.4 Usage
• 12 Service development
  • 12.1 Module installation
  • 12.2 Modules basics
  • 12.3 Commit hooks
  • 12.4 Service attributes
  • 12.5 Python object tree
  • 12.6 Object tree API
• 13 FAQ (Frequently Asked Questions)
  • 13.1 Clixon Controller FAQ