Personal tools
Namespaces

Variants
Actions

DNS Manager For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About DNS Manager For WHMCS

DNS Manager For WHMCS is an end-to-end module that enables your customers to be in charge of their DNS zones.

Thanks to a wide variety of submodules, combined with options allowing you to prepare ready packages, your DNS Manager For WHMCS is there for you to surely meet your expectations.
As an administrator you have full control over DNS zones and possess access to a broad range of management options.

Wiki of DNS Manager For WHMCS 1.9.10 can be found here.

  • Admin Area Features:
✔ Define DNS Servers
✔ Define Packages
✔ Create DNS Zones
✔ View And Edit Existing Zones
✔ Migrate Zones Between Chosen Servers
✔ Import Zones From Chosen Server
✔ Manage Zones Backups
✔ Define DNS Records Set
✔ Apply DNS Record Sets To Multiple Zones At Once
✔ Wipe Existing Zone Records Upon Applying DNS Records Set
✔ Set Up Automated Tasks And Execution Time
✔ Toggle Administrator Notifications And Choose Who Send Them To
✔ Modify Notifications Email Templates
✔ Allow Creation Of PTR Record Without DNS Zone
✔ Protect DNS Zones On Product Termination
✔ Manage Client Area Zones Features:
✔ Select Default Template
✔ Toggle DNS Management Link
✔ Choose Scope Of Zones Management:
✔ Allow DNS And rDNS Management
✔ Allow Only DNS Management
✔ Allow Only rDNS Management
✔ Allow Zones With Related Service IP Addresses Only
✔ Allow Zones With Owned Domains Only
✔ Allow Zones With Custom Subnet IP Addresses
✔ Allow rDNS With Custom IP Address
✔ Allow DNS With Custom IP Address
✔ Allow Management Of DNS Record Sets
✔ Allow Management Of Zones Backups
✔ Define Zones Backups Limit
✔ Choose Whether To Display Zone's Product Name
✔ Define Zone Statutes Displayed In Client Area
✔ SOA Warning
✔ Available Domain
✔ Active
✔ Pending
✔ Define Blocked DNS Strings With Regex Support
✔ Define Logs And Notifications Settings
✔ View Details And Notifications Related To Zones And Servers Load
✔ View Information About Automated Tasks
✔ View Scheduled Tasks Progress
✔ Display Usage Of DNS Servers
✔ View Email Notifications Statistics
✔ View Logs
  • Client Area Features:
✔ View List Of Owned Packages
✔ View Domain Status
✔ Add And Manage New Zones Within Package Limit
✔ Add And Manage Zones Records Within Records Limits
✔ Add And Manage PTR Records Without DNS Zone
✔ Toggle DNSSEC For Zone
✔ View DNSSEC Details Of Zone
✔ Add And Manage DNS Records Sets
✔ Create Zone From DNS Records Set
✔ View Zones Limit Per Package
✔ View DNS Records Limits Per Zone
✔ Create Selected Zones Backups:
✔ On Server
✔ Export To File
✔ Import From File
  • Automation Features:
✔ Provision Packages
✔ Migrate Zones
✔ Import Zones
✔ Clear Unused Zones
✔ Clear Logs
  • Server Settings:
✔ Allow rDNS Records
✔ Enable DNSSEC
✔ Allow Multiple PTR Records
✔ Use Cache To Optimize Loading Time
✔ Overwrite SOA Record
✔ Populate Nameservers
✔ Define Nameservers
  • Package Settings:
✔ Define Zones Limit Per Package
✔ Define Items (Products/Domains/Products Addons) Purchase Of Which Results In Receiving Package
✔ Define If Single Instance Of Package Should Be Assigned To Each Client
✔ Define Servers Used By Package
✔ Define Allowed Record Types
✔ Define Total Records Limit
✔ Define Record Limits Per Type
✔ Define Automation Settings For Creating First Zone
✔ Assign Default DNS Records Set
✔ Allow Client To Create Zone Using Chosen DNS Records Sets
✔ Introduce DNS Management Functionality If Domain Registrar Does Not Support It By Default
✔ Toggle Client And Administrator Notifications
  • Supported DNS Servers:
✔ 4PSA
✔ AtomiaDNS
✔ AWS Route 53
✔ Cloudflare
✔ cPanel & cPanel DNSOnly
✔ DigitalOcean
✔ DirectAdmin (DNSSEC Support)
✔ DNS Made Easy
✔ DNS Pod
✔ DNS.com
✔ DynECT
✔ EuroDNS
✔ Freenom
✔ InterWorx
✔ Nettica
✔ OpenSRS
✔ OVH
✔ Plesk
✔ PowerDNS (DNSSEC Support)
✔ PowerDNS Hosted
✔ PowerDNS V4 (DNSSEC Support)
✔ Rackspace
✔ Rage4 DNS
✔ RRPProxy
✔ Simple DNS Plus
✔ Simple DNS Plus V8 (DNSSEC Support)
✔ Storm On Demand
✔ Zonomi
  • Supported DNS Record Types:
✔ A
✔ AAAA
✔ AFSDB
✔ ALIAS
✔ CAA
✔ CNAME
✔ DNAME
✔ DNSKEY
✔ DS
✔ HINFO
✔ ISDN
✔ LOC
✔ MB
✔ MD
✔ MF
✔ MG
✔ MINFO
✔ MR
✔ MX
✔ NAPTR
✔ NS
✔ PTR
✔ RP
✔ RRSIG
✔ SOA
✔ SRV
✔ TXT
✔ WKS
✔ X25
  • General Info:
✔ Supports IDN Zones
✔ AJAX Loaded Pages In Admin Area
✔ Supports Template Customization
✔ Connect With DNS Manager Using Its API
✔ Integrated With IP Manager For WHMCS - Complete Management of IP Subnets (read more)
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.1
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.2 And Later

Installation

In this short tutorial we will show you how to successfully install DNS Manager For WHMCS.

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

1. Log in to our client area and download the module.
DNS2 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.
It does not apply to open source versions.

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.

DNS2.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

DNS2 2.png
4. When you install DNS Manager For WHMCS for the first time you have to rename the 'license_RENAME.php' file.

This file is located in 'modules/addons/dns_manager/license_RENAME.php.' Rename it from 'license_RENAME.php' to 'license.php'.

DNS3.png
5. In order to configure your license key you have to edit the previously renamed 'license.php' file.

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

DNS4.png
6. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Click 'Setup' then choose 'Addon Modules'.
Afterward, find 'DNS Manager' and press the 'Activate' button.

DNS 3.png
7. In the next step you need to permit access to this module. To do so click on the 'Configure' button, choose 'Full Administrator' and press 'Save Changes'.
DNS 4.png
8. Good job! You have just successfully installed DNS Manager For WHMCS! Now in your WHMCS system press 'Addons' then press 'DNS Manager'.
DNS2 6.png

Configuration and Management

This section has been divided into two main parts to allow full and, at the same time, easy understanding of the whole module functionality.
In the first part 'Basic Configuration' an exemplary flow of basic configuration of servers, through creating packages and then zones management
from both the client and the administrator side has been presented.
In the second part, there are described additional settings and tools that can be used while working with DNS Manager For WHMCS.

Basic Configuration

In the first place we would like to show you the process of configuring your DNS manager on a simple example.
Follow the steps below to see how the process looks like in practice.

Proceed to 'Addons' → 'DNS Manager'. There are several sections, but the one that you should be interested in the most in the beginning is named 'Servers'.
You will find it under the 'Settings' tab.

DNS2 6 1.png

Servers Configuration

To start your work, add a new server.
DNS 7.png
To add a new server you must fill out some data to allow connection with it. As an example, we will try to connect with cPanel server.
Additionally, you may declare here whether you need rDNS, Multiple PTR or Cashe. Select the desired options.

Please note, that there is also an option Enable DNSSEC available. However, it is currently compatible only with DirectAdmin, PowerDNS and PowerDNS V4 submodules.
DNSSEC (DNS Security Extensions) - allows enabling validation and authentication of the origin and integrity of DNS data.
If you enable this option, the client will be allowed to turn on DNSSEC for a zone and display its DNSSEC-related details accordingly.

DNS 8.png
If you want to have the nameserver records populated each time a new zone is created, make sure to check the Populate Nameservers option.

Similar scenario applies to the Overwrite SOA record checkbox which stands for automatically assigned nameservers in the SOA record.

DNS 8 1.png
Once you have chosen a server from the dropdown menu, 'Configuration' and 'Nameservers' tabs appear.
Enter your username, password, Hostname/IP and any other details needed to connect successfully.
Now, press 'Nameservers' and enter the nameservers that will be visible for your customers in their client area.

Before you save the changes remember to test the connection.

DNS 9.png
Please also note that the configuration differs per selected submodule!
DNS 9 1.png
Now, that you have a ready server on the list of servers you may manage it. Turn it on/off, edit or delete.
DNS 10.png

Management of Packages

Packages - these are collections of settings related to the products for sale.
Thanks to these, the client will be allowed to create specific zones and will possess the access to DNS Management in the Client Area.
Click 'Add Package' to see how to configure it and what exactly can be specified there.
DNS 11.png
In the General section, you obviously have to name the newly created package and define the number of zones per item (limit of zones that a client may then create within this package).
Here, you can also decide if zones should be created automatically after defined actions.
These are:
  • New Item - zones will be created automatically for every new product being activated
  • Pending Transfer Domain - zones will be automatically created for the domains during their transfer:
    • Pre - a new zone will be created right before launching the transfer to the registrar
    • After - the transfer occurs first, and only if it ends successfully a new zone is created
  • Pending Registration Domain - zones will be created automatically for newly registered domains
  • Domain with DNS Management - zones will be created automatically for domains that have been ordered with the 'DNS Management' domain addon
  • Allow Update Of Existing Zone - if zone already exists, it will be updated with newly added record sets
DNS 12.png

Items

Assign Domains, Products or/and Product Addons from available ones to the package. Here you can also allow clients to create their own free zones.

Simply select option under the 'Other' section. Remember that you may use this option for one package only.

DNS 13.png

Servers

Assign the package to the previously added server.

Note: You may always assign the package to more than one server.

DNS 14.png

Record

In this part, you may define the record types that you want to enable and declare their limit.

Note: The 'Total' value cannot be lower than the sum of limits set for individual records.

DNS 15.png
You may also choose DNS Records Sets that will be applied to this package.
  • Default DNS Record Set - this default set will be automatically applied upon the zone creation
  • DNS Record Sets - choose the sets created by the administrator that will also be available for clients to choose from when adding a new zone
DNS 15 0.png

Registrars

In this part, you may allow 'DNS Management ' option for selected here registrars that do not support DNS management by default.
DNS 15 1.png
Please note that the inbuilt WHMCS DNS Management will be used to handle the above functionality.
DNS 15 2.png

Notification

In the last part you may configure which notification will be sent to clients and administrators.
Do not forget to 'Add' the package.
DNS 16.png
Enable the newly created package to allow it to be used!
DNS 17.png

DNS Management in Client Area

Now, that we already have the module configured you may see how clients will add and then manage their zones.
In the client area find the button 'Manage DNS', it will redirect you to the management page.
DNS2 18.png

New Zones

In here, clients may add new zones. To do so, simply type in the name of the zone and choose IP address from the available or enter your custom IP.
It depends on your configuration - read more about possible options here.
From the dropdown menu clients can also define record sets. If they do not have any added, the default one created by the administrator in the admin area will be selected.
When clients create sets by themselves, they can use the one defined by them as default, or choose other one from the list.
DNS2 19.png
DNS2 19 1.png
Allowed actions on a zone:
  • edit existing zone
  • delete zone
DNS2 20.png
Press 'Edit' to see details of the zone, you may edit the zone here and add new records if limits allow you.
DNS2 45.png
Enter a new record's name, choose the type from available etc.
DNS2 46.png

Enable DNSSEC

If the 'Enable DNSSEC' option has been selected ('DirectAdmin', 'PowerDNS' and 'PowerDNS V4' submodules), the client may turn it on.

To do so, press the 'DNSSEC' button.

DNS2 45 1.png
Enable DNSSEC here, you will then get access to DNNSSEC details for the zone, including keys and delegation signer records.

Press 'Rectify Zone' to comply with DNSSEC.

DNS2 45 3.png

Add rDNS Records

If you have allowed the rDNS management in the client area by selecting either 'Allow DNS And rDNS Management' or 'Allow Only rDNS Management' option (read more here) in global settings,
your clients can create PTR records for IPv4 and IPv6 addresses without any related zone. To do so press 'Manage Reverse DNS'.
DNS2 63.png
Find and press the 'Add PTR' button.
DNS2 64.png
Select related item, then depending on the configuration enter IP address or choose IP or Subnet from the available list.

Note: Subnets are available only if you have integrated your DNS Manager with IP Manager For WHMCS - see below options for more details.

DNS2 65.png
Your newly created rDNS record should appear on the list. You may edit RDATA or delete the record completely.
DNS2 66.png

Add DNS Record Sets

You can add and manage records sets in the DNS Record Sets section as shown below.
DNS3 10.png
Click the 'Add Set' button and provide the necessary details.
It can be also set as default.
DNS3 11.png
DNS3 12.png
You newly created DNS record should appear on the list. You may edit or delete it completely.
DNS3 13.png

Backups

You can manage fully your zones backups. Move to the mentioned section to see any options.

Note that this option must have been previously allowed by your administrator in general settings.

DNS3 15.png
There are two sections available. Current "Backups Tasks" and a "Backups List" including files with backed up zones.

Press the 'Create Backup' button to start.

DNS3 16.png
A new task is added immediately. Now, all you need to do is select the zones from available that will be processed and stored in a backup file.

Press the 'Backup Zones' button when ready.

DNS3 17.png
Backups Tasks

The just added task to back up the zones is now visible on the list of all tasks. There are also information on the task progress and number of zones already processed.
To see details, press 'Show List' button.
Important: Keep in mind that you must wait until the next execution of the "Cron Importer" to start processing. If it is set to more than 5 minutes, you will not see the results on the run.

DNS3 18.png
You will be moved to the list of currently maintained zones. Check the status of each one of them.
DNS3 19.png
Backups List

Here you will find a list of all files with a number of backed up zones. In order to upload a ready backup file, simply press the 'Upload File' button.

DNS3 20.png
Select the file from your store, keep in mind that only the previously downloaded backup files can be used.
Surely, such file can be edited in any editor to adjust the records inside it to your needs, but you must be careful and stick to its form.
DNS3 21.png
Use the action buttons to start the tasks:

1. - Restore backup file. This action, when stared, is also visible on the list of tasks above.
2. - Download the file.
3. - Delete the file.

DNS3 22.png

Zones Management

In the administrator panel, you can spot all your client zones. You are free to preview those already existing.
You will see whose zone it is, its type, on which server it is created and its status (created/deleted).
DNS 21.png
You can always add a new custom zone directly for your client from your admin area.

To do so, press the button marked on the screen below.

DNS 121.png
Now, you are required to fill out the visible fields.
DNS 122.png
Note that both the admin and client area allow the user to apply a record set to a single or to multiple zones.
DNS 122 1.png
DNS 122 2.png
If you wish to wipe the selected zone at the same time, make sure to tick the Wipe Records option.
DNS 122 3.png
Actions on zones from the admin area:
  • change related item - choose one from a dropdown menu of available items and save changes
  • edit zone - modify existing records or add new ones
  • create - use this button to create a zone on the server
  • import - choose a file from which zones will be imported
  • export - choose a file to which zones will be exported
  • delete - if you use this button, the zone will be deleted both from WHMCS and from the server
  • remove from WHMCS - zone will still be available on the server
DNS 22.png

Additional Tools

DNS Record Sets

Create ready made sets of DNS records. You will find them in 'Settings' → 'DNS Records Sets'.
Press 'Add Set' to create a new one.
DNS 23.png
Enter the newly created set name and then choose records from the dropdown menu, press '+'.
DNS 24.png
Now, fill out the data as required.

Note: You may add adequate variables for domain and IP address and then these fields will be automatically changed to domain/zone IP when this record set is used.
For example, if you have the 'example.com' domain with '123.123.123.123' IP address all you have to do is add the following variable to the DNS Record Set:

  • {$domain} - will return full 'example.com' domain address
  • {$domainname} - will return only 'example' name
  • {$domainextension} - will return 'com' extension
  • {$ip} - will return the '123.123.123.123' IP address
DNS 25.png
Created DNS Records Sets can be then used while preparing ready packages, as it was described.
Ready made sets allow much faster and more personal configuration of packages.
DNS 26.png

Global Settings

This section has been designed to allow quick and simple configuration of global settings from one place.
DNS 27.png

Templates

Choose a default template that will be used in the client area.

If you have more than one template then you may allow your clients switch between them.
Decide whether you wish to use a ready-configured redirection to the DNS Management page in the client area.

DNS2 28.png

Notifications

In this part, set which notification should be sent to clients and which to the administrator. Select the ones that interest you.

Press 'Modify' and you will be quickly redirected to the email template page where you can adjust it to your needs.

DNS 29.png
Use the 'Exclude' button to specify domains, products and addons that the zones assigned to them will NOT be included in notifications.
DNS 30.png
Use the 'Include' button to specify which admin users will receive notifications.
DNS 31.png

Client Area Zones Status

Checking the selected boxes will result in an additional status concerning a given domain in the client area.
DNS31 1.png
Pressing the Modify button next to a given option will cause a new window to appear where you can set up your own custom status by means of HTML.

Your new description can include the {$domain} variable which will give the domain address back in the status message.

DNS31 2.png
You can see an example status on the screen below.
DNS31 3.png

Logs And Notifications

In this part you may impose when log entries and notifications should be removed from the system database.
If you wish you may also check the 'Log Successful Actions' option to store all entries in logs (DNS Manager → Settings → Logs).
DNS2 32.png

Other

The box with 'Other' options available is a crucial part of configuration where you can manage IP Manager For WHMCS IP Manager For WHMCS integration module and manage PTR records creation.
Besides, here you can switch off the guide with simple instructions visible on dashboard.
DNS 62.png
1. Client Area Management - depending on the configuration, the client has access to:
  • DNS And rDNS Management
  • rDNS Management Only
  • DNS Management Only


rDNS Management Only - create PTR records for IPv4 and IPv6 addresses without a related zone.
If this option is enabled your clients will be allowed to add reverse DNS with no zone related. To do so proceed to 'Manage DNS' → 'Manage Reverse DNS' in your client area.

DNS2 66 2.png
DNS Management Only - add and edit existing DNS zones.
DNS2 66 1.png
DNS And rDNS Management - give your clients full access to DNS management in the client area.
DNS2 66 3.png
2. Related Service IP Addresses Only - create zones and PTR records with a related IP address only.
When adding a new zone/PTR record you can choose from available hosting related IP addresses only as marked on the screen below.
DNS2 67.png
3. Owned Domains Only - restrict clients to manually create zones using their own domains only.
DNS2 67 1.png
4. Custom Subnet IP Address - create zones and PTR records with an IP address included in a subnet related to the product.

Note: This option works only if you have integrated your DNS Manager with IP Manager For WHMCS.

DNS2 68.png
5. rDNS Custom IP Address - create PTR records with a custom IP, enter a new IP address to create a new PTR.
Note: Both IPv4 and IPv6 are supported by DNS Manager For WHMCS.
DNS2 68 1.png
6. Custom IP Address - create zones with a custom IP address, you have no IP addresses to choose from, you have to enter a new IP address.
Note: Both IPv4 and IPv6 are supported by DNS Manager For WHMCS.
DNS2 69.png
7. Client Area Record Sets - clients may manage DNS records sets.
DNS2 69 1.png
8. Client Area Backups and Client Area Backups Limit - clients are given the option to create backups of their zones and upload backup files.
It is advised to set a limit on the number of allowed backups. Default '-1' indicates unlimited
DNS2 69 2.png
9. Protect Zones On Product Termination - zones are not automatically deleted once the product has been terminated.
10. Show Product Name - a full product name is shown, instead of the general type with an order number.
DNS2 69 4.png

DNS Blocked Strings

Proceed to Settings → Blocked Strings now.

In this section you may define a lists of words that will not be allowed to be used while creating DNS and rDNS records.

DNS32 1.png
In order to add certain words, simply type them in the adequate box.

Allowed formats:

  • each word in new line
  • space separated
  • coma separated
  • coma with space separated


Allowed regular expression options:

  • test* - all expressions that begin with a 'test' word
  • *test - all expressions that end with a 'test' word
  • rec...ord - three dots inside will block all expressions with any three signs inside a word
  • rec*ord - an asterisk inside will block all expressions that begin with a 'rec' and end with a 'ord' as in example


You may create a separate list for DNS records and another one for rDNS or create one shared list for both of them.
In the latter case just select 'Use same values as for DNS' option like on the screen below.

DNS32 2.png
At the very bottom, you may also create a list of clients who will be excluded from the above restrictions.

All the other clients will have to follow the 'Blocked Strings' rule. Remember to save the changes in the end.

DNS32 3.png
In practice, when a client will by trying to create a record using one of the forbidden words, the action will be blocked.
DNS32 4.png

Cron Jobs

In order to manage your cron job tasks proceed to 'Tools' → 'Cron'.
Here, you will find four information boxes, each one responsible for management of a separate cron task.
These are: migration, import, synchronization and cleaner.
DNS 33.png
At the very top, there is an info box with general cron details, such as recommended time interval of a cron execution (5 minutes is suggested),
the last execution time and run time period. (Keep it as frequent as possible!)
DNS2 34.png

Cron Migration - responsible for calling added tasks to migrate zones between servers.
Choose interval and declare how many zones can be migrated during a single execution.

Cron Importer - responsible for calling added task to import zones from an external server to WHMCS.
Choose interval and declare how many zones can be imported during a single execution (Admin and Client backup tasks).
Select option to automatically check recognized records to perform the import much faster.
Mark Active Users/Services and only such will be imported
Import Priority - decide whetehr these should be services that will be assigned to a clinent firstly ('Services, Domains' sequence) at Related Itmes or domains if selected the other way round.

Cron Synchronization - this cron job is responsible for regular synchronization of created zones.
Choose interval and declare how many zones can be synchronized during a single execution.
Note: When NS records are inconsistent with nameservers set in the server configuration, this cron job also deletes the zones.

DNS 35.png
Cron Cleaner - this option is a little bit more complex. Just like in case of other cron jobs, firstly choose interval and declare how many zones shall be cleared
during a single execution. Then you may specify conditions of clearing zones and records.

Warning! By default, the cron job is disabled and the 'Notify Only' option is enabled.
You will need to change these settings manually if you would like to have the zones removed.
What is more, when the cron will be enabled and the 'Notify Only' feature disabled, the module will send the warning about the zones deletion as an additional layer of safety.

Zones are removed:

  • Not Included In Package - if no longer match with any package
  • Not Modified For - have not been modified for a specified period of time
  • Not Found In WHOIS - their domain is not found in WHOIS Lookup
  • Without Records - no chosen records are included
  • Inactive Services - with canceled, terminated and/or suspended status
  • Inactive Domains - with canceled and/or expired status

PTR Records are removed:

  • Inactive Services - if service is terminated or canceled
DNS 36.png

Import

Import - this is an additional tool that allows to import zones that exist on outside servers to WHMCS.
Move to Tools' → 'Import' in your admin panel. You will find here a list of 'Import' assignments with information on which server they are imported from,
total number of already imported zones and the number of all zones, progress of import task.

To add a new import task press 'Add Import'.

DNS 37 1.png
Choose server that you want to import zones from.
DNS 38.png
Now, when the new import task appeared on the list of awaiting imports, schedule the action.
DNS 37 2.png
When schedule is confirmed, preview the list of imported zones to assign a client and a related product to the zone.

To do so, press the button as marked on the screen.

DNS 37 3.png
A list of zones appears.

DNS Manager Import tool detects the client and product which the domain and IP address is assigned to and automatically designates related client and product to migrate.
You can also do it manually by selecting a client and product from the list of available.
When ready, press 'Import Zones' to import several zones at once or use action buttons for a single import.

DNS 37 4.png
If you do not schedule import tasks, regular cron execution will trigger the import.
However, you always have to make sure that selected zones are assigned to related clients and products.

Zone Backups

'Zone Backups' section allows you to export your zones to the file and, when needed, easily import them on the server.
DNS3 2.png
To export zone automatically, press 'Export To File', define from which server you wish to export it and click on Add.
DNS3 3.png
DNS3 4.png
Schedule the task. Remember to confirm the action.
DNS3 5.png
You can now move to the list of zones to assign clients and products. Press the button marked on the screen.
DNS3 6.png
Select zones using action buttons next to single zones and 'Import Zones' for mass import.
DNS3 7.png
You can also manually export zones. All you have to do is press the Add Export button, then choose the appropriate server and source file.
DNS3 8.png
DNS3 9.png

Tasks

You will find a list of current tasks in 'Tools' → 'Tasks' section.
Among all tasks there are import tasks, migration and synchronization tasks.
DNS 42.png
According to specifically set-up cron jobs all created tasks are regularly executed. Here, you can see current status of each task.
If it is queuing for the next cron run, is currently executed, aborted or complete. Check when they were executed for the last time (Last Execution) and when the task was added.
Available actions: call execution manually and remove the task.

Dashboard

Home page of DNS Manager which can be used to get a quick and clear preview on the crucial parts of the module: added servers with number of zones created on them,
summary of email messages sent to clients and finally the most important notifications.
DNS2 43.png

Custom cPanel Zone Templates

You can allow your customers to create zones without cPanel Default Records. To do so you need to create your own Zone Template in the WHM.

If you don't know how to create your own Zone Template you can follow this short guide made by cPanel: Edit Zone Templates Guide
To apply your newly created zone template simply log in to your WHMCS and go to 'Addons' 'cPanel Extended Functions' 'Configuration'.
As a module choose 'cPanel' and enter the name of your zone template in the 'Template' field as shown on the screen below. Remember to save the changes.

DNS 55.2.png

DNS Manager Logs

This section helps you keep track of all the activities carried out in DNS Manager. Find them here: 'Settings' → 'Logs'.
DNS 60.png

IP Manager For WHMCS Integration

As it has been mentioned above, some of the options in our DNS Manager For WHMCS are available if you are also using IP Manager For WHMCS simultaneously.
In this section you will learn how to integrate the two products to work together. For more inforamtion on the IP manager module configuration please refer to our documentation.

Let us take a look at the IP Manager module firstly. There you have to create a subnet.

DNS2 70.png
You can do it ether for IPv4 or IPv6 type. DNS Manager For WHMCS supports both types.
DNS2 71.png
When ready, create a proper configuration and assign required products to it.
DNS2 71 1.png
Assign created subnet to this configuration.
DNS2 71 2.png
DNS2 71 3.png
Under 'Relations Configuration' → 'Products' define the number of IP addresses that will be allowed for a client.
By default this is only one address.
DNS2 71 5.png
Move to DNS Manager now and create an appropriate package where you declare limits for zones, select the product and allow records types and limits
that will be provided within the purchased service.
DNS 71 4.png
Now, a client upon purchase of such service may now use assigned IP addresses from the subnet and manage the DNS zones and rDNS zones according to limits specified in the package.
DNS2 73.png
The client may now add PTR records within the related service.
DNS2 74.png
Create zones with IP addresses included in a subnet related to a service in IP Manager.
DNS2 74 1.png
You only need to remember that relevant options must be enabled in the 'General Settings' section.
DNS 75.png

DNS Manager Migrator

If you have been already using DNS Manager For WHMCS, you can migrate data from your current system to the latest version.
To do so follow the below steps:

1. Activate DNS Manager For WHMCS V2.x.x.
2. Run the following command in your browser or in the console:

your_whmcs_path\modules\addons\DNSManager2\cron\migration.php

3. Follow the steps that you see on your screen now!

Note: It is advised to use your console to do the migration between the previous and the new versions of your DNS Manager in case you have a huge number of zones
(if more than 1000, it is highly recommended).

4. Once the script has run and the migration is complete you need to review the configuration of your servers to alter their naming and which is the most important enable migrated servers and packages.
Freshly migrated servers and packages are by default disabled.

Once the migration of zones is ready you can migrate rDNS records.

To do so:
1. Run command in your browser or in console:

your_whmcs_path\modules\addons\DNSManager2\cron\ptr_migration.php

2. Follow the steps that you see on your screen now.
3. Your PTR records will be assigned to adequate zones. In case pointing domain does not exist, the required zone will be created and added to the client's account (if no other user already has it).
4. Migrated rDNS records are visible in edition page of its zone as PTR records.

API Methods

You may access your DNS Manager For WHMCS API. Here is a short instruction how to do that:

The main required command that has to be used is:

  • 'dnsmanager'

Additionally, you have to define 'dnsaction' with some specific value.
Note: the 'action' parameter is no longer used since the 2.7.0 version due to not being allowed as a method to be executed as external.
These specific values can be:

  • 'getServerList' - returns the list of servers in DNS Manager
  • 'saveRDNS' - allows adding new rDNS record. Additional parameters are required here, these are:
    • 'serverid' - ID of a server
    • 'ip' - IP address that will be used
    • 'clientid' - ID of a client, record will be assigned to that client
    • 'ttl' - value of TTL for record
    • 'rdata' - record's value
  • 'removeRDNS' - allows removing existing rDNS record. Additional, required parameters:
    • 'serverid' - ID of a server
    • 'ip' - IP address that will be used

Exemplary use:

<?php
  // Set Vars
  $command = 'dnsmanager';
  $values = array( 'dnsaction' => 'getServerList', 'params' => array() );
  $adminuser = 'DemoAdmin';

  // Call API
  $results = localAPI($command, $values, $adminuser);
  var_dump($results);
?>

Since the 2.7.0 version, there are new methods available:

  • 'createZone' - creates a zone. Additional parameters are required here, these are:
    • 'action = dnsmanager'
    • 'dnsaction = createZone ' - DNS action, that DNS Manager should execute
    • 'zone_name' - name of the zone being created
    • 'type = 1 or 2' - type of related item. Use 1 for domain or 2 for the product
    • 'relid' - ID of the related item (hosting ID, domain ID)
    • 'userid - ID of user
    • 'zone_ip' - IP address assigned to the zone. If empty, a default IP address will be used

Exemplary use:

$postfields = array(
 'action' => 'dnsmanager',
 'dnsaction' => 'createZone',
 'zone_name' => 'zonename.com', 
 'type' => '1',
 'relid' => '2',
 'zone_ip' => '192.168.56.101',
 'userid' => '1',
);
  • 'updateZone' - updates records of the zone. Use with these parameters:
    • 'action = dnsmanager'
    • 'dnsaction = updateZone' - DNS action that DNS Manager should execute
    • 'zone_id - ID of the zone that should be updated (use ID from WHMCS)
    • 'records - array of the records that should be updated (added/changed/removed) if DNS Manager compare these records and add/change/remove corresponding difference. These are:
      • 'name' - name of the node to which this record pertains
      • 'type' - type of the updating resource record (e.g. MX)
      • 'class' - class node
      • 'ttl' - number of seconds that the RR stays valid (e.g. 14400)
      • 'data' - additional specific RR data

Exemplary use:

$result = localAPI('dnsmanager' ,
    array(
      'dnsaction' => 'updateZone',
      'zone_id' => 2,
      'records' => array(
        array(
          'name' => 'example.website.com',
          'type' => 'A',
          'class' => 'IN',
          'ttl' => '14440',
          'data' => '192.168.56.101',
        ),
        array(
          'name' => 'example.website.com',
          'type' => 'A',
          'class' => 'IN',
          'ttl' => '14440',
          'data' => '192.168.56.102',
        ),
      )
      ),'admin');
  • 'getZone' - returns the zone with records. Use with these parameters:
      • action = dnsmanager'
      • dnsaction = getZone' - DNS action that DNS Manager should execute
      • zone_id' - ID of the zone that should be retrieved (use ID from WHMCS)
  • 'removeZone' - deletes the zone. Use with these parameters:
      • action = dnsmanager'
      • dnsaction = removeZone' - DNS action that DNS Manager should execute
      • zone_id' - ID of the zone that should be removed (use ID from WHMCS)

Tips

1. Keep track of your 'pending' and in 'progress' 'Tasks' to set an optimum interval time for the tasks execution.

For example, set interval in the way that half of the time task is set to the pending status.

2. While using the OVH submodule, note that each time a client wants to remove a zone, the administrator will receive an email sent by OVH. Only after its confirmation, a given zone will be successfully terminated.
3. 255 characters in TXT records is a maximum limit for the 'PowerDNS' submodule.
4. When you try to add a record of not supported type to a package, you will be informed about the lack of support with a note as on the screen below.
DNS x1.png
5. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.

Update Instructions

Essential guidance through the process of updating the module is offered here.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

Migration

'Migration' is another useful tool that you may use to manage zones efficiently. With this tool you may migrate zones between servers.

Keep in mind, that when you are migrating zones from one server to another they are not imported to your WHMCS in the meantime!
If you wish to update the list of migrated zones, you will have to import them to WHMCS from the final server after migration.

Remember that migrated zones are available on both servers now! Migration does not delete zones, just copy them to the new server!

DNS 40.png
To add migration task, press 'Add Migration', specify from which server you wish to migrate zones, and the target server, as simple as that.

Note: Migration does not copy DNS Manager settings, to illustrate: if you are migrating zones that exist in DNS Manager their locations for example are not updated.

DNS 41.png
Schedule the migration. Remember to confirm the action.
DNS 41 1.png
Move to the list of zones to assign clients and products. Press button marked on the screen.
DNS 41 2.png
Select zones and 'Migrate Zones' for mass migration or use action buttons next to single zones.
DNS 41 3.png

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. jQuery 1.9 is required to work properly.
3. In case you cannot see any zone records in your client area after import or migration actions, then disable cache for the DNS server.
To do so, edit the 'General' section of the server.
DNS8 1.png
4. Once you are having problems with manually creating zones for specific domains, along with the 'Subdomain is not allowed' or 'Invalid zone name' error,
make sure to add the .tld that you would like to use to the following file:
modules\addons\DNSManager2\storage\tld.list 
5. In case your backup task started in your client area is not being processed, make sure that your Cron Import job is not disabled or set to a low frequency.
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
DNS Manager For WHMCS