Interface: DeviceProfile
Defined in: netconf/src/devices/device.ts:56
How a kind of device differs from the RFCs and what it offers beyond them: detection rules, connection defaults, quirks, capability corrections, the edit workflow, named paths and the device's own operations. Load one from JSON with loadDeviceProfile(), take a built-in one, or write one with defineDeviceProfile; pass it to connect({ profile }), or several through autoDetect. See Device profiles.
Properties
capabilities?
readonly capabilities?: object;Defined in: netconf/src/devices/device.ts:89
Corrections to the capabilities the server advertises; capability checks use the corrected set.
add?
readonly add?: readonly string[];Capability URIs to treat as advertised.
remove?
readonly remove?: readonly string[];Capability URIs to treat as not advertised.
connection?
readonly connection?: Partial<Pick<SshOptions,
| "port"
| "algorithms"
| "keepaliveInterval"
| "keepaliveCountMax"
| "subsystem"
| "command">>;Defined in: netconf/src/devices/device.ts:85
Defaults for ssh(), such as the port. They are needed before the hello, so they only apply when you spread them into ssh() yourself.
definition?
readonly definition?: DeviceProfileSpec;Defined in: netconf/src/devices/device.ts:121
The effective JSON definition this profile was compiled from, in the profile file format: extends merged away, $schema left out, YANG module directories resolved. It holds each operation's request template and result rule, so tools can show what an operation sends without running it. Deeply frozen. Unset for a profile made in code with defineDeviceProfile().
description?
readonly description?: string;Defined in: netconf/src/devices/device.ts:62
What devices and software the profile covers, for people reading it.
descriptors?
readonly descriptors?: Readonly<Record<string, OperationDescriptor>>;Defined in: netconf/src/devices/device.ts:111
Each operation described as plain data, by operation name. JSON profiles always have them. An operation without one is described conservatively: no parameters, and mutates: true.
detect?
readonly detect?: (hello) => number;Defined in: netconf/src/devices/device.ts:76
Score how well a server hello matches this profile; 0 means no match.
Parameters
hello
Returns
number
id
readonly id: string;Defined in: netconf/src/devices/device.ts:58
The profile's unique name, such as nokia-7210-sas.
match?
readonly match?: DeviceMatch;Defined in: netconf/src/devices/device.ts:78
A JSON profile's match rules (merged with its parent's when it extends one), which detect scores.
namespaces?
readonly namespaces?: Readonly<Record<string, string>>;Defined in: netconf/src/devices/device.ts:101
Module name → namespace, for modules the device uses but the server doesn't advertise.
operations?
readonly operations?: Readonly<Record<string, DeviceOperation>>;Defined in: netconf/src/devices/device.ts:105
The device's own operations by name, called with client.ops.device.call(name, params).
paths?
readonly paths?: Readonly<Record<string, string>>;Defined in: netconf/src/devices/device.ts:103
Named paths, usable as @name wherever a path is accepted.
quirks?
readonly quirks?: Quirks;Defined in: netconf/src/devices/device.ts:87
Switches for the device's known deviations from the RFCs. See Quirks.
source?
readonly source?: ProfileSource;Defined in: netconf/src/devices/device.ts:80
Where a loaded profile came from. Unset for a profile made in code with defineDeviceProfile().
status?
readonly status?: "verified" | "unverified";Defined in: netconf/src/devices/device.ts:67
'verified' once tested against a real device; see testedWith. Auto-detecting an 'unverified' profile logs a warning.
testedWith?
readonly testedWith?: readonly object[];Defined in: netconf/src/devices/device.ts:69
The device models and software versions the profile was tested against.
vendor?
readonly vendor?: string;Defined in: netconf/src/devices/device.ts:60
The vendor, for people reading the profile.
workflow?
readonly workflow?: Partial<Workflow>;Defined in: netconf/src/devices/device.ts:99
How set(), remove() and configure() apply changes on this device. Anything left out comes from what the server advertises.
yang?
readonly yang?: YangSettings;Defined in: netconf/src/devices/device.ts:113
YANG schemas for RFC 7951 JSON output (format: 'json').