module installation

Important Warnings

• Regular backups of your vCenter Server Appliance are essential to guard against potential failures. Without them, you may need to manually reconfigure services tied to the module!
• You can perform backups (FTP/local) via the Backup menu in the management interface at "https://vcenter.example.com:5480". During a fresh installation, you can restore your configuration from these backups.
• Do not remove (delete) any hosts registered in the vCenter configured for VMTools (they may be disconnected); otherwise, their IDs in the module database will become invalid when re-added.
• If you are using Plesk Panel, the panel’s address must have a valid SSL certificate. Otherwise, module requests will fail with cURL SSL errors.
• If you use Plesk Panel or cPanel and Imunify360 is installed and active, you must add the VMTools module’s files and directories to the exclusion list.

Pre-installation Information

• Carefully follow the steps below to complete the installation of the VMTools Server Automation Software.
• If you encounter any errors during installation, you can review the steps, open a support ticket in your customer panel, or get technical help via our WhatsApp support line.

We value your feedback and suggestions. We offer free, fast solutions for any bugs, feature requests, or support inquiries you report.

WhatsApp Support Line: +90 (224) 334 01 24

Customer Panel: Open a Support Ticket

Email: info@vmtools.io

Getting Started

1. Log in to your VMTools (https://vmtools.io) customer panel and go to the License Management menu. Click the "Edit" button next to your license.

2. Enter and save the vCenter IP Address, vCenter Port, Domain Name (where WHMCS/WiseCP is installed), and Web Hosting IP Address.

3. In the Developer Center, click the cloud icon to download the "vmtools_modules_latest.zip" module files that match your WHMCS/WiseCP PHP version. (Supported Hosting Automation Software Versions)

4. Extract the downloaded .zip file to a folder on your computer. Upload all extracted folders to the root directory of your hosting automation software installation (e.g., public_html, whmcs, wisecp).

5. If your website, vCenter, or PowerDNS panel is protected by a software or hardware firewall (e.g., MikroTik), you must allow the following IP addresses for the VMTools license servers and modules to function:

• 128.140.30.116/32 (IPv4)
• 188.245.195.135/32 (IPv4)
• 188.245.199.76/32 (IPv4)
• your hosting IP address/32 (IPv4 and IPv6)

6. Next, continue with the section for the automation software you use: "WiseCP (4.a) / WHMCS (4.b)".
6.a. WISECP module configuration;

1. In the WiseCP admin panel, go to "Tools > Addons" (do not click VMTools Module yet).
2. Find "VMTools Module", click "Activate", then click "Settings".
3. On the settings page, enter your license key from the "License Management" page in your VMTools customer panel. Then enter your vCenter credentials and select the permissions for module users. Save.
4. Return to the WiseCP admin home page. "Select Tools > Addon > VMTools Module" to open the VMTools Module Management Panel.
5. In the Management Panel, go to "Template Management" to map each template to the appropriate host and image, then save.
6. Under "Server Management", add your server configurations. Then in Pool Management, assign servers to pools.
7. In your WiseCP product package settings under the "Automation Settings" tab, select a Server Pool and configure basic resources (CPU, RAM, disk). (Note: CPU Cores × CPU MHz Limit are multiplied as units!)
8. Under "Optional Add-ons", mark any custom or VMTools-generated configurable options.
9. To control which operating systems customers can install, go to "Products/Services > Product Add-ons" and replicate the VMTools Addon settings.
10. Under "Upgradable Products", choose other products/services that customers can upgrade or downgrade to. Upgrades and downgrades happen automatically. ⚠️ Downgrading (reducing disk) will reformat the server – please warn customers!
11. If you create a minimal package with "Optional Add-ons", customers can add extra resources during ordering.
12. In the VMTools Management Panel’s "General Settings", add the cronjob commands and schedule to your hosting control panel’s Cron Jobs section.
13. Also in "General Settings", if you do not enable the Default Information option, hostnames and passwords will be auto-generated during order steps. Enabling it lets customers specify them.

6.b. WHMCS module configuration;

1. In the WHMCS admin panel, click the gear icon in the top right and open "Setup > Addon Modules".
2. Find VMTools Module, click "Activate", then click "Configure".
3. On the configuration page, enter your license key from the VMTools customer panel’s License Management page. Then enter your vCenter credentials and select the appropriate permissions. Save.
4. Return to the WHMCS admin home page. "Go to Addons > VMTools Module" to open the VMTools Module Management Panel.
5. In the Management Panel, first go to "Template Management" to map each template to the appropriate host and image, then save.
6. Under "Server Management", add your server configurations. Then in "Pool Management", assign servers to pools.
7. In WHMCS’s product package settings under "Module Settings", select a Server Pool and configure CPU, RAM, disk, etc. (Note: CPU Cores × CPU MHz Limit are multiplied!)
8. Under "Configurable Options", select any custom or VMTools-generated options.
9. To control which operating systems customers can install, go to "Setup > Configurable Options" and replicate the VMTools Addon fields.
10. Under "Upgrades", choose other products/services that customers can upgrade or downgrade to (automatic). ⚠️ Downgrading disk capacity will reformat the server – please warn customers!
11. If you create a minimal package with Configurable Options, customers can add extra resources during ordering.
12. In "General Settings", add the VMTools cronjob commands and schedule to your hosting control panel’s Cron Jobs section.
13. Also in "General Settings", if you do not enable "Default Information", hostnames and passwords will be auto-generated. Enabling it lets customers specify them.

7. Deploying Operating Systems and Applications

In the VMTools customer panel’s "Developer Center", select your desired OS .ova image. In vCenter, right-click on your ESXi host and choose "Deploy OVF Template", then pick the target datastore. You can use an OS Library .ova to bundle all operating systems and applications into a single image for deployment. For details on matching OS/app templates to ESXi hosts, see Edit Template.

• The “os_library.ova” contains 110 VMs and is in vApp format, which cannot be deployed inside a cluster. To deploy: disconnect the host from vCenter, move it out of the cluster, reconnect, deploy the vApp, then move the host back into the cluster. The vApp will convert automatically.
• Do not use “Convert to Template” on deployed OS images; they must remain VMs.

Server Web Console

• In VMTools Module > General Settings, configure the "Web Console Settings" with your proxy URL. For proxy setup details, see Websocket Proxy Setup.
• Enable the customer web console via VMTools Module > Page Settings > Web Console.

Pool and Server Creation

• After installation, create a server pool and add your servers. For details, see Create New Pool | Create New Server.

Thank you for choosing VMTools, and happy automation! ☺️