Skip to content

Latest commit

 

History

History
121 lines (97 loc) · 6.51 KB

README.md

File metadata and controls

121 lines (97 loc) · 6.51 KB
Raw

libnetconf – The NETCONF protocol library

[Project Stats] (https://www.openhub.net/p/libnetconf)

libnetconf is a NETCONF library in C intended for building NETCONF clients and servers. It provides basic functions to connect NETCONF client and server to each other via SSH, to send and receive NETCONF messages and to store and work with the configuration data in a datastore.

libnetconf implements the NETCONF protocol introduced by IETF. More information about NETCONF protocol can be found at [NETCONF WG] (http://trac.tools.ietf.org/wg/netconf/trac/wiki).

libnetconf is maintained and further developed by the Tools for Monitoring and Configuration department of CESNET. Any testing of the library is welcome. Please inform us about your experiences with using libnetconf via the [issue tracker] (https://github.com/CESNET/libnetconf/issues).

Based on our experiences with development libnetconf, we are currently working on next generation of this library based on [libyang] (https://github.com/CESNET/libyang) library. libnetconf2 is already quite mature, but is still missing server-side notifications. Also, libnetconf2 does not include NETCONF datastore implementation. So, if you either want to build a standard NETCONF client or a NETCONF server without notifications (for now) and with your own datastores, it is recommended to use libnetconf2 instead libnetconf. Examples of applications built on libnetconf2 are netopeer2 server and CLI.

Documentation

libnetconf's API documentation including a description of its use is available here (Python API is available here).

Documentation can be also built from source codes:

$ make doc

Instructions to compile the libnetconf library can be found in INSTALL file.

Informations about differencies to the previous version can be found in [RELEASE_NOTES] (./RELEASE_NOTES) document or compatibility reports.

Features

Interoperability

In November 2012, prior to the IETF 85 meeting, libnetconf was one of the NETCONF protocol implementation participating in [NETCONF Interoperability Testing] (http://www.internetsociety.org/articles/successful-netconf-interoperability-testing-announced-ietf-85).

Papers and Articles

  • Building NETCONF-enabled Network Management Systems with libnetconf at the IFIP/IEEE International Symposium on Integrated Network Management 2013 (IM2013),
  • Managing SamKnows Probes using NETCONF at the IEEE/IFIP Network Operations and Management Symposium 2014 (NOMS 2014),

Project History

libnetconf comes from the Netopeer project. The first version of Netopeer was implemented in 2007 as a bachelor thesis at Masaryk university (available only czech). Further work on the project was covered by CESNET, z.s.p.o., Czech National Research and Education Network (NREN) operator and in 2009 released as an open source project at GoogleCode.

Further development led to splitting the original Netopeer applications and creating a separate library implementing NETCONF functionality. The libnetconf library was detached as a standalone project in 2012. For some time, the Netopeer server was developed internally at CESNET to control specific CESNET devices.

In 2013, the Netopeer project was restarted. Currently it contains an advanced NETCONF server developed at CESNET with several transAPI modules covering basic configuration of the Linux server. Furthermore, it also contains a command line interface that came from the libnetconf, where it was used as example application. [The Netopeer web client] (https://github.com/CESNET/Netopeer-GUI) is available separately at GitHub.

In June 2015, the project was moved to GitHub because of GoogleCode shutdown.

Release History

  • libnetconf-0.10 was released in June 2015
  • libnetconf-0.9 was released in November 2014
  • libnetconf-0.8 was released in May 2014
  • libnetconf-0.7 was released in February 2014
  • libnetconf-0.6 was released in September 2013
  • libnetconf-0.5 was released in June 2013
  • libnetconf-0.4 was released in April 2013
  • libnetconf-0.3 was released in December 2012
  • libnetconf-0.2 was released in October 2012
  • libnetconf-0.1 was released in July 2012
  • The libnetconf project was started in April 2012

Other Resources