Skip to content

Interface: SshEndpoint ​

Defined in: netconf/src/transport/ssh.ts:30

One SSH server to log in to: the NETCONF server itself, or a jump host on the way.

Extended by ​

Properties ​

agent? ​

ts
readonly agent?: string;

Defined in: netconf/src/transport/ssh.ts:44

Path of an ssh-agent socket, e.g. process.env.SSH_AUTH_SOCK.


algorithms? ​

ts
readonly algorithms?: SshAlgorithms;

Defined in: netconf/src/transport/ssh.ts:66

Change the algorithm lists offered. The defaults, DEFAULT_SSH_ALGORITHMS, are ssh2's own minus every legacy algorithm (SHA-1 host keys and MACs, SHA-1 key exchange, CBC ciphers, DSA). Per category, a list replaces the default; { append, prepend, remove } edits the default; an omitted category keeps it. Whenever the result offers a legacy algorithm, each connection logs a warning naming it.


host ​

ts
readonly host: string;

Defined in: netconf/src/transport/ssh.ts:32

The host name or address to connect to.


hostKey ​

ts
readonly hostKey: HostKeyPolicy;

Defined in: netconf/src/transport/ssh.ts:57

Required. How to verify this server's host key: a SHA256: fingerprint, a public key line, a list of either, a verifier such as knownHostsFile(), or 'insecure-accept-any' to skip verification (logged as a warning).


keepaliveCountMax? ​

ts
readonly keepaliveCountMax?: number;

Defined in: netconf/src/transport/ssh.ts:70

Unanswered keepalives before the connection is considered dead. Default 3.


keepaliveInterval? ​

ts
readonly keepaliveInterval?: number;

Defined in: netconf/src/transport/ssh.ts:68

Milliseconds between SSH keepalives. Default 30 000; 0 disables.


keyboardInteractive? ​

ts
readonly keyboardInteractive?: KeyboardInteractiveHandler;

Defined in: netconf/src/transport/ssh.ts:51

Answer keyboard-interactive challenges (RFC 4256), as TACACS+ and RADIUS set-ups often require. Without it, a password answers a challenge whose prompts are all hidden; a prompt that would echo is never given the password. See KeyboardInteractiveHandler.


passphrase? ​

ts
readonly passphrase?: Secret<string>;

Defined in: netconf/src/transport/ssh.ts:42

The passphrase that decrypts privateKey.


password? ​

ts
readonly password?: Secret<string>;

Defined in: netconf/src/transport/ssh.ts:38

The password, for password authentication (and hidden keyboard-interactive prompts).


port? ​

ts
readonly port?: number;

Defined in: netconf/src/transport/ssh.ts:34

Default 830 for the NETCONF server, 22 for a jump host.


privateKey? ​

ts
readonly privateKey?: Secret<string | Buffer<ArrayBufferLike>>;

Defined in: netconf/src/transport/ssh.ts:40

A private key in OpenSSH or PEM format.


username ​

ts
readonly username: string;

Defined in: netconf/src/transport/ssh.ts:36

The user to log in as.

Released under the MIT Licence.