root / docs / source / userdoc / transport.rst @ 216bb34c
History | View | Annotate | Download (1.1 kB)
1 |
:mod:`transport` module |
---|---|
2 |
======================== |
3 |
|
4 |
.. module:: ncclient.transport |
5 |
:synopsis: Transport protocol layer |
6 |
.. moduleauthor:: Shikhar Bhushan <shikhar@schmizz.net> |
7 |
|
8 |
Base types |
9 |
----------- |
10 |
|
11 |
.. autoclass:: Session |
12 |
:members: add_listener, remove_listener, get_listener_instance, client_capabilities, server_capabilities, connected, id, can_pipeline |
13 |
|
14 |
.. autoclass:: SessionListener |
15 |
:members: callback, errback |
16 |
|
17 |
SSH session implementation |
18 |
-------------------------- |
19 |
|
20 |
.. automethod:: ssh.default_unknown_host_cb |
21 |
|
22 |
.. autoclass:: SSHSession |
23 |
:show-inheritance: |
24 |
:members: load_known_hosts, close, transport |
25 |
|
26 |
.. automethod:: connect(host[, port=830, timeout=None, username=None, password=None, key_filename=None, allow_agent=True, look_for_keys=True]) |
27 |
|
28 |
Errors |
29 |
------ |
30 |
|
31 |
.. autoexception:: TransportError |
32 |
:show-inheritance: |
33 |
|
34 |
.. autoexception:: SessionCloseError |
35 |
:show-inheritance: |
36 |
|
37 |
.. autoexception:: SSHError |
38 |
:show-inheritance: |
39 |
|
40 |
.. autoexception:: AuthenticationError |
41 |
:show-inheritance: |
42 |
|
43 |
.. autoexception:: SSHUnknownHostError |
44 |
:show-inheritance: |
45 |
|