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

    Interface FtpTransportOptionsExperimental

    Options of FtpTransport.

    interface FtpTransportOptions {
        allowInsecure?: boolean;
        certificateChanged?: (change: CertificateChange) => Promise<void>;
        confirmCertificate?: (
            info: CertificateInfo,
        ) => Promise<CertificateDecision>;
        expectedCertificate?: string;
        host: string;
        ipFamily?: 4 | 6;
        listingLimit?: number;
        logger?: Logger;
        platform?: Platform;
        port: number;
        protocol: "ftps" | "ftps-implicit" | "ftp";
        remoteRoot: string;
        resolver?: NameResolver;
        secret: (kind: SecretKind) => Promise<string>;
        serverName?: string;
        signedIn?: () => Promise<void>;
        timeoutMs: number;
        tls?: {
            caFile?: string;
            minVersion?: "TLSv1.2" | "TLSv1.3";
            servername?: string;
            trustedCertificate?: TrustedCertificate;
        };
        username?: string;
    }
    Index
    allowInsecure? certificateChanged? confirmCertificate? expectedCertificate? host ipFamily? listingLimit? logger? platform? port protocol remoteRoot resolver? secret serverName? signedIn? timeoutMs tls? username?
    allowInsecure?: boolean

    Required for plain FTP, which sends the password in clear text.

    certificateChanged?: (change: CertificateChange) => Promise<void>

    Saves what a certificate decision changed: the host, the name to check the certificate as, or the trusted certificate.

    confirmCertificate?: (info: CertificateInfo) => Promise<CertificateDecision>

    Asks what to do about a certificate that did not verify; absent when nobody can be asked, and the certificate is then refused.

    expectedCertificate?: string

    A certificate fingerprint to accept when verification fails, for unattended runs (--trust-certificate).

    host: string

    The server's host name or address.

    ipFamily?: 4 | 6

    Connect over IPv4 or IPv6 only.

    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 control port: usually 21, or 990 for implicit TLS.

    protocol: "ftps" | "ftps-implicit" | "ftp"

    FTPS with explicit TLS, FTPS with implicit TLS, or plain FTP.

    remoteRoot: string

    The site root on the server, an absolute path.

    resolver?: NameResolver

    Looks names up to suggest one the certificate covers. Default: the system resolver.

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

    Supplies the password once the TLS certificate 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.

    tls?: {
        caFile?: string;
        minVersion?: "TLSv1.2" | "TLSv1.3";
        servername?: string;
        trustedCertificate?: TrustedCertificate;
    }

    Extra certificate authorities, the name to verify, the lowest TLS version, and a certificate a person chose to trust.

    username?: string

    The account to sign in as. Default: anonymous.

    Settings
    Member Visibility

    On This Page
    Properties