Interface: SshSessionOptions
Connection, key, host-verification, and command settings for one SSH machine.
Properties
Section titled “Properties”connectTimeoutMs
Section titled “connectTimeoutMs”connectTimeoutMs:
number
Connection timeout in milliseconds.
host:
string
Databricks Sandbox gateway hostname.
knownHost?
Section titled “knownHost?”
optionalknownHost?:string
Previously trusted SHA-256 host-key fingerprint.
knownHostsPath
Section titled “knownHostsPath”knownHostsPath:
string
Dedicated OpenSSH known-host file for this workspace, user, and gateway.
port:
number
SSH gateway port.
privateKey
Section titled “privateKey”privateKey:
string
In-memory private key used by ssh2 forwarding.
privateKeyPath
Section titled “privateKeyPath”privateKeyPath:
string
Private key file used by native OpenSSH commands.
rememberHost?
Section titled “rememberHost?”
optionalrememberHost?: (fingerprint,key) =>Promise<void>
Persists the first accepted host key after a successful connection.
Parameters
Section titled “Parameters”fingerprint
Section titled “fingerprint”string
Buffer
Returns
Section titled “Returns”Promise<void>
resolvePublicAddresses?
Section titled “resolvePublicAddresses?”
optionalresolvePublicAddresses?: (host) =>Promise<string[]>
Resolves public fallback addresses for a service-direct gateway.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string[]>
sshCommand?
Section titled “sshCommand?”
optionalsshCommand?:string
Native OpenSSH executable. Defaults to ssh.
username
Section titled “username”username:
string
SSH username accepted by the Sandbox gateway.