NAME¶

nbox-interface-set - Set a writable field on an interface. A write: requires the `--allow-writes` gate AND confirmation (`--confirm`, or an interactive prompt on a TTY in plain output). `--dry-run` previews with no mutation and needs neither

SYNOPSIS¶

nbox interface set [--message] [--dry-run] [--confirm] [--allow-writes] [-h|--help] <FIELD> <VALUE>

DESCRIPTION¶

Set a writable field on an interface. A write: requires the `--allow-writes` gate AND confirmation (`--confirm`, or an interactive prompt on a TTY in plain output). `--dry-run` previews with no mutation and needs neither

OPTIONS¶

--message <MESSAGE>

Record this message in NetBox's object-change entry (a write-only request field, never stored on the object). Validated to NetBox's 200-character limit before applying. Optional

--dry-run

Preview the plan + diff and perform no mutation. Needs neither `--allow-writes` nor confirmation. With `--json`, returns the stable `MutationPlan` JSON

--confirm

Apply the reviewed plan without an interactive prompt. Does NOT enable writes on its own — `--confirm` without `--allow-writes` is a usage error (exit 2). With `--json`, returns the stable `MutationReceipt` JSON

--allow-writes

The write-enable gate: required to apply ANY mutation. Kept separate from `--confirm` so a read-only invocation can never be silently turned into a write (ADR-0001 §4)

-h, --help

Print help

<FIELD>

Field to set. Only `description` is supported in v1; any other value is a usage error (exit 2) before any network write

<VALUE>

New value verbatim. Pass an empty string (`""`) to clear the field. A value equal to the current one is a no-op: apply sends no `PATCH` and reports "no change"