The great advantage of this module is the fact that customers can manage virtual servers, backups and much more in your own WHMCS client area!
Additionally it allows you to conveniently overview and manage all the customers' servers.

We will guide you step by step through the whole installation and configuration process.

File is located at 'modules/servers/OpenStackVPS/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

Enter your license key between quotation marks as presented on the following screen.
You can find your license key at your client area → 'My Products' .

Go to the 'Setup' → 'Products/Services' → 'Servers' and press 'Add New Server' .

Choose 'OpenStackVPS' from a dropdown menu and press 'Save Changes' .

Simply edit previously created server and press 'Test Connection' as shown on the screen below.

Click on 'Create a New Group' .

To create a product click on 'Create a New Product' .

'Product Type' should be set to 'Dedicated/VPS Server' .

Next, click on 'Save Changes' .

In this section we will show you configuration of VPS with predefined resources.
Configuration of VPS with resources chosen by client can be found here.

You can set up network in two ways. You can find more information about the configuration here.
We will set up a network without floating IP address as presented on the following screen.
Additionally, choose quantity of IP addresses assigned to product by typing it into 'Default Number Of IP Addresses' .

Mark 'Backups Routing' checkbox if you want to replace oldest backup with newest one when backups file limit is reached.
Afterwards, enter limit of backup files into 'Default Backups Files Limit' .

Mark checkbox next to a feature to enable it. Press 'Save Changes' when you are done.

Use cron job below but switch 'your_whmcs' with your root WHMCS path.

php -q /your_whmcs/modules/servers/OpenStackVPS/cron/cron.php

It will prepare default configurable options which can be afterwards easily edited by as described in this article.

Choose 'Fixed Network' , 'Floating Network' and 'Default Number Of IP Addresses' .
You can set up a network in two ways. For additional information visit this page.
As you can see on the following screen, we will set up a network without floating IP address.

Backups routing is useful when your client orders product with limited backup files quantity.
It will replace oldest backup with backup just created, but only when backup limit is reached.
Backups routing can be enabled through marking 'Backups Routing' checkbox.

Mark checkbox next to the feature to enable it. Press 'Save Changes' when you are done.

Use cron job below, but switch 'your_whmcs' with your root WHMCS path.

php -q /your_whmcs/modules/servers/OpenStackVPS/cron/cron.php

You can monitor and manage each product from your WHMCS admin area.
1. Configurable options which enables you to view current VPS resources and change VPS specifications through changing configurable options and pressing 'Change Package' .
2. Module commands enables you to manage VPS status.
3. Here you can find VPS details and refresh them through pressing 'Refresh Details' icon.
4. Scheduled tasks status can be found in this table.
5. In marked custom fields you can find IDs of VM and private flavor.

Additionally, you are able to set up pricing for each configurable option, which make your offer even more competitive.
Important: VPS is not created immediately after ordering 'Create' . Therefore, it is wise to inform your clients about the delay.

Module allows your customers to easily start/stop, pause/unpause, resume, soft reboot, hard reboot and reset network of their servers through pressing specified button.
Clients can also rebuild the server, access noVNC console, create a backup and view scheduled tasks.
At 'Tasks' your customers can view all requested tasks that was not yet completed with information bounded to them, like type of task, attempts to perform tasks or last returned response.

Press 'Rebuild' button as shown on the following screen in order to move to the rebuild page.

Afterwards, confirm through clicking on 'Rebuild' button.

As you may notice on the following screen, presented earlier 'OldBackup' backup was replaced with 'NewBackup' .
It was caused by backup routing feature which was triggered by reaching backups file limit.

First one is a network without floating IP address.
To set up this type of a network, choose 'Public' as 'Fixed Network' and 'Disabled' as 'Floating Network' .
On the following screen you can view exemplary topology of such network.

Select 'Shared Network' as 'Fixed Network' and 'Public' as 'Floating Network' .

To do so, go to 'Setup' → 'Products/Services' → 'Configurable Option' and press edit button next to configurable option used by your product.
Its name is 'Configurable options for your_product_name' .

Now we will show you how to edit options. Let's say that you want to add an option to order VPS with 8GB (8192 MB) RAM.
To do so, edit 'ram|RAM' by pressing edit button as shown on the screen below.

To add new option, enter it in a textbox under all other options. If you want to replace it with option you currently have, simply edit its textbox.
Next, press 'Save Changes' .

Tasks visible at 'Scheduled Tasks' are subsequently performed by cron job.
Full list of tasks supported by 'Scheduled Tasks' are: create, terminate, change package, remove IP address and remove backup.

Reason: WHMCS server cannot resolve OpenStack endpoint hostnames.
Solution: Log in to your OpenStack via SSH and use 'keystone endpoint-list' command to obtain list of needed endpoints.

All not reachable URLs have to be added to 'hosts' file on a server with your WHMCS.