Module Installation

From VMTools English Wiki
Jump to navigation Jump to search

VMTools modules consist of two modules: VMTools_Addon and VMTools_Server. A "console" folder is located in the main directory.
The module installation and configuration are outlined below. Please proceed carefully and in order.

VMTools Module Installation

  1. Log in to the VMTools (vmtools.io) customer panel and click the "Edit" button located next to your license under the "License Management" menu. Ensure that the vCenter IP Address, vCenter Port, Domain Name (where Whmcs/Wisecp is installed), and IP Address (the web server IP where Whmcs/Wisecp is installed) are correctly filled.
  2. From the "Developer Center" menu in your customer panel, you need to deploy the desired OS .ova image to any disk of your ESXi server using vCenter (Deploy OVF Template). You can deploy the entire operating system and applications by downloading the OS Library with a single .ova image.
  3. From the "Developer Center," click "Download" to download the module files suitable for your version of Wisecp/Whmcs. Extract the downloaded .zip file to a folder on your computer. Then, upload all the extracted folders to the main directory of your hosting automation software (Wisecp/Whmcs). (e.g., public_html, whmcs, wisecp)
  4. You must whitelist the IP addresses of VMTools License Servers and the hosting IP address where Wisecp/Whmcs is installed in the vCenter firewall configuration if you have set up one; otherwise, the module will not work.
  5. Log in as admin to the Wisecp/Whmcs admin panel and proceed with the steps based on which automation software you are using:


6.a. Wisecp Module Configuration

  1. In the Wisecp admin panel, click the "Tools" menu and select the "Plugins" submenu. (Do not click on VMTools Module!)
  2. Find the "VMTools Module" and click the "Activate" button to enable the module. Then click the "Settings" button.
  3. Enter the license key from the "License Management" page in your VMTools customer panel on the opened page. Then, enter your vCenter login details and select the permissions for module settings, and click save.
  4. Return to the Wisecp admin panel homepage. Navigate to "Tools>Plugins>VMTools Module" to access the VMTools Module Management Panel.
  5. In the VMTools Management Panel, first go to the "Template Management" menu, edit all templates, and specify which server and image each template should match, then save.
  6. From the "Server Management" menu, you can add your server configurations. Then, from the "Pool Management" menu, determine which servers should be added to which pool.
  7. In the Wisecp product package settings, under the "Automation Settings" tab, you can select the Server Pool and define basic package features such as CPU, RAM, and disk. (Important: The CPU Core count and CPU MHz Limit are multiplied by their units!)
  8. In the Wisecp product package settings, under the "Optional Add-ons" and "Requirements" tabs, select the configurable options created by you or VMTools Module.
  9. To configure which operating systems customers can install in which packages, go to "Products/Services>Product/Service Addons" and replicate them according to the settings in VMTools Addon.
  10. In the Wisecp product package settings, under the "Upgradeable Products" tab, select the other product/service packages that customers can upgrade to. Upgrade and downgrade operations are performed automatically. If the "Disk" is reduced during the downgrade process, the server will be formatted! It is important to add this as a warning to your customer panel.
  11. Create a package with the lowest specifications and define "Optional Add-ons," so customers can add extra resources to their packages during ordering.


6.b. Whmcs Module Configuration

  1. In the Whmcs admin panel, click on the key icon in the top right corner to open the "Setup" menu. Enter the "Additional Modules" page.
  2. Find the "VMTools Module" and click the "Enable" button to activate the module. Then click the "Configure" button.
  3. Enter the license key from the "License Management" page in your VMTools customer panel on the opened page. Then, enter your vCenter login details and select the permissions for module settings, and click save.
  4. Return to the Whmcs admin panel homepage. Navigate to "Modules>VMTools Module" to access the VMTools Module Management Panel.
  5. In the VMTools Management Panel, first go to the "Template Management" menu, edit all templates, and specify which server and image each template should match, then save.
  6. From the "Server Management" menu, you can add your server configurations. Then, from the "Pool Management" menu, determine which servers should be added to which pool.
  7. In the Whmcs product and service package settings, under the "Module Settings" tab, you can select the Server Pool and define basic package features such as CPU, RAM, and disk. (Important: The CPU Core count and CPU MHz Limit are multiplied by their units!)
  8. In the Whmcs product and service package settings, under the "Configurable Options" tab, select the configurable options created by you or VMTools Module.
  9. To configure which operating systems customers can install in which packages, go to the "Setup" menu and select the "Configurable Options" page, replicating them according to the settings in VMTools Addon.
  10. In the Whmcs product and package settings, under the "Upgrades" tab, select the other product/service packages that customers can upgrade to. Upgrade and downgrade operations are performed automatically. If the "Disk" is reduced during the downgrade process, the server will be formatted! It is important to add this as a warning to your customer panel.
  11. Create a package with the lowest specifications and define "Configurable Options," so customers can add extra resources to their packages during ordering.


We value your feedback and suggestions. Any bugs or feature requests you report will be reviewed promptly.

VMTools Software Solutions / Software Department
info@vmtools.io - www.vmtools.io
+90 224 334 01 24 (Whatsapp)