Proxbox CLI

nbx proxbox is the dedicated command surface for the netbox-proxbox plugin. It includes a stable catalog of Proxbox plugin endpoints, generated CRUD commands, the existing streaming sync workflow, and a Proxbox-focused Textual request workbench.

Use this surface when you want Proxbox operations without remembering raw plugin paths such as /api/plugins/proxbox/firewall/rules/{id}/.

Command Map

Command	Purpose
nbx proxbox resources	Show the catalog with Rich-colored command, category, action, and description columns
nbx proxbox ops RESOURCE	Show the HTTP methods and paths behind one catalog resource
nbx proxbox <category> <resource> list	GET a Proxbox list endpoint
nbx proxbox <category> <resource> get --id N	GET a Proxbox detail endpoint
nbx proxbox <category> <resource> create --body-json ...	POST to writable list endpoints
nbx proxbox <category> <resource> update --id N --body-json ...	PUT to writable detail endpoints
nbx proxbox <category> <resource> patch --id N --body-json ...	PATCH writable detail endpoints
nbx proxbox <category> <resource> delete --id N	DELETE writable detail endpoints
nbx proxbox sync	Schedule a guided sync job and stream SSE progress
nbx proxbox tui	Open the Proxbox-only request workbench

Read-only Proxbox resources only register read commands. For example, operations deletion-requests and operations apply-jobs expose list and get only; write subcommands are not present.

Examples

# Find supported resources and actions.
nbx proxbox resources
nbx proxbox resources --json

# Inspect one resource before writing automation around it.
nbx proxbox ops firewall/rules
nbx proxbox ops operations/deletion-requests --json

# Standard CRUD commands.
nbx proxbox endpoints proxmox list -q name=pve-prod
nbx proxbox endpoints proxmox get --id 12
nbx proxbox endpoints proxmox create --body-json '{"name":"pve-prod","url":"https://pve.example.com:8006"}' --confirm
nbx proxbox firewall rules patch --id 7 --body-json '{"enabled":false}' --confirm
nbx proxbox sdn vnets delete --id 31 --confirm

# Dry-run write requests without sending them.
nbx proxbox firewall rules patch --id 7 --dry-run --body-json '{"enabled":false}'

# Low-level schedule endpoint. The guided command below is usually better.
nbx proxbox schedule create --dry-run --body-json '{"sync_types":["all"]}'

# Guided sync with live progress bars.
nbx proxbox sync pve-prod -t virtual-machines -t storage --confirm

# Proxbox-only TUI.
nbx proxbox tui --confirm
nbx proxbox tui --theme dracula --confirm
nbx proxbox tui --theme

Live Proxbox CRUD, sync scheduling, and TUI launch require --confirm or NETBOX_SDK_CONFIRM_WRITE=1; dry runs remain confirmation-free. Inside the request workbench, every POST, PUT, PATCH, or DELETE also requires its own confirmation dialog showing the method, path, and payload before dispatch. If a sync SSE stream fails after scheduling, the CLI fetches the authoritative NetBox job and polls that same job within the remaining timeout when needed. A completed job stays successful with the disconnect in warnings; a failed or still non-terminal job is reported from its authoritative status without implying the scheduled work never happened. If the authoritative fetch itself fails, JSON error output preserves the known job_id; automation must inspect that existing job before considering another sync rather than blindly rescheduling.

Resource Families

The catalog groups plugin endpoints by operator workflow:

Family	Examples
Endpoints	endpoints proxmox, endpoints netbox, endpoints pbs, endpoints pdm
Inventory	inventory clusters, inventory nodes, inventory storage
Virtual machines	virtual-machines templates, virtual-machines cloudinit
Operations	operations backups, operations snapshots, operations task-history
Firecracker	firecracker host-pools, firecracker hosts, firecracker microvms
Firewall	firewall security-groups, firewall rules, firewall ipsets
SDN	sdn fabrics, sdn controllers, sdn zones, sdn vnets, sdn subnets
Views	views home, views dashboard, resource-views virtual-machines

Flow

flowchart LR
    A[nbx proxbox command] --> B[Proxbox catalog]
    B --> C[SchemaIndex resource path]
    C --> D[Dynamic request resolver]
    D --> E[NetBoxApiClient]
    E --> F[netbox-proxbox plugin API]

TUI

nbx proxbox tui launches the same request workbench used by nbx dev tui, but with a Proxbox-only schema index. The sidebar starts at the Proxbox catalog, the method/path/body/response panels work the same way as the developer workbench, and live plugin discovery is disabled so the catalog remains stable even when the connected NetBox instance does not expose OpenAPI metadata for the plugin. Launch requires --confirm (or NETBOX_SDK_CONFIRM_WRITE=1), and each mutating send requires a second, request-specific confirmation in the TUI.