Skip to main content

Connecting to Proxmox

Learn how to use OneIQ Pulse to discover Proxmox VE to profile clusters, nodes, virtual machines, LXC containers and storage

Written by Omega Team

Overview

OneIQ Pulse for Datacenter collects configuration and performance data from Proxmox VE through the Proxmox API. Supported objects include clusters, nodes, virtual machines, LXC containers, and storage.

This article explains how to deploy OneIQ Pulse to connect with a Proxmox environment.

Prerequisites

  • Outbound Internet connectivity on port 443 (SSL) to OneIQ

  • A read-only Proxmox VE user and API token with auditor-level permissions (see Create a read-only user and API token in Proxmox VE below)

  • OneIQ Pulse supports Windows Server 2016 or later, and Windows 10 or 11. A dedicated computer is recommended but not required

Verify Supported Versions

  • Proxmox VE: 9.0 and later

Verify Networking

  • A network path must exist from OneIQ Pulse to the Proxmox VE host or cluster nodes on port 8006 (HTTPS), which is the default Proxmox VE management API port. If the default port has been changed on the Proxmox VE host or cluster, use that port instead.

OneIQ Pulse Windows Services

OneIQ Pulse is designed to run under built-in Windows accounts, which are set automatically during installation:

  • OneIQ Pulse Service runs as Network Service

  • OneIQ Deputy Service runs as Local System

We recommend keeping these default accounts. OneIQ Pulse has not been validated with other service accounts, so changing them after installation may affect how it runs. If your organization requires a specific service account, please contact OneIQ Support to discuss your requirements.

OneIQ Pulse connects to your infrastructure using the credentials you enter for each target platform, so no additional service account is needed for discovery.

Create a read-only user and API token in Proxmox VE

Unlike VMware and Nutanix, OneIQ Pulse authenticates to Proxmox VE using an API token rather than a username and password. In the Proxmox VE web UI:

  1. Create a group. Go to Datacenter → Permissions → Groups → Create.

    • Name: e.g. PVEAuditors

  2. Assign the group read-only permission. Go to Datacenter → Permissions → Add → Group Permission.

    • Path: /

    • Group: the group created above

    • Role: PVEAuditor
      ​


      ​

  3. Create a user. Go to Datacenter → Permissions → Users → Add.

    • User name: Enter the desired user name (e.g. pulse)

    • Realm: Proxmox VE authentication server

    • Password: Enter a password for the user

    • Group: the group created above
      ​


      ​

  4. Generate an API token. Go to Datacenter → Permissions → API Tokens → Add.

    • User: the user created above

    • Privilege Separation: unchecked (so the token inherits the user's permissions instead of needing its own)

    • Click on Add and then be sure to save the generated Token ID (usually pulse@pve!pulse) and Token Secret
      ​NOTE: the Token Secret will only be shown this one time
      ​


      ​

Deploying OneIQ Pulse for Proxmox

  1. In the OneIQ portal, go to the Connectors section, click on Deploy Connector and select the Proxmox platform.

  2. Copy the connection key to the clipboard or save it. Then select Download OneIQ Pulse for Datacenter to download the OneIQ Pulse executable.

  3. Once you've downloaded the OneIQ Pulse for Datacenter binary to a Windows computer in your environment, run the executable.

  4. Paste the Connection key into OneIQ Pulse during setup.

  5. In the Select Discovery Target step, choose Proxmox.

  6. Enter the following information:

    • Proxmox VE Address: FQDN hostname or IP address of the Proxmox VE host or cluster node

    • Port: defaults to 8006; update this if the Proxmox VE host or cluster uses a non-default port

    • Authentication method: API Token

    • Token ID (e.g. pulse@pve!pulse)

    • Secret: the Token Secret that was generated
      ​


      ​

  7. Click Create to initiate discovery.

  8. Add a certificate to the trusted list if the Proxmox VE endpoint is being discovered for the first time by clicking Trust.
    ​

  9. Upon successful discovery, the Proxmox entities will be available in the Entity Type drop down menu in the Dashboard. Please note that it could take several minutes to a few hours before data metrics appear in the Dashboard.
    ​


    ​


    ​

Repeat the steps above for each Proxmox VE host or cluster.

OneIQ Pulse only displays tiles for discovered Proxmox endpoints. Configuration and performance data for Proxmox clusters, nodes, virtual machines, LXC containers, and storage are available in the OneIQ Portal.

What's next?

Use OneIQ Pulse to discover other supported datacenter platforms and collect network flows to identify dependencies.

Cloud-native platforms inside the datacenter can be connected using the following OneIQ Pulse connectors:

Did this answer your question?