Skip to content

Interface: CallHomeDevice<E> ​

Defined in: netconf/src/call-home.ts:63

What identify returns for a device it knows.

Type Parameters ​

E ​

E extends readonly Extension[] = readonly Extension[]

Properties ​

agent? ​

ts
readonly agent?: string;

Defined in: netconf/src/call-home.ts:75

Path of an ssh-agent socket.


connect? ​

ts
readonly connect?: CallHomeConnectOptions<E>;

Defined in: netconf/src/call-home.ts:79

Connect options for this device (a profile, say), over the listener's connect.


keyboardInteractive? ​

ts
readonly keyboardInteractive?: KeyboardInteractiveHandler;

Defined in: netconf/src/call-home.ts:77

Answer keyboard-interactive challenges, as for ssh().


name? ​

ts
readonly name?: string;

Defined in: netconf/src/call-home.ts:65

Your name for the device, carried through to the call.


passphrase? ​

ts
readonly passphrase?: Secret<string>;

Defined in: netconf/src/call-home.ts:73

SSH: the passphrase that decrypts privateKey.


password? ​

ts
readonly password?: Secret<string>;

Defined in: netconf/src/call-home.ts:69

SSH: the password to log in with.


privateKey? ​

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

Defined in: netconf/src/call-home.ts:71

SSH: a private key in OpenSSH or PEM format.


username? ​

ts
readonly username?: string;

Defined in: netconf/src/call-home.ts:67

SSH: the user to log in as. Required for SSH calls.

Released under the MIT Licence.