NAME¶

nbox-prefix-reserve - Reserve (allocate) the next available child prefix. 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. NetBox allocates the prefix server-side and race-safe, so the applied prefix may differ from any previewed candidate

SYNOPSIS¶

nbox prefix reserve [--length] [--vrf] [--description] [--message] [--dry-run] [--confirm] [--allow-writes] [-h|--help]

DESCRIPTION¶

Reserve (allocate) the next available child prefix. 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. NetBox allocates the prefix server-side and race-safe, so the applied prefix may differ from any previewed candidate

OPTIONS¶

--length <LEN>

The prefix length for the new child prefix (e.g. `26` for a /26 inside a /24). If omitted, NetBox allocates the next available block of any size (the parent's prefix length + 1 by default)

--vrf <VRF>

Disambiguate the parent prefix by VRF (name, slug, or RD)

--description <TEXT>

Set the new prefix's description. Optional

--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 + the candidate prefix 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