Skip to main content

bb-eco template apply

Apply a configuration template to a device

Usage

bb-eco template apply <device> <file> [options]

Arguments

NameDescription
<device>IP address, MAC address, or device name
<file>Template file path (.json)

Options

OptionDescription
--csvOutput in CSV format
--dry-runPreview changes without applying
--forceSkip confirmation prompt
--jsonOutput in JSON format
--timeout <timeout>Override default timeout in milliseconds
--verboseEnable verbose/debug output
-?, -h, --helpShow help and usage information

Examples

Preview what a template would change without touching the device:

bb-eco template apply 192.168.2.97 es-522-baseline.json --dry-run
DRY RUN — no changes will be applied.
[device] applying
[device] planned
[serial.1] applying
[serial.1] planned
[serial.2] applying
[serial.2] planned
[wport] applying
[wport] planned
[network] applying
[network] planned

Dry run: 34 settings would be applied.

Apply it for real by dropping --dry-run. Sections are written in a safe order — device settings first, network settings last, because a network change can drop the connection mid-apply. The summary counts template settings: values that differed and were written count as applied, values the device already had count as matched, and a device that fully matches is left untouched:

bb-eco template apply 192.168.2.97 es-522-baseline.json
Applied 3 settings; 31 already matched.

Re-running the same apply is safe — nothing is written twice:

No changes — all 34 settings already match the device. Nothing was sent.

The template's family (and optional compatibleModels list) must match the target device; --force overrides the model check when you knowingly apply a template across similar models.

warning

Applying serial-port settings to an ES device is rejected with an error while a TCP client is connected to that port — close active connections first.

This page is auto-generated from the live CLI help text. Do not edit by hand - re-run node scripts/gen-cli-reference.mjs after changes. Example sections are maintained in docs/cli-examples/ in the bb-eco repo.