root / docs / source / index.rst @ 84e0f4f2
History | View | Annotate | Download (1.3 kB)
| 1 |
ncclient documentation |
|---|---|
| 2 |
====================== |
| 3 |
|
| 4 |
ncclient is a Python library for NETCONF clients. NETCONF is a network management protocol defined in :rfc:`4741`. It is suitable for Python 2.6+ (not Python 3 yet, though), and depends on paramiko, an SSH library. |
| 5 |
|
| 6 |
The objective is to offer an intuitive API that sensibly maps the XML-encoded parameters of NETCONF to Python constructs and idioms. The other features are: |
| 7 |
|
| 8 |
* Supports all operations and capabilities defined in :rfc:`4741`. |
| 9 |
* Request pipelining. |
| 10 |
* Asynchronous RPC requests. |
| 11 |
* Keeping XML out of the way unless really needed. |
| 12 |
* Extensible. New transport mappings and capabilities/operations can be easily added. |
| 13 |
|
| 14 |
The best way to introduce is of course, through a simple code example:: |
| 15 |
|
| 16 |
from ncclient import manager |
| 17 |
|
| 18 |
# use ssh-agent or ~/.ssh keys for auth, and relying on known_hosts |
| 19 |
with manager.connect_ssh("host", username="username") as m:
|
| 20 |
assert(":url" in manager.server_capabilities)
|
| 21 |
with m.locked("running"):
|
| 22 |
m.copy_config(source="running", target="file:///new_checkpoint.conf") |
| 23 |
m.copy_config(source="file:///old_checkpoint.conf", target="running") |
| 24 |
|
| 25 |
Contents: |
| 26 |
|
| 27 |
.. toctree:: |
| 28 |
|
| 29 |
manager |
| 30 |
extending |
| 31 |
|
| 32 |
Indices and tables |
| 33 |
================== |
| 34 |
|
| 35 |
* :ref:`genindex` |
| 36 |
* :ref:`modindex` |
| 37 |
* :ref:`search` |