Skip to content
Security hardening, live updates and lease fixes
Verlocx

Connecting Proxmox VE

Verlocx talks to your cluster through the Proxmox API. You can connect it with an API token or with an admin account — both work; they differ in one feature.

Which one to choose

API tokenAdmin account
CredentialsToken ID (e.g. verlocx@pve!portal) + secretUser (e.g. root@pam) + password
How Verlocx signs inToken on every request — nothing expiresLogs in like the web UI; the session is renewed automatically
Revoke without touching the userYes — delete the tokenOnly by changing the password
Two-factor on the accountNot affectedNot supported — use an account without 2FA, or a token
LVM snapshots (raw LVM storage)Not availableYes — the password is also used for SSH to the nodes
Everything elseYesYes
Recommendation: use an API token. Use the admin account only if your VMs live on raw LVM storage and you want snapshots for them — Proxmox can't snapshot raw LVM through its API, so Verlocx does it over SSH.

Option A — API token

Create a dedicated user for Verlocx, give it administrator rights on the cluster, and create a token that inherits them (privilege separation off). On any node:

shell
pveum user add verlocx@pve --comment "Verlocx portal"pveum acl modify / --users verlocx@pve --roles Administratorpveum user token add verlocx@pve portal --privsep 0

The last command prints the token's secret once — copy it. The token ID is verlocx@pve!portal. You can also create a token for root@pam in the web UI under Datacenter → Permissions → API Tokens; untick Privilege Separation so it has root's rights.

With privilege separation on, a token has no rights of its own until you grant them — Verlocx would connect, but every action would fail with “permission denied”.

Option B — Admin account

Use root@pam and its password, or another user in the pam realm with administrator rights and a matching Linux account on every node. The account must not require two-factor authentication.

  • Verlocx logs in to the API and renews its session in the background.
  • For VMs on raw LVM storage, Verlocx connects to the node over SSH (port 22) with the same user and password to create, merge and remove LVM snapshots.
  • All other storages (qcow2 directories, ZFS, Ceph RBD, LVM-thin) use Proxmox snapshots through the API — no SSH needed.

Add the cluster in Verlocx

  1. Open Clusters and choose Add cluster.
  2. Enter the API address of one node, e.g. https://pve01.example.com:8006. Add other nodes as fallback addresses — Verlocx switches over if the first is down.
  3. Pick API token or Admin account and enter the credentials.
  4. If the cluster uses its self-signed certificate, allow it (skip TLS verification) — or install a trusted certificate on the nodes.
  5. Test the connection. Verlocx lists the nodes it found; save to finish.

Credentials are stored encrypted with VERLOCX_DB_ENCRYPTION_KEY and never sent to the browser.

What Verlocx does on the cluster

AreaThrough
Clone templates, set CPU/RAM/disk, SMBIOS identityAPI
Power: start, shutdown, reboot, stop, hibernate, resumeAPI
Proxmox snapshots and rollbacksAPI
LVM snapshots on raw LVMSSH (admin account only)
Backup jobs and restoresAPI
HA resources and node-affinity rulesAPI
Migration between nodesAPI
Browser console (VNC)API (console ticket)

Troubleshooting

MessageUsually means
“401 authentication failure”Wrong token secret or password — or the admin account has two-factor authentication.
“403 permission denied” on actionsThe token has privilege separation on, or the user lacks the Administrator role on /.
Connection test times outPort 8006 blocked between the Verlocx server and the node — see Firewall & ports.
“needs SSH access” on a snapshotThe VM is on raw LVM storage and the cluster uses an API token — switch to the admin account for LVM snapshots.
Next up

See Verlocx in action

A 30-minute walkthrough on your use case — deployments, workflows, governance.

Hypervisor

We use your details only to handle this request — privacy policy.

Type to search the docs, the user guide, all features, the product pages and the changelog.

↑ ↓ to move↵ to openesc to close