root / docs / source / operations.rst @ e3b66e4b
History | View | Annotate | Download (1.1 kB)
1 |
:mod:`~ncclient.operations` -- Everything RPC |
---|---|
2 |
============================================= |
3 |
|
4 |
Base classes |
5 |
------------ |
6 |
|
7 |
.. module:: ncclient.operations |
8 |
:synopsis: Everything RPC |
9 |
|
10 |
.. autoclass:: RPC(session[, async=False, timeout=None, raise_mode="none"]) |
11 |
:members: DEPENDS, REPLY_CLS, _assert, _request, request, event, error, reply, raise_mode, is_async, timeout |
12 |
|
13 |
.. autoclass:: RPCReply |
14 |
:members: xml, ok, error, errors |
15 |
|
16 |
.. autoexception:: RPCError |
17 |
:show-inheritance: |
18 |
:members: type, severity, tag, path, message, info |
19 |
|
20 |
Operations |
21 |
---------- |
22 |
|
23 |
*TODO* |
24 |
|
25 |
The operation classes are currently undocumented. See documentation of `~ncclient.manager.Manager` |
26 |
for methods that utilize the operation classes. The parameters accepted by :meth:`~RPC.request` for |
27 |
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: |