root / docs / source / operations.rst @ fb7a450b
History | View | Annotate | Download (1.9 kB)
| 1 |
:mod:`~ncclient.operations` -- Everything RPC |
|---|---|
| 2 |
============================================= |
| 3 |
|
| 4 |
.. module:: ncclient.operations |
| 5 |
:synopsis: Everything RPC |
| 6 |
|
| 7 |
.. autoclass:: RaiseMode |
| 8 |
:members: NONE, ERRORS, ALL |
| 9 |
|
| 10 |
Base classes |
| 11 |
------------ |
| 12 |
|
| 13 |
.. autoclass:: RPC |
| 14 |
:members: DEPENDS, REPLY_CLS, _assert, _request, request, event, error, reply, raise_mode, is_async, timeout |
| 15 |
|
| 16 |
.. autoclass:: RPCReply |
| 17 |
:members: xml, ok, error, errors, _parsing_hook |
| 18 |
|
| 19 |
.. autoexception:: RPCError |
| 20 |
:show-inheritance: |
| 21 |
:members: type, severity, tag, path, message, info |
| 22 |
|
| 23 |
Operations |
| 24 |
---------- |
| 25 |
|
| 26 |
Retrieval |
| 27 |
.......... |
| 28 |
|
| 29 |
.. autoclass:: Get |
| 30 |
:members: request |
| 31 |
:show-inheritance: |
| 32 |
|
| 33 |
.. autoattribute:: REPLY_CLS |
| 34 |
|
| 35 |
.. autoclass:: GetConfig |
| 36 |
:members: request |
| 37 |
:show-inheritance: |
| 38 |
|
| 39 |
.. autoattribute:: REPLY_CLS |
| 40 |
|
| 41 |
.. autoclass:: GetReply |
| 42 |
:show-inheritance: |
| 43 |
:members: data, data_ele, data_xml |
| 44 |
|
| 45 |
.. autoclass:: Dispatch |
| 46 |
:members: request |
| 47 |
:show-inheritance: |
| 48 |
|
| 49 |
.. autoattribute:: REPLY_CLS |
| 50 |
|
| 51 |
Editing |
| 52 |
........ |
| 53 |
|
| 54 |
.. autoclass:: EditConfig |
| 55 |
:members: request |
| 56 |
:show-inheritance: |
| 57 |
|
| 58 |
.. autoclass:: DeleteConfig |
| 59 |
:members: request |
| 60 |
:show-inheritance: |
| 61 |
|
| 62 |
.. autoclass:: CopyConfig |
| 63 |
:members: request |
| 64 |
:show-inheritance: |
| 65 |
|
| 66 |
.. autoclass:: Validate |
| 67 |
:members: request |
| 68 |
:show-inheritance: |
| 69 |
|
| 70 |
.. autoclass:: Commit |
| 71 |
:members: request |
| 72 |
:show-inheritance: |
| 73 |
|
| 74 |
.. autoclass:: DiscardChanges |
| 75 |
:members: request |
| 76 |
:show-inheritance: |
| 77 |
|
| 78 |
Locking |
| 79 |
........ |
| 80 |
|
| 81 |
.. autoclass:: Lock |
| 82 |
:members: request |
| 83 |
:show-inheritance: |
| 84 |
|
| 85 |
.. autoclass:: Unlock |
| 86 |
:members: request |
| 87 |
:show-inheritance: |
| 88 |
|
| 89 |
Session |
| 90 |
........ |
| 91 |
|
| 92 |
.. autoclass:: CloseSession |
| 93 |
:members: request |
| 94 |
:show-inheritance: |
| 95 |
|
| 96 |
.. autoclass:: KillSession |
| 97 |
:members: request |
| 98 |
:show-inheritance: |
| 99 |
|
| 100 |
Exceptions |
| 101 |
---------- |
| 102 |
|
| 103 |
.. autoexception:: OperationError |
| 104 |
:show-inheritance: |
| 105 |
|
| 106 |
.. autoexception:: MissingCapabilityError |
| 107 |
:show-inheritance: |
| 108 |
|
| 109 |
.. autoexception:: TimeoutExpiredError |
| 110 |
:show-inheritance: |
| 111 |
|