root / docs / source / operations.rst @ 19e7c7f6
History | View | Annotate | Download (1.2 kB)
| 1 |
:mod:`~ncclient.operations` -- Everything RPC |
|---|---|
| 2 |
============================================= |
| 3 |
|
| 4 |
|
| 5 |
.. module:: ncclient.operations |
| 6 |
:synopsis: Everything RPC |
| 7 |
|
| 8 |
.. autoclass:: RaiseMode |
| 9 |
:members: NONE, ERRORS, ALL |
| 10 |
|
| 11 |
Base classes |
| 12 |
------------ |
| 13 |
|
| 14 |
.. autoclass:: RPC(session, async=False, timeout=None, raise_mode="none") |
| 15 |
:members: DEPENDS, REPLY_CLS, _assert, _request, request, event, error, reply, raise_mode, is_async, timeout |
| 16 |
|
| 17 |
.. autoclass:: RPCReply |
| 18 |
:members: xml, ok, error, errors, _parsing_hook |
| 19 |
|
| 20 |
.. autoexception:: RPCError |
| 21 |
:show-inheritance: |
| 22 |
:members: type, severity, tag, path, message, info |
| 23 |
|
| 24 |
Operations |
| 25 |
---------- |
| 26 |
|
| 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. |
| 28 |
|
| 29 |
Replies with data |
| 30 |
----------------- |
| 31 |
|
| 32 |
.. autoclass:: GetReply |
| 33 |
:show-inheritance: |
| 34 |
:members: data, data_ele, data_xml |
| 35 |
|
| 36 |
Exceptions |
| 37 |
---------- |
| 38 |
|
| 39 |
.. autoexception:: OperationError |
| 40 |
:show-inheritance: |
| 41 |
|
| 42 |
.. autoexception:: MissingCapabilityError |
| 43 |
:show-inheritance: |
| 44 |
|
| 45 |
.. autoexception:: TimeoutExpiredError |
| 46 |
:show-inheritance: |