edgeport - v1.0.3
    Preparing search index...

    Interface SshConnectOptions

    Options for connect and exec.

    interface SshConnectOptions {
        algorithms?: AlgorithmPrefs;
        hostKey?: HostKeyVerifier;
        hostname: string;
        onKeyboardInteractive?: (prompts: KeyboardPrompt[]) => Promise<string[]>;
        password?: string;
        port?: number;
        privateKey?: CryptoKey | { passphrase?: string; pem: string };
        rekeyThresholdBytes?: number;
        timeoutMs?: number;
        username: string;
    }
    Index
    algorithms? hostKey? hostname onKeyboardInteractive? password? port? privateKey? rekeyThresholdBytes? timeoutMs? username
    algorithms?: AlgorithmPrefs

    Algorithm preference overrides (e.g. to force a cipher).

    hostKey?: HostKeyVerifier

    Host-key pinning hook (TOFU if omitted; the host signature is always verified).

    hostname: string

    Host to connect to.

    onKeyboardInteractive?: (prompts: KeyboardPrompt[]) => Promise<string[]>

    Callback answering keyboard-interactive prompts.

    password?: string

    Password for password authentication.

    port?: number

    TCP port (default 22).

    privateKey?: CryptoKey | { passphrase?: string; pem: string }

    Private key for publickey authentication (PKCS8 PEM or an extractable CryptoKey).

    rekeyThresholdBytes?: number

    Auto re-exchange keys after roughly this many bytes (default 1 GiB; 0 disables).

    timeoutMs?: number

    Connect timeout in milliseconds.

    username: string

    Login username.

    Settings
    Member Visibility

    On This Page
    Properties