Skip to content

Interface: ToXmlOptions ​

Defined in: netconf/src/operations/json.ts:119

Options of the input conversion seam, ExtensionContext.toXml.

Extends ​

Properties ​

action? ​

ts
readonly action?: boolean;

Defined in: netconf/src/operations/json.ts:134

Convert a whole action invocation instead: one top-level member, the data-node tree down to the action with its input, as client.ops.action() takes it. The datastore defaults to operational.


datastore? ​

ts
readonly datastore?: JsonDatastore;

Defined in: netconf/src/operations/json.ts:45

JSON input only: the datastore whose schema types the input. Default: the one the operation addresses (an edit's target, a get-config filter's source, operational for <get>).

Inherited from ​

JsonOptions.datastore


filter? ​

ts
readonly filter?: boolean;

Defined in: netconf/src/operations/json.ts:121

Subtree-filter content (RFC 6241 §6) rather than edit content. Default false.


operation? ​

ts
readonly operation?: string;

Defined in: netconf/src/operations/json.ts:128

Convert an RPC's or action's input parameters instead: the result is the parameter elements, to go inside the operation element. The value is the operation's data path, in the form of ToJsonOptions.operation. The datastore defaults to operational.


requireSchema? ​

ts
readonly requireSchema?: boolean;

Defined in: netconf/src/operations/json.ts:31

Refuse to convert data without a YANG schema: reject with a SchemaUnavailableError (no schema could be built) or a YANG data error (the data doesn't match the schema), instead of converting that subtree schema-less and reporting a warning. For JSON input (config or filter), reject with SchemaUnavailableError instead of sending a member no schema covers schema-less. Default: the connection's yang.requireSchema, then the device profile's, then false.

Inherited from ​

JsonOptions.requireSchema


validate? ​

ts
readonly validate?: boolean;

Defined in: netconf/src/operations/json.ts:39

JSON input only: refuse JSON that doesn't match its YANG schema (unknown nodes, values of the wrong type or out of range, missing list keys, config-false nodes in an edit), rejecting with a YANG data error that lists every problem. Default true. With false, a top-level member that doesn't match is sent schema-less, with a warning.

Inherited from ​

JsonOptions.validate

Released under the MIT Licence.