root / docs / source / operations.rst @ 4bc8021f
History | View | Annotate | Download (1.1 kB)
| 1 | 4bc8021f | Shikhar Bhushan | :mod:`~ncclient.operations` -- Everything RPC |
|---|---|---|---|
| 2 | 4bc8021f | Shikhar Bhushan | ============================================= |
| 3 | 4bc8021f | Shikhar Bhushan | |
| 4 | 4bc8021f | Shikhar Bhushan | Base classes |
| 5 | 4bc8021f | Shikhar Bhushan | ------------ |
| 6 | 4bc8021f | Shikhar Bhushan | |
| 7 | 4bc8021f | Shikhar Bhushan | .. module:: ncclient.operations |
| 8 | 4bc8021f | Shikhar Bhushan | :synopsis: Everything RPC |
| 9 | 4bc8021f | Shikhar Bhushan | |
| 10 | 4bc8021f | Shikhar Bhushan | .. autoclass:: RPC(session[, async=False, timeout=None, raise_mode="none"]) |
| 11 | 4bc8021f | Shikhar Bhushan | :members: DEPENDS, REPLY_CLS, _assert, _request, request, event, error, reply, raise_mode, is_async, timeout |
| 12 | 4bc8021f | Shikhar Bhushan | |
| 13 | 4bc8021f | Shikhar Bhushan | .. autoclass:: RPCReply |
| 14 | 4bc8021f | Shikhar Bhushan | :members: xml, ok, error, errors |
| 15 | 4bc8021f | Shikhar Bhushan | |
| 16 | 4bc8021f | Shikhar Bhushan | .. autoexception:: RPCError |
| 17 | 4bc8021f | Shikhar Bhushan | :show-inheritance: |
| 18 | 4bc8021f | Shikhar Bhushan | :members: type, severity, tag, path, message, info |
| 19 | 4bc8021f | Shikhar Bhushan | |
| 20 | 4bc8021f | Shikhar Bhushan | Operations |
| 21 | 4bc8021f | Shikhar Bhushan | ---------- |
| 22 | 4bc8021f | Shikhar Bhushan | |
| 23 | 4bc8021f | Shikhar Bhushan | *TODO* The operation classes are currently undocumented. See documentation of |
| 24 | 4bc8021f | Shikhar Bhushan | `~ncclient.manager.Manager` for methods that utilize the operation classes. The parameters accepted |
| 25 | 4bc8021f | Shikhar Bhushan | by :meth:`~RPC.request` for these classes are the same. |
| 26 | 4bc8021f | Shikhar Bhushan | |
| 27 | 4bc8021f | Shikhar Bhushan | Replies with data |
| 28 | 4bc8021f | Shikhar Bhushan | ----------------- |
| 29 | 4bc8021f | Shikhar Bhushan | |
| 30 | 4bc8021f | Shikhar Bhushan | .. autoclass:: GetReply |
| 31 | 4bc8021f | Shikhar Bhushan | :show-inheritance: |
| 32 | 4bc8021f | Shikhar Bhushan | :members: data, data_ele, data_xml |
| 33 | 4bc8021f | Shikhar Bhushan | |
| 34 | 4bc8021f | Shikhar Bhushan | Exceptions |
| 35 | 4bc8021f | Shikhar Bhushan | ---------- |
| 36 | 4bc8021f | Shikhar Bhushan | |
| 37 | 4bc8021f | Shikhar Bhushan | .. autoexception:: OperationError |
| 38 | 4bc8021f | Shikhar Bhushan | :show-inheritance: |
| 39 | 4bc8021f | Shikhar Bhushan | |
| 40 | 4bc8021f | Shikhar Bhushan | .. autoexception:: MissingCapabilityError |
| 41 | 4bc8021f | Shikhar Bhushan | :show-inheritance: |
| 42 | 4bc8021f | Shikhar Bhushan | |
| 43 | 4bc8021f | Shikhar Bhushan | .. autoexception:: TimeoutExpiredError |
| 44 | 4bc8021f | Shikhar Bhushan | :show-inheritance: |