API Documentation

• ssh.session
  • Session
    • Session.accept_forward()
    • Session.blocking_flush()
    • Session.cancel_forward()
    • Session.channel_new()
    • Session.connect()
    • Session.connector_new()
    • Session.copy_options()
    • Session.disconnect()
    • Session.dump_knownhost()
    • Session.get_cipher_in()
    • Session.get_cipher_out()
    • Session.get_clientbanner()
    • Session.get_disconnect_message()
    • Session.get_error()
    • Session.get_error_code()
    • Session.get_fd()
    • Session.get_hmac_in()
    • Session.get_hmac_out()
    • Session.get_issue_banner()
    • Session.get_kex_algo()
    • Session.get_openssh_version()
    • Session.get_poll_flags()
    • Session.get_server_publickey()
    • Session.get_serverbanner()
    • Session.get_status()
    • Session.get_version()
    • Session.gssapi_set_creds()
    • Session.is_blocking()
    • Session.is_connected()
    • Session.is_server_known()
    • Session.listen_forward()
    • Session.options_get()
    • Session.options_get_port()
    • Session.options_getopt()
    • Session.options_parse_config()
    • Session.options_set()
    • Session.options_set_gssapi_delegate_credentials()
    • Session.options_set_port()
    • Session.scp_new()
    • Session.send_debug()
    • Session.send_ignore()
    • Session.service_request()
    • Session.set_agent_channel()
    • Session.set_agent_socket()
    • Session.set_blocking()
    • Session.set_counters()
    • Session.set_fd_except()
    • Session.set_fd_toread()
    • Session.set_fd_towrite()
    • Session.set_socket()
    • Session.sftp_init()
    • Session.sftp_new()
    • Session.silent_disconnect()
    • Session.userauth_agent()
    • Session.userauth_gssapi()
    • Session.userauth_kbdint()
    • Session.userauth_kbdint_getanswer()
    • Session.userauth_kbdint_getinstruction()
    • Session.userauth_kbdint_getname()
    • Session.userauth_kbdint_getnanswers()
    • Session.userauth_kbdint_getnprompts()
    • Session.userauth_kbdint_getprompt()
    • Session.userauth_kbdint_setanswer()
    • Session.userauth_list()
    • Session.userauth_none()
    • Session.userauth_password()
    • Session.userauth_publickey()
    • Session.userauth_publickey_auto()
    • Session.userauth_try_publickey()
    • Session.write_knownhost()
    • Session.sock
• ssh.channel
  • Channel
    • Channel.accept_x11()
    • Channel.change_pty_size()
    • Channel.close()
    • Channel.get_exit_status()
    • Channel.get_session()
    • Channel.is_closed()
    • Channel.is_eof()
    • Channel.is_open()
    • Channel.open_auth_agent()
    • Channel.open_forward()
    • Channel.open_session()
    • Channel.open_x11()
    • Channel.poll()
    • Channel.poll_timeout()
    • Channel.read()
    • Channel.read_nonblocking()
    • Channel.read_timeout()
    • Channel.request_auth_agent()
    • Channel.request_env()
    • Channel.request_exec()
    • Channel.request_pty()
    • Channel.request_pty_size()
    • Channel.request_send_break()
    • Channel.request_send_signal()
    • Channel.request_sftp()
    • Channel.request_shell()
    • Channel.request_subsystem()
    • Channel.request_x11()
    • Channel.select()
    • Channel.send_eof()
    • Channel.set_blocking()
    • Channel.set_counter()
    • Channel.window_size()
    • Channel.write()
    • Channel.write_stderr()
    • Channel.closed
    • Channel.session
• ssh.exceptions
  • AdministrativelyProhibited
  • AuthenticationDenied
  • AuthenticationError
  • AuthenticationPartial
  • BaseSSHError
  • ChannelClosed
  • ChannelOpenFailure
  • CompressionError
  • ConnectFailed
  • ConnectionLost
  • Disconnected
  • EOF
  • GSSAPIError
  • GSSAPIErrorTok
  • HostAuthenticationFailed
  • HostKeyNotVerifiable
  • HostNotAllowedToConnect
  • InvalidAPIUse
  • KeyExchangeFailed
  • KeyExportError
  • KeyGenerationError
  • KeyImportError
  • MACError
  • OptionError
  • OtherError
  • ProtocolError
  • ProtocolVersionNotSupport
  • RequestFailure
  • ResourceShortage
  • SFTPError
  • SFTPHandleError
  • SSHError
  • ServiceNotAvailable
  • TooManyConnections
  • UnImplemented
  • UnknownChannelType
• ssh.options
  • Option
    • Option.value
• ssh.key
  • SSHKey
    • SSHKey.ecdsa_name()
    • SSHKey.export_privkey_file()
    • SSHKey.export_privkey_to_pubkey()
    • SSHKey.export_pubkey_base64()
    • SSHKey.is_private()
    • SSHKey.is_public()
    • SSHKey.key_type()
  • copy_cert_to_privkey()
  • generate()
  • import_cert_base64()
  • import_cert_file()
  • import_privkey_base64()
  • import_privkey_file()
  • import_pubkey_base64()
  • import_pubkey_file()
• ssh.keytypes
  • DSSCert01Key
  • DSSKey
  • ECDSAKey
  • ECDSA_P256
  • ECDSA_P256_CERT01
  • ECDSA_P384
  • ECDSA_P384_CERT01
  • ECDSA_P521
  • ECDSA_P521_CERT01
  • ED25519Key
  • ED25519_CERT01
  • KeyType
    • KeyType.value
  • RSA1Key
  • RSACert01Key
  • RSAKey
  • UnknownKey
  • key_type_from_name()
• ssh.sftp
  • SFTP
    • SFTP.canonicalize_path()
    • SFTP.chmod()
    • SFTP.chown()
    • SFTP.extension_supported()
    • SFTP.extensions_get_count()
    • SFTP.extensions_get_data()
    • SFTP.extensions_get_name()
    • SFTP.get_error()
    • SFTP.init()
    • SFTP.lstat()
    • SFTP.mkdir()
    • SFTP.open()
    • SFTP.opendir()
    • SFTP.readlink()
    • SFTP.rename()
    • SFTP.rmdir()
    • SFTP.server_version()
    • SFTP.setstat()
    • SFTP.stat()
    • SFTP.statvfs()
    • SFTP.symlink()
    • SFTP.unlink()
    • SFTP.utimes()
    • SFTP.session
• ssh.sftp_handles
  • SFTPDir
    • SFTPDir.closedir()
    • SFTPDir.eof()
    • SFTPDir.readdir()
    • SFTPDir.closed
    • SFTPDir.sftp
    • SFTPDir.sftp_session
  • SFTPFile
    • SFTPFile.async_read()
    • SFTPFile.async_read_begin()
    • SFTPFile.close()
    • SFTPFile.fstat()
    • SFTPFile.fstatvfs()
    • SFTPFile.fsync()
    • SFTPFile.read()
    • SFTPFile.rewind()
    • SFTPFile.seek()
    • SFTPFile.seek64()
    • SFTPFile.set_blocking()
    • SFTPFile.set_nonblocking()
    • SFTPFile.tell()
    • SFTPFile.tell64()
    • SFTPFile.write()
    • SFTPFile.closed
    • SFTPFile.sftp
• ssh.sftp_attributes
  • SFTPAttributes
    • SFTPAttributes.new_attrs()
    • SFTPAttributes.acl
    • SFTPAttributes.atime
    • SFTPAttributes.atime64
    • SFTPAttributes.atime_nseconds
    • SFTPAttributes.createtime
    • SFTPAttributes.createtime_nseconds
    • SFTPAttributes.extended_count
    • SFTPAttributes.extended_data
    • SFTPAttributes.extended_type
    • SFTPAttributes.flags
    • SFTPAttributes.gid
    • SFTPAttributes.group
    • SFTPAttributes.longname
    • SFTPAttributes.mtime
    • SFTPAttributes.mtime64
    • SFTPAttributes.mtime_nseconds
    • SFTPAttributes.name
    • SFTPAttributes.owner
    • SFTPAttributes.permissions
    • SFTPAttributes.sftp
    • SFTPAttributes.size
    • SFTPAttributes.type
    • SFTPAttributes.uid
• ssh.sftp_statvfs
  • SFTPStatVFS
    • SFTPStatVFS.f_bavail
    • SFTPStatVFS.f_bfree
    • SFTPStatVFS.f_blocks
    • SFTPStatVFS.f_bsize
    • SFTPStatVFS.f_favail
    • SFTPStatVFS.f_ffree
    • SFTPStatVFS.f_files
    • SFTPStatVFS.f_flag
    • SFTPStatVFS.f_frsize
    • SFTPStatVFS.f_fsid
    • SFTPStatVFS.f_namemax
    • SFTPStatVFS.sftp
• ssh.scp
  • SCP
    • SCP.accept_request()
    • SCP.close()
    • SCP.deny_request()
    • SCP.init()
    • SCP.leave_directory()
    • SCP.pull_request()
    • SCP.push_directory()
    • SCP.push_file()
    • SCP.push_file64()
    • SCP.read()
    • SCP.request_get_filename()
    • SCP.request_get_permissions()
    • SCP.request_get_size()
    • SCP.request_get_size64()
    • SCP.request_get_warning()
    • SCP.write()
    • SCP.closed
    • SCP.session
• ssh.callbacks
  • Callbacks
    • Callbacks.set_callbacks()
    • Callbacks.set_userdata()
• ssh.connector
  • Connector
    • Connector.set_in_channel()
    • Connector.set_in_fd()
    • Connector.set_out_channel()
    • Connector.set_out_fd()
    • Connector.session
  • Flag
• ssh.event
  • Event
    • Event.add_connector()
    • Event.add_fd()
    • Event.add_session()
    • Event.dopoll()
    • Event.remove_connector()
    • Event.remove_fd()
    • Event.remove_session()
    • Event.connector
    • Event.session
    • Event.socket
• ssh.utils
  • wait_socket()