Skip to content

Interface: Augment ​

Defined in: netconf/src/operations/extension.ts:192

Extra parameters an extension adds to a base operation, like a YANG augment of an RPC's input.

Properties ​

operation ​

ts
readonly operation: string;

Defined in: netconf/src/operations/extension.ts:194

The base operation's RPC name, such as get-config.


params ​

ts
readonly params: readonly ParamDescriptor[];

Defined in: netconf/src/operations/extension.ts:196

The parameters it adds, described as for the base operation's own.

Methods ​

apply() ​

ts
apply(
   request, 
   args, 
   ctx
): OperationRequest;

Defined in: netconf/src/operations/extension.ts:201

Add the parameters to a built request. Called only when at least one of params was given. May throw (for example CapabilityError) before anything is sent.

Parameters ​

request ​

OperationRequest

args ​

RequestArgs

ctx ​

ExtensionContext

Returns ​

OperationRequest

Released under the MIT Licence.