Initial configuration of the module

Overview#

To configure the SolusVM module in WHMCS, you must generate an API token in SolusVM and then add your SolusVM server to WHMCS. This establishes the connection between WHMCS and your SolusVM management node.

Generate an API token#

To generate an API token in SolusVM:

1. Log in to the SolusVM administrator web interface.

2. Navigate to Access > API Tokens > Generate API Token.

3. Enter a name in the Name field.

4. Click Generate, then copy and save the generated token in a secure place.

   Warning:

   After you click Copy & Close it is not possible to view the token.

   The following image shows the API token generation interface:

Add the SolusVM server to WHMCS#

To add the SolusVM server to WHMCS:

1. Log in to the WHMCS administrator web interface.

2. Navigate to WHMCS > System Settings > Servers > Add New Server.

   The following image shows the server addition interface:

3. Select SolusVM VPS in the Module dropdown list.

4. Enter the IP address or hostname of your SolusVM management node in the Hostname or IP Address field.

5. Copy the API token from step 4 in the previous section and paste it into the Password field.

6. Click Test Connection.

   The following image shows the server configuration form:

   If the server settings are correct and WHMCS can connect to the SolusVM management server, the system displays the following success message:

   

7. The page displays three sections: Add Server, Nameservers, and Server Details. Configure the following settings in the Add Server section:

   • Name — Enter your server name.
   • Hostname — Enter the hostname or IP address of the SolusVM management server.

   The following image shows the server details configuration:

8. Click Save changes.

Create a server group#

To create a server group in WHMCS:

1. Navigate to WHMCS > System Settings > Servers > Create New Group.

   The following image shows the server group creation interface:

2. Configure the server group settings:

   • Name — Enter a name for your server group.
   • Keep the Add to the least full server option selected.
   • In the Selected Servers box, add the server you created in the previous steps.

   The following image shows the server group configuration:

3. Click Save Changes.