Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/CESNET/libnetconf

C NETCONF library
https://github.com/CESNET/libnetconf

liberouter netconf

Last synced: 18 days ago
JSON representation

C NETCONF library

Awesome Lists containing this project

README 

        
## libnetconf – The NETCONF protocol library



[![Project Stats](https://www.openhub.net/p/libnetconf/widgets/project_thin_badge.gif)](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.



With the experiences from **libnetconf**, we have moved our activities to

work on next generation of this library based on [libyang](https://github.com/CESNET/libyang)

library. [libnetconf2](https://github.com/CESNET/libnetconf2)

is mature enough to be used as a replacement of the original **libnetconf**. Therefore, the

**libnetconf** is no more developed neither maintained. Note, that while **libnetconf2** does not

include NETCONF datastore implementation, this particular functionality can be implemented

via [sysrepo](https://github.com/sysrepo/sysrepo) project. Similarly, the NETCONF server/client

implementation [Netopeer](https://github.com/CESNET/netopeer) is deprecated and replaced by [Netopeer2](https://github.com/CESNET/netopeer2) which can be also used as a reference tool using **libnetconf2**

functions.



**libnetconf** was developed by the [Tools for

Monitoring and Configuration](https://www.liberouter.org/) department of

[CESNET](http://www.ces.net/). It 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).



## Documentation



**libnetconf**'s API documentation including a description of its use is available

[here](https://rawgit.com/CESNET/libnetconf/master/doc/doxygen/html/index.html) (Python API

is available [here](https://rawgit.com/CESNET/libnetconf/master/doc/python/html/index.html)).



Documentation can be also built from source codes:

```

$ make doc

```

Instructions to compile the **libnetconf** library can be found in [INSTALL](./INSTALL) file.



Informations about differencies to the previous version can be found in [RELEASE_NOTES]

(./RELEASE_NOTES) document or [compatibility reports](./doc/compat_reports/).



## Features



* NETCONF v1.0 and v1.1 compliant ([RFC 6241](http://tools.ietf.org/html/rfc6241))

* NETCONF over SSH ([RFC 6242](http://tools.ietf.org/html/rfc6242)) including Chunked Framing Mechanism

  * DNSSEC SSH Key Fingerprints ([RFC 4255](http://tools.ietf.org/html/rfc4255))

* NETCONF over TLS ([RFC 5539bis](http://tools.ietf.org/html/draft-ietf-netconf-rfc5539bis-05))

* NETCONF Writable-running capability ([RFC 6241](http://tools.ietf.org/html/rfc6241))

* NETCONF Candidate configuration capability ([RFC 6241](http://tools.ietf.org/html/rfc6241))

* NETCONF Validate capability ([ RFC 6241](http://tools.ietf.org/html/rfc6241))

* NETCONF Distinct startup capability ([ RFC 6241](http://tools.ietf.org/html/rfc6241))

* NETCONF URL capability ([RFC 6241](http://tools.ietf.org/html/rfc6241])

* NETCONF Event Notifications ([RFC 5277](http://tools.ietf.org/html/rfc5277) and [RFC 6470](http://tools.ietf.org/html/rfc6470))

* NETCONF With-defaults capability ([RFC 6243](http://tools.ietf.org/html/rfc6243))

* NETCONF Access Control ([RFC 6536](http://tools.ietf.org/html/rfc6536))

* NETCONF Call Home ([Reverse SSH draft](http://tools.ietf.org/html/draft-ietf-netconf-reverse-ssh-05), [RFC 5539bis](http://tools.ietf.org/html/draft-ietf-netconf-rfc5539bis-05))

* [Python bindings](https://rawgit.com/CESNET/libnetconf/master/doc/python/html/index.html)



## 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),

  * [paper](https://github.com/CESNET/libnetconf/raw/wiki/papers/im2013/paper.pdf),

  * [poster](https://github.com/CESNET/libnetconf/raw/wiki/papers/im2013/poster.pdf).

* *Managing SamKnows Probes using NETCONF* at the IEEE/IFIP Network Operations and

  Management Symposium 2014 (NOMS 2014),

  * [paper](https://github.com/CESNET/libnetconf/raw/wiki/papers/noms2014/paper.pdf),

  * [poster](https://github.com/CESNET/libnetconf/raw/wiki/papers/noms2014/poster.pdf).



## 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](http://is.muni.cz/th/98863/fi_b/)). 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](https://www.liberouter.org/?page_id=827) was developed internally

at CESNET to control specific CESNET devices.



In 2013, the [Netopeer project](http://code.google.com/p/netopeer/) 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.



In 2016 we have moved our activity to [libyang](https://github.com/CESNET/libyang)

and [libnetconf2](https://github.com/CESNET/libnetconf2). The tools became mature

in 2017 so the original libnetconf is no more maintained from that time.



## 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



* [Netopeer project](https://github.com/CESNET/Netopeer)

* [Netopeer GUI](https://github.com/CESNET/Netopeer-GUI)

* [CESNET TMC department](https://www.liberouter.org/)