Interface: OperationDescriptor
Defined in: netconf/src/operations/extension.ts:85
One operation, described as plain data (no functions), so tools can build commands from it.
Most operations are RPCs. An extension's read operation is a content method that reads state (with a <get>, say) and decodes it, such as monitoring's sessions(): it has no RPC element of its own, never changes anything, and runs through the extension's content method, so client.ops.run() resolves with the decoded result (plain data) instead of an RpcReply.
Properties
description
readonly description: string;Defined in: netconf/src/operations/extension.ts:109
A one-line description, for help text.
device?
readonly device?: string;Defined in: netconf/src/operations/extension.ts:119
The device profile that provides it, by profile id; absent unless it is a profile operation.
extension?
readonly extension?: string;Defined in: netconf/src/operations/extension.ts:117
The extension that provides it; absent for base operations.
kind?
readonly kind?: "rpc" | "read";Defined in: netconf/src/operations/extension.ts:95
'rpc' (the default when absent): an RPC, built from the arguments and sent. 'read': an extension method that reads and decodes state.
method
readonly method: string;Defined in: netconf/src/operations/extension.ts:107
The method that runs it, relative to its layer: on client.ops for a base operation (close-session's is the client's own close()), on client.ops.<id> for an extension's RPC, on client.content.<id> for an extension's read (a read is always run through it), and call (on client.ops.device) for a device profile operation.
mutates
readonly mutates: boolean;Defined in: netconf/src/operations/extension.ts:111
True if the operation can change server state (configuration, locks, sessions).
name
readonly name: string;Defined in: netconf/src/operations/extension.ts:90
The RPC element name, such as get-config; for a read, a name for what it reads, such as sessions. Tools use it as the command name.
namespace
readonly namespace: string;Defined in: netconf/src/operations/extension.ts:100
Namespace of the RPC element, so a tool can recognise the operation in raw XML; for a read, the namespace of the data it reads.
params
readonly params: readonly ParamDescriptor[];Defined in: netconf/src/operations/extension.ts:115
The arguments: positional ones first, in order, then the named options.
requires
readonly requires: readonly string[];Defined in: netconf/src/operations/extension.ts:113
Capabilities always needed. Arguments may add more (ParamDescriptor.requires).