Python
Clone or download
nickylba and einarnn add Huawei device support through YANG (#1) (#242)
The existing huawei.py device having some private capabilities in <hello>, like "http://www.huawei.com/netconf/capability/exchange/1.0", which tell the connected NE (network element) to work in private work-mode. 

In order to ask NE to work in  standard way that accpeting only RFC compatible rpc and reply with standard rpc-reply, huaweiyang.py is added
Latest commit ed613f1 Jul 12, 2018

README.md

Build Status Coverage Status Documentation Status

ncclient: Python library for NETCONF clients


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) and Einar Nilsen-Nygaard (@einarnn)

Docs: http://ncclient.readthedocs.org

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

Recent Highlights

Date Release Description
07/02/18 0.6.0 Minor release reinstating Python 3.7 and greater compatibility, but necessitating a change to client code that uses async_mode.
07/02/18 0.5.4 New release rolling up myriad of small commits since 0.5.3. Please note that this release is incompatible wth Python 3.7 due to the use of a new Python 3.7 keyword, async, in function signatures. This will be resolved in 0.6.0

Requirements

  • Python 2.7 or Python 3.4+
  • 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'}
  • Cisco IOS XR: device_params={'name':'iosxr'}
  • Cisco IOS XE: device_params={'name':'iosxe'}
  • Huawei: device_params={'name':'huawei'}
  • Alcatel Lucent: device_params={'name':'alu'}
  • H3C: device_params={'name':'h3c'}
  • HP Comware: device_params={'name':'hpcomware'}
  • Server or anything not in above: device_params={'name':'default'}

Changes | brief - v0.5.3

  • Add notifications support
  • Add support for ecdsa keys
  • Various bug fixes

Contributors