Back to the list of connectors[1]

Promox Virtual Environment (REST) Enterprise

Description

This connector enables VM monitoring for Proxmox hypervisors via Proxmox VE REST API.

hardware[2] linux[3] proxmox[4]

Target

Typical platform: Proxmox Hypervisors

Operating systems: Linux, Out-Of-Band

Prerequisites

Leverages: Proxmox VE REST API version V6.4-14 or higher

Technology and protocols: HTTP/REST

This connector is not available for the local host (it is applicable to remote hosts only).

Examples

CLI

metricshub HOSTNAME -t linux -c +ProxmoxVEREST --https --http-port 443 -u USERNAME

metricshub.yaml

resourceGroups:
  <RESOURCE_GROUP>:
    resources:
      <HOSTNAME-ID>:
        attributes:
          host.name: <HOSTNAME> # Change with actual host name
          host.type: linux
        connectors: [ +ProxmoxVEREST ] # Optional, to load only this connector
        protocols:
          http:
            https: true
            port: 443 # or probably something else
            username: <USERNAME> # Change with actual credentials
            password: <PASSWORD> # Encrypted using metricshub-encrypt

Connector Activation Criteria

The Promox Virtual Environment (REST) connector will be automatically activated, and its status will be reported as OK if all the below criteria are met:

  • The HTTP Request below to the managed host succeeds:
    • GET /
    • Request Header:
      Content-Type: application/json
    • The response body contains: Proxmox Virtual Environment (regex)

Metrics

Type Collected Metrics Specific Attributes
vm
  • hw.power_state{hw.type="vm", state="off|on|suspended"}
  • hw.vm.power_ratio
  • hw.parent.type
  • id
  • name
  • vm.host.name
No results.