Skip to content

Interface: DeviceProfileSpec ​

Defined in: netconf/src/devices/device.ts:170

The JSON shape of a device profile file. See profiles/profile.schema.json and Writing a profile.

Properties ​

$schema? ​

ts
readonly $schema?: string;

Defined in: netconf/src/devices/device.ts:172

The JSON schema, for editor checking and autocomplete; ignored when loading.


capabilities? ​

ts
readonly capabilities?: object;

Defined in: netconf/src/devices/device.ts:199

Corrections to the capabilities the server advertises.

add? ​

ts
readonly add?: readonly string[];

Capability URIs to treat as advertised.

remove? ​

ts
readonly remove?: readonly string[];

Capability URIs to treat as not advertised.


connection? ​

ts
readonly connection?: Partial<Pick<SshOptions, 
  | "port"
  | "algorithms"
  | "keepaliveInterval"
  | "keepaliveCountMax"
  | "subsystem"
| "command">>;

Defined in: netconf/src/devices/device.ts:195

Defaults for ssh(). See connection.


description? ​

ts
readonly description?: string;

Defined in: netconf/src/devices/device.ts:180

What devices and software the profile covers, for people reading it.


extends? ​

ts
readonly extends?: string;

Defined in: netconf/src/devices/device.ts:176

The id of a profile to build on; each section is merged key by key.


id ​

ts
readonly id: string;

Defined in: netconf/src/devices/device.ts:174

The profile's unique name. The only required field.


match? ​

ts
readonly match?: DeviceMatch;

Defined in: netconf/src/devices/device.ts:193

Rules for auto-detection from the server's hello. See match.


namespaces? ​

ts
readonly namespaces?: Readonly<Record<string, string>>;

Defined in: netconf/src/devices/device.ts:208

Module name → namespace, for modules the device uses but the server doesn't advertise, or advertises wrongly.


notes? ​

ts
readonly notes?: readonly string[];

Defined in: netconf/src/devices/device.ts:191

Anything surprising found while testing, for people reading the profile.


operations? ​

ts
readonly operations?: Readonly<Record<string, OperationSpec>>;

Defined in: netconf/src/devices/device.ts:212

Vendor RPCs as XML templates, by name. See operations.


paths? ​

ts
readonly paths?: Readonly<Record<string, string>>;

Defined in: netconf/src/devices/device.ts:210

Named paths, usable as @name. See paths.


quirks? ​

ts
readonly quirks?: Quirks;

Defined in: netconf/src/devices/device.ts:197

Switches for the device's known deviations from the RFCs. See Quirks.


status? ​

ts
readonly status?: "verified" | "unverified";

Defined in: netconf/src/devices/device.ts:182

'verified' once tested against a real device. Auto-detecting an 'unverified' profile logs a warning.


testedWith? ​

ts
readonly testedWith?: readonly object[];

Defined in: netconf/src/devices/device.ts:184

The device models and software versions the profile was tested against.


vendor? ​

ts
readonly vendor?: string;

Defined in: netconf/src/devices/device.ts:178

The vendor, for people reading the profile.


workflow? ​

ts
readonly workflow?: Partial<Workflow>;

Defined in: netconf/src/devices/device.ts:206

How changes are applied on this device. See workflow.


yang? ​

ts
readonly yang?: YangSettings;

Defined in: netconf/src/devices/device.ts:214

YANG schemas for RFC 7951 JSON conversion. See yang.

Released under the MIT Licence.