Supplemental Data Forwarding

VPSMON functionality may be enhanced via supplemental data provided from your billing and OpenVZ control panel systems. We refer to the scripts which send VPSMON this type of data as "supplemental data forwarders."

We currently support the forwarding of supplemental container information from WHMCS and SolusVM:

If you have a system you'd like supplemental data forwarded from please let us know

  • SolusVM Forwarder Notification emails to container owners upon event generation require VPSMON to be aware of your client's contact email address associated with a respective container ID ("CTID").
  • WHMCS Forwarder Package-specific CPU rule conditions require the association of container IDs ("CTID") to a user-defined package names.

Using a supplemental data forwarder is simple - installation takes only a minute - requiring the download of a few PHP scripts and entering security credentials within the configuration file. The respective script may then be run regularly (e.g. via a crontab) to keep VPSMON updated of your customer packages and email addresses associated with their container IDs.

The supplemental data forwarder scripts are released under the MIT License, allowing you to view the source code and modify the source code as you require. A tarball containing the scripts is available here.


SolusVM - forwarder-solusvm.php

The SolusVM forwarder sends VPSMON the VPS container IDs associated with your client's contact email address, main IP address, and name.

The following steps outline how to install the SolusVM forwarder:

  1. Choose a server to install the forwarder on. The server must have network access to your SolusVM installation's API.
  2. Download and extract the forwarder archive from our website:
# wget --quiet https://www.vpsmon.com/forwarders/VPSMON-forwarders-0.94.tar -O ./VPSMON-forwarders-0.94.tar
# tar -xf VPSMON-forwarders-0.94.tar
# cd VPSMON-forwarders/
# cp config.php.orig config.php
  1. Access the VPSMON API Credentials configuration page to copy and paste the respective API endpoint and credentials into the config.php file. To edit the config.php file:
# nano config.php

Or if nano isn't available:

# vi config.php
  1. Access your SolusVM installation's Configuration -> API Access -> Add API User page.
  2. Create an API user with the respective IP address of the server onto which you are installing the VPSMON forwarder.
  3. Copy and paste the respective SolusVM API credentials into your config.php file values for the API_SOLUSVM_ID and API_SOLUSVM_KEY constants, and set the API_SOLUSVM_EP constant to the proper URL to your SolusVM installation. This is commonly in the form: https://solusvm.example.com:5656/api/admin/

To run the script manually or via a cronjob run the following. Log information will be printed to standard output and logged to the path within the value of config.php's LOG_PATH constant.

# php forwarder-solusvm.php
What data is collected?

The SolusVM forwarder collects per container:

  • Container ID ("CTID").
  • Container owner email address.
  • Container main IP. Optional
  • Container owner first, last name. Optional

This data is transmitted to VPSMON over an encrypted HTTPS (SSL) connection and stored within a secured database.

Important Note By default the SolusVM forwarder collects CTID information for each OpenVZ VPS node configured within SolusVM. This may be changed to send only specific nodes' CTID data via the config.php file. To have the script send only specific nodes' data, simply set the SOLUSVM_SYNC_NODES constant to a comma-separated string of node IDs as provided by the SolusVM Nodes -> List Nodes page.

Important Note The SolusVM forwarder collects client name information for each OpenVZ VPS CTID forwarded to VPSMON by default, which helps us personalize enforcement notification emails sent to your clients. This may be disabled via the config.php file by setting the SOLUSVM_SYNC_NAMES constant to false.

Important Note The SolusVM forwarder collects container main IP addresses for each OpenVZ VPS CTID forwarded to VPSMON by default, which helps us associate each product package names received from the WHMCS forwarder. This may be disabled via the config.php file by setting the SOLUSVM_SYNC_MAINIP constant to false.


WHMCS - forwarder-whmcs.php

The WHMCS forwarder sends VPSMON the product name per active VPS product/service in your WHMCS system. This is used to allow you to specify package-specific CPU collector rule conditions for your VPS containers.

For example:

  • Package "Basic" should not be allowed to utilize more than 1 GHz of CPU for 1 hour constantly, but has OpenVZ CPU access (`cpulimit'/`cpus' CT config options) fair share access to more than 1 GHz-worth of processing power for bursting purposes..
  • Package "Intermediate" should not be able to utilize more than 3 GHz entire CPU core for 1 hour constantly, but has OpenVZ CPU access access to more than 3 GHz-worth of processing power for bursting purposes.

Out-of-the-box SolusVM / WHMCS integration does not associate OpenVZ container IDs per service within the WHMCS. In order to work around this our data forwarder associates the main IP address of each service with your WHMCS product names. This data is then associated to the respective container ID once received by the VPSMON API. This requires that you have the SOLUSVM_SYNC_MAINIP SolusVM forwarder constant set to true.

The following steps outline how to install the WHMCS forwarder:

  1. Choose a server to install the forwarder on. The server must have network access to your WHMCS installation's API.
  2. Download and extract the forwarder archive from our website:
# wget --quiet https://www.vpsmon.com/forwarders/VPSMON-forwarders-0.94.tar -O ./VPSMON-forwarders-0.94.tar
# tar -xf VPSMON-forwarders-0.94.tar
# cd VPSMON-forwarders/
# cp config.php.orig config.php
  1. Access the VPSMON API Credentials configuration page to copy and paste the respective API endpoint and credentials into the config.php file. To edit the config.php file:
# nano config.php

Or if nano isn't available:

# vi config.php
  1. Access your WHMCS systems's Setup -> Administrators -> Add New Administrator page.
  2. Create an new WHMCS administrator user with your desired username and password credentials.
  3. Copy and paste the respective WHMCS user credentials into your config.php file as values for the API_WHMCS_USERNAME and API_WHMCS_PASSHASH constants, and set the API_WHMCS_EP constant to the proper URL to your WHMCS API file. This is commonly in the form: https://example.com/clients/includes/api.php
  4. Ensure the main IP address of the server running this data forwarder is added to the WHMCS Setup -> General Settings -> Security -> API IP Access Restriction field.

To run the script manually or via a cronjob run the following. Log information will be printed to standard output and logged to the path within the value of config.php's LOG_PATH constant.

# php forwarder-whmcs.php
What data is collected?

The WHMCS forwarder collects per container:

  • Container's main IP.
  • Container's WHMCS product name.

This data is transmitted to VPSMON over an encrypted HTTPS (SSL) connection and stored within a secured database.



Please enter your current password to continue.
Invalid password.
×

VPSMon Connection Issue


We urge you to immediately access the node and investigate the trouble. You may ensure that the VPSMon services are running using the below commands.

# service vpsmon-agent status
# service vpsmon-enforce status

If needed, you may remove this agent from VPSMon.

×

VPSMon Upgrade Available


This notice indicates that the VPSMon software on the node is not fully up to date. We recommend that you upgrade all of your nodes as soon as an update is available to increase the stability and performance of our software.

Agent Upgrade Documentation

Changelog

×

How much account credit would you like to add?

$
×