Contact Sales

Advanced Settings

Starting with Toolbox 26.06, you can manage Braiins OS advanced settings across your fleet directly from Toolbox.

Some settings are marked dangerous and may damage hardware if misused. Change them only if you understand the impact.

GUI

Select one or more devices in the Device List, open Actions by clicking the tree dots button in the menu bar, and choose Advanced Settings to open the configuration modal.

The modal lists all available settings where ,each row shows:

  • Title and status tags — a red Dangerous tag, a blue Beta tag (when applicable), and a grey BOS version tag indicating the minimum required Braiins OS version.
  • Description, with a Read more link when extended documentation is available.
  • A dropdown with available options on the setting type.

Key behaviors:

  • No Change by default: every field defaults to No Change, regardless of how many devices are selected. The modal does not read current device values; only fields you change are sent to devices.
  • Subsettings: settings that depend on another setting are nested under their parent and stay disabled until the parent meets the required value.
  • Reset All to Default: a button at the top-right of the list marks every field to be reset to the device's defaults. Touching any field afterwards cancels the reset-all intent and reverts to applying only the fields you changed.

CLI

The advanced command manages Braiins OS advanced settings from the command line. It has four subcommands:

  • list: list all available settings (no device connection required)
  • get: read current values from device(s)
  • set: configure one or more settings on device(s)
  • reset: reset settings to their default values
$ ./braiins-toolbox advanced --help
Manage Advanced Braiins OS settings

Usage: braiins-toolbox advanced [OPTIONS] <COMMAND>

Commands:
  list   List all available advanced settings with their type, default, status, and constraints
  get    Read current advanced setting values from one or more devices.
  set    Apply advanced settings to one or more devices.
  reset  Reset advanced setting values on one or more devices.

List

Lists all available (non-hidden) settings in the latest version, including title, description, type, default value, status (stable / beta / dangerous), minimum Braiins OS version, and unit.

$ ./braiins-toolbox advanced list

Get

Reads the current value of one or more settings, or all settings, from the target device(s).

$ ./braiins-toolbox advanced get -S <KEY> [-S <KEY>...] <IP_LIST|--ip-file <FILE>>
$ ./braiins-toolbox advanced get --all <IP_LIST|--ip-file <FILE>>
  • -S, --setting <KEY> is repeatable to read several settings at once.
  • --all reads every advanced setting.
  • --all and --setting are mutually exclusive, and exactly one of them is required.

For example:

$ ./braiins-toolbox advanced get -S enable_defrost -S defrost_temperature_limit_c 192.168.1.0/24

Set

Applies one or more settings to the target device(s). Each setting is passed with the repeatable -S, --setting <KEY=VALUE> flag, where KEY is a setting name from the schema and VALUE is validated against the schema.

$ ./braiins-toolbox advanced set -S <KEY=VALUE> [-S <KEY=VALUE>...] <IP_LIST|--ip-file <FILE>>

Set multiple values in a single command:

$ ./braiins-toolbox advanced set -S enable_defrost=true -S defrost_temperature_limit_c=10 192.168.1.0/24

Settings must be passed with -S. Bare positional KEY=VALUE tokens are treated as targets, not settings, and will fail target resolution.

Values are validated according to the setting type:

TypeAccepted inputValidation
booleantrue / falseAny other value is rejected.
integerA numeric valueRejected if outside the schema min/max range; the unit is shown in the error.
string (enum)One of the enum valuesRejected if not in the allowed list.

Reset

Resets one or more settings, or all settings, to their defined defaults.

$ ./braiins-toolbox advanced reset -S <KEY> [-S <KEY>...] <IP_LIST|--ip-file <FILE>>
$ ./braiins-toolbox advanced reset --all <IP_LIST|--ip-file <FILE>>
  • -S, --setting <KEY> is repeatable; --all resets every setting.
  • --all and --setting are mutually exclusive, and exactly one is required.
  • Resetting a dangerous setting prints a warning and prompts for confirmation. Use --force to skip the prompt when scripting.

Status and version handling

  • Beta settings print a notice when changed.
  • Dangerous settings print a warning and require confirmation (--force bypasses it for scripting).
  • Before applying, each device's Braiins OS version is checked against the setting's minimum version. Devices that are too old are skipped with a clear message, and after the batch Toolbox prints a summary of applied, skipped, and failed counts.
Was this helpful?