Interface: CallHomeOptions<E>
Defined in: netconf/src/call-home.ts:113
Options for listenCallHome. See Call home.
Type Parameters
E
E extends readonly Extension[] = readonly Extension[]
Properties
connect?
readonly connect?: CallHomeConnectOptions<E>;Defined in: netconf/src/call-home.ts:125
Connect options for every client (extensions, timeouts, …). A device's own override these.
handshakeTimeout?
readonly handshakeTimeout?: number;Defined in: netconf/src/call-home.ts:135
Milliseconds a call may take from accept to a ready client. Default 30 000. Infinity means no limit, and values above 2,147,483,647 are shortened to it; zero, a negative number or NaN is a RangeError.
identify
readonly identify: (caller) =>
| false
| CallHomeDevice<E>
| Promise<false | CallHomeDevice<E> | undefined>
| undefined;Defined in: netconf/src/call-home.ts:123
Identify the caller by its host key or certificate fingerprint, and return the device (with SSH credentials), or undefined or false to refuse it. May be async. Throwing refuses it too.
Parameters
caller
Returns
| false | CallHomeDevice<E> | Promise<false | CallHomeDevice<E> | undefined> | undefined
logger?
readonly logger?: Logger;Defined in: netconf/src/call-home.ts:146
Where the listener and its transports log. Clients log to connect.logger, if given.
maxPending?
readonly maxPending?: number;Defined in: netconf/src/call-home.ts:127
Most calls being set up at once; more are closed straight away. Default 16.
maxQueued?
readonly maxQueued?: number;Defined in: netconf/src/call-home.ts:129
Most clients waiting to be taken from the listener; more are closed. Default 16.
signal?
readonly signal?: AbortSignal;Defined in: netconf/src/call-home.ts:144
Closes the listener when aborted.
ssh?
readonly ssh?: CallHomeSshListen;Defined in: netconf/src/call-home.ts:115
Listen for SSH call home (RFC 8071 §3.1).
tls?
readonly tls?: CallHomeTlsListen;Defined in: netconf/src/call-home.ts:117
Listen for TLS call home (RFC 8071 §4.1).
wrapConnection?
readonly wrapConnection?: (connection, caller) => Connection;Defined in: netconf/src/call-home.ts:142
Wrap each accepted call's connection before the NETCONF hello, to watch or record what passes over it (a tool's trace, say). It gets the connection and the identified caller, and returns the connection the client uses. A throw fails the call (a failed event). Default: none.