Interface: SubscriptionOptions
Defined in: netconf/src/operations/notifications.ts:81
Options for client.ops.notifications.createSubscription(): what to subscribe to, plus RPC and queue options.
Extends
Properties
filter?
readonly filter?: Filter;Defined in: netconf/src/operations/notifications.ts:73
A subtree filter, or an XPath filter (needs :xpath).
Inherited from
CreateSubscriptionOptions.filter
queueSize?
readonly queueSize?: number;Defined in: netconf/src/operations/notifications.ts:83
Most notifications held for a slow reader before the subscription fails. Default 1000.
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
startTime?
readonly startTime?: string | Date;Defined in: netconf/src/operations/notifications.ts:75
Replay logged notifications from this time (RFC 3339 string or Date).
Inherited from
CreateSubscriptionOptions.startTime
stopTime?
readonly stopTime?: string | Date;Defined in: netconf/src/operations/notifications.ts:77
End the subscription at this time. Needs startTime, and must be later than it.
Inherited from
CreateSubscriptionOptions.stopTime
stream?
readonly stream?: string;Defined in: netconf/src/operations/notifications.ts:71
The stream to receive. The server default is NETCONF.
Inherited from
CreateSubscriptionOptions.stream
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.