Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gnmyt/Nexterm/llms.txt

Use this file to discover all available pages before exploring further.

Nexterm integrates with Proxmox VE (PVE) to give you terminal and console access to your virtual machines and containers directly from the Nexterm UI. Once you connect a PVE cluster, Nexterm automatically discovers all nodes, QEMU VMs, and LXC containers and adds them to your sidebar as managed entries.

What the Proxmox integration provides

Node shell

Open a direct shell to any Proxmox node. Appears in Nexterm as a pve-shell entry using the terminal renderer.

LXC console

Attach to the console of any LXC container on your cluster. Appears as a pve-lxc entry using the terminal renderer.

QEMU VM console

Open a VNC console to any QEMU virtual machine. Appears as a pve-qemu entry using the Guacamole graphical renderer.

Power management

Start, stop, or gracefully shut down QEMU VMs and LXC containers from the Nexterm sidebar without logging into the Proxmox web UI.

Connecting a Proxmox cluster

1

Open the integrations settings

In Nexterm, navigate to Settings → Integrations and click Add integration.
2

Fill in the connection details

Provide the following fields:
FieldDescription
NameA display name for this integration. Nexterm uses this as the folder name in your sidebar.
IP addressThe IP address of your Proxmox server or cluster VIP.
PortThe PVE API port. The default is 8006.
UsernameA PVE API user in the format user@realm, for example root@pam or nexterm@pve.
PasswordThe password for the PVE user.
3

Save and sync

Click Save. Nexterm connects to the PVE API, authenticates, queries all nodes in the cluster, and imports every QEMU VM, LXC container, and node shell as entries in a new sidebar folder.If the credentials are invalid, Nexterm returns a 401 error. If the server is unreachable, it returns a 503 error with the address it tried to contact.
Nexterm communicates with the Proxmox API over HTTPS on the configured port. The connection uses the PVE ticket authentication mechanism — Nexterm obtains a session ticket and CSRF token at connection time and uses them for all subsequent API calls.
When a sync completes, Nexterm creates one folder per node in the cluster. Each node folder contains:
  • A node shell entry (pve-shell, ID 0) — a direct terminal connection to the Proxmox node itself.
  • One entry per LXC container (pve-lxc) discovered on that node.
  • One entry per QEMU VM (pve-qemu) discovered on that node.
Each entry shows the resource name and its last-known status (running, stopped, etc.) as reported by the PVE API at sync time.

Opening a session

Click any Proxmox entry in the sidebar to open a session:
  • pve-shell — opens a terminal in the Nexterm terminal renderer, connected directly to the Proxmox node.
  • pve-lxc — opens a terminal console for the LXC container.
  • pve-qemu — opens a VNC-based graphical console via Apache Guacamole.
QEMU VM consoles use the VNC proxy endpoint on the Proxmox API. The graphical renderer is powered by Guacamole, the same renderer used for RDP and VNC server entries.

Power management

You can start, force-stop, and gracefully shut down QEMU VMs and LXC containers directly from Nexterm.
Right-click the entry in the sidebar and choose Start. Nexterm calls the PVE status start endpoint for the resource and reports success or failure.
Right-click and choose Stop. This is equivalent to pulling the power — the guest OS does not shut down gracefully. Use this only when the guest is unresponsive.
Right-click and choose Shutdown. Nexterm sends a shutdown signal through the PVE API, allowing the guest OS to close applications and unmount filesystems cleanly before powering off.
Force-stopping a VM or container (stop) terminates it immediately without giving the guest OS a chance to flush disk writes. Use Shutdown for graceful power-off whenever possible.

Re-syncing after cluster changes

If you add or remove VMs, containers, or nodes in Proxmox after the initial sync, you need to re-sync the integration to reflect those changes in Nexterm.
1

Open integrations settings

Go to Settings → Integrations and find the Proxmox integration you want to update.
2

Trigger a sync

Click Sync. Nexterm removes all previously synced entries and folders for that integration, queries the PVE API again, and rebuilds the sidebar with the current state of the cluster.
A sync operation replaces all automatically managed folders and entries for the integration. Any position changes you made to synced entries will be reset. Personal scripts or snippets are not affected.

Monitoring Proxmox nodes

If monitoring is enabled on the integration, your Proxmox node appears in the Nexterm Monitoring dashboard alongside your regular SSH servers. Data is collected via the PVE API rather than a direct SSH connection. See the monitoring documentation for details on configuring collection intervals and viewing historical charts.

Multi-node clusters

Nexterm queries the /nodes endpoint on the PVE API and processes every node in the response. Each node gets its own folder in the sidebar. If a node is unreachable during a sync, Nexterm marks it as offline in the folder name and imports an empty folder rather than failing the entire sync.

Troubleshooting

Nexterm could not reach the PVE API at the configured IP and port. Verify that the Proxmox web interface is accessible from the host running Nexterm, and that port 8006 (or your custom port) is not blocked by a firewall.
The username or password was rejected by the PVE API. Confirm the username is in user@realm format and that the account has API access in Proxmox. The root@pam account works, but creating a dedicated PVE API user with restricted permissions is recommended.
The PVE API returned an empty node list. This can happen if the authenticated user does not have permission to list nodes. Check the user’s privileges in Datacenter → Permissions in the Proxmox web UI.
QEMU consoles use the VNC proxy on the PVE API node. Ensure the VM is running and that the Nexterm engine can reach the Proxmox node on the VNC proxy port returned by the API.

Build docs developers (and LLMs) love