How do I enable Proxmox VE monitoring?

Introduction

Proxmox VE monitoring authentication methods

Endpoints

To enable monitoring with API Token login authentication

To enable monitoring with Ticket login authentication

Introduction:

Entuity supports monitoring of the Proxmox Virtual Environment (VE) platform, version 7.0 upwards. To collect metrics from the Proxmox VE platform, the Entuity collector uses the Proxmox VE REST API. For more information on the Proxmox VE REST API, see the Proxmox API documentation.

Note, the Proxmox VE platform doesn't support multi-cluster monitoring. Because of this, Entuity gathers metrics only on a cluster-by-cluster basis. Entuity can monitor all hypervisors (nodes) connected to a Proxmox VE cluster.

Note, the Entuity collector does not support ProxMox Datacenter Manager (DCM). 

Proxmox VE monitoring authentication methods:

There are two authentication methods that Entuity can use to gather metrics from the Proxmox VE platform for monitoring:

• API Token login - (recommended) authentication is generated with a pre-generated API token ID/Secret key pair that is associated with an individual user. An API token is created in the Proxmox VE user interface (UI), and has no time limit. However, an API token can be set up with an expiry date, can limit access based on the access level of the user to which the API token is associated, and can be deleted server-side. 
   
• Ticket login - authentication is generated with the username and password of an individual user. A ticket is created for the user with each polling cycle, and has a limit of two hours. There are no server-side limitations on the number of tickets issued to a single user. 

With both authentication methods, the user must be assigned the Proxmox VE PVEAuditor role (which has read-only access), at minimum. For information about Proxmox user management and roles, see the ProxMox User Management documentation.

Endpoints:

For Proxmox VE monitoring to function, the following endpoints must be accessible:

• /api2/json/access/ticket
• /api2/json/cluster/status
• /api2/json/nodes
• /api2/json/nodes/{node}/status
• /api2/json/nodes/{node}/storage
• /api2/json/nodes/{node}/disks/lvm
• /api2/json/nodes/{node}/disks/lvmthin
• /api2/json/nodes/{node}/network
• /api2/json/nodes/{node}/sdn/zones
• /api2/json/nodes/{node}/sdn/zones/${zone.zone}/content
• /api2/json/nodes/{node}/qemu
• /api2/json/nodes/{node}/qemu/${vm.vmid}/config 
• /api2/json/nodes/{node}/qemu/${vm.vmid}/status/current
• /api2/json/nodes/{node}/qemu/${vm.vmid}/snapshot
• /api2/json/nodes/{node}/lxc
• /api2/json/nodes/{node}/lxc/${vm.vmid}/status/current
• /api2/json/nodes/{node}/lxc/${vm.vmid}/snapshot
• /api2/json/nodes/{node}/ceph/mon
• /api2/json/nodes/{node}/ceph/osd
• /api2/json/nodes/{node}/ceph/pool

The PVEAuditor role allows access to these endpoints. 

To enable monitoring with API Token login authentication:

1. From the Proxmox VE UI, add a new user by navigating to the cluster that you want to monitor, clicking Users in the Permissions category, and then clicking Add. 
   
   
    
2. Specify the user details of the new user, and make sure the user is assigned the PVEAuditor role. 
3. Associate an API token with the newly created user by clicking API Tokens in the Permissions category, and then clicking Add. 
   
   
    
4. From the Add:Token window that is displayed, enter the newly created user name in the User field (red), enter the Token ID of your choosing (green), and then click Add. 
   Note, do not select the Privilege Separation checkbox (yellow). Selecting this checkbox causes the collection of metrics to fail. 
   
   
   
   The Token Secret window is displayed, showing the Secret key.
    
5. Record the Secret key. 
   You must enter this API token ID/Secret key pair later in Entuity when you add the Proxmox VE platform as a managed asset. Keep in mind that the Secret key is displayed only one time, and must be regenerated, if lost. 
   
    
6. Add the Proxmox VE platform as a managed asset in Entuity, and on the Credential form, choose the API token authentication method, and then enter the API key in the  {Token-ID}={Secret} format.
   For example, do the following in Entuity:
   1. Start adding the Proxmox VE VM platform as a managed asset, as described in this article.
   2. When you get to the Monitoring section of the Add Asset form, click the Credential field to access the  Credential form.
   3. From the Credential Type dropdown field, select API Key.
   4. In the API Key field, enter the API key in the following format: {Token-ID}={Secret}
      For example, with the Token ID and Secret field values from the Token Secret window in step 5, you'd enter root@pam!token_id=f0e0d260-a7c1-48e7-9250-178d71ef8bac in the API Key field, as shown.
      
      
       
   5. Click Done to save and exit out of the Credential form, and then continue the process of adding the Proxmox VE platform as a managed asset.
      
       

To enable monitoring with Ticket login authentication:

1. From the Proxmox VE UI, add a new user by navigating to the cluster that you want to monitor, clicking Users in the Permissions category, and then clicking Add.
   
    
2. Specify the user details of the new user, and make sure the user is assigned the PVEAuditor role. 
3. Add the Proxmox VE platform as a managed asset in Entuity, as described in this article.
4. When you get to the Monitoring section of the Add Asset form, click the Credential field to access the  Credential form.
5. From the Credential Type dropdown field, select User and Password (not SSH). 
6. Enter the user name and password of the newly created user, and click Done to save and exit out of the Credential form.
   
    
7. Continue the process of adding the Proxmox VE platform as a managed asset.