Properties
Whether to automatically disconnect the SSH connection when the last channel is closed.
Client version string sent during SSH handshake.
Enable zlib compression. When true, the client offers zlib@openssh.com,zlib,none; when false, only none.
Hostname for TCP connections. Used with default KtorTcpTransport. Ignored if transportFactory is set explicitly.
Host key verifier.
IP version preference for the default TCP transport. Ignored if transportFactory is set explicitly.
Quantize outbound keystroke packet timing to this interval (milliseconds) to mask inter-keystroke timing patterns. Requires a PTY session and server support for ping@openssh.com. Set to 0 to disable.
Port for TCP connections. Used with default KtorTcpTransport. Ignored if transportFactory is set explicitly.
When true, prefer password over keyboard-interactive when both are available. By default, keyboard-interactive is preferred.
Re-key after this many wire bytes (sent or received). Default: 1 GB.
Re-key after this many milliseconds. Default: 1 hour.
Receive window, in bytes, for shells, commands and manually opened subsystems. SFTP channels opened by SshClient.openSftp use sftpWindowSize. A channel moves at most one window of data per network round trip, so a larger window speeds up bulk transfers on slower links. Each channel may buffer up to this much unread data. Default: 2 MiB. Reduce this for sessions with tighter memory limits.
Receive window, in bytes, for channels opened by SshClient.openSftp. Default: 8 MiB, to sustain bulk downloads on higher-latency links. Each channel may buffer up to this much unread data; reduce this for tighter memory limits.
Custom transport factory. If not set, uses KtorTcpTransportFactory with host, port, and ipVersion.