This section guides you through setting up, configuring, and managing the Proxmox integration in OpsRamp.

Prerequisites

Before configuring the integration, ensure that your environment meets the following requirements related to gateway versions, credentials, and connectivity.

  • OpsRamp Classic Gateway (Linux) version 14.2.0 or later.
  • OpsRamp NextGen Gateway version 14.2.0 or later.
  • Proxmox management IP or FQDN must be reachable from the gateway.
  • Proxmox API port 8006 (default) must be open and reachable.
  • HTTPS communication must be allowed between gateway and Proxmox endpoint.
  • Follow the steps below to create a dedicated API user for the monitoring integration.
    • Create a Dedicated User: Create a monitoring user in your Proxmox environment. Set the Realm (authentication backend) explicitly to pve (Proxmox VE authentication server).
    • Generate the API Token: Create an API Token for this new user. Ensure that the Privilege Separation checkbox is Checked (Enabled). Copy the 36-character secret key immediately.
    • Assign the Role & Path: Add an API Token Permission. Set the Path to / (the root path, giving visibility to the whole cluster) and assign the PVEAuditor role to your newly created token.
    • Configure the Integration UI: Enter the generated token details into our integration interface using the following mapping:
      • Username / API Token ID: monitoring-agent@pve!monitoring-gateway
      • Password / API Token Secret: [Your-36-Character-Secret-UUID]

Configure Proxmox Integration

To configure the integration:

  1. From All Clients, select a client.
  2. Navigate to Setup > Account.
  3. Select the Integrations tab.
  4. The Installed Integrations page, where all the installed integrations are displayed. Click + ADD on the Installed Integrations page.
  5. If you do not have any installed applications, you will be navigated to the Available Integrations page. The Available Integrations page displays all the available applications along with the newly created application with the version.
    Note: Search for the application using the search option available. Alternatively, use the All Categories option to search.
  6. Click ADD on the Proxmox tile.
  7. From the Configurations page, click + ADD. The Add Configuration page appears.
  8. Enter the following BASIC INFORMATION:
Field NameDescriptionField TypeDefault Value
NameA user-defined display name for the integration instance.String
Proxmox IpAddress/HostnameEnter the management IP address or hostname of the Proxmox. You must be able to connect to this using HTTPS. This is the primary endpoint for all REST API.String
Is SecureSelect this checkbox if you want the communication between your system and the specified endpoint to be secured using HTTPS (HTTP over SSL/TLS).
Default Selection: When selected, it signifies that the connection is encrypted, providing an added layer of security to the data being transmitted.		Checkboxtrue
API PortProvide the API Port details. The port must be open and accessible for API communication from the gateway. This port is used for both discovery REST APIs (Kubernetes-style) and Prometheus monitoring queries.
Note: By default API Port is 443.		String8006
credentialsSelect the Credential from the drop-down list.

(Optional): Click + Add to create a credential. The ADD CREDENTIAL window is displayed. Enter the following information.
  • Name: Credential name.
  • Description: Brief description of the credential.
  • User Name: API Token ID.
  • Password: API Token Secret.
  • Confirm Password: Confirm API Token Secret
Dropdown
App Failure NotificationsEnable or disable application failure notification alerts. When enabled, OpsRamp generates alerts if the integration encounters connectivity or authentication failures during discovery or monitoring operations.Checkboxfalse

Notes:

  • By default the Is Secure checkbox is selected.
  • IP Address and Port should be accessible from Gateway.
  • Select the following:
    • App Failure Notifications: if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
  1. Select the following Custom Attribute:
FunctionalityDescription
Custom AttributeSelect the custom attribute from the drop down list.
ValueSelect the value from the drop down list.

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

  1. In the Native Types section, select the native types to be discovered.
  2. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.

The configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.

  1. Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications. Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.
  2. Click NEXT.
  3. (Optional) Click +ADD to create a new collector. You can either use the pre-populated name or give the name to your collector.
  4. Select an existing registered profile.
  5. Click FINISH.

The integration is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify the Configuration

Note: Select Proxmox.

View the Proxmox Details

To discover resources for Proxmox:

  1. Navigate to Infrastructure > Search > Virtualization > Proxmox. The Proxmox page is displayed.
  1. Select the application on the Proxmox page.
  2. The RESOURCE page appears from the right.
  3. Click the ellipsis (…) on the top right and select View Details.
  4. Navigate to the Attributes tab to view the discovery details.
  5. Click the Metrics tab to view the metric details for Proxmox.

View resource metrics

To confirm Proxmox monitoring, review the following:

  • Metric graphs: A graph is plotted for each metric that is enabled in the configuration.
  • Alerts: Alerts are generated for metrics that are configured as defined for integration.