Vendor profiles
Reusable, schema-validated per-OS profiles that drive CLI/SSH session behaviour and gNMI/NETCONF/SNMP collection defaults in Prelude Collector.
A vendor profile captures how a particular network OS behaves, so the collector can talk to every device of that type consistently. One profile per OS drives collection end to end — CLI/SSH session handling and the default collection settings for gNMI, NETCONF, and SNMP — instead of those details being hard-coded or repeated on every device.
Profiles are schema-validated: each field has a defined type and allowed values, and the form only saves a valid document.
What a profile drives
- CLI / SSH sessions — prompt patterns, error patterns, a clean-shell flag, and auto-responses. Patterns are validated as regular expressions when you save or import the profile.
- gNMI defaults — default encoding and path origin.
- NETCONF defaults — default port.
- SNMP — the compiled version matching used during collection (changes take effect on save, without a restart).
How defaults are resolved
For any setting a profile can supply, the collector applies this precedence:
- An explicit value set on the device (or mapping) wins.
- Otherwise the vendor-profile default is used.
- Otherwise the collector's built-in default applies.
This means a profile sets sensible defaults for a whole OS family while any individual device can still override them.
Built-in profiles
The collector ships with built-in profiles for common vendors, seeded from its proven CLI drivers, so collection works out of the box. Built-ins are kept current automatically on upgrade — but any profile you have edited is never overwritten.
Using profiles on a device
On the device form, the Network OS field offers your enabled profiles as a picklist (free text is still allowed). If you enter an OS that has no matching profile, the collector warns you but still lets you save (warn-but-allow), and flags the device with a "no profile" badge.
Manage profiles
From the vendor-profiles page you can:
- Create / edit a profile with a structured form (text inputs, enum dropdowns, and add/remove chips for list fields). The OS identifier is fixed once a profile exists.
- Create from scratch a brand-new profile.
- Export a single profile or all profiles as JSON or YAML.
- Review history — every change is versioned. View a diff between revisions and restore an earlier one.
REST API
Vendor profiles have a full REST API under /api/v1/vendor-profiles,
covering CRUD, import/export, and revision history (list, diff, restore).
See the API reference for details.