stephanerobert/ncclient

ncclient: Python library for NETCONF clients

##Important - Python3 support!

ncclient 0.5.0 with Python 3 support is now in pypitest. To install and test:

pip install -i https://testpypi.python.org/pypi ncclient

or get it via the v3 branch

Latest stable Python2 version is 0.4.6 (Nov 2015) and is now on PyPi:

pip install ncclient

ncclient is a Python library that facilitates client-side scripting and application development around the NETCONF protocol. ncclient was developed by Shikar Bhushan. It is now maintained by Leonidas Poulopoulos (@leopoul)

Docs: http://ncclient.readthedocs.org

PyPI: https://pypi.python.org/pypi/ncclient

Requirements:

Python 2.6 <= version < 3.0
setuptools 0.6+
Paramiko 1.7+
lxml 3.0+
libxml2
libxslt

If you are on Debian/Ubuntu install the following libs (via aptitude or apt-get):

libxml2-dev
libxslt1-dev

Installation:

[ncclient] $ sudo python setup.py install

or via pip:

pip install ncclient

Examples:

[ncclient] $ python examples/juniper/*.py

Usage

####Get device running config Use either an interactive Python console (ipython) or integrate the following in your code:

from ncclient import manager

with manager.connect(host=host, port=830, username=user, hostkey_verify=False) as m:
    c = m.get_config(source='running').data_xml
    with open("%s.xml" % host, 'w') as f:
        f.write(c)

As of 0.4.1 ncclient integrates Juniper's and Cisco's forks, lots of new concepts have been introduced that ease management of Juniper and Cisco devices respectively. The biggest change is the introduction of device handlers in connection paramms. For example to invoke Juniper's functions annd params one has to re-write the above with device_params={'name':'junos'}:

from ncclient import manager

with manager.connect(host=host, port=830, username=user, hostkey_verify=False, device_params={'name':'junos'}) as m:
    c = m.get_config(source='running').data_xml
    with open("%s.xml" % host, 'w') as f:
        f.write(c)

Device handlers are easy to implement and prove to be futureproof.

####Supported device handlers

Juniper: device_params={'name':'junos'}
Cisco CSR: device_params={'name':'csr'}
Cisco Nexus: device_params={'name':'nexus'}
Huawei: device_params={'name':'huawei'}
Alcatel Lucent: device_params={'name':'alu'}
H3C: device_params={'name':'h3c'}
HP Comware: device_params={'name':'hpcomware'}

Changes | brief

Fix multiple RPC error handling
Add support for cancel-commit and persist param
Add more examples

Acknowledgements

v0.4.6: Thanks to all contribs and bug hunters; [Nitin Kumar] (https://github.com/vnitinv), [Carl Moberg] (https://github.com/cmoberg), [Stavros Kroustouris] (https://github.com/kroustou) .
v0.4.5: Thanks to all contribs and bug hunters; [Sebastian Wiesinger] (https://github.com/sebastianw), [Vincent Bernat] (https://github.com/vincentbernat), [Matthew Stone] (https://github.com/bigmstone), [Nitin Kumar] (https://github.com/vnitinv)
v0.4.3: Thanks to all contributors and bug hunters; Jeremy Schulman, Ray Solomon, Rick Sherman, subhak186
v0.4.2: Thanks to all contributors; katharh, Francis Luong (Franco), Vincent Bernat, Juergen Brendel, Quentin Loos, Ray Solomon, Sebastian Wiesinger, Ebben Aries
v0.4.1: Many thanks, primarily to Jeremy Schulman (Juniper) for providing his precious feedback, to Ebben Aries (Juniper) for his contribution, to Juergen Brendel (Cisco) for the Cisco fork and to all contributors from Cisco and Juniper.

stephanerobert / ncclient