Interface: ReadOptions
Defined in: netconf/src/client-content.ts:39
Options for read(): the RPC options, and any options that enabled extensions add to get and get-config.
Extends
RpcOptionsOmit<GetConfigOptions,"source"|"filter">
Properties
signal?
readonly signal?: AbortSignal;Defined in: netconf/src/messages/session.ts:100
Stop waiting for the reply. NETCONF has no way to cancel an RPC, so the server still processes it; its reply is discarded when it arrives.
Inherited from
source?
readonly source?: Datastore | "config+state";Defined in: netconf/src/client-content.ts:46
A configuration datastore, read with <get-config> (default 'running'), or 'config+state' for <get>: running configuration and state data together. The NMDA <operational> datastore is read with client.ops.nmda.getData({ datastore: 'operational' }), not here.
timeout?
readonly timeout?: number;Defined in: netconf/src/messages/session.ts:95
Milliseconds to wait for the reply. Default: the session's timeouts.rpc. Infinity waits with no limit, and values above 2,147,483,647 are shortened to it. A value that is not a number rejects with a TypeError, and zero, a negative number or NaN with a RangeError, before anything is sent.
Inherited from
withDefaults?
readonly withDefaults?: WithDefaultsMode;Defined in: netconf/src/operations/with-defaults.ts:51
How to report nodes at their default values (RFC 6243). Needs the with-defaults extension.