vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-12-16 10:32:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update dns.rst

Browse Source 
Updated command syntax for dynamic dns - changed set service dns dynamic interface to set service dns dynamic address. 

Changed the login option from 'login' to 'username' 

Changed the web options from 'use-web' to 'web-options' 

Changed because I ran into the command syntax change on a 1.4 install. Updating documents to match.
This commit is contained in:
Shnoobins 2023-10-02 12:40:37 -05:00 committed by GitHub
parent 08ac110e10
commit cf1c7eb76d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/configuration/service/dns.rst
View File

@ -308,40 +308,40 @@ VyOS is also able to use any service relying on protocols supported by ddclient.
To use such a service, one must define a login, password, one or multiple To use such a service, one must define a login, password, one or multiple
hostnames, protocol and server. hostnames, protocol and server.
.. cfgcmd:: set service dns dynamic interface <interface> service <service> .. cfgcmd:: set service dns dynamic address <interface> service <service>
host-name <hostname> host-name <hostname>
Setup the dynamic DNS hostname `<hostname>` associated with the DynDNS Setup the dynamic DNS hostname `<hostname>` associated with the DynDNS
provider identified by `<service>` when the IP address on interface provider identified by `<service>` when the IP address on address
`<interface>` changes. `<interface>` changes.
.. cfgcmd:: set service dns dynamic interface <interface> service <service> .. cfgcmd:: set service dns dynamic address <interface> service <service>
login <username> username <username>
Configure `<username>` used when authenticating the update request for Configure `<username>` used when authenticating the update request for
DynDNS service identified by `<service>`. DynDNS service identified by `<service>`.
For Namecheap, set the <domain> you wish to update. For Namecheap, set the <domain> you wish to update.
.. cfgcmd:: set service dns dynamic interface <interface> service <service> .. cfgcmd:: set service dns dynamic address <interface> service <service>
password <password> password <password>
Configure `<password>` used when authenticating the update request for Configure `<password>` used when authenticating the update request for
DynDNS service identified by `<service>`. DynDNS service identified by `<service>`.
.. cfgcmd:: set service dns dynamic interface <interface> service <service> .. cfgcmd:: set service dns dynamic address <interface> service <service>
protocol <protocol> protocol <protocol>
When a ``custom`` DynDNS provider is used the protocol used for communicating When a ``custom`` DynDNS provider is used the protocol used for communicating
to the provider must be specified under `<protocol>`. See the embedded to the provider must be specified under `<protocol>`. See the embedded
completion helper for available protocols. completion helper for available protocols.
.. cfgcmd:: set service dns dynamic interface <interface> service <service> .. cfgcmd:: set service dns dynamic address <interface> service <service>
server <server> server <server>
When a ``custom`` DynDNS provider is used the `<server>` where update When a ``custom`` DynDNS provider is used the `<server>` where update
requests are being sent to must be specified. requests are being sent to must be specified.
.. cfgcmd:: set service dns dynamic interface <interface> ipv6-enable .. cfgcmd:: set service dns dynamic address <interface> ipv6-enable
Allow explicit IPv6 address for the interface. Allow explicit IPv6 address for the interface.
@ -353,10 +353,10 @@ Use DynDNS as your preferred provider:
.. code-block:: none .. code-block:: none
set service dns dynamic interface eth0 service dyndns set service dns dynamic address eth0 service dyndns
set service dns dynamic interface eth0 service dyndns login my-login set service dns dynamic address eth0 service dyndns username my-login
set service dns dynamic interface eth0 service dyndns password my-password set service dns dynamic address eth0 service dyndns password my-password
set service dns dynamic interface eth0 service dyndns host-name my-dyndns-hostname set service dns dynamic address eth0 service dyndns host-name my-dyndns-hostname
.. note:: Multiple services can be used per interface. Just specify as many .. note:: Multiple services can be used per interface. Just specify as many
services per interface as you like! services per interface as you like!
@ -366,12 +366,12 @@ Example IPv6 only:
.. code-block:: none .. code-block:: none
set service dns dynamic interface eth0 ipv6-enable set service dns dynamic address eth0 ipv6-enable
set service dns dynamic interface eth0 service dyndns6 login my-login set service dns dynamic address eth0 service dyndns6 username my-login
set service dns dynamic interface eth0 service dyndns6 password my-password set service dns dynamic address eth0 service dyndns6 password my-password
set service dns dynamic interface eth0 service dyndns6 host-name my-dyndns-hostname set service dns dynamic address eth0 service dyndns6 host-name my-dyndns-hostname
set service dns dynamic interface eth0 service dyndns6 protocol dyndns2 set service dns dynamic address eth0 service dyndns6 protocol dyndns2
set service dns dynamic interface eth0 service dyndns6 server dyndns-v6-server set service dns dynamic address eth0 service dyndns6 server dyndns-v6-server
Running Behind NAT Running Behind NAT
@ -384,12 +384,12 @@ record will be updated to point to your internal IP.
ddclient_ has another way to determine the WAN IP address. This is controlled ddclient_ has another way to determine the WAN IP address. This is controlled
by: by:
.. cfgcmd:: set service dns dynamic interface <interface> use-web url <url> .. cfgcmd:: set service dns dynamic address <interface> web-options url <url>
Use configured `<url>` to determine your IP address. ddclient_ will load Use configured `<url>` to determine your IP address. ddclient_ will load
`<url>` and tries to extract your IP address from the response. `<url>` and tries to extract your IP address from the response.
.. cfgcmd:: set service dns dynamic interface <interface> use-web skip <pattern> .. cfgcmd:: set service dns dynamic address <interface> web-options skip <pattern>
ddclient_ will skip any address located before the string set in `<pattern>`. ddclient_ will skip any address located before the string set in `<pattern>`.