summaryrefslogtreecommitdiff
path: root/docs/system
diff options
context:
space:
mode:
authorcurrite <sll@disroot.org>2020-11-05 21:52:44 +0100
committercurrite <sll@disroot.org>2020-11-05 21:52:44 +0100
commitb772c4f678ace50280195d9691974dc41cb7ae58 (patch)
tree087a962f8bb7adcee92b25d0c2d5f5bd9f1e98ff /docs/system
parent168247e76ad1b03e4d1dab2631ee970afeb74549 (diff)
downloadvyos-documentation-b772c4f678ace50280195d9691974dc41cb7ae58.tar.gz
vyos-documentation-b772c4f678ace50280195d9691974dc41cb7ae58.zip
system: add system dns page
Diffstat (limited to 'docs/system')
-rw-r--r--docs/system/basic-index.rst1
-rw-r--r--docs/system/system-dns.rst69
2 files changed, 70 insertions, 0 deletions
diff --git a/docs/system/basic-index.rst b/docs/system/basic-index.rst
index cb030089..b7bbf1c5 100644
--- a/docs/system/basic-index.rst
+++ b/docs/system/basic-index.rst
@@ -11,3 +11,4 @@ Basic System Tweaks
host-information
default-route
time-zone
+ system-dns
diff --git a/docs/system/system-dns.rst b/docs/system/system-dns.rst
new file mode 100644
index 00000000..59cfdb5d
--- /dev/null
+++ b/docs/system/system-dns.rst
@@ -0,0 +1,69 @@
+.. _system-dns:
+
+##########
+System DNS
+##########
+
+
+This section describes configuring DNS on the system, namely:
+
+ * DNS name servers
+ * Domain search order
+
+
+DNS name servers
+================
+
+.. cfgcmd:: set system name-server <address>
+
+ Use this command to specify a DNS server for the system to be used
+ for DNS lookups. More than one DNS server can be added, configuring
+ one at a time. Both IPv4 and IPv6 addresses are supported.
+
+
+
+Example
+-------
+
+In this example, some *OpenNIC* servers are used, two IPv4 addresses
+and two IPv6 addresses:
+
+
+.. code-block:: none
+
+ set system name-server 176.9.37.132
+ set system name-server 195.10.195.195
+ set system name-server 2a01:4f8:161:3441::1
+ set system name-server 2a00:f826:8:2::195
+
+
+Domain search order
+===================
+
+In order for the system to use and complete unqualified host names, a
+list can be defined which will be used for domain searches.
+
+
+.. cfgcmd:: set system domain-search domain <domain>
+
+ Use this command to define domains, one at a time, so that the system
+ uses them to complete unqualified host names. Maximum: 6 entries.
+
+
+.. note:: Domain names can include letters, numbers, hyphens and periods
+ with a maximum length of 253 characters.
+
+
+Example
+-------
+
+The system is configured to attempt domain completion in the following
+order: vyos.io (first), vyos.net (second) and vyos.network (last):
+
+
+.. code-block:: none
+
+ set system domain-search domain vyos.io
+ set system domain-search domain vyos.net
+ set system domain-search domain vyos.network
+