dns: DNS Zones on Domains
The dns
utility is used to manage DNS zones on domains and domain
aliases through CLI. By using this utility, you can perform the
following tasks:
- adding resource records to or deleting them from a domain’s or domain alias’ DNS zone
- enabling or disabling a local DNS service on a domain or domain alias
- setting Plesk name server as the primary or secondary server for a DNS zone
- assigning external primary DNS servers for a DNS zone
- enabling or disabling the www-prefixed alias (in the
www.<domain name>
form) support for canonical domain names - updating the Start-of-Authority (SOA) record for a DNS zone
Usage
dns <command> [<domain_name>|<domain_alias>] [
<option_1> [<param>]
[<option_2> [<param>]]
... [<option_N> [<param>]]
]
Example
The following command removes all pre-existing resource records from the DNS zone on the domain example.com and adds the following two records to the DNS zone:
-
new
MX
resource record mail3.example.com specifying domain name mail.example.com as the mail exchanger and setting the mail exchanger’s priority to 15 -
new
NS
resource record ns2.example.com setting domain ns.example.com as the name serverplesk bin dns --set example.com -list "MX,mail3,mail.example.com,15;NS,ns2,ns.example.com"
Commands
Command | Parameter | Description | Example |
---|---|---|---|
--add or -a
|
<domain_name>|<domain_alias> |
Adds a resource record to a domain’s DNS zone. If a record already exists, the command returns code |
To add an plesk bin dns --add example.com -mx mail3 -mailexchanger mail.example.com or plesk bin dns -a example.com -mx mail3 -mailexchanger mail.example.com |
--set or -s
|
<domain_name>|<domain_alias> |
Adds specified resource records to and removes all pre-existing resource records from a domain’s DNS zone. Requires the |
To add the following two resource records to the DNS zone of domain example.com, while removing all pre-existing resource records from the DNS zone:
or plesk bin dns -s example.com -list "MX,mail3,example.com,15;NS,ns2,ns.example.com" |
--del or -d
|
<domain_name>|<domain_alias> |
Deletes a resource record from a domain’s DNS zone. |
To delete an existing plesk bin dns --del example.com -mx mail3 -mailexchanger mail.example.com or plesk bin dns -d example.com -mx mail3 -mailexchanger mail.example.com |
--del-all or -da
|
<domain_name>|<domain_alias> |
Deletes all resource records from a domain’s DNS zone. |
To delete all existing resource records from the DNS zone for the domain example.com: plesk bin dns --del-all example.com or plesk bin dns -da example.com |
--reset or -res
|
<domain_name>|<domain_alias> |
Restores the default resource records for a domain’s zone based on the Plesk server DNS zone template. Requires the |
To restore the default resource records for a domain’s zone based on the Plesk server DNS zone template: plesk bin dns --reset example.com -ip 192.0.2.9 or plesk bin dns -res example.com -ip 192.0.2.9 |
--on |
<domain_name>|<domain_alias> |
Enables DNS service on a domain or domain alias. |
To enable DNS service on the domain example.com: plesk bin dns --on example.com |
--off |
<domain_name>|<domain_alias> |
Disables DNS service on a domain or domain alias. |
To disable DNS service on the domain example.com: plesk bin dns --off example.com |
--set-master |
<domain_name>|<domain_alias> |
Sets the Plesk name server as the primary server for domain’s or domain alias’ DNS zone. |
To set the Plesk name server as the primary server for DNS zone on the domain example.com: plesk bin dns --set-master example.com |
--set-slave |
<domain_name>|<domain_alias> |
Sets the Plesk name server as a secondary for domain’s or domain alias’ DNS zone. |
To set the Plesk name server as a secondary server for DNS zone on the domain example.com: plesk bin dns --set-slave example.com |
--update-soa |
<domain_name>|<domain_alias> |
Updates the SOA record settings for domain’s or domain alias’ DNS zone. |
To set the TTL value for the SOA record of the DNS zone on the domain example.com to 5 hours: plesk bin dns --update-soa example.com -soa-ttl 5H |
--info |
<domain_name>|<domain_alias> |
Displays the list of resource records for a domain’s or domain alias’ DNS zone. |
To view the list of resource records in the DNS zone for the domain example.com: plesk bin dns --info example.com |
--help or -h
|
Displays help on the use of the utility. |
To view help on the use of the plesk bin dns --help or plesk bin dns -h |
Options
Option | Parameter | Description | Example |
---|---|---|---|
-a |
''| <subdomain_name>
|
Specifies the Used with the Requires the |
To add an plesk bin dns -a example.com -a sample -ip 192.0.2.78 To add an plesk bin dns -a example.com -aaaa sample -ip 2001:db8:85a3:0:0:8a2e:370:7334 |
-aaaa |
''| <subdomain_name>
|
Specifies the Used with the Requires the |
|
-ip |
<IP_address> |
Specifies an address for creating a resource record (IPv4 for A type records and IPv6 for AAAA type records) in a domain’s DNS zone. Used with the |
|
-ns |
''| <subdomain_name>
|
Specifies the Used with the Requires the |
To add an plesk bin dns -a example.com -ns ns2 -nameserver example.net |
-nameserver |
<domain_name> |
Specifies the name of a nameserver for creating an NS type resource record in a domain’s DNS zone. | |
-mx |
''| <subdomain_name>
|
Specifies the Used with the Requires the |
To add an plesk bin dns -a example.com -mx mail3 -mailexchanger mail.example.com -priority 15 |
-https |
'' | <subdomain_name>
|
Specifies the HTTPS DNS record in a domain’s DNS zone. Used with the Requires the |
To add an HTTPS DNS record for the domain plesk bin dns --add example.com -https '' -https-priority 1 -https-protocols h3,h2 To add an HTTPS DNS record for the domain plesk bin dns --set example.com -list 'NS,,ns1.example.com.;A,ns1,192.0.2.1;HTTPS,service,example.com. alpn=h3\,h3-29 no-default-alpn port=8443 ipv4hint=192.0.2.1 ipv6hint=2001:db8:85a3::8a2e:370:7334\,2001:db8:85a3::8a2e:370:7335,1' |
-mailexchanger |
<domain_name> |
Specifies the name of a mail exchanger for creating an MX
type DNS record in a domain’s DNS zone. |
|
-priority |
[0-50] |
Specifies the mail exchanger priority (0 - the highest, 50 -
the lowest) for creating an MX type DNS record in a
domain’s DNS zone. |
|
-cname |
''| <subdomain_name>
|
Specifies the Used with the Requires the |
To add a plesk bin dns --add example.com -cname sample -canonical example.org |
-canonical |
<domain_name> |
Specifies a canonical name for creating a CNAME type DNS
record in a domain’s DNS zone. |
|
-ptr |
''| <subdomain_name>
|
Specifies the Used with the Requires the |
To add a plesk bin dns -a example.com -ptr sample -subnet 192.0.2.1/16 |
-subnet |
<IP_address> | <subnet_mask>
|
Specifies an IP address and a subnet mask for creating a
PTR type DNS record in a domain’s DNS zone. |
|
-srv |
''| <subdomain_name>
|
Specifies the SRV type resource record in a domain’s DNS zone. Used with the Requires the use of options
|
To add an SRV record to make domain example.com handle SIP protocol connections, that will point to a server named sipserver.sample.com listening on TCP port 5060. The priority given here is 0, and the weight is 5: plesk bin dns --add example.com -srv '' -srv-service sip -srv-target-host sipserver.sample.com. -srv-protocol TCP -srv-port 5060 -srv-priority 0 -srv-weight 5 |
-srv-priority |
[0-50] |
Specifies priority of the SRV record (0 - the highest, 50 - the lowest). | |
-srv-weight |
[0-50] |
Specifies relative weight of the SRV record among records with the same priority (0 - the lowest, 50 - the highest). | |
-srv-port |
[0-65535] |
Specifies the port on which the service is to be found (for SRV record). | |
-srv-target-host |
<host> |
Specifies canonical hostname of the machine providing the service (for SRV record). | |
-srv-protocol |
TCP|UDP |
Specifies the service protocol for SRV record. | |
-srv-service |
<service> |
Specifies symbolic name of the service for SRV record. | |
-txt |
''|<text> |
Specifies the Used with the Requires the |
To specify the plesk bin dns -a example.com -txt "This record is used to implement the Senders Policy Framework and DKIM specifications" -domain sample |
-domain |
<subdomain_name> |
Specifies a subdomain name for creating a Used with the |
|
-ds |
''|"<key-tag> <algorithm> <digest-type> <digest>" |
Specifies the Used with the Requires the The information about the DS records that you need to add to the parent zone is available in Plesk UI in DNSSEC settings of a domain. |
To specify the DNS record of the DS type for the subdomain sample in the DNS zone of the domain example.com: plesk bin dns --add example.com -domain sample -ds "62181 10 2 6CBB33AB0260421C08968A4384AE38778FC88E740B660336A5CF7900 8F3AF9AD" |
-www |
true|false |
Enables/Disables support of the www-prefixed alias for a canonical domain name in a domain’s DNS zone. Used with the Creates/Deletes a |
To enable support of the www-prefixed alias www.example.com (pointing to domain example.com) in the DNS zone on the domain example.com: plesk bin dns -res example.com -www true -ip 192.0.2.94 |
-primary |
<IP_address> |
Adds an IP address of a primary DNS server for a domain’s DNS zone. Used with the |
To add the IP address 192.0.2.78 of the primary DNS server for DNS zone on the domain example.com: plesk bin dns -a example.com -primary 192.0.2.78 |
-soa-ttl |
<number>[S|M|H|D|W] |
Sets the TTL value for the SOA record of a domain’ or domain alias’ DNS zone. Used with the |
To set the TTL value to 5 hours, the Refresh value to 4 hours, the Retry value to 10 seconds, the Expire value to 2 weeks, and the Minimum value to 2 days for the SOA record in the DNS zone on the domain example.com: plesk bin dns --update-soa example.com -soa-ttl 5H -soa-refresh 4H -soa-retry 10S -soa-expire 2W -soa-minimum 2D |
-soa-refresh |
<number>[S|M|H|D|W] |
Sets the Refresh value for the SOA record of a domain’ or domain alias’ DNS zone. Used with the |
|
-soa-retry |
<number>[S|M|H|D|W] |
Sets the Retry value for the SOA record of a domain’ or domain alias’ DNS zone. Used with the |
|
-soa-expire |
<number>[S|M|H|D|W] |
Sets the Expire value for the SOA record of a domain’ or domain alias’ DNS zone. Used with the |
|
-soa-minimum |
<number>[S|M|H|D|W] |
Sets the Minimum value for the SOA record of a domain’ or domain alias’ DNS zone. Used with the |
|
-soa-serial-format |
timestamp|yyyymmddnn |
Specifies format of SOA record serial number: UNIX timestamp or recommended by IETF and RIPE. Used with the |
To change the SOA record serial format to recommended by IETF and RIPE for domain example.com: plesk bin dns --update-soa example.com -soa-serial-format yyyymmddnn |
-list |
where the
For adding resource records of respective types individually, consult descriptions of the options in this table. |
Specifies resource records to be included in a domain’s DNS zone. Used with the |
To add the following two resource records to the DNS zone of the domain example.com, while removing all pre-existing resource records from the DNS zone:
|
-https-priority |
[0-50] |
Specifies the priority of the created HTTPS DNS record (0 - the highest, 50 - the lowest). The priority is applied if multiple HTTPS records are available for the same domain name. |
To add an HTTPS DNS record for the domain plesk bin dns --add example.com -https '' -https-priority 1 -https-protocols h3,h2 |
-https-target-port |
[0-65535] |
Specifies the target port for the HTTPS DNS record. |
To add an HTTPS DNS record for the domain plesk bin dns --add example.com -https '' -https-priority 1 -https-protocols h3,h2 -https-target-port 8443 |
-https-target-host |
'' | <domain_name>
|
Specifies the target host for the HTTPS DNS record. An empty value means the host is the same as the domain name. |
To add an HTTPS DNS record for the domain plesk bin dns --add example.com -https '' -https-priority 1 -https-protocols h3,h2 -https-target-host cdn.example.com |
-https-protocols |
protocol_1,protocol_2,protocol_n |
Specifies a comma-separated list of protocols supported by the server for the HTTPS DNS record. |
To add an HTTPS DNS record for the domain plesk bin dns --add example.com -https '' -https-priority 1 -https-protocols h3,h3-29,h2,http/1.1 |
-https-force-protocols |
<true|false> |
Forces to use only the specified protocols for the HTTPS DNS record. Requires the |
To add an HTTPS DNS record for the domain plesk bin dns --add example.com -https '' -https-priority 1 -https-protocols h3,h3-29 -https-force-protocols true |
-https-ipv4-hint |
<IP_address_1>,<IP_address_2>,<IP_address_n> |
Specifies a comma-separated list of IPv4 addresses that can be used by a client to reach the service for the HTTPS DNS record. |
To add an HTTPS DNS record for the domain plesk bin dns --add example.com -https '' -https-priority 1 -https-protocols h3,h2 -https-ipv4-hint 192.0.2.1 |
-https-ipv6-hint |
<IP_address_1>,<IP_address_2>,<IP_address_n> |
Specifies a comma-separated list of IPv6 addresses that can be used by a client to reach the service for the HTTPS DNS record. |
To add an HTTPS DNS record for the domain plesk bin dns --add example.com -https '' -https-priority 1 -https-protocols h3,h2 -https-ipv6-hint 2001:db8:85a3::8a2e:370:7334 |