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 <http://schmizz.net>
. It is now
maintained by Leonidas Poulopoulos (@leopoul) <http://ncclient.org>
and Einar Nilsen-Nygaard (@einarnn)
.
Docs:
http://ncclient.readthedocs.org <http://ncclient.readthedocs.org>
_
Github:
https://github.com/ncclient/ncclient <https://github.com/ncclient/ncclient>
_
Requirements: ^^^^^^^^^^^^^
If you are on Debian/Ubuntu install the following libs (via aptitude or apt-get):
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'}`
- Nexus: `device_params={'name':'nexus'}`
- IOS XR: `device_params={'name':'iosxr'}`
- IOS XE: `device_params={'name':'iosxe'}`
* Huawei:
- `device_params={'name':'huawei'}`
- `device_params={'name':'huaweiyang'}`
* Nokia SR OS: `device_params={'name':'sros'}`
* H3C: `device_params={'name':'h3c'}`
* HP Comware: `device_params={'name':'hpcomware'}`
* Server or anything not in above: `device_params={'name':'default'}`
Changes \| brief
v0.6.12
v0.6.11
v0.6.10
action
supportv0.6.9
v0.6.8
edit-config
parameter validationv0.6.7
v0.6.6
v0.6.5
v0.6.4
v0.6.3
v0.6.2
v0.6.0
v0.5.4
v0.5.3
v0.5.2
v0.4.7
v0.4.6
v0.4.5
Add Huawei device support
Add cli command support for hpcomware v7 devices
Add H3C support, Support H3C CLI,Action,Get_bulk,Save,Rollback,etc.
Add alcatel lucent support
Rewrite multiple error handling
Add coveralls support, with shield in README.md
Set severity level to higher when multiple
Simplify logging and multi-error reporting
Keep stacktrace of errors
Check for known hosts on hostkey_verify only
Add check for device sending back null error_text
Fix RPC.raise_mode
Specifying hostkey_verify=False should not load_known_hosts
Check the correct field on rpc-error element
v0.4.3
v0.4.2
v0.4.1
Acknowledgements
- v0.6.11: @musicinmybrain, @sstancu, @earies
- v0.6.10: @vnitinv, @omaxx, @einarnn, @musicinmybrain, @tonynii, @sstancu, Martin Volf, @fredgan, @avisom, Viktor Velichkin, @ogenstad, @earies
- v0.6.9: [Fred Gan](https://github.com/fredgan)
- v0.6.8: [Fred Gan](https://github.com/fredgan), @vnitinv, @kbijakowski, @iwanb, @badguy99, @liuyong, Andrew Mallory, William Lvory
- v0.6.7: @vnitinv, @chaitu-tk, @sidhujasminder, @crutcha, @markgoddard, @ganeshrn, @songxl, @doesitblend, @psikala, @xuxiaowei0512, @muffizone
- v0.6.6: @sstancu, @hemna, @ishayansheikh
- v0.6.4: @davidhankins, @mzagozen, @knobix, @markafarrell, @psikala, @moepman, @apt-itude, @yuekyang
- v0.6.3: @rdkls, @Anthony25, @rsmekala, @vnitinv, @siming85
- v0.6.2: @einarnn, @glennmatthews, @bryan-stripe, @nickylba
- v0.6.0: `Einar Nilsen-Nygaard`_
- v0.5.4: Various
- v0.5.3: `Justin Wilcox`_, `Stacy W. Smith`_, `Mircea Ulinic`_,
`Ebben Aries`_, `Einar Nilsen-Nygaard`_, `QijunPan`_
- v0.5.2: `Nitin Kumar`_, `Kristian Larsson`_, `palashgupta`_,
`Jonathan Provost`_, `Jainpriyal`_, `sharang`_, `pseguel`_,
`nnakamot`_, `Алексей Пастухов`_, `Christian Giese`_, `Peipei Guo`_,
`Time Warner Cable Openstack Team`_
- v0.4.7: `Einar Nilsen-Nygaard`_, `Vaibhav Bajpai`_, Norio Nakamoto
- v0.4.6: `Nitin Kumar`_, `Carl Moberg`_, `Stavros Kroustouris`_
- v0.4.5: `Sebastian Wiesinger`_, `Vincent Bernat`_, `Matthew Stone`_,
`Nitin Kumar`_
- v0.4.3: `Jeremy Schulman`_, `Ray Solomon`_, `Rick Sherman`_,
`subhak186`_
- v0.4.2: `katharh`_, `Francis Luong (Franco)`_, `Vincent Bernat`_,
`Juergen Brendel`_, `Quentin Loos`_, `Ray Solomon`_, `Sebastian
Wiesinger`_, `Ebben Aries`_
- v0.4.1: `Jeremy Schulman`_, `Ebben Aries`_, Juergen Brendel
.. _Nitin Kumar: https://github.com/vnitinv
.. _Kristian Larsson: https://github.com/plajjan
.. _palashgupta: https://github.com/palashgupta
.. _Jonathan Provost: https://github.com/JoProvost
.. _Jainpriyal: https://github.com/Jainpriyal
.. _sharang: https://github.com/sharang
.. _pseguel: https://github.com/pseguel
.. _nnakamot: https://github.com/nnakamot
.. _Алексей Пастухов: https://github.com/p-alik
.. _Christian Giese: https://github.com/GIC-de
.. _Peipei Guo: https://github.com/peipeiguo
.. _Time Warner Cable Openstack Team: https://github.com/twc-openstack
.. _Einar Nilsen-Nygaard: https://github.com/einarnn
.. _Vaibhav Bajpai: https://github.com/vbajpai
.. _Carl Moberg: https://github.com/cmoberg
.. _Stavros Kroustouris: https://github.com/kroustou
.. _Sebastian Wiesinger: https://github.com/sebastianw
.. _Vincent Bernat: https://github.com/vincentbernat
.. _Matthew Stone: https://github.com/bigmstone
.. _Jeremy Schulman: https://github.com/jeremyschulman
.. _Ray Solomon: https://github.com/rsolomo
.. _Rick Sherman: https://github.com/shermdog
.. _subhak186: https://github.com/subhak186
.. _katharh: https://github.com/katharh
.. _Francis Luong (Franco): https://github.com/francisluong
.. _Juergen Brendel: https://github.com/juergenbrendel
.. _Quentin Loos: https://github.com/Kent1
.. _Ebben Aries: https://github.com/earies
.. _Justin Wilcox: https://github.com/jwwilcox
.. _Stacy W. Smith: https://github.com/stacywsmith
.. _Mircea Ulinic: https://github.com/mirceaulinic
.. _QijunPan: https://github.com/QijunPan