Skip to main content

A Python NETCONF client

Project description

Build Status PyPI version Coverage Status

netconf_client

A NETCONF client for Python 3.8+.

Basic Usage

from netconf_client.connect import connect_ssh
from netconf_client.ncclient import Manager

session = connect_ssh(host="localhost", port=830, username="admin", password="password")
mgr = Manager(session, timeout=120)

mgr.edit_config(config="""<config> ... </config>""")
print(mgr.get(filter="""<filter> ... </filter>""").data_xml)

More complete documentation can be found in the User Guide

Comparison with ncclient

Compared to ncclient, netconf_client has several advantages:

  • It's simpler (at the time of writing: 789 LoC vs 2889 LoC)
  • lxml can be bypassed, which can work around issues where lxml breaks namespaces of e.g. identityrefs
  • Support for TLS sessions

And a few disadvantages:

  • Support for non-RFC-compliant devices isn't really included in netconf_client
  • netconf_client does a lot less error checking and assumes you're sending valid messages to the server (however this can be useful for testing edge-case behavior of a server)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netconf_client-3.1.2.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

netconf_client-3.1.2-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file netconf_client-3.1.2.tar.gz.

File metadata

  • Download URL: netconf_client-3.1.2.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for netconf_client-3.1.2.tar.gz
Algorithm Hash digest
SHA256 687993607fb758f9367efcb923e5ce6c8a11991397a5dc7008de2471fdb5463d
MD5 f938a824b077848dc152d89c01022430
BLAKE2b-256 785dd66fc62c5913bccfe8ff556b27c5e1eeddac1949f5bec45fd763ed93a54e

See more details on using hashes here.

File details

Details for the file netconf_client-3.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for netconf_client-3.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d8f34117a8ec96646ea6f4093319d24cdb1eb32199902a7fe569af95db747208
MD5 011ca9b7ee58746cf824d2f4df0ca425
BLAKE2b-256 c7fac81bdf070af418214b6a34a09bf97be6c08fefecfd21c00d7cb173409c32

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page