code.grnet.gr Git - ncclient/blob - docs/source/transport.rst

   1 :mod:`~ncclient.transport` -- Transport / Session layer
   2 =======================================================
   3
   4 .. module:: ncclient.transport
   5     :synopsis: Transport / Session layer
   6
   7 Base types
   8 -----------
   9
  10 .. autoclass:: Session
  11     :members: add_listener, remove_listener, get_listener_instance, client_capabilities, server_capabilities, connected, id
  12
  13 .. autoclass:: SessionListener
  14     :members: callback, errback
  15
  16 SSH session implementation
  17 --------------------------
  18
  19 .. automethod:: ssh.default_unknown_host_cb
  20
  21 .. autoclass:: SSHSession
  22     :show-inheritance:
  23     :members: load_known_hosts, close, transport
  24
  25     .. automethod:: connect(host[, port=830, timeout=None, unknown_host_cb=default_unknown_host_cb, username=None, password=None, key_filename=None, allow_agent=True, look_for_keys=True])
  26
  27 Errors
  28 ------
  29
  30 .. autoexception:: TransportError
  31     :show-inheritance:
  32
  33 .. autoexception:: SessionCloseError
  34     :show-inheritance:
  35
  36 .. autoexception:: SSHError
  37     :show-inheritance:
  38
  39 .. autoexception:: AuthenticationError
  40     :show-inheritance:
  41
  42 .. autoexception:: SSHUnknownHostError
  43     :show-inheritance: