Desired State preset reference

Prerequisites and authority

Use this reference with your installed release. Internal implementation routes and settings are not public integration contracts.

Desired State reference and support boundary

The inspected reconciliation service handles interfaces, bridge, IP addresses, pools, DHCP, hotspot server profile/server, DNS, NAT and address lists. It also contains inspection/validation machinery. This component inventory does not establish the exact shipped preset names or accepted JSON schema.

Use the preset shipped with your installed release. Before applying it, review its name, version, intended topology, required values, managed resources and effects on existing manual configuration. Keep a router export and validate the proposed changes on a non-production device first.

For every key, document type, supported values, default, required/optional status and conflict behavior. Do not publish invented JSON just because the handler name looks descriptive.

Shipped presets are the supported baseline. A customized preset is an operator-maintained variation requiring separate acceptance: management reachability, customer addressing/login, provisioning, concurrency, quota/expiry, accounting and recovery.

Inspection before apply is desirable, but a source method is not proof that the release UI offers a preview/diff. Document only the controls actually available after UI verification.

Configuration reconciliation can replace managed manual changes. Preserve backups and a recovery route; do not promise a universal atomic undo. Shipped Desired State presets and safe customization is the authoritative operating procedure.

Related guides

Related guides: Configuration reference (env vars, ports, URLs), Docker services, Compose files and persistent volumes, Database diagnostics and safe query reference, Subscription and provisioning state model.