Skip to content

Interface: GetDataOptions ​

Defined in: netconf/src/operations/nmda.ts:60

Options for <get-data> (RFC 8526 §3.1.1). See nmda.

Properties ​

configFilter? ​

ts
readonly configFilter?: boolean;

Defined in: netconf/src/operations/nmda.ts:70

true: only configuration nodes. false: only state nodes.


datastore ​

ts
readonly datastore: DatastoreRef;

Defined in: netconf/src/operations/nmda.ts:62

The datastore to read: a standard one by name ('operational', 'intended', …) or another identity.


filter? ​

ts
readonly filter?: 
  | YangJsonObject
  | Filter;

Defined in: netconf/src/operations/nmda.ts:68

A subtree filter (subtree(...)), an XPath filter (xpath(...), needs :xpath), or an RFC 7951 JSON object, converted to a subtree filter with the datastore's YANG schema.


maxDepth? ​

ts
readonly maxDepth?: number | "unbounded";

Defined in: netconf/src/operations/nmda.ts:76

Levels returned below each selected node, 1–65535, or 'unbounded' (the default).


negatedOriginFilter? ​

ts
readonly negatedOriginFilter?: 
  | OriginRef
  | readonly OriginRef[];

Defined in: netconf/src/operations/nmda.ts:74

Keep configuration nodes whose origin is none of these. operational only; not with originFilter.


originFilter? ​

ts
readonly originFilter?: 
  | OriginRef
  | readonly OriginRef[];

Defined in: netconf/src/operations/nmda.ts:72

Keep configuration nodes whose origin is (or derives from) any of these. operational only.


withDefaults? ​

ts
readonly withDefaults?: WithDefaultsMode;

Defined in: netconf/src/operations/nmda.ts:80

Default reporting (RFC 6243). On operational the server must also advertise :with-operational-defaults.


withOrigin? ​

ts
readonly withOrigin?: boolean;

Defined in: netconf/src/operations/nmda.ts:78

Annotate configuration nodes with or:origin. operational only, and the server's origin feature.

Released under the MIT Licence.