Interface: DatastoreSubscriptionOptions
Defined in: netconf/src/operations/subscriptions/types.ts:46
Subscribe to a datastore's updates (RFC 8641 YANG-Push): periodic or on-change.
Extends
CommonOptions
Properties
datastore
readonly datastore: DatastoreRef;Defined in: netconf/src/operations/subscriptions/types.ts:48
An NMDA datastore: running, operational, … or { name, namespace }.
filter?
readonly filter?: Filter;Defined in: netconf/src/operations/subscriptions/types.ts:12
A subtree filter, or an XPath filter. Checked against the server's subtree / xpath features.
Inherited from
CommonOptions.filter
onChange?
readonly onChange?: OnChangeOptions;Defined in: netconf/src/operations/subscriptions/types.ts:52
On-change updates (needs the on-change feature).
periodic?
readonly periodic?: PeriodicOptions;Defined in: netconf/src/operations/subscriptions/types.ts:50
Periodic updates. Give this or onChange.
queueSize?
readonly queueSize?: number;Defined in: netconf/src/operations/subscriptions/types.ts:16
Most updates held for a slow reader before the subscription fails. Default 1000.
Inherited from
CommonOptions.queueSize
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
CommonOptions.signal
stopTime?
readonly stopTime?: string | Date;Defined in: netconf/src/operations/subscriptions/types.ts:14
End the subscription at this time (RFC 3339 string or Date).
Inherited from
CommonOptions.stopTime
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
CommonOptions.timeout