1. Manuals
  2. Tumbleweed
  3. nbox
  4. nbox-ip-range-reserve(1)

Scroll to navigation

nbox-ip-range-reserve(1) General Commands Manual nbox-ip-range-reserve(1)

NAME

nbox-ip-range-reserve - Reserve (allocate) the next available IP address within this IP range. 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 address server-side and race-safe, so the applied address may differ from any previewed candidate

SYNOPSIS

nbox ip-range reserve [--description] [--dns-name] [--count] [--message] [--dry-run] [--confirm] [--allow-writes] [-h|--help]

DESCRIPTION

Reserve (allocate) the next available IP address within this IP range. 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 address server-side and race-safe, so the applied address may differ from any previewed candidate

OPTIONS

Set the new IP's description. Optional
Set the new IP's DNS name. Optional
How many IP addresses to allocate. Default 1; `>1` sends one atomic list-body POST to NetBox's `available-ips` endpoint — all N are created or none are (the receipt's `object` is a JSON array of the N created IPs). Any failure leaves nothing created (clean error)
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
Preview the plan + the candidate address and perform no mutation. Needs neither `--allow-writes` nor confirmation. With `--json`, returns the stable `MutationPlan` JSON
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
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)
Print help
reserve