Skip to content

Interface: OperationSpec ​

Defined in: netconf/src/devices/device.ts:142

A profile file's operation: a vendor RPC as an XML template. See operations.

Properties ​

description? ​

ts
readonly description?: string;

Defined in: netconf/src/devices/device.ts:144

What the operation does, shown in tools such as the CLI.


mutates? ​

ts
readonly mutates?: boolean;

Defined in: netconf/src/devices/device.ts:149

Whether the operation can change device state. Left out, it counts as possibly changing state, so tools treat it as a write.


params? ​

ts
readonly params?: Readonly<Record<string, ProfileParamType>>;

Defined in: netconf/src/devices/device.ts:151

Each parameter's type, by name.


request? ​

ts
readonly request?: string;

Defined in: netconf/src/devices/device.ts:156

The operation element as XML. may be a whole text node or attribute value. Required, except in a profile that extends another and only changes other fields.


result? ​

ts
readonly result?: object;

Defined in: netconf/src/devices/device.ts:158

What to return from the reply. Left out, the whole reply.

as? ​

ts
readonly as?: "object" | "element" | "text" | "reply";

Default: 'element' with a path, 'reply' without.

path? ​

ts
readonly path?: string;

/-separated local names, relative to <rpc-reply>.

Released under the MIT Licence.