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.

The Wiki page for DNS Manager For WHMCS 2.x can be found here.

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

The content of the package to upload should look like this.

This file is located in 'modules/addons/DNSManager3/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 in our client area → 'My Products'.

This folder is available at 'your_whmcs/modules/addons/DNSManager3/storage' .

Go to 'WHMCS Admin Area' → 'System Settings' → 'Addon Modules' . Afterward, find 'DNS Manager' and activate the addon.

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

Please note, that there is also an option Enable DNSSEC available. However, it is currently compatible only with CloudFlare, cPanel, DirectAdmin, PowerDNS V4 and Simple DNS Plus V8 And V9 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.

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

Remember to save the changes when ready.

Please note that currently DNSSEC for BIND 9 is not supported yet.

In this part, we will show you an exemplary BIND 9 configuration.
Firstly, go to the 'Servers' section in the 'Settings' tab, click 'Add Server' and select 'Bind9' module.

The 'Path To Bind9 Config Directory' filed is used to locate the BIND 9 'named.conf.local' configuration file.
Please remember that all paths presented on the screens below are only an illustration and you need to adjust to directory paths on your own BIND 9 server.
The module should also have permissions set to access these directories.
Thanks to the provided backup paths, you can also easily revert a backup copy in case of any breakdown so it is extremely important to carry out the configuration properly.
Also, note that the module can create a large number of backup files within a newly created 'zones' directory based on the provided path.

Important: Remember that paths to 'Bind9 Config Directory' and 'Backup Directory' should start with / and be absolute.

Do not also forget to save the changes.

• name the newly created package
• define the number of zones per item (limit of zones that a client may then create within this package)

• decide if you allow creating slave zones
  Important: The module allows the creation of two types of DNS zones, master and slave ones:
  Primary (Master) DNS zones – it is a holder of the original zone file (all the DNS records for the zone). You can manage a host through this zone.
  Secondary (Slave) DNS zone – it holds a copy of the zone file. You can use them for better performance, for hiding your primary zones, for backups and redundancy.
  

2. 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 Domain Transfer - zones will be automatically created for the domains during their transfer:
  • Before - 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 Domain Registration - zones will be created automatically for newly registered domains
  • Before - a new zone will be created shortly before sending a registration request to the registrar
  • After - a new zone will be created once the status of the registration request is received from the registrar
• Domain with DNS Management - zones will be created automatically for domains that have been ordered with the 'DNS Management' domain addon
• Existing Zone Update - if a zone already exists, it will be updated with newly added record sets
  

3. Define the maximum, allowed limit of records.

4. Choose DNS Record 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

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

Note: You may always assign the package to more than one server.
Due to extra synchronization, you may select which server will be marked as 'Master Server '.
As a result, once you modify the 'Master Server' and run cron commands, all performed changes (such as adding, deleting new records etc.) will be implemented to other servers as well.

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

Remember to save the changes when the package configuration is ready.

Note: You can turn on this mode in the 'DNS Manager addon' → 'Settings' → 'Global Settings' → 'Other' → 'Zones Single Table View'.

Form to create a master DNS zone:

• edit an existing zone
• delete zone

You may force the slave zone to refresh by pressing the button (1.) - related to slave zones on servers other than PowerDNSv4.
A new task will be added to the queue and the zone will be refreshed with the setup time interval.

To do so, navigate to 'Additional Actions' → 'DNSSEC'.

Press 'Rectify Zone' to comply with DNSSEC.

Allowed actions:

• Add Record
• Modify Record
• Delete Record
• List Records
• Change Record Set
• Delete Zones

• /abc/ - all records including "abc" string (lower case only)
• /[\d]+/ - all records including numbers
• /^www/ - all records that start with "www" (lower case only)
• /\.com$/ - all records that end with ".com" (lower case only)
• /[abc]/i - all records that include "a," "b" or "c" letters (lower or capital case, any position)

Search: /(\d+)abc/i
Replace With: def$1

The above example will result in exchanging all records that include a string of numbers followed by abc letters to a 'def' phrase with the same string of numbers:

phrase2137abc → phrasedef2137

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

You can manage fully your zone 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. Press the 'Create Backup' button to start.

Press the 'Create Zones Backup' button when ready.

To see details, press the '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.

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.

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

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

Important: The module may create two types of zones, master and slave ones. Master type zones are created on DNS servers and the records are synchronized via AXFR protocol by itself.
In the case of slave zones, the module creates a slave zone on DNS servers and that is the DNS server that performs the synchronization.
("PowerDNSV4" only, in the case of other servers like "cPanel", you have to manually force the synchronization).

1. Change Related Item - choose one of the available items from a dropdown menu and save changes
2. Edit DNS Zone Records- modify existing records or add new ones
3. Add DNS Zone - use this button to create a zone on the server
4. Import DNS Zone From File - choose a file from which zones will be imported
5. Export DNS Zone To File - choose a file to which zones will be exported
6. Export DNS Zone To TXT File In BIND Format - a TXT file will be saved just after pressing the button
7. Lock/Unlock DNS Zone - if you lock a zone, it will not be possible to edit this zone in the client area
8. Delete DNS Zone - if you use this button, the zone will be deleted both from WHMCS and from the server
9. Remove DNS Zone From WHMCS - zone will still be available on the server
10. Refresh Slave Zone - press this button to manually add the task to the queue and force refreshing a slave zone via AXFR protocol (slave zones created on servers other than PowerDNSv4)
11. View DNS Zone - press to see a list of records; you may also refresh the slave zone from this level (slave zones only)

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

Here, you may define the time interval at which the slave zones will be refreshed and their information synchronized with a remote DNS master server using the AXFR protocol.
Note that the time is measured in hours.

• DNS And rDNS Management - give your clients full access to DNS management in the client area.
• rDNS Management Only - create PTR records for IPv4 and IPv6 addresses without a related zone.
  If this option is enabled your clients will be only allowed to add reverse DNS with no zone related. Other sections are blocked
• DNS Management Only - the 'rDNS' tab will be blocked for the client

• Allow Only That Domain
• Allow Only That Product Domain
• Allow Only Domains From Domains Items
• Allow Only Domains From Product Items
• Allow Only Domains From Domains And Product Items
• Allow Custom Domain

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

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

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

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; that can be:
  • IP address assigned to the domain by a client, provided while creating a zone
  • hosting dedicated IP address
  • WHMCS server address provided it is a hosting
• {$serverhostname} - will return the DNS server address or its IP address, depending on which one has been provided in the module's DNS server configuration in the admin area,
  e.g.: yourdnsserver.com or 12.23.34.45
• {$ns1}, {$ns2}, {$ns3}, {$ns4} and {$ns5} - will return the addresses of the global nameservers specified in the order basing on the sequential number of the corresponding data in the variables
• {$serverassignedipX} – allows you to use 'Assigned IP Addresses' from another server configuration ( WHMCS → System Settings → Servers).
  Important! You need to replace X with a number. For example: If you provide {$serverassignedip1} in the DNS Record Set, the first address from the 'Assigned IP Addresses' section will be used.

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

Allowed formats:

• each word in a 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 the 'Use same values as for DNS' option like on the screen below.

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

Use the cron tasks to delete all tasks with the 'Finished' or 'Canceled' status:

php -q /yourwhmcs/modules/addons/DNSManager3/cron/cron.php JobsCleaner --clean

Note 1: The module cron will delete finished/canceled tasks each run.
Note 2: The module cron is separate from the WHMCS daily cron, which for the purposes of the module only deletes joblogs and finished/canceled tasks after 30 days have passed.

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

Import Cron - responsible for calling added tasks to import zones from an external server to WHMCS.
Choose an interval and declare how many zones can be imported during a single execution (Admin and Client backup tasks).
Select the 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 whether these should be services that will be assigned to a client firstly ('Services, Domains' sequence) at Related Items or domains if selected the other way round.

Synchronization Cron - this cron job is responsible for regular synchronization of created zones.
Choose an 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.

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 is enabled and the 'Notify Only' feature disabled, the module will send the warning about the zones deletion as an additional layer of safety.

Define which zones get removed:

• Excluded from Package - if no longer match with any package.
• Unmodified for - have not been modified for a specified period.
• Missing 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.

Decide for which of the following services, the PTR Records should be removed:

• Terminated Services
• Cancelled Services
• Suspended Services

• Stored Backups Limit - you can set the maximum number of backups that will be stored. If the provided number is exceeded, then the oldest backups will be overwritten.

Important: For this function to work properly, the Import Cron has to be running.
It's also crucial to configure both crons correctly:

• Backup Schedule Cron cannot queue more tasks, than the Import Cron can handle.

Example:
There are:

• 100 clients
• Each client has between 1 and 100 zones
• Backup Schedule Cron is set to run every 3 hours

By extension, the Import Cron has to be configured in such a way, to handle those 1000 tasks across 3 hours and still have some leeway for other tasks.
The suggested configuration of the 'Import Cron' here would be:

• Run every 5 minutes
• Zones per Execution: 30

This means a maximum of 1080 tasks across 3 hours, which exceeds the potential tasks from the Backup Schedule Cron and leaves some additional space for unrelated tasks.

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

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

Select the related client and item in the next window.
If you do not schedule import tasks, regular cron execution will trigger the import.

Note: Automatic backups will export all zones of every user.

• Destination Server
• Source File

• View task information details and logs
• Download Task File (csv)
• Delete task

Click on the 'Add PTR Record' button to add a new record to a client.

If you do not 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 changes.

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

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 which is the most important enable migrated servers and packages.
Freshly migrated servers and packages are by default disabled.

To do so:
1. Run the command in your browser or in the 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 when the 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 on the edition page of its zone as PTR records.

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
  • 'recordSet' - ID of the DNS Record Set, it can be downloaded from the base, table: 'DNSManager3_SetRecord', field: 'setid'
    (In module version 3.3.2 and earlier, the mentioned table name was: "dns_manager2_setrecord")

Exemplary use:

$postfields = array(
 'action' => 'dnsmanager',
 'dnsaction' => 'createZone',
 'zone_name' => 'zonename.com', 
 'type' => '1',
 'relid' => '2',
 'zone_ip' => '192.168.56.101',
 'userid' => '1',
 'recordSet' => '2',
);

• 'updateZone' - updates the zone with the records specified in the request. Any records not included in the request are removed.
  Use 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 compares these records and add/change/remove the 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 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 the dns_manager2_zone table)
    • 'zone_name' - name of the zone

• 'removeZone' - deletes the zone. Use 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)

• 'createRecords' - adds new record. Use these parameters:
  • • 'action = dnsmanager'
    • 'dnsaction = createRecords' - DNS action that DNS Manager should execute
    • 'zone_id' - ID of the zone that should be removed (use ID from WHMCS)

Use Cases

Offering DNS Management For Ordered Services

Deploying Backup DNS Server For External DNS Zones

Delivering DNS Zone Management With rDNS For Ordered Servers

Managing Client rDNS Records As Admin

Using Reseller Account For cPanel Server

Providing DNS Zone Management For Domains Without It

Tips

 RRset A.testdnsipdefault.by. IN CNAME: Conflicts with pre-existing non-CNAME RRset   

 $_LANG['addonCA']['dashboard']['errors']['RRset :domain_word: IN CNAME: Conflicts with pre-existing non-CNAME RRset'] = "Some serious problem occurred with :domain_word:";

 Some serious problems occurred with A.testdnsipdefault.by.

 $_LANG['addonCA']['dashboard']['errors']['RRset :domain_word: IN CNAME: Conflicts with pre-existing non-CNAME RRset'] = "Some serious problem occurred";
 $_LANG['addonCA']['dashboard']['errors']['RRset :domain_word: IN CNAME: Conflicts with pre-existing non-CNAME RRset'] = 'My custom translation';  

Update Instructions

Migration from V2x.x to V3.x.x

Migration from V3x.x to V3.4.0

php -q /yourwhmcs/modules/addons/DNSManager3/cron/cron.php upgrade-3-3-to-3-4

Migration from V2 to V3.5.0

php -q /yourwhmcs/modules/addons/DNSManager3/cron/cron.php upgrade-3-3-to-3-4

Migration of Zones

Upgrade Guide

Common Problems

modules\addons\DNSManager2\storage\tld.list