Skip to main content

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)

Metadata

Release files for netconf-client 3.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for netconf-client 3.6.0
File Size Uploaded
netconf_client-3.6.0.tar.gz 14.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for netconf-client 3.6.0
File Interpreter ABI Platform
netconf_client-3.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 31.6 kB

Release files / netconf_client-3.6.0.tar.gz

Download URL netconf_client-3.6.0.tar.gz
Size 14.8 kB
Tags Source
SHA-256 checksum
How to use checksums
6281700784ea9758af36b35461a3fd7bc518ba0e0093499552e8fcf841b0bb7d
BLAKE2b-256 checksum
How to use checksums
1c1e6626086d8333889b13f55e782ba5c5ea0909950fdad6215b2c5c4fd7e4d0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / netconf_client-3.6.0-py3-none-any.whl

Download URL netconf_client-3.6.0-py3-none-any.whl
Size 16.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6b36797f07ffa6790a723c571ad83061fd4520c2f6c8bad6afdd84d2ae84af14
BLAKE2b-256 checksum
How to use checksums
1ebbc6aa8f901fdb114a26feca8aa3a654997eb3097a5ff4ed33896b0e3ccb70
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release history Release notifications | RSS feed

This release

3.6.0 This release

2 release files

3.5.0

2 release files

3.4.0

2 release files

3.3.0

2 release files

3.2.0

2 release files

3.1.3

2 release files

3.1.2

2 release files

3.1.1

2 release files

3.1.0

2 release files

3.0.0

2 release files

2.5.1

2 release files

2.5.0

2 release files

2.4.1

2 release files

2.4.0

2 release files

2.3.0

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.7.3

2 release files

1.7.2

2 release files

1.7.1

2 release files

1.7.0

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.1

2 release files

1.5.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page