Skip to content

Interface: JsonOptions ​

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

How RFC 7951 JSON output is produced.

Extended by ​

Properties ​

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>).


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.


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.

Released under the MIT Licence.