cmd-sync-servers - v1.0.0
    Preparing search index...

    Interface SftpTransportOptionsExperimental

    Options of SftpTransport.

    interface SftpTransportOptions {
        agent?: string;
        auth: { keyPath?: string; method: "password" | "key" | "agent" };
        env?: Readonly<Record<string, string | undefined>>;
        host: string;
        hostKeys: HostKeyPolicy;
        ipFamily?: 4 | 6;
        legacyAlgorithms?: boolean;
        listingLimit?: number;
        logger?: Logger;
        platform?: Platform;
        port: number;
        remoteRoot: string;
        secret: (kind: SecretKind) => Promise<string>;
        serverName?: string;
        signedIn?: () => Promise<void>;
        timeoutMs: number;
        username: string;
    }
    Index
    agent? auth env? host hostKeys ipFamily? legacyAlgorithms? listingLimit? logger? platform? port remoteRoot secret serverName? signedIn? timeoutMs username
    agent?: string

    The SSH agent: a socket path, a Windows pipe, or pageant. Default: SSH_AUTH_SOCK, then the Windows OpenSSH agent.

    auth: { keyPath?: string; method: "password" | "key" | "agent" }

    How to sign in; keyPath names the private key file of the key method.

    env?: Readonly<Record<string, string | undefined>>

    Where SSH_AUTH_SOCK is read. Default: the process environment.

    host: string

    The server's host name or address.

    hostKeys: HostKeyPolicy

    The pinned host key, and how to confirm and pin a new one.

    ipFamily?: 4 | 6

    Connect over IPv4 or IPv6 only.

    legacyAlgorithms?: boolean

    Also offer older algorithms, with a warning on every connection.

    listingLimit?: number

    The most entries one folder listing may hold.

    logger?: Logger

    Where protocol traces and warnings go.

    platform?: Platform

    The platform whose name rules apply to listed names. Default: this one.

    port: number

    The SSH port, usually 22.

    remoteRoot: string

    The site root on the server, an absolute path.

    secret: (kind: SecretKind) => Promise<string>

    Supplies the password or key passphrase, only once the host key has been verified.

    serverName?: string

    The server's name, for messages that suggest a command.

    signedIn?: () => Promise<void>

    Called once the server has accepted the sign-in.

    timeoutMs: number

    How long a connection or an operation may wait, in milliseconds.

    username: string

    The account to sign in as.

    Settings
    Member Visibility

    On This Page
    Properties