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.

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

In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.
If you need a package for the previous versions of PHP, please contact our support.

The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.
Note: Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

The content of the chosen PHP version files to upload should look like this.

This file is located in 'modules/addons/dns_manager/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'.

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

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.

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.

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

Before you save the changes remember to test the connection.

• 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

Simply select 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.

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

• 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

• edit existing zone
• delete zone

To do so, press the 'DNSSEC' button.

Press 'Rectify Zone' to comply with DNSSEC.

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

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

Press the 'Create Backup' button to start.

Press the 'Backup Zones' button when ready.

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.

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. - Restore backup file. This action, when stared, is also visible on the list of tasks above.
2. - Download the file.
3. - Delete the file.

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

• 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

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 or {$serverhostname} - will return the 'yourdnsserver.com'
  - depends which one has been provided in the server configuration 'Hostname/IP' field

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.

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.

• 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.

• Allow Only That 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.

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

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.

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

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 whether these should be services that will be assigned to a client 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.

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

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

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

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.

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.

Let us take a look at the IP Manager module firstly. 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 and which is the most important enable migrated servers and packages.
Freshly migrated servers and packages are by default disabled.

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.

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)

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

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.

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!

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.

To do so, edit the 'General' section of the server.

modules\addons\DNSManager2\storage\tld.list