/ncclient

Python library for NETCONF clients

Primary LanguagePythonApache License 2.0Apache-2.0

Build Status Coverage Status Documentation Status

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

Latest stable Python2 version is 0.4.7 (Jan 2016) 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:

  • version >= Python 2.6
  • setuptools 0.6+
  • Paramiko 1.7+
  • lxml 3.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

  • Python 3 support

Acknowledgements