diff options
Diffstat (limited to 'docs/configuration/service')
| -rw-r--r-- | docs/configuration/service/dhcp-relay.rst | 2 | ||||
| -rw-r--r-- | docs/configuration/service/https.rst | 17 | ||||
| -rw-r--r-- | docs/configuration/service/mdns.rst | 67 | ||||
| -rw-r--r-- | docs/configuration/service/ssh.rst | 28 | 
4 files changed, 91 insertions, 23 deletions
| diff --git a/docs/configuration/service/dhcp-relay.rst b/docs/configuration/service/dhcp-relay.rst index e1fbe1d2..dc45d071 100644 --- a/docs/configuration/service/dhcp-relay.rst +++ b/docs/configuration/service/dhcp-relay.rst @@ -154,6 +154,8 @@ Configuration     Disable dhcpv6-relay service. +.. _dhcp_relay:v6_options: +  Options  ------- diff --git a/docs/configuration/service/https.rst b/docs/configuration/service/https.rst index 08b16575..eb2e30eb 100644 --- a/docs/configuration/service/https.rst +++ b/docs/configuration/service/https.rst @@ -20,28 +20,19 @@ Configuration  .. cfgcmd:: set service https api debug -   To enable debug messages. Available via :opcmd:`show log` or  +   To enable debug messages. Available via :opcmd:`show log` or     :opcmd:`monitor log` -.. cfgcmd:: set service https api port - -   Set the listen port of the local API, this has no effect on the -   webserver. The default is port 8080 - -.. cfgcmd:: set service https api socket - -   Use local socket for API -  .. cfgcmd:: set service https api strict     Enforce strict path checking -.. cfgcmd:: set service https virtual-host <vhost> listen-address  +.. cfgcmd:: set service https virtual-host <vhost> listen-address              <ipv4 or ipv6 address>     Address to listen for HTTPS requests -.. cfgcmd:: set service https virtual-host <vhost> listen-port <1-65535> +.. cfgcmd:: set service https virtual-host <vhost> port <1-65535>     Port to listen for HTTPS requests; default 443 @@ -91,6 +82,6 @@ To use this full configuration we asume a public accessible hostname.     set service https certificates certbot domain-name rtr01.example.com     set service https certificates certbot email mail@example.com     set service https virtual-host rtr01 listen-address 198.51.100.2 -   set service https virtual-host rtr01 listen-port 11443 +   set service https virtual-host rtr01 port 11443     set service https virtual-host rtr01 server-name rtr01.example.com     set service https api-restrict virtual-host rtr01 diff --git a/docs/configuration/service/mdns.rst b/docs/configuration/service/mdns.rst index 9d6a292a..51fbf1a1 100644 --- a/docs/configuration/service/mdns.rst +++ b/docs/configuration/service/mdns.rst @@ -5,28 +5,44 @@ Starting with VyOS 1.2 a :abbr:`mDNS (Multicast DNS)` repeater functionality is  provided. Additional information can be obtained from  https://en.wikipedia.org/wiki/Multicast_DNS. -Multicast DNS uses the 224.0.0.251 address, which is "administratively scoped" -and does not leave the subnet. It retransmits mDNS packets from one interface -to other interfaces. This enables support for e.g. Apple Airplay devices across -multiple VLANs. +Multicast DNS uses the reserved address ``224.0.0.251``, which is +`"administratively scoped"` and does not leave the subnet. mDNS repeater +retransmits mDNS packets from one interface to other interfaces. This enables +support for devices using mDNS discovery (like network printers, Apple Airplay, +Chromecast, various IP based home-automation devices etc) across multiple VLANs. -Since the mDNS protocol sends the AA records in the packet itself, the repeater -does not need to forge the source address. Instead, the source address is of -the interface that repeats the packet. +Since the mDNS protocol sends the :abbr:`AA(Authoritative Answer)` records in +the packet itself, the repeater does not need to forge the source address. +Instead, the source address is of the interface that repeats the packet.  Configuration  =============  .. cfgcmd:: set service mdns repeater interface <interface> -   To enable mDNS repeater you need to configure at least two interfaces. To -   re-broadcast all incoming mDNS packets from any interface configured here to -   any other interface configured under this section. +   To enable mDNS repeater you need to configure at least two interfaces so that +   all incoming mDNS packets from one interface configured here can be +   re-broadcasted to any other interface(s) configured under this section.  .. cfgcmd:: set service mdns repeater disable     mDNS repeater can be temporarily disabled without deleting the service using +.. cfgcmd:: set service mdns repeater ip-version <ipv4 | ipv6 | both> + +   mDNS repeater can be enabled either on IPv4 socket or on IPv6 socket or both +   to re-broadcast. By default, mDNS repeater will listen on both IPv4 and IPv6. + +.. cfgcmd:: set service mdns repeater allow-service <service> + +   mDNS repeater can be configured to re-broadcast only specific services. By +   default, all services are re-broadcasted. + +.. cfgcmd:: set service mdns repeater browse-domain <domain> + +   Allow listing additional custom domains to be browsed (in addition to the +   default ``local``) so that they can be reflected. +  .. note:: You can not run this in a VRRP setup, if multiple mDNS repeaters     are launched in a subnet you will experience the mDNS packet storm death! @@ -41,4 +57,35 @@ received on `eth0` to `eth1` (and vice-versa) use the following commands:    set service mdns repeater interface 'eth0'    set service mdns repeater interface 'eth1' +To allow only specific services, for example ``_airplay._tcp`` or ``_ipp._tcp``, +(instead of all services) to be re-broadcasted, use the following command: + +.. code-block:: none + +  set service mdns repeater allow-service '_airplay._tcp' +  set service mdns repeater allow-service '_ipp._tcp' + +To allow listing additional custom domain, for example +``openthread.thread.home.arpa``, so that it can reflected in addition to the +default ``local``, use the following command: + +.. code-block:: none + +   set service mdns repeater browse-domain 'openthread.thread.home.arpa' +  .. _`Multicast DNS`: https://en.wikipedia.org/wiki/Multicast_DNS + +Operation +========= + +.. opcmd:: restart mdns repeater + +  Restart mDNS repeater service. + +.. opcmd:: show log mdns repeater + +  Show logs for mDNS repeater service. + +.. opcmd:: monitor log mdns repeater + +  Follow the logs for mDNS repeater service. diff --git a/docs/configuration/service/ssh.rst b/docs/configuration/service/ssh.rst index 15c2390c..efdbc651 100644 --- a/docs/configuration/service/ssh.rst +++ b/docs/configuration/service/ssh.rst @@ -218,3 +218,31 @@ Operation      commit      save      exit + +.. opcmd:: show log ssh + +  Show SSH server log. + +.. opcmd:: monitor log ssh + +  Follow the SSH server log. + +.. opcmd:: show log ssh dynamic-protection + +  Show SSH dynamic-protection log. + +.. opcmd:: monitor log ssh dynamic-protection + +  Follow the SSH dynamic-protection log. + +.. opcmd:: show ssh dynamic-protection + +  Show list of IPs currently blocked by SSH dynamic-protection. + +.. opcmd:: show ssh fingerprints + +  Show SSH server public key fingerprints. + +.. opcmd:: show ssh fingerprints ascii + +  Show SSH server public key fingerprints, including a visual ASCII art representation. | 
