Integration with WHMCS

From ISPWiki
Jump to: navigation, search
Hierarchy: VMmanager KVM ->INTEGRATIONS
VMmanager Cloud ->INTEGRATIONS

Installation of the integration module

In order to install the integration modules with DCImanager, VMmanager OVZ and VMmanager KVM, browse to the modules directory of WHMCS setup root directory and unpack the following files:

WHMCS v7.x

http://download.ispsystem.com/extras/whmcs/7/whmcs_isp_ve.tar.gz - archive for  VMmanager OVZ
http://download.ispsystem.com/extras/whmcs/7/whmcs_isp_vm.tar.gz - archive for VMmanager KVM
http://download.ispsystem.com/extras/whmcs/7/whmcs_isp_dci.v.2.tar.gz - archive for DCImanager

Previous versions

http://download.ispsystem.com/extras/whmcs/whmcs_isp_ve.tar.gz - archive for VMmanager OVZ
http://download.ispsystem.com/extras/whmcs/whmcs_isp_vm.tar.gz - archive for VMmanager KVM
http://download.ispsystem.com/extras/whmcs/whmcs_isp_dci.v.2.tar.gz - archive for DCImanager

Once the modules are installed, navigate to Setup - Addon Modules and click Activate for ISPsystem global module.

After the installation is complete, you can create service packages and server connections.

Integration

To connect tp DCImanager, VMmanager KVM or VMmanager OVZ, go to "Setup -> Products/Services -> Servers" and click "Add New Server" (we recommend that you group several servers when adding).

Select an appropriate server type: Vemanager for VMmanager OVZ, Vmmanager for VMmanager, Dcimanager for DCImanager, and the administrator's (not root) login and password to access the control panel. Note: in the "IP address' field you need to enter the server IP address and port 1500, eg. "1.2.3.4:1500". For each connection the "Log in" button will show in allowing for automatic authentication with a temporary key.

Service package settings

When configuring a service package, the following values are provided:

  • Product Type - Dedicated/VPS Server
  • Product Group - required product group
  • Product Name - name a service package

In the Module Settings tab you can select:

  • Module Name - Vmmanager, Vemanager or Dcimanager, depending on the control panel
  • Server Group - group of the corresponding servers

The following parameters vary depending on a control panel.

VMmanager KVM


  • Package Name- name of the container's template in the control panel. It can be found in the "Container templates" module
  • File system - file system that will be used for creating new containers
  • Memory quota - amount of memory that will be allocated to the container
  • Processor frequency - processor priority that will be set for the container
  • Files count - maximum number of open files per container
  • SSH public key - you can specify the SSH public key for facilitating support of that container
  • Operation system - name of the default template disk (lowercase)
  • Disk quota - limit on the hard disk size
  • Processors count - limit on the number of processors
  • Processes count - limit on the number of running processes
  • Main IP address type - type of IP addresses that will be allocated to the container. If the value for parameter is not specified, the value will be imported from the container template.
  • Recipe Name - name of the recipe that will be executed after OS installation (the default value is null). For local recipes #local__recipe_name, for recipes from repository repository_name__recipe_name. You can find a recipe name in the /nfsshare/recipes/local/ and /nfsshare/recipes/repo/repository_name/ correspondingly.
  • Don't wait the OS install - do not wait for the OS installation process to complete when activating a service.
  • Domain template - domain template. If nothing is specified, the domain name that a user enters in WHMCS order form, will be added.

VMmanager OVZ


  • Package Name- name of the container template in the control panel. It can be found in the "Container templates" module
  • Disk quota - limit on the hard disk size
  • Memory quota - amount of memory that will be allocated to the container
  • Processor frequency - processor priority that will be set for the container
  • Processors count - limit on the number of processors
  • SSH public key - you can specify the SSH public key for facilitating support of that container
  • Main IP address type - type of IP addresses that will be allocated to the container
  • Operation system - id of the default disk template. (eg. centos-7-amd64-ispmgr5). You can find a name in VMmanager in the disk template directory.

Example

[root@vemgr ~]# ls /nfsshare/ISPsystem__VECentos-7-amd64-ispmgr5/
centos-7-amd64-ispmgr5.tar.gz  metainfo.xml

delete .tar.gz - centos-7-amd64-ispmgr5

  • Memory quota - amount of RAM that will be allocated to a container.
  • Processor frequency - priority of the process that will be set for a container.
  • SSH public key - enter a public SHH key
  • Recipe Name - name of the recipe that will be executed after OS installation (the default value is null). For local recipes #local__recipe_name, for recipes from the repository repository_name__recipe_name. You can find a name in the /nfsshare/recipes/local/ and /nfsshare/recipes/repo/repository_name/ correspondingly.

DCImanager


  • Package Name - enter the name of the server configuration
  • Operation system - id of the default template disk. You can view a list of ids by calling https://server_ip:1500/dcimgr?func=osmgr&out=xml function
  • Recipe Name - name of the recipe that will be executed after OS installation (the default value is null). For local recipes #local__recipe_name, for recipes from the repository repository_name__recipe_name. You can find a name in the /nfsshare/recipes/local/ and /nfsshare/recipes/repo/repository_name/ correspondingly
  • Don't wait the OS install - do not wait for the OS installation process to complete when activating a service.

For more information about integration between WHMCS and DCImanager, please refer to this article.

Additional options


The following options can be configured for tariff plans:

  • operating system
  • recipe
  • IPv4 and IPv6 address

Navigate to the "Configurable Options" section to create a new group of options (we recommend that you have a separate group of options for each connection to the control panel, or the list of disk templates must be suitable for all the connections), in which you can create the appropriate options.

You can use one of the following names for the list of operating systems:

  • OS
  • os
  • ostemplate

Use the following name for recipes:

  • recipe

The name of each option must match the name of the disk template, the same way as in "Module Settings". For IPv4 the option name should be IP, IPv6 - for IPv6 addresses.

Integration capabilities

At the moment of writing the article, the integration modules support the following operations:

  • Create containers and virtual machines, deploy dedicated servers
  • Start / stop containers and virtual machines, power on/ off the dedicated servers, enable/disable network ports
  • Delete containers and virtual machines, activate and clean off the owner for DCImanager servers
  • Reboot containers, virtual machines and servers
  • Log in into the panel with administrator and user permissions
  • Modify service package for containers and virtual machines
  • Collect statistics of disk space usage and bandwidth usage per container and virtual machine, as well as bandwidth usage per dedicated server.
  • DCImanager: reinstallation of an operating system based on a customer's order

Additional information

  • The suspend function in WHMCS corresponds to server.disable (the "Block" button) in DCImanager.
  • The terminate function in WHMCS corresponds to server.poweroff (the "Of"f button) in DCImanager.

Troubleshooting

  • Q: Order failed with the "Can not create user!" error. In "Utilities->Logs->Module Logs" you can see error report "value:The 'Password' field has invalid value. This password is too weak. The server administrator does not allow using such passwords"

A: Change password strength in VMmanager (Settings - System configuration - Password strength - set "Weak"). The second way is to change "Required Password Strength" Setup->General settings->Security in WHMCS.

  • Q:

The DCImanager module. Statistics from switch port, label, ipmi ip. is not collected.

A: Check that addons/ispsystem_official/ispsystem_official.php 1.1 is used. Upload it if needed. Corresponding fields must be specified in mod_ispsystem. If not, open the page with add-ons, the fields will be added.