Statistics
| Branch: | Tag: | Revision:

root / docs / source / operations.rst @ 4bc8021f

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* The operation classes are currently undocumented. See documentation of
24
`~ncclient.manager.Manager` for methods that utilize the operation classes. The parameters accepted
25
by :meth:`~RPC.request` for these classes are the same.
26

    
27
Replies with data
28
-----------------
29

    
30
.. autoclass:: GetReply
31
    :show-inheritance:
32
    :members: data, data_ele, data_xml
33

    
34
Exceptions
35
----------
36

    
37
.. autoexception:: OperationError
38
    :show-inheritance:
39

    
40
.. autoexception:: MissingCapabilityError
41
    :show-inheritance:
42

    
43
.. autoexception:: TimeoutExpiredError
44
    :show-inheritance: