Difference between revisions of "Ahsay Backups"

From WHMCS Documentation

(Supported Operations)
(Customising Username)
 
(6 intermediate revisions by 3 users not shown)
Line 2: Line 2:
  
 
The module we have in WHMCS is designed to enable the offering of Ahsay backup accounts in an automated way. With support for fully automated setup and management, utilising all the options available in the Ahsay API.
 
The module we have in WHMCS is designed to enable the offering of Ahsay backup accounts in an automated way. With support for fully automated setup and management, utilising all the options available in the Ahsay API.
 +
 +
<div class="docs-alert-danger">
 +
This module is currently compatible with Ahsay v5.x only. The API in version 6 of the Ahsay software's is not backwards compatible, meaning that unfortunately this module cannot be used with newer releases.
 +
</div>
  
 
==Supported Operations==
 
==Supported Operations==
Line 12: Line 16:
 
*Password Changes/Resets
 
*Password Changes/Resets
 
*Trial Accounts
 
*Trial Accounts
 
==Purchase==
 
 
The Ahsay Backups module is available for $100 can be purchased from: https://www.whmcs.com/members/cart.php?a=add&pid=164
 
  
 
==Setup Instructions==
 
==Setup Instructions==
Line 21: Line 21:
 
Following purchasing the Ahsay Backup module via the link above, you will be able to download the module from our client area.  Once you have it, upload it to the folder '''/modules/servers/ahsaybackups/''' and then configure it as follows.
 
Following purchasing the Ahsay Backup module via the link above, you will be able to download the module from our client area.  Once you have it, upload it to the folder '''/modules/servers/ahsaybackups/''' and then configure it as follows.
  
#Begin by logging into your WHMCS admin area and then go to '''Setup > Products/Services > Servers'''
+
#Begin by logging into your WHMCS admin area and then go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
#Now create a new server, giving it a name, entering the IP address of your Ahsay server in the IP Address field, choosing "Ahsaybackups" in the Module dropdown and entering your Ahsay username & password in the respective fields
+
#Create a new server, giving it a name, entering the IP address of your Ahsay server in the IP Address field, choosing "Ahsaybackups" in the Module dropdown and entering your Ahsay username and password in the respective fields
#Once that's done, now move to '''Setup > Products/Services'''
+
#Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.
 
#Click the '''Create New Product''' link, and then configure the name, description, pricing and other settings as desired
 
#Click the '''Create New Product''' link, and then configure the name, description, pricing and other settings as desired
#Then switch to the '''Module Settings''' tab, choose '''Ahsaybackups''' in the Module dropdown and then the page will reload with the options for Ahsay Products
+
#Go to the '''Module Settings''' tab.
#From here, you can then set the Product Type, Client Type, Quota, Bandwidth, etc... as desired
+
#Choose '''Ahsaybackups''' in the Module dropdown. The page will reload with the options for Ahsay Products.
#Once done, save your changes and the product is then ready to be tested
+
#Configure the desired settings.
 +
#Save your changes.
  
 
==Configurable Options==
 
==Configurable Options==
Line 48: Line 49:
 
*'''EnableShadowProtectBareMetal'''
 
*'''EnableShadowProtectBareMetal'''
 
*'''EnableWinServer2008BareMetal'''
 
*'''EnableWinServer2008BareMetal'''
 +
 +
==Customising Username==
 +
 +
By default the module will use the client's email address for their login to Ahsay, however there may be occasions where it's beneficial to specify a different username. This can be achieved by creating a [[Custom_Fields#Product_Custom_Fields|Product Custom Field]] within the Ashay product called '''Username''' (select Text Box as the custom field type).
 +
 +
If the Username custom field has been completed under the client's '''[[Clients:Products/Services Tab|Products/Services]]''' tab before the module creation is triggered, then this will be used instead of the email address.

Latest revision as of 18:35, 18 April 2022

Ahsay Backup Software is a backup solution for users of all sizes, that can backup virtual machines, database servers, email servers, file servers, desktops and notebooks. Ahsay is the solution of choice by a large number of service providers for reselling and providing backup services to their customers.

The module we have in WHMCS is designed to enable the offering of Ahsay backup accounts in an automated way. With support for fully automated setup and management, utilising all the options available in the Ahsay API.

This module is currently compatible with Ahsay v5.x only. The API in version 6 of the Ahsay software's is not backwards compatible, meaning that unfortunately this module cannot be used with newer releases.

Supported Operations

  • Create Accounts
  • Suspend Accounts
  • Unsuspend/Reactivate
  • Terminate Accounts
  • Account Upgrades/Downgrades
  • Password Changes/Resets
  • Trial Accounts

Setup Instructions

Following purchasing the Ahsay Backup module via the link above, you will be able to download the module from our client area. Once you have it, upload it to the folder /modules/servers/ahsaybackups/ and then configure it as follows.

  1. Begin by logging into your WHMCS admin area and then go to Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers.
  2. Create a new server, giving it a name, entering the IP address of your Ahsay server in the IP Address field, choosing "Ahsaybackups" in the Module dropdown and entering your Ahsay username and password in the respective fields
  3. Go to Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services.
  4. Click the Create New Product link, and then configure the name, description, pricing and other settings as desired
  5. Go to the Module Settings tab.
  6. Choose Ahsaybackups in the Module dropdown. The page will reload with the options for Ahsay Products.
  7. Configure the desired settings.
  8. Save your changes.

Configurable Options

The following keywords can be used for configurable options in order to allow users to customise and choose the products you offer for Ahsay using optional items during the order process.

  • Quota
  • Bandwidth
  • EnableMSSQL
  • EnableMSExchange
  • EnableOracle
  • EnableLotusNotes
  • EnableLotusDomino
  • EnableMySQL
  • EnableInFileDelta
  • EnableShadowCopy
  • EnableExchangeMailbox
  • ExchangeMailboxQuota
  • EnableCDP
  • EnableShadowProtectBareMetal
  • EnableWinServer2008BareMetal

Customising Username

By default the module will use the client's email address for their login to Ahsay, however there may be occasions where it's beneficial to specify a different username. This can be achieved by creating a Product Custom Field within the Ashay product called Username (select Text Box as the custom field type).

If the Username custom field has been completed under the client's Products/Services tab before the module creation is triggered, then this will be used instead of the email address.