Revision c15671aa docs/source/operations.rst
| b/docs/source/operations.rst | ||
|---|---|---|
| 1 | 1 |
:mod:`~ncclient.operations` -- Everything RPC |
| 2 | 2 |
============================================= |
| 3 | 3 |
|
| 4 |
|
|
| 5 | 4 |
.. module:: ncclient.operations |
| 6 | 5 |
:synopsis: Everything RPC |
| 7 | 6 |
|
| ... | ... | |
| 11 | 10 |
Base classes |
| 12 | 11 |
------------ |
| 13 | 12 |
|
| 14 |
.. autoclass:: RPC(session, async=False, timeout=None, raise_mode="none")
|
|
| 13 |
.. autoclass:: RPC |
|
| 15 | 14 |
:members: DEPENDS, REPLY_CLS, _assert, _request, request, event, error, reply, raise_mode, is_async, timeout |
| 16 | 15 |
|
| 17 | 16 |
.. autoclass:: RPCReply |
| ... | ... | |
| 24 | 23 |
Operations |
| 25 | 24 |
---------- |
| 26 | 25 |
|
| 27 |
The operation classes are currently undocumented. See documentation of :class:`~ncclient.manager.Manager` for methods that utilize the operation classes. The parameters accepted by :meth:`~RPC.request` for these classes are the same. |
|
| 26 |
Retrieval |
|
| 27 |
.......... |
|
| 28 |
|
|
| 29 |
.. autoclass:: Get |
|
| 30 |
:members: request |
|
| 31 |
:show-inheritance: |
|
| 32 |
|
|
| 33 |
.. autoattribute:: REPLY_CLS |
|
| 28 | 34 |
|
| 29 |
Replies with data |
|
| 30 |
----------------- |
|
| 35 |
.. autoclass:: GetConfig |
|
| 36 |
:members: request |
|
| 37 |
:show-inheritance: |
|
| 38 |
|
|
| 39 |
.. autoattribute:: REPLY_CLS |
|
| 31 | 40 |
|
| 32 | 41 |
.. autoclass:: GetReply |
| 33 | 42 |
:show-inheritance: |
| 34 | 43 |
:members: data, data_ele, data_xml |
| 35 | 44 |
|
| 45 |
Editing |
|
| 46 |
........ |
|
| 47 |
|
|
| 48 |
.. autoclass:: EditConfig |
|
| 49 |
:members: request |
|
| 50 |
:show-inheritance: |
|
| 51 |
|
|
| 52 |
.. autoclass:: DeleteConfig |
|
| 53 |
:members: request |
|
| 54 |
:show-inheritance: |
|
| 55 |
|
|
| 56 |
.. autoclass:: CopyConfig |
|
| 57 |
:members: request |
|
| 58 |
:show-inheritance: |
|
| 59 |
|
|
| 60 |
.. autoclass:: Validate |
|
| 61 |
:members: request |
|
| 62 |
:show-inheritance: |
|
| 63 |
|
|
| 64 |
.. autoclass:: Commit |
|
| 65 |
:members: request |
|
| 66 |
:show-inheritance: |
|
| 67 |
|
|
| 68 |
.. autoclass:: DiscardChanges |
|
| 69 |
:members: request |
|
| 70 |
:show-inheritance: |
|
| 71 |
|
|
| 72 |
Locking |
|
| 73 |
........ |
|
| 74 |
|
|
| 75 |
.. autoclass:: Lock |
|
| 76 |
:members: request |
|
| 77 |
:show-inheritance: |
|
| 78 |
|
|
| 79 |
.. autoclass:: Unlock |
|
| 80 |
:members: request |
|
| 81 |
:show-inheritance: |
|
| 82 |
|
|
| 83 |
Session |
|
| 84 |
........ |
|
| 85 |
|
|
| 86 |
.. autoclass:: CloseSession |
|
| 87 |
:members: request |
|
| 88 |
:show-inheritance: |
|
| 89 |
|
|
| 90 |
.. autoclass:: KillSession |
|
| 91 |
:members: request |
|
| 92 |
:show-inheritance: |
|
| 93 |
|
|
| 36 | 94 |
Exceptions |
| 37 | 95 |
---------- |
| 38 | 96 |
|
Also available in: Unified diff