Back to the list of connectors

Promox Virtual Environment (REST)

Description

This connector provides VM monitoring for Proxmox hypervisors via Proxmox VE REST api

Connector ID: ProxmoxVEREST

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

hws HOSTNAME -t linux -f ProxmoxVEREST --https --http-port 443 -u USERNAME

hws-config.yaml

hosts:
- host:
    hostname: <HOSTNAME> # Change with actual host name
    type: linux
  selectedConnectors: [ ProxmoxVEREST ] # Optional, to load only this connector
  http:
    https: true
    port: 443 # or probably something else
    username: <USERNAME> # Change with actual credentials
    password: <PASSWORD> # Encrypted using hws-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 (Labels)
Virtual Machine
  • hw.energy{hw.type="vm"}
  • hw.status{hw.type="vm",state="present"}
  • hw.vm.power_state{state="on|off|suspended"}
  • vm.host.name
No results.