Skip to content

Interface: SubscriptionsOps ​

Defined in: netconf/src/operations/subscriptions/extension.ts:28

What client.ops.subscriptions holds.

Properties ​

active ​

ts
readonly active: ReadonlyMap<number, DynamicSubscription>;

Defined in: netconf/src/operations/subscriptions/extension.ts:43

The subscriptions open on this session, by id.

Methods ​

delete() ​

ts
delete(id, options?): Promise<void>;

Defined in: netconf/src/operations/subscriptions/extension.ts:37

<delete-subscription> by id. For a subscription this session holds, this is its delete().

Parameters ​

id ​

number

options? ​

RpcOptions

Returns ​

Promise<void>


establish() ​

ts
establish(options): Promise<DynamicSubscription>;

Defined in: netconf/src/operations/subscriptions/extension.ts:30

Send <establish-subscription> and return the subscription to read from.

Parameters ​

options ​

EstablishOptions

Returns ​

Promise<DynamicSubscription>


kill() ​

ts
kill(id, options?): Promise<void>;

Defined in: netconf/src/operations/subscriptions/extension.ts:41

<kill-subscription>: end any session's dynamic subscription (an administrator's operation).

Parameters ​

id ​

number

options? ​

RpcOptions

Returns ​

Promise<void>


modify() ​

ts
modify(id, options?): Promise<void>;

Defined in: netconf/src/operations/subscriptions/extension.ts:35

<modify-subscription> by id. For a subscription this session holds, this is its modify(); otherwise give datastore for a datastore subscription.

Parameters ​

id ​

number

options? ​

ModifyOptions & object

Returns ​

Promise<void>


resync() ​

ts
resync(id, options?): Promise<void>;

Defined in: netconf/src/operations/subscriptions/extension.ts:39

YANG-Push <resync-subscription> by id.

Parameters ​

id ​

number

options? ​

RpcOptions

Returns ​

Promise<void>

Released under the MIT Licence.