Skip to content

Interface: ConfigureOptions ​

Defined in: netconf/src/client-content.ts:73

Options for configure(): the workflow steps (editTarget, lock, validate, commit), which override the device profile's, plus the per-call options. See How changes are applied.

Extends ​

Properties ​

commit? ​

ts
readonly commit?: boolean;

Defined in: netconf/src/content/configure.ts:20

<commit> after editing (candidate only).

Inherited from ​

Workflow.commit


confirmed? ​

ts
readonly confirmed?: true | ConfirmedCommitOptions;

Defined in: netconf/src/client-content.ts:87

Apply with a confirmed commit (RFC 6241 §8.4) through withCandidate(): configure() then resolves with the PendingCommit to confirm() or cancel(). Needs the candidate workflow with commit; anything else is refused before sending. timeout is in seconds; persist needs :confirmed-commit:1.1.


editTarget? ​

ts
readonly editTarget?: "running" | "candidate";

Defined in: netconf/src/content/configure.ts:14

Datastore to edit.

Inherited from ​

Workflow.editTarget


json? ​

ts
readonly json?: JsonOptions;

Defined in: netconf/src/client-content.ts:89

Options for the transaction's JSON edits (txn.merge(json), txn.replace(json)); see JsonOptions.


lock? ​

ts
readonly lock?: boolean;

Defined in: netconf/src/content/configure.ts:16

Lock the target while editing.

Inherited from ​

Workflow.lock


onStep? ​

ts
readonly onStep?: (step) => void;

Defined in: netconf/src/client-content.ts:80

Called as each workflow request succeeds (lock, discard-changes, edit-config, validate, commit, unlock), including cleanup after a failure. A failed request isn't reported: the rejection says where it failed. A listener that throws is logged and ignored.

Parameters ​

step ​

ConfigureStep

Returns ​

void


signal? ​

ts
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 ​

RpcOptions.signal


timeout? ​

ts
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 ​

RpcOptions.timeout


validate? ​

ts
readonly validate?: boolean;

Defined in: netconf/src/content/configure.ts:18

<validate> before committing (candidate only).

Inherited from ​

Workflow.validate

Released under the MIT Licence.