Statistics
| Branch: | Tag: | Revision:

root / docs / source / index.rst @ 09e50473

History | View | Annotate | Download (1.3 kB)

1 09e50473 Shikhar Bhushan
Welcome
2 09e50473 Shikhar Bhushan
=======
3 39ce7446 Shikhar Bhushan
4 09e50473 Shikhar Bhushan
``ncclient`` is a Python library for NETCONF clients. It aims to offer an intuitive API that sensibly maps the XML-encoded nature of NETCONF to Python constructs and idioms, and make writing network-management scripts easier. Other key features are:
5 84e0f4f2 Shikhar Bhushan
6 84e0f4f2 Shikhar Bhushan
* Supports all operations and capabilities defined in :rfc:`4741`.
7 84e0f4f2 Shikhar Bhushan
* Request pipelining.
8 84e0f4f2 Shikhar Bhushan
* Asynchronous RPC requests.
9 84e0f4f2 Shikhar Bhushan
* Keeping XML out of the way unless really needed.
10 84e0f4f2 Shikhar Bhushan
* Extensible. New transport mappings and capabilities/operations can be easily added.
11 84e0f4f2 Shikhar Bhushan
12 09e50473 Shikhar Bhushan
It is suitable for Python 2.6+ (not Python 3 yet, though), and depends on `paramiko <http://www.lag.net/paramiko/>`_, an SSH library.
13 09e50473 Shikhar Bhushan
14 84e0f4f2 Shikhar Bhushan
The best way to introduce is of course, through a simple code example::
15 84e0f4f2 Shikhar Bhushan
16 84e0f4f2 Shikhar Bhushan
    from ncclient import manager
17 84e0f4f2 Shikhar Bhushan
18 09e50473 Shikhar Bhushan
    # use unencrypted keys from ssh-agent or ~/.ssh keys, and rely on known_hosts
19 09e50473 Shikhar Bhushan
    with manager.connect_ssh("host", username="user") as m:
20 84e0f4f2 Shikhar Bhushan
        assert(":url" in manager.server_capabilities)
21 84e0f4f2 Shikhar Bhushan
        with m.locked("running"):
22 84e0f4f2 Shikhar Bhushan
            m.copy_config(source="running", target="file:///new_checkpoint.conf")
23 84e0f4f2 Shikhar Bhushan
            m.copy_config(source="file:///old_checkpoint.conf", target="running")
24 84e0f4f2 Shikhar Bhushan
25 39ce7446 Shikhar Bhushan
Contents:
26 39ce7446 Shikhar Bhushan
27 39ce7446 Shikhar Bhushan
.. toctree::
28 84e0f4f2 Shikhar Bhushan
    
29 84e0f4f2 Shikhar Bhushan
    manager
30 09e50473 Shikhar Bhushan
    api
31 84e0f4f2 Shikhar Bhushan
    extending
32 39ce7446 Shikhar Bhushan
33 39ce7446 Shikhar Bhushan
Indices and tables
34 09e50473 Shikhar Bhushan
------------------
35 39ce7446 Shikhar Bhushan
36 39ce7446 Shikhar Bhushan
* :ref:`genindex`
37 39ce7446 Shikhar Bhushan
* :ref:`modindex`
38 39ce7446 Shikhar Bhushan
* :ref:`search`