netconf-client

library3.6.0pypypi✓ verified 79d ago

Netconf Client is a Python library for interacting with NETCONF-enabled network devices. It supports NETCONF over SSH and TLS, with features like candidate configuration, datastore operations, and YANG-based filtering. The current version is 3.6.0, requiring Python >=3.8, <4.0. Release cadence is irregular, with occasional minor version bumps.

devops

pip install netconf-client

github ↗homepage ↗

INSTALL

IMPORT

SIG · NETCONF-CLIENT

netconf-client

devopspythonv3.6.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

connect

✓ from netconf_client import connect

✗ from netconf_client.connect import connect

Connect to a NETCONF device (SSH), retrieve the running configuration, and print it as XML.

from netconf_client.connect import connect from netconf_client.session import NetconfSession session = connect( host='192.168.1.1', port=830, username='admin', password='password', hostkey_verify=False ) # Get running config response = session.get_config(source='running') print(response.data_xml) session.close()

Debug

Known issues

breakingIn version 3.x, the connect function now returns a NetconfSession directly, not a manager object. Old code using manager methods will break.

fix

Update to use session methods like get_config, edit_config instead of get, edit.

affects: >=3.0.0

deprecatedThe 'hostkey_verify' parameter is deprecated and may be removed in future versions. Use 'host_key_check_policy' instead.

fix

Replace 'hostkey_verify=False' with 'host_key_check_policy=HostKeyCheckPolicy.IGNORE' from netconf_client.constants.

affects: >=3.5.0

gotchaSessions are not thread-safe. Do not share a session across threads without external synchronization.

fix

Create separate sessions per thread or use a mutex around method calls.

affects: all

Upgrade

Version history

3.6.0latest on PyPI · released May 27, 2026

Audit

Dependencies

paramikorequiredSSH transport

lxmlrequiredXML parsing

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/ADTRAN/netconf_client ↗

homepagehttps://github.com/ADTRAN/netconf_client ↗