cluster register flags
Complete flag reference for nr cluster register
nr cluster register [flags]Identity and location
| Flag | Default | Description |
|---|---|---|
--name | Agent/cluster name (required unless --agent-id) | |
--agent-id | Existing agent UUID; skips CreateAgent | |
--agent-ip | Public (or reachable) IPv4 for the agent | |
--gateway-region | Gateway region (AMS01) | |
--org-id | Provider organization UUID (required; or NR_ORGANIZATION_ID). Sent as X-Organization-ID. Does not authenticate. | |
--description | Optional agent description |
--org-id must be the provider organization you are registering into. Copy it from Create agent in the console (the command already includes it). The CLI does not list organizations to pick a tenant. Authenticate with a service-account token (NR_API_TOKEN); a token from another organization is rejected.
Control flow
| Flag | Default | Description |
|---|---|---|
--resume | false | Continue from last checkpoint |
--force | false | Force reinstall / cleanup; auto-reuses existing name |
--yes / -y | false | Non-interactive confirmations (reuse, etc.) |
--dry-run | false | Print planned actions without executing |
--skip-prechecks | false | Skip host prechecks (not recommended) |
--offline | false | Skip fetching platform version pins from the API |
Offloading
| Flag | Default | Description |
|---|---|---|
--vnc-gateway-namespace | vnc-gateway | Provider namespace to offload for VNC |
--operator-namespace | Optional extra provider namespace to offload | |
--offload-namespaces | Additional namespaces to offload | |
--disable-offloading | false | Skip provider-side namespace offloading |
--namespace-mapping-strategy | SelectedName | Liqo namespace mapping strategy |
--remote-cluster-id | Remote Liqo cluster ID (auto-detected if empty) |
Operator
| Flag | Default | Description |
|---|---|---|
--skip-operator-install | false | Skip hypervisor operator / VNC gateway Helm install |
--reinstall-operator | false | Clear operator checkpoint and re-run Helm (with --resume) |
--operator-chart | Local path or OCI ref for the chart | |
--operator-chart-version | Chart version when using OCI | |
--hypervisor-driver | proxmox, virtfusion, or solusvm. One per organization. Omit it only with --pterodactyl. | |
--pterodactyl | false | Install the game server operator. The CLI asks for the panel URL, keys, and user id, and shows the keys as you type. Export PTERODACTYL_APPLICATION_KEY and PTERODACTYL_CLIENT_KEY to the keys themselves to skip those prompts. |
--panel-url | Optional with --pterodactyl. Panel origin. Prompted, or PTERODACTYL_PANEL_URL. | |
--panel-user-id | Optional. Panel user that owns NodeRings servers. Prompted, or PTERODACTYL_PANEL_USER_ID. | |
--pterodactyl-chart | Local path or OCI ref for the Pterodactyl chart. | |
--proxmox-instances-file | YAML file of Proxmox instances (or PROXMOX_INSTANCES_FILE) | |
--virtfusion-instances-file | YAML file of VirtFusion instances (or VIRTFUSION_INSTANCES_FILE) | |
--solusvm-instances-file | YAML file of SolusVM 2 instances (or SOLUSVM_INSTANCES_FILE) |
Output
| Flag | Default | Description |
|---|---|---|
--output | text | Format for the post-register verify report: text or json |
Global flags such as --api-url and --config-dir also apply.
Related environment variables
See Environment variables for NR_API_TOKEN, NR_ORGANIZATION_ID, PROXMOX_*, VIRTFUSION_*, SOLUSVM_*, PTERODACTYL_*, MIMIR_BEARER_TOKEN, and related settings.