root / docs / source / intro.rst @ 216bb34c
History | View | Annotate | Download (1 kB)
| 1 |
************* |
|---|---|
| 2 |
Introduction |
| 3 |
************* |
| 4 |
|
| 5 |
NCClient is a Python library for NETCONF clients. NETCONF is a network management protocol defined in :rfc:`4741`. It is meant for Python 2.6+ (not Python 3 yet, though). |
| 6 |
|
| 7 |
The features of NCClient include: |
| 8 |
|
| 9 |
* Request pipelining. |
| 10 |
* (A)synchronous RPC requests. |
| 11 |
* Keeps XML out of the way unless really needed. |
| 12 |
* Supports all operations and capabilities defined in :rfc:`4741`. |
| 13 |
* Extensible. New transport mappings and capabilities/operations can be easily added. |
| 14 |
|
| 15 |
The best way to introduce is of course, through a simple code example:: |
| 16 |
|
| 17 |
from ncclient import manager |
| 18 |
|
| 19 |
with manager.connect_ssh('host', '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 |
It is recommended to use the high-level :class:`Manager` API where possible. It exposes almost all of the functionality. |
| 26 |
|