From 32652cce15d200363c0dbaf5d2c6c41621f51e73 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sat, 21 Dec 2019 18:03:01 +0100 Subject: install: overall chapter improvement --- docs/services/dhcp.rst | 2 ++ docs/services/tftp.rst | 6 +++--- 2 files changed, 5 insertions(+), 3 deletions(-) (limited to 'docs/services') diff --git a/docs/services/dhcp.rst b/docs/services/dhcp.rst index 19c92aac..ed5082d4 100644 --- a/docs/services/dhcp.rst +++ b/docs/services/dhcp.rst @@ -6,6 +6,8 @@ DHCP / DHCPv6 VyOS uses ISC DHCPd for both IPv4 and IPv6 address assignment. +.. _dhcp-server: + DHCP Server =========== diff --git a/docs/services/tftp.rst b/docs/services/tftp.rst index c33d6c7c..8647dfa8 100644 --- a/docs/services/tftp.rst +++ b/docs/services/tftp.rst @@ -1,8 +1,8 @@ .. _tftp-server: -#### -TFTP -#### +########### +TFTP Server +########### :abbr:`TFTP (Trivial File Transfer Protocol)` is a simple, lockstep file transfer protocol which allows a client to get a file from or put a file onto -- cgit v1.2.3 From 66c64bd3a30ea8ffbbaf9fa5c8d657d815bb0392 Mon Sep 17 00:00:00 2001 From: Jernej Jakob Date: Sat, 21 Dec 2019 12:08:54 +0100 Subject: dhcp: T1806: explain how to use quote characters inside raw parameters --- docs/services/dhcp.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'docs/services') diff --git a/docs/services/dhcp.rst b/docs/services/dhcp.rst index ed5082d4..94efeaf1 100644 --- a/docs/services/dhcp.rst +++ b/docs/services/dhcp.rst @@ -317,12 +317,24 @@ Always verify that the parameters are correct before commiting the configuration Refer to isc-dhcp's dhcpd.conf manual for more information: https://kb.isc.org/docs/isc-dhcp-44-manual-pages-dhcpdconf +Quotes can be used inside parameter values by replacing all quote characters +with the string ``"``. They will be replaced with literal quote characters +when generating dhcpd.conf. + Example ^^^^^^^ .. opcmd:: set service dhcp-server shared-network-name dhcpexample subnet 192.0.2.0/24 static-mapping example static-mapping-parameters "option domain-name-servers 192.0.2.11, 192.0.2.12;" - Override the static-mapping's dns-server with a custom one that will be sent only to this host. + Override the static-mapping's dns-server with a custom one that will be sent + only to this host. + +.. opcmd:: set service dhcp-server shared-network-name dhcpexample subnet 192.0.2.0/24 static-mapping example static-mapping-parameters "option pxelinux.configfile "pxelinux.cfg/01-00-15-17-44-2d-aa";" + + An option that takes a quoted string is set by replacing all quote characters + with the string ``"`` inside the static-mapping-parameters value. + The resulting line in dhcpd.conf will be + ``option pxelinux.configfile "pxelinux.cfg/01-00-15-17-44-2d-aa";``. Operation Mode -------------- -- cgit v1.2.3 From 46466561cd16890a51a08e93924d6f8d48b5a7b7 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Mon, 23 Dec 2019 09:19:43 +0100 Subject: lldp: we now have multiple IPv4/IPv6 management addresses --- docs/services/lldp.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/services') diff --git a/docs/services/lldp.rst b/docs/services/lldp.rst index c1f39fba..da52adb0 100644 --- a/docs/services/lldp.rst +++ b/docs/services/lldp.rst @@ -40,7 +40,8 @@ Configuration .. cfgcmd:: set service lldp management-address
- Define IPv4 management address transmitted via LLDP. + Define IPv4/IPv6 management address transmitted via LLDP. Multiple addresses + can be defined. Only addresses connected to the system will be transmitted. .. cfgcmd:: set service lldp interface -- cgit v1.2.3 From ed9bd9815a1a8341bad29d228015ad536c586cb6 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Mon, 23 Dec 2019 09:28:26 +0100 Subject: lldp: update 'show lldp neighbors' examples --- docs/services/lldp.rst | 103 ++++++++++++++++++++++++------------------------- 1 file changed, 51 insertions(+), 52 deletions(-) (limited to 'docs/services') diff --git a/docs/services/lldp.rst b/docs/services/lldp.rst index da52adb0..4b1743e6 100644 --- a/docs/services/lldp.rst +++ b/docs/services/lldp.rst @@ -73,65 +73,64 @@ Operation Displays information about all neighbors discovered via LLDP. -.. code-block:: none + .. code-block:: none - vyos@vyos:~# show lldp neighbors - Capability Codes: R - Router, B - Bridge, W - Wlan r - Repeater, S - Station - D - Docsis, T - Telephone, O - Other + vyos@vyos:~$ show lldp neighbors + Capability Codes: R - Router, B - Bridge, W - Wlan r - Repeater, S - Station + D - Docsis, T - Telephone, O - Other - Device ID Local Proto Cap Platform Port ID - --------- ----- ----- --- -------- ------- - Switch0815 eth0 LLDP B Cisco IOS Software, Gi0/4 + Device ID Local Proto Cap Platform Port ID + --------- ----- ----- --- -------- ------- + BR2.vyos.net eth0 LLDP R VyOS 1.2.4 eth1 + BR3.vyos.net eth0 LLDP RB VyOS 1.2.4 eth2 + SW1.vyos.net eth0 LLDP B Cisco IOS Software GigabitEthernet0/6 .. opcmd:: show lldp neighbors detail Get detailed information about LLDP neighbors. -.. code-block:: none - - vyos@vyos:~# show lldp neighbors detail - ------------------------------------------------------------------------------- - LLDP neighbors: - ------------------------------------------------------------------------------- - Interface: eth0, via: LLDP, RID: 1, Time: 12 days, xxxx:xxxx:40 - Chassis: - ChassisID: mac 00:50:40:20:03:00 - SysName: Switch0815 - SysDescr: Cisco IOS Software, C2960 Software (C2960-LANBASEK9-M), Version 15.0(2)SE11, RELEASE SOFTWARE (fc3) - Technical Support: http://www.cisco.com/techsupport - Copyright (c) 1986-2017 by Cisco Systems, Inc. - Compiled Sat 19-Aug-17 09:34 by prod_rel_team - MgmtIP: 192.0.2.201 - Capability: Bridge, on - Port: - PortID: ifname Gi0/4 - PortDescr: GigabitEthernet0/4 - TTL: 120 - PMD autoneg: supported: yes, enabled: yes - Adv: 10Base-T, HD: yes, FD: yes - Adv: 100Base-TX, HD: yes, FD: yes - Adv: 1000Base-T, HD: no, FD: yes - MAU oper type: 1000BaseTFD - Four-pair Category 5 UTP, full duplex mode - VLAN: 1, pvid: yes - LLDP-MED: - Device Type: Network Connectivity Device - Capability: Capabilities, yes - Capability: Policy, yes - Capability: Location, yes - Capability: Inventory, yes - LLDP-MED Network Policy for: Voice, Defined: no - Priority: Best effort - PCP: 0 - DSCP Value: 0 - LLDP-MED Network Policy for: Voice Signaling, Defined: no - Priority: Best effort - PCP: 0 - DSCP Value: 0 - Inventory: - Hardware Revision: WS-C2960G-8TC-L (PowerPC405):C0 - Software Revision: 15.0(2)SE11 - Manufacturer: Cisco Systems, Inc. - Model: WS-C2960G-8TC-L + .. code-block:: none + + vyos@vyos:~$ show lldp neighbors detail + ------------------------------------------------------------------------------- + LLDP neighbors: + ------------------------------------------------------------------------------- + Interface: eth0, via: LLDP, RID: 28, Time: 0 day, 00:24:33 + Chassis: + ChassisID: mac 00:53:00:01:02:c9 + SysName: BR2.vyos.net + SysDescr: VyOS 1.3-rolling-201912230217 + MgmtIP: 192.0.2.1 + MgmtIP: 2001:db8::ffff + Capability: Bridge, on + Capability: Router, on + Capability: Wlan, off + Capability: Station, off + Port: + PortID: mac 00:53:00:01:02:c9 + PortDescr: eth0 + TTL: 120 + PMD autoneg: supported: no, enabled: no + MAU oper type: 10GigBaseCX4 - X copper over 8 pair 100-Ohm balanced cable + VLAN: 201 eth0.201 + VLAN: 205 eth0.205 + LLDP-MED: + Device Type: Network Connectivity Device + Capability: Capabilities, yes + Capability: Policy, yes + Capability: Location, yes + Capability: MDI/PSE, yes + Capability: MDI/PD, yes + Capability: Inventory, yes + Inventory: + Hardware Revision: None + Software Revision: 4.19.89-amd64-vyos + Firmware Revision: 6.00 + Serial Number: VMware-42 1d 83 b9 fe c1 bd b2-7 + Manufacturer: VMware, Inc. + Model: VMware Virtual Platform + Asset ID: No Asset Tag + ------------------------------------------------------------------------------- .. opcmd:: show lldp neighbors interface -- cgit v1.2.3 From ef0b747f39b9187bc631442396d2e720f952194f Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sat, 28 Dec 2019 22:59:58 +0100 Subject: dns-forwarding: minor fixes - remove redundant "be" - proper indent note block --- docs/services/dns-forwarding.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'docs/services') diff --git a/docs/services/dns-forwarding.rst b/docs/services/dns-forwarding.rst index fb996709..a529f6a7 100644 --- a/docs/services/dns-forwarding.rst +++ b/docs/services/dns-forwarding.rst @@ -29,9 +29,10 @@ avoid to be tracked by the provider of your upstream DNS server. .. cfgcmd:: set service dns forwarding domain server
Forward received queries for a particular domain (specified via `domain-name`) - to a given name-server. Multiple nameservers can be specified. + to a given name-server. Multiple nameservers can be specified. You can use + this feature for a DNS split-horizon configuration. -.. note:: This also works for reverse-lookup zones e.g. ``18.172.in-addr.arpa``. + .. note:: This also works for reverse-lookup zones (``18.172.in-addr.arpa``). .. cfgcmd:: set service dns forwarding allow-from @@ -71,8 +72,8 @@ avoid to be tracked by the provider of your upstream DNS server. as with process. * **validate** The highest mode of DNSSEC processing. In this mode, all - queries will be be validated and will be answered with a SERVFAIL in case - of bogus data, regardless of the client's request. + queries will be validated and will be answered with a SERVFAIL in case of + bogus data, regardless of the client's request. .. note:: The famous UNIX/Linux ``dig`` tool sets the AD-bit in the query. This might lead to unexpected query results when testing. Set ``+noad`` -- cgit v1.2.3 From 37a891f7cf0499c958eb6bbff5699455a4ada01a Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sun, 29 Dec 2019 11:00:16 +0100 Subject: provide common-references file Spinx references used accross different files should be stored here as a single source reference. Include this file as needed by: .. include:: common-references.rst --- docs/common-references.rst | 2 ++ docs/services/index.rst | 2 -- docs/services/ipoe-server.rst | 9 +++------ docs/services/pppoe-server.rst | 6 +++--- docs/services/references.rst | 11 ----------- docs/services/snmp.rst | 6 +++++- docs/services/sstp-server.rst | 6 +++--- docs/services/webproxy.rst | 5 +++-- 8 files changed, 19 insertions(+), 28 deletions(-) create mode 100644 docs/common-references.rst delete mode 100644 docs/services/references.rst (limited to 'docs/services') diff --git a/docs/common-references.rst b/docs/common-references.rst new file mode 100644 index 00000000..9f0b9b84 --- /dev/null +++ b/docs/common-references.rst @@ -0,0 +1,2 @@ +.. _`accel-ppp`: https://accel-ppp.org/ +.. _`Secure Socket Tunneling Protocol`: https://en.wikipedia.org/wiki/Secure_Socket_Tunneling_Protocol diff --git a/docs/services/index.rst b/docs/services/index.rst index af3e6cb1..e0773090 100644 --- a/docs/services/index.rst +++ b/docs/services/index.rst @@ -1,7 +1,5 @@ .. _services: -.. include:: references.rst - ######## Services ######## diff --git a/docs/services/ipoe-server.rst b/docs/services/ipoe-server.rst index 8e3a88eb..a1144301 100644 --- a/docs/services/ipoe-server.rst +++ b/docs/services/ipoe-server.rst @@ -4,9 +4,9 @@ IPoE server VyOS utilizes `accel-ppp`_ to provide IPoE server functionality. It can be used with local authentication (mac-address) or a connected RADIUS server. -.. note:: **Please be aware, due to an upstream bug, config changes/commits +.. note:: Please be aware, due to an upstream bug, config changes/commits will restart the ppp daemon and will reset existing IPoE sessions, - in order to become effective.** + in order to become effective. Configuration ^^^^^^^^^^^^^ @@ -123,7 +123,4 @@ The rate-limit is set in kbit/sec. -------+------------+-------------------+-------------+-----+--------+------------+--------+----------+------------------ ipoe0 | eth2 | 08:00:27:2f:d8:06 | 192.168.0.2 | | | 500/500 | active | 00:00:05 | dccc870fd31349fb - - - -.. _`accel-ppp`: https://accel-ppp.org/ +.. include:: ../common-references.rst diff --git a/docs/services/pppoe-server.rst b/docs/services/pppoe-server.rst index 481831ba..a229d3f9 100644 --- a/docs/services/pppoe-server.rst +++ b/docs/services/pppoe-server.rst @@ -7,9 +7,9 @@ PPPoE Server VyOS utilizes `accel-ppp`_ to provide PPPoE server functionality. It can be used with local authentication or a connected RADIUS server. -.. note:: **Please be aware, due to an upstream bug, config changes/commits +.. note:: Please be aware, due to an upstream bug, config changes/commits will restart the ppp daemon and will reset existing PPPoE connections from - connected users, in order to become effective.** + connected users, in order to become effective. Configuration ============= @@ -241,4 +241,4 @@ subnet for the clients internal use. --------+----------+-------------+--------------------------+---------------------+-------------------+------------+--------+----------+----------+---------- ppp0 | test | 192.168.0.1 | 2001:db8:8002:0:200::/64 | 2001:db8:8003::1/56 | 00:53:00:12:42:eb | | active | 00:00:49 | 875 B | 2.1 KiB -.. _`accel-ppp`: https://accel-ppp.org/ +.. include:: ../common-references.rst diff --git a/docs/services/references.rst b/docs/services/references.rst deleted file mode 100644 index 704f33f7..00000000 --- a/docs/services/references.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _MIB: https://en.wikipedia.org/wiki/Management_information_base -.. _SNMP: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol -.. _SNMPv2: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_2 -.. _SNMPv3: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_3 -.. _SSH: https://en.wikipedia.org/wiki/Secure_Shell -.. _Squid3: http://www.squid-cache.org/ -.. _Squidguard: http://www.squidguard.org/ -.. _TFTP: https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol -.. _`arbitrary extension commands`: http://net-snmp.sourceforge.net/docs/man/snmpd.conf.html#lbAZ -.. _`accel-ppp`: https://accel-ppp.org/ -.. _`Secure Socket Tunneling Protocol`: https://en.wikipedia.org/wiki/Secure_Socket_Tunneling_Protocol diff --git a/docs/services/snmp.rst b/docs/services/snmp.rst index c4b8fa32..c27cf02a 100644 --- a/docs/services/snmp.rst +++ b/docs/services/snmp.rst @@ -254,4 +254,8 @@ following content: -.. include:: references.rst +.. _MIB: https://en.wikipedia.org/wiki/Management_information_base +.. _SNMP: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol +.. _SNMPv2: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_2 +.. _SNMPv3: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_3 + diff --git a/docs/services/sstp-server.rst b/docs/services/sstp-server.rst index 64a5206b..8e67b95c 100644 --- a/docs/services/sstp-server.rst +++ b/docs/services/sstp-server.rst @@ -6,9 +6,9 @@ SSTP server VyOS utilizes accel-ppp_ to provide SSTP server functionality. It can be used with local authentication or a connected RADIUS server. -.. note:: **Please be aware, due to an upstream bug, config changes/commits +.. note:: Please be aware, due to an upstream bug, config changes/commits will restart the ppp daemon and will reset existing PPPoE connections from - connected users, in order to become effective.** + connected users, in order to become effective. Configuration ^^^^^^^^^^^^^ @@ -73,4 +73,4 @@ looks for all files and directories in ``/config/user-data/sstp``. set sstp-settings ssl-certs server-cert 'server.crt' set sstp-settings ssl-certs server-key 'server.key' -.. include:: references.rst +.. include:: ../common-references.rst diff --git a/docs/services/webproxy.rst b/docs/services/webproxy.rst index b4b20ef5..20e1eb73 100644 --- a/docs/services/webproxy.rst +++ b/docs/services/webproxy.rst @@ -3,7 +3,7 @@ Webproxy The proxy service in VyOS is based on Squid3 and some related modules. -Squid is a caching and forwarding HTTP web proxy. It has a wide variety of +Squid3_ is a caching and forwarding HTTP web proxy. It has a wide variety of uses, including speeding up a web server by caching repeated requests, caching web, DNS and other computer network lookups for a group of people sharing network resources, and aiding security by filtering traffic. Although @@ -149,4 +149,5 @@ So sometimes it is useful to bypass a transparent proxy: (This can be useful when a called service has many and/or often changing destination addresses - e.g. Netflix.) -.. include:: references.rst +.. _Squid3: http://www.squid-cache.org/ +.. _Squidguard: http://www.squidguard.org/ -- cgit v1.2.3 From 37850e2f6f9efed96c9e807fd98623465337d330 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Mon, 30 Dec 2019 11:28:52 +0100 Subject: remove all enclosing '' from cfgcmd/opcmd --- docs/appendix/examples/dmvpn.rst | 4 ++-- docs/configuration-overview.rst | 2 +- docs/interfaces/dummy.rst | 8 ++++---- docs/interfaces/ethernet.rst | 30 +++++++++++++++--------------- docs/routing/bgp.rst | 10 +++++----- docs/routing/static.rst | 32 ++++++++++++++++---------------- docs/services/dhcp.rst | 26 +++++++++++++------------- docs/services/ssh.rst | 10 +++++----- docs/services/tftp.rst | 2 +- docs/services/udp-broadcast-relay.rst | 8 ++++---- docs/system/config-management.rst | 2 +- docs/system/default-route.rst | 4 ++-- docs/system/flow-accounting.rst | 30 +++++++++++++++--------------- docs/system/host-information.rst | 10 +++++----- docs/system/ntp.rst | 8 ++++---- docs/system/proxy.rst | 8 ++++---- docs/system/serial-console.rst | 6 +++--- docs/system/task-scheduler.rst | 8 ++++---- docs/system/time-zone.rst | 2 +- docs/system/user-management.rst | 26 +++++++++++++------------- 20 files changed, 118 insertions(+), 118 deletions(-) (limited to 'docs/services') diff --git a/docs/appendix/examples/dmvpn.rst b/docs/appendix/examples/dmvpn.rst index cbb9f300..49b1fcaa 100644 --- a/docs/appendix/examples/dmvpn.rst +++ b/docs/appendix/examples/dmvpn.rst @@ -17,7 +17,7 @@ Configuration set interfaces tunnel tun100 multicast 'enable' set interfaces tunnel tun100 parameters ip key '1' - set protocols nhrp tunnel tun100 cisco-authentication '' + set protocols nhrp tunnel tun100 cisco-authentication set protocols nhrp tunnel tun100 holding-time '300' set protocols nhrp tunnel tun100 multicast 'dynamic' set protocols nhrp tunnel tun100 redirect @@ -43,7 +43,7 @@ Configuration set vpn ipsec ipsec-interfaces interface 'eth0' set vpn ipsec profile NHRPVPN authentication mode 'pre-shared-secret' - set vpn ipsec profile NHRPVPN authentication pre-shared-secret '' + set vpn ipsec profile NHRPVPN authentication pre-shared-secret set vpn ipsec profile NHRPVPN bind tunnel 'tun100' set vpn ipsec profile NHRPVPN esp-group 'ESP-HUB' set vpn ipsec profile NHRPVPN ike-group 'IKE-HUB' diff --git a/docs/configuration-overview.rst b/docs/configuration-overview.rst index 646f4dea..0ee4e0f5 100644 --- a/docs/configuration-overview.rst +++ b/docs/configuration-overview.rst @@ -109,7 +109,7 @@ added through a collection of :cfgcmd:`set` and :cfgcmd:`delete` commands. set service ssh port '22' set system config-management commit-revisions '20' set system console device ttyS0 speed '9600' - set system login user vyos authentication encrypted-password '' + set system login user vyos authentication encrypted-password '$6$Vt68...QzF0' set system login user vyos level 'admin' set system ntp server '0.pool.ntp.org' set system ntp server '1.pool.ntp.org' diff --git a/docs/interfaces/dummy.rst b/docs/interfaces/dummy.rst index 1b35cefd..c74e5f48 100644 --- a/docs/interfaces/dummy.rst +++ b/docs/interfaces/dummy.rst @@ -16,7 +16,7 @@ Configuration Address ------- -.. cfgcmd:: set interfaces dummy '' address
+.. cfgcmd:: set interfaces dummy address
Configure dummy interface `` with one or more interface addresses. @@ -40,12 +40,12 @@ Address Link Administration ------------------- -.. cfgcmd:: set interfaces dummy '' description '' +.. cfgcmd:: set interfaces dummy description Assign given `` to interface. Description will also be passed to SNMP monitoring systems. -.. cfgcmd:: set interfaces dummy '' disable +.. cfgcmd:: set interfaces dummy disable Disable given ``. It will be placed in administratively down state. @@ -65,7 +65,7 @@ Operation --------- ---------- --- ----------- dum0 172.18.254.201/32 u/u -.. opcmd:: show interfaces dummy '' +.. opcmd:: show interfaces dummy Show detailed information on given `` diff --git a/docs/interfaces/ethernet.rst b/docs/interfaces/ethernet.rst index d0537b41..693634fb 100644 --- a/docs/interfaces/ethernet.rst +++ b/docs/interfaces/ethernet.rst @@ -10,7 +10,7 @@ Configuration Address ------- -.. cfgcmd:: set interfaces ethernet '' address
+.. cfgcmd:: set interfaces ethernet address
Configure ethernet interface `` with one or more interface addresses. @@ -31,7 +31,7 @@ Address set interfaces ethernet eth0 address 2001:db8::ffff/64 set interfaces ethernet eth0 address 2001:db8:100::ffff/64 -.. cfgcmd:: set interfaces ethernet '' ipv6 address autoconf +.. cfgcmd:: set interfaces ethernet ipv6 address autoconf :abbr:`SLAAC (Stateless Address Autoconfiguration)` :rfc:`4862`. IPv6 hosts can configure themselves automatically when connected @@ -45,7 +45,7 @@ Address .. note:: This method automatically disables IPv6 traffic forwarding on the interface in question. -.. cfgcmd:: set interfaces ethernet '' ipv6 address eui64 '' +.. cfgcmd:: set interfaces ethernet ipv6 address eui64 :abbr:`EUI-64 (64-Bit Extended Unique Identifier)` as specified in :rfc:`4291` allows a host to assign iteslf a unique 64-Bit IPv6 address. @@ -57,7 +57,7 @@ Address Speed/Duplex ------------ -.. cfgcmd:: set interfaces ethernet '' duplex +.. cfgcmd:: set interfaces ethernet duplex Configure physical interface duplex setting. @@ -67,7 +67,7 @@ Speed/Duplex VyOS default will be `auto`. -.. cfgcmd:: set interfaces ethernet '' speed +.. cfgcmd:: set interfaces ethernet speed Configure physical interface speed setting. @@ -88,27 +88,27 @@ Speed/Duplex Link Administration ------------------- -.. cfgcmd:: set interfaces ethernet '' description '' +.. cfgcmd:: set interfaces ethernet description Assign given `` to interface. Description will also be passed to SNMP monitoring systems. -.. cfgcmd:: set interfaces ethernet '' disable +.. cfgcmd:: set interfaces ethernet disable Disable given ``. It will be placed in administratively down state. -.. cfgcmd:: set interfaces ethernet '' disable-flow-control +.. cfgcmd:: set interfaces ethernet disable-flow-control Disable Ethernet flow control (pause frames). -.. cfgcmd:: set interfaces ethernet '' mac '' +.. cfgcmd:: set interfaces ethernet mac Configure user defined :abbr:`MAC (Media Access Control)` address on given ``. -.. cfgcmd:: set interfaces ethernet '' mtu '' +.. cfgcmd:: set interfaces ethernet mtu Configure :abbr:`MTU (Maximum Transmission Unit)` on given ``. It is the size (in bytes) of the largest ethernet frame sent on this link. @@ -119,11 +119,11 @@ Router Advertisements Router advertisements are described in :rfc:`4861#section-4.6.2`. They are part of what is known as :abbr:`SLAAC (Stateless Address Autoconfiguration)`. -.. cfgcmd:: set interfaces ethernet '' ipv6 router-advert send-advert +.. cfgcmd:: set interfaces ethernet ipv6 router-advert send-advert Enable or disable router advertisements in this ``. -.. cfgcmd:: set interfaces ethernet '' ipv6 router-advert prefix '' +.. cfgcmd:: set interfaces ethernet ipv6 router-advert prefix Prefix information is described in :rfc:`4861#section-4.6.2`. @@ -144,7 +144,7 @@ Operation eth1 172.18.202.11/24 u/u WAN eth2 - u/D -.. opcmd:: show interfaces ethernet '' +.. opcmd:: show interfaces ethernet Show detailed information on given `` @@ -161,7 +161,7 @@ Operation TX: bytes packets errors dropped carrier collisions 5601460 62595 0 0 0 0 -.. opcmd:: show interfaces ethernet '' physical +.. opcmd:: show interfaces ethernet physical Show information about physical `` @@ -200,7 +200,7 @@ Operation supports-register-dump: yes supports-priv-flags: no -.. opcmd:: show interfaces ethernet '' transceiver +.. opcmd:: show interfaces ethernet transceiver Show transceiver information from plugin modules, e.g SFP+, QSFP diff --git a/docs/routing/bgp.rst b/docs/routing/bgp.rst index d8860e15..14ea1238 100644 --- a/docs/routing/bgp.rst +++ b/docs/routing/bgp.rst @@ -159,14 +159,14 @@ BGP Router Configuration ASN and Router ID ----------------- -.. cfgcmd:: set protocols bgp '' +.. cfgcmd:: set protocols bgp First of all you must configure BGP router with the :abbr:`ASN (Autonomous System Number)`. The AS number is an identifier for the autonomous system. The BGP protocol uses the AS number for detecting whether the BGP connection is internal or external. -.. cfgcmd:: set protocols bgp '' parameters router-id +.. cfgcmd:: set protocols bgp parameters router-id This command specifies the router-ID. If router ID is not specified it will use the highest interface IP address. @@ -174,19 +174,19 @@ ASN and Router ID Route Selection --------------- -.. cfgcmd:: set protocols bgp '' parameters bestpath as-path confed +.. cfgcmd:: set protocols bgp parameters bestpath as-path confed This command specifies that the length of confederation path sets and sequences should should be taken into account during the BGP best path decision process. -.. cfgcmd:: set protocols bgp '' parameters bestpath as-path multipath-relax +.. cfgcmd:: set protocols bgp parameters bestpath as-path multipath-relax This command specifies that BGP decision process should consider paths of equal AS_PATH length candidates for multipath computation. Without the knob, the entire AS_PATH must match for multipath computation. -.. cfgcmd:: set protocols bgp '' parameters bestpath as-path ignore +.. cfgcmd:: set protocols bgp parameters bestpath as-path ignore Ignore AS_PATH length when selecting a route diff --git a/docs/routing/static.rst b/docs/routing/static.rst index cebe42fa..52a73354 100644 --- a/docs/routing/static.rst +++ b/docs/routing/static.rst @@ -18,32 +18,32 @@ used to determine the forwarding table used for unicast packet forwarding. Static Routes ############# -.. cfgcmd:: set protocols static route '' next-hop '
' +.. cfgcmd:: set protocols static route next-hop
Configure next-hop `
` for an IPv4 static route. Multiple static routes can be created. -.. cfgcmd:: set protocols static route '' next-hop '
' disable +.. cfgcmd:: set protocols static route next-hop
disable Disable this IPv4 static route entry. -.. cfgcmd:: set protocols static route '' next-hop '
' distance '' +.. cfgcmd:: set protocols static route next-hop
distance Defines next-hop distance for this route, routes with smaller administrative distance are elected prior those with a higher distance. Range is 1 to 255, default is 1. -.. cfgcmd:: set protocols static route6 '' next-hop '
' +.. cfgcmd:: set protocols static route6 next-hop
Configure next-hop `
` for an IPv6 static route. Multiple static routes can be created. -.. cfgcmd:: set protocols static route6 '' next-hop '
' disable +.. cfgcmd:: set protocols static route6 next-hop
disable Disable this IPv6 static route entry. -.. cfgcmd:: set protocols static route6 '' next-hop '
' distance '' +.. cfgcmd:: set protocols static route6 next-hop
distance Defines next-hop distance for this route, routes with smaller administrative distance are elected prior those with a higher distance. @@ -57,34 +57,34 @@ Static Routes Interface Routes ================ -.. cfgcmd:: set protocols static interface-route '' next-hop-interface '' +.. cfgcmd:: set protocols static interface-route next-hop-interface Allows you to configure the next-hop interface for an interface-based IPv4 static route. `` will be the next-hop interface where trafic is routed for the given ``. -.. cfgcmd:: set protocols static interface-route '' next-hop-interface '' disable +.. cfgcmd:: set protocols static interface-route next-hop-interface disable Disables interface-based IPv4 static route. -.. cfgcmd:: set protocols static interface-route '' next-hop-interface '' distance '' +.. cfgcmd:: set protocols static interface-route next-hop-interface distance Defines next-hop distance for this route, routes with smaller administrative distance are elected prior those with a higher distance. Range is 1 to 255, default is 1. -.. cfgcmd:: set protocols static interface-route6 '' next-hop-interface '' +.. cfgcmd:: set protocols static interface-route6 next-hop-interface Allows you to configure the next-hop interface for an interface-based IPv6 static route. `` will be the next-hop interface where trafic is routed for the given ``. -.. cfgcmd:: set protocols static interface-route6 '' next-hop-interface '' disable +.. cfgcmd:: set protocols static interface-route6 next-hop-interface disable Disables interface-based IPv6 static route. -.. cfgcmd:: set protocols static interface-route6 '' next-hop-interface '' distance '' +.. cfgcmd:: set protocols static interface-route6 next-hop-interface distance Defines next-hop distance for this route, routes with smaller administrative distance are elected prior those with a higher distance. @@ -95,7 +95,7 @@ Interface Routes Blackhole ========= -.. cfgcmd:: set protocols static route '' blackhole +.. cfgcmd:: set protocols static route blackhole Use this command to configure a "black-hole" route on the router. A black-hole route is a route for which the system silently discard packets @@ -103,12 +103,12 @@ Blackhole it does not prevent them from being used as a more specific route inside your network. -.. cfgcmd:: set protocols static route '' blackhole distance '' +.. cfgcmd:: set protocols static route blackhole distance Defines blackhole distance for this route, routes with smaller administrative distance are elected prior those with a higher distance. -.. cfgcmd:: set protocols static route6 '' blackhole +.. cfgcmd:: set protocols static route6 blackhole Use this command to configure a "black-hole" route on the router. A black-hole route is a route for which the system silently discard packets @@ -116,7 +116,7 @@ Blackhole it does not prevent them from being used as a more specific route inside your network. -.. cfgcmd:: set protocols static route6 '' blackhole distance '' +.. cfgcmd:: set protocols static route6 blackhole distance Defines blackhole distance for this route, routes with smaller administrative distance are elected prior those with a higher distance. diff --git a/docs/services/dhcp.rst b/docs/services/dhcp.rst index 94efeaf1..bcadb673 100644 --- a/docs/services/dhcp.rst +++ b/docs/services/dhcp.rst @@ -146,23 +146,23 @@ inside the subnet definition but can be outside of the range statement. DHCP Options ------------ -.. cfgcmd:: set service dhcp-server shared-network-name '' subnet 192.0.2.0/24 default-router '
' +.. cfgcmd:: set service dhcp-server shared-network-name subnet 192.0.2.0/24 default-router
Specify the default routers IPv4 address which should be used in this subnet. This can - of course - be a VRRP address (DHCP option 003). -.. cfgcmd:: set service dhcp-server shared-network-name '' subnet 192.0.2.0/24 dns-server '
' +.. cfgcmd:: set service dhcp-server shared-network-name subnet 192.0.2.0/24 dns-server
Specify the DNS nameservers used (Option 006). This option may be used mulltiple times to specify additional DNS nameservers. -.. cfgcmd:: set service dhcp-server shared-network-name '' subnet 192.0.2.0/24 domain-name '' +.. cfgcmd:: set service dhcp-server shared-network-name subnet 192.0.2.0/24 domain-name The domain-name parameter should be the domain name that will be appended to the client's hostname to form a fully-qualified domain-name (FQDN) (DHCP Option 015). -.. cfgcmd:: set service dhcp-server shared-network-name '' subnet 192.0.2.0/24 domain-search '' +.. cfgcmd:: set service dhcp-server shared-network-name subnet 192.0.2.0/24 domain-search The domain-name parameter should be the domain name used when completing DNS request where no full FQDN is passed. This option can be given multiple times @@ -401,41 +401,41 @@ Configuration Options Clients receiving advertise messages from multiple servers choose the server with the highest preference value. The range for this value is ``0...255``. -.. cfgcmd:: set service dhcpv6-server shared-network-name '' subnet '' lease-time {default | maximum | minimum} +.. cfgcmd:: set service dhcpv6-server shared-network-name subnet lease-time {default | maximum | minimum} The default lease time for DHCPv6 leases is 24 hours. This can be changed by supplying a ``default-time``, ``maximum-time`` and ``minimum-time``. All values need to be supplied in seconds. -.. cfgcmd:: set service dhcpv6-server shared-network-name '' subnet '' nis-domain '' +.. cfgcmd:: set service dhcpv6-server shared-network-name subnet nis-domain A :abbr:`NIS (Network Information Service)` domain can be set to be used for DHCPv6 clients. -.. cfgcmd:: set service dhcpv6-server shared-network-name '' subnet '' nisplus-domain '' +.. cfgcmd:: set service dhcpv6-server shared-network-name subnet nisplus-domain The procedure to specify a :abbr:`NIS+ (Network Information Service Plus)` domain is similar to the NIS domain one: -.. cfgcmd:: set service dhcpv6-server shared-network-name '' subnet '' nis-server '
' +.. cfgcmd:: set service dhcpv6-server shared-network-name subnet nis-server
Specify a NIS server address for DHCPv6 clients. -.. cfgcmd:: set service dhcpv6-server shared-network-name '' subnet '' nisplus-server '
' +.. cfgcmd:: set service dhcpv6-server shared-network-name subnet nisplus-server
Specify a NIS+ server address for DHCPv6 clients. -.. cfgcmd:: set service dhcpv6-server shared-network-name '' subnet '' sip-server-address '
' +.. cfgcmd:: set service dhcpv6-server shared-network-name subnet sip-server-address
Specify a :abbr:`SIP (Session Initiation Protocol)` server by IPv6 address for all DHCPv6 clients. -.. cfgcmd:: set service dhcpv6-server shared-network-name '' subnet '' sip-server-name '' +.. cfgcmd:: set service dhcpv6-server shared-network-name subnet sip-server-name Specify a :abbr:`SIP (Session Initiation Protocol)` server by FQDN for all DHCPv6 clients. -.. cfgcmd:: set service dhcpv6-server shared-network-name '' subnet '' sntp-server-address '
' +.. cfgcmd:: set service dhcpv6-server shared-network-name subnet sntp-server-address
A SNTP server address can be specified for DHCPv6 clients. @@ -570,7 +570,7 @@ https://wiki.vyos.net/wiki/Network_address_setup. Configuration ------------- -.. cfgcmd:: set service dhcp-relay interface '' +.. cfgcmd:: set service dhcp-relay interface Enable the DHCP relay service on the given interface. diff --git a/docs/services/ssh.rst b/docs/services/ssh.rst index fde575ea..1dd996d4 100644 --- a/docs/services/ssh.rst +++ b/docs/services/ssh.rst @@ -30,17 +30,17 @@ and integrity of data over an unsecured network, such as the Internet. Configuration ============= -.. cfgcmd:: set service ssh port '' +.. cfgcmd:: set service ssh port -Enabling SSH only requires you to specify the port ```` you want SSH to +Enabling SSH only requires you to specify the port ```` you want SSH to listen on. By default, SSH runs on port 22. -.. cfgcmd:: set service ssh listen-address '
' +.. cfgcmd:: set service ssh listen-address
Specify IPv4/IPv6 listen address of SSH server. Multiple addresses can be defined. -.. cfgcmd:: set service ssh ciphers '' +.. cfgcmd:: set service ssh ciphers Define allowed ciphers used for the SSH connection. A number of allowed ciphers can be specified, use multiple occurrences to allow multiple ciphers. @@ -71,7 +71,7 @@ security! Disable the host validation through reverse DNS lookups - can speedup login time when reverse lookup is not possible. -.. cfgcmd:: set service ssh macs '' +.. cfgcmd:: set service ssh macs Specifies the available :abbr:`MAC (Message Authentication Code)` algorithms. The MAC algorithm is used in protocol version 2 for data integrity protection. diff --git a/docs/services/tftp.rst b/docs/services/tftp.rst index 8647dfa8..ce87011c 100644 --- a/docs/services/tftp.rst +++ b/docs/services/tftp.rst @@ -22,7 +22,7 @@ files. content on image upgrades. Any directory under ``/config`` is save at this will be migrated. -.. cfgcmd:: set service tftp-server listen-address '
' +.. cfgcmd:: set service tftp-server listen-address
Configure the IPv4 or IPv6 listen address of the TFTP server. Multiple IPv4 and IPv6 addresses can be given. There will be one TFTP server instances listening diff --git a/docs/services/udp-broadcast-relay.rst b/docs/services/udp-broadcast-relay.rst index 10939c9d..f9e1b03e 100644 --- a/docs/services/udp-broadcast-relay.rst +++ b/docs/services/udp-broadcast-relay.rst @@ -17,23 +17,23 @@ support 99 IDs! Configuration ------------- -.. cfgcmd:: set service broadcast-relay id '' description '' +.. cfgcmd:: set service broadcast-relay id description A description can be added for each and every unique relay ID. This is usefull to distinguish between multiple different ports/appliactions. -.. cfgcmd:: set service broadcast-relay id '' interface '' +.. cfgcmd:: set service broadcast-relay id interface The interface used to receive and relay individual broadcast packets. If you want to receive/relay packets on both `eth1` and `eth2` both interfaces need to be added. -.. cfgcmd:: set service broadcast-relay id '' port '' +.. cfgcmd:: set service broadcast-relay id port The UDP port number used by your apllication. It is mandatory for this kind of operation. -.. cfgcmd:: set service broadcast-relay id '' disable +.. cfgcmd:: set service broadcast-relay id disable Each broadcast relay instance can be individually disabled without deleting the configured node by using the following command: diff --git a/docs/system/config-management.rst b/docs/system/config-management.rst index df2a80aa..9d65adb3 100644 --- a/docs/system/config-management.rst +++ b/docs/system/config-management.rst @@ -13,7 +13,7 @@ stored on a remote host for archiving/backup reasons. Change the number of commit revisions to ``, the default setting for this value is to store 20 revisions locally. -.. cfgcmd:: set system config-management commit-archive location '' +.. cfgcmd:: set system config-management commit-archive location If you want to save all config changes to a remote destination. Set the commit-archive location. Every time a commit is successfully the diff --git a/docs/system/default-route.rst b/docs/system/default-route.rst index a46790e4..27c74188 100644 --- a/docs/system/default-route.rst +++ b/docs/system/default-route.rst @@ -5,13 +5,13 @@ Default Gateway/Route ##################### In the past (VyOS 1.1) used a gateway-address configured under the system tree -(:cfgcmd:`set system gateway-address '
'`), this is no longer supported +(:cfgcmd:`set system gateway-address
`), this is no longer supported and existing configurations are migrated to the new CLI command. Configuration ============= -.. cfgcmd:: set protocols static route 0.0.0.0/0 next-hop '
' +.. cfgcmd:: set protocols static route 0.0.0.0/0 next-hop
Specify static route into the routing table sending all non local traffic to the nexthop address `
`. diff --git a/docs/system/flow-accounting.rst b/docs/system/flow-accounting.rst index 52a2a18d..df58e1f3 100644 --- a/docs/system/flow-accounting.rst +++ b/docs/system/flow-accounting.rst @@ -45,7 +45,7 @@ Configururation In order for flow accounting information to be collected and displayed for an interface, the interface must be configured for flow accounting. -.. cfgcmd:: set system flow-accounting interface '' +.. cfgcmd:: set system flow-accounting interface Configure and enable collection of flow information for the interface identified by ``. @@ -68,12 +68,12 @@ you have high traffic levels or noted some problems with missed records or stopping exporting, you may try to increase a default buffer size (10 MiB) with the next command: -.. cfgcmd:: set system flow-accounting buffer-size '' +.. cfgcmd:: set system flow-accounting buffer-size In case, if you need to catch some logs from flow-accounting daemon, you may configure logging facility: -.. cfgcmd:: set system flow-accounting syslog-facility '' +.. cfgcmd:: set system flow-accounting syslog-facility Flow Export @@ -85,7 +85,7 @@ exported them to a collection server. NetFlow ^^^^^^^ -.. cfgcmd:: set system flow-accounting netflow version '' +.. cfgcmd:: set system flow-accounting netflow version There are multiple versions available for the NetFlow data. The `` used in the exported flow data can be configured here. The following @@ -95,20 +95,20 @@ NetFlow * **9** - NetFlow version 9 (default) * **10** - :abbr:`IPFIX (IP Flow Information Export)` as per :rfc:`3917` -.. cfgcmd:: set system flow-accounting netflow server '
' +.. cfgcmd:: set system flow-accounting netflow server
Configure address of NetFlow collector. NetFlow server at `
` can be both listening on an IPv4 or IPv6 address. -.. cfgcmd:: set system flow-accounting netflow source-ip '
' +.. cfgcmd:: set system flow-accounting netflow source-ip
IPv4 or IPv6 source address of NetFlow packets -.. cfgcmd:: set system flow-accounting netflow engine-id '' +.. cfgcmd:: set system flow-accounting netflow engine-id NetFlow engine-id which will appear in NetFlow data. The range is 0 to 255. -.. cfgcmd:: set system flow-accounting netflow sampling-rate '' +.. cfgcmd:: set system flow-accounting netflow sampling-rate Use this command to configure the sampling rate for flow accounting. The system samples one in every `` packets, where `` is the value @@ -120,7 +120,7 @@ NetFlow Per default every packet is sampled (that is, the sampling rate is 1). -.. cfgcmd:: set system flow-accounting netflow timeout expiry interval '' +.. cfgcmd:: set system flow-accounting netflow timeout expiry interval Specifies the interval at which Netflow data will be sent to a collector. As per default, Netflow data will be sent every 60 seconds. @@ -128,24 +128,24 @@ NetFlow You may also additionally configure timeouts for different types of connections. -.. cfgcmd:: set system flow-accounting netflow max-flows '' +.. cfgcmd:: set system flow-accounting netflow max-flows If you want to change the maximum number of flows, which are tracking simultaneously, you may do this with this command (default 8192). sFlow ^^^^^ -.. cfgcmd:: set system flow-accounting sflow server '
' +.. cfgcmd:: set system flow-accounting sflow server
Configure address of sFlow collector. sFlow server at `
` can be an IPv4 or IPv6 address. But you cannot export to both IPv4 and IPv6 collectors at the same time! -.. cfgcmd:: set system flow-accounting sflow sampling-rate '' +.. cfgcmd:: set system flow-accounting sflow sampling-rate Enable sampling of packets, which will be transmitted to sFlow collectors. -.. cfgcmd:: set system flow-accounting sflow agent-address '
' +.. cfgcmd:: set system flow-accounting sflow agent-address
Configure a sFlow agent address. It can be IPv4 or IPv6 address, but you must set the same protocol, which is used for sFlow collector addresses. By @@ -169,7 +169,7 @@ Operation Once flow accounting is configured on an interfaces it provides the ability to display captured network traffic information for all configured interfaces. -.. opcmd:: show flow-accounting interface '' +.. opcmd:: show flow-accounting interface Show flow accounting information for given ``. @@ -186,7 +186,7 @@ display captured network traffic information for all configured interfaces. eth0 00:53:01:b2:22:48 00:53:02:58:a2:92 192.0.2.100 192.0.2.14 40006 22 tcp 16 146 1 9444 eth0 00:53:01:b2:22:48 00:53:02:58:a2:92 192.0.2.100 192.0.2.14 0 0 icmp 192 27 1 4455 -.. opcmd:: show flow-accounting interface '' host '
' +.. opcmd:: show flow-accounting interface host
Show flow accounting information for given `` for a specific host only. diff --git a/docs/system/host-information.rst b/docs/system/host-information.rst index e4cbd584..30efe01e 100644 --- a/docs/system/host-information.rst +++ b/docs/system/host-information.rst @@ -20,7 +20,7 @@ network and is used to distinguish one device from another on specific networks or over the internet. On the other hand this will be the name which appears on the command line prompt. -.. cfgcmd:: set system host-name '' +.. cfgcmd:: set system host-name Set system hostname. The hostname can be up to 63 characters. A hostname must start and end with a letter or digit, and have as interior characters @@ -36,7 +36,7 @@ unique. VyOS appends the domain name as a suffix to any unqualified name. For example, if you set the domain name `example.com`, and you would ping the unqualified name of `crux`, then VyOS qualifies the name to `crux.example.com`. -.. cfgcmd:: set system domain-name '' +.. cfgcmd:: set system domain-name Configure system domain name. A domain name must start and end with a letter or digit, and have as interior characters only letters, digits, or a hyphen. @@ -48,16 +48,16 @@ How an IP address is assigned to an interface in :ref:`ethernet-interface`. This section shows how to statically map an IP address to a hostname for local (meaning on this VyOS instance) name resolution. -.. cfgcmd:: set system static-host-mapping host-name '' inet '
' +.. cfgcmd:: set system static-host-mapping host-name inet
Create a static hostname mapping which will always resolve the name `` to IP address `
`. -.. cfgcmd:: set system static-host-mapping host-name '' alias '' +.. cfgcmd:: set system static-host-mapping host-name alias Create named `` for the configured static mapping for ``. Thus the address configured as :cfgcmd:`set system static-host-mapping - host-name '' inet '
'` can be reached via multiple names. + host-name inet
` can be reached via multiple names. Multiple aliases can pe specified per host-name. diff --git a/docs/system/ntp.rst b/docs/system/ntp.rst index 0836f2fa..5fd1837f 100644 --- a/docs/system/ntp.rst +++ b/docs/system/ntp.rst @@ -33,9 +33,9 @@ in :rfc:`1305`. Configuration ============= -.. cfgcmd:: set system ntp server '
' +.. cfgcmd:: set system ntp server
- Configure one or more servers for synchronisation. Server name cen be either + Configure one or more servers for synchronisation. Server name can be either an IP address or :abbr:`FQDN (Fully Qualified Domain Name)`. There are 3 default NTP server set. You are able to change them. @@ -44,13 +44,13 @@ Configuration * 1.pool.ntp.org * 2.pool.ntp.org -.. cfgcmd:: set system ntp listen-address '
' +.. cfgcmd:: set system ntp listen-address
Setup VyOS as an NTP responder, you must specify the `
` and optionally the permitted clients. Multiple listen addresses can be configured. -.. cfgcmd:: set system ntp allow-clients address '
' +.. cfgcmd:: set system ntp allow-clients address
List of networks or client addresses permitted to contact this NTP server. Multiple networks can be configured. diff --git a/docs/system/proxy.rst b/docs/system/proxy.rst index 40bdf998..8e0339a7 100644 --- a/docs/system/proxy.rst +++ b/docs/system/proxy.rst @@ -8,21 +8,21 @@ Some IT environments require the use of a proxy to connect to the Internet. Without this configuration VyOS updates could not be installed directly by using the :opcmd:`add system image` command (:ref:`update_vyos`). -.. cfgcmd:: set system proxy url '' +.. cfgcmd:: set system proxy url Set proxy for all connections initiated by VyOS, including HTTP, HTTPS, and FTP (anonymous ftp). -.. cfgcmd:: set system proxy port '' +.. cfgcmd:: set system proxy port Configure proxy port if it does not listen to the default port 80. -.. cfgcmd:: set system proxy username '' +.. cfgcmd:: set system proxy username Some proxys require/support the "basic" HTTP authentication scheme as per :rfc:`7617`, thus a username can be configured. -.. cfgcmd:: set system proxy password '' +.. cfgcmd:: set system proxy password Some proxys require/support the "basic" HTTP authentication scheme as per :rfc:`7617`, thus a password can be configured. diff --git a/docs/system/serial-console.rst b/docs/system/serial-console.rst index cd27fa21..309c6ad2 100644 --- a/docs/system/serial-console.rst +++ b/docs/system/serial-console.rst @@ -16,7 +16,7 @@ access to the console is the only way to diagnose and correct software failures. Major upgrades to the installed distribution may also require console access. -.. cfgcmd:: set system console device '' +.. cfgcmd:: set system console device Defines the specified device as a system console. Available console devices can be (see completion helper): @@ -25,7 +25,7 @@ Major upgrades to the installed distribution may also require console access. * ``ttyUSBX`` - USB Serial device name * ``hvc0`` - Xen console -.. cfgcmd:: set system console device '' speed '' +.. cfgcmd:: set system console device speed The speed (baudrate) of the console device. Supported values are: @@ -44,6 +44,6 @@ Network Console TBD. -.. cfgcmd:: set system console network '' +.. cfgcmd:: set system console network ... and many more commands ... \ No newline at end of file diff --git a/docs/system/task-scheduler.rst b/docs/system/task-scheduler.rst index 869a0600..382da39f 100644 --- a/docs/system/task-scheduler.rst +++ b/docs/system/task-scheduler.rst @@ -11,7 +11,7 @@ use of UNIX cron_. be dangerous. Together with :ref:`command-scripting` this can be used for automating (re-)configuration. -.. cfgcmd:: set system task-scheduler task '' interval '' +.. cfgcmd:: set system task-scheduler task interval Specify the time interval when `` should be executed. The interval is specified as number with one of the following suffixes: @@ -23,17 +23,17 @@ use of UNIX cron_. .. note:: If suffix is omitted, minutes are implied. -.. cfgcmd:: set system task-scheduler task '' crontab-spec '' +.. cfgcmd:: set system task-scheduler task crontab-spec Set execution time in common cron_ time format. A cron `` of ``30 */6 * * *`` would execute the `` at minute 30 past every 6th hour. -.. cfgcmd:: set system task-scheduler task '' executable path '' +.. cfgcmd:: set system task-scheduler task executable path Specify absolute `` to script which will be run when `` is executed. -.. cfgcmd:: set system task-scheduler task '' executable arguments '' +.. cfgcmd:: set system task-scheduler task executable arguments Arguments which will be passed to the executable. diff --git a/docs/system/time-zone.rst b/docs/system/time-zone.rst index d65e1d78..025c4376 100644 --- a/docs/system/time-zone.rst +++ b/docs/system/time-zone.rst @@ -8,7 +8,7 @@ Time Zone setting is very important as e.g all your logfile entries will be based on the configured zone. Without proper time zone configuration it will be very difficult to compare logfiles from different systems. -.. cfgcmd:: set system time-zone '' +.. cfgcmd:: set system time-zone Specify the systems `` as the Region/Location that best defines your location. For example, specifying US/Pacific sets the time zone to US diff --git a/docs/system/user-management.rst b/docs/system/user-management.rst index b2dd3d08..bb9a6e90 100644 --- a/docs/system/user-management.rst +++ b/docs/system/user-management.rst @@ -15,23 +15,23 @@ Authentication Dial-In User Service)` accounts are supported. Local ===== -.. cfgcmd:: set system login user '' full-name "" +.. cfgcmd:: set system login user full-name "" Create new system user with username `` and real-name specified by ``. -.. cfgcmd:: set system login user '' authentication plaintext-password '' +.. cfgcmd:: set system login user authentication plaintext-password Specify the plaintext password user by user `` on this system. The plaintext password will be automatically transferred into a secure hashed password and not saved anywhere in plaintext. -.. cfgcmd:: set system login user '' authentication encrypted-password '' +.. cfgcmd:: set system login user authentication encrypted-password Setup encrypted password for given username. This is usefull for transferring a hashed password from system to system. -.. cfgcmd:: set system login user '' group '' +.. cfgcmd:: set system login user group Specify additional group membership for given username ``. @@ -55,12 +55,12 @@ and paste it. Some terminal emulators may accidentally split this over several lines. Be attentive when you paste it that it only pastes as a single line. The third part is simply an identifier, and is for your own reference. -.. cfgcmd:: set system login user '' authentication public-keys '' key '' +.. cfgcmd:: set system login user authentication public-keys key Assign the SSH public key portion `` identified by per-key `` to the local user ``. -.. cfgcmd:: set system login user '' authentication public-keys '' type '' +.. cfgcmd:: set system login user authentication public-keys type Every SSH public key portion referenced by `` requires the configuration of the `` of public-key used. This type can be any of: @@ -75,7 +75,7 @@ The third part is simply an identifier, and is for your own reference. .. note:: You can assign multiple keys to the same user by using a unique identifier per SSH key. -.. cfgcmd:: loadkey '' '' +.. cfgcmd:: loadkey SSH keys can not only be specified on the command-line but also loaded for a given user with `` from a file pointed to by `.` Keys @@ -113,17 +113,17 @@ Dial-In User Service)` servers as backend for user authentication. Configuration ------------- -.. cfgcmd:: set system login radius server '
' secret '' +.. cfgcmd:: set system login radius server
secret Specify the `
` of the RADIUS server user with the pre-shared-secret given in ``. Multiple servers can be specified. -.. cfgcmd:: set system login radius server '
' port '' +.. cfgcmd:: set system login radius server
port Configure the discrete port under which the RADIUS server can be reached. This defaults to 1812. -.. cfgcmd:: set system login radius server '
' timeout '' +.. cfgcmd:: set system login radius server
timeout Setup the `` in seconds when querying the RADIUS server. @@ -132,7 +132,7 @@ Configuration the attribute you will only get regular, non privilegued, system users. -.. cfgcmd:: set system login radius source-address '
' +.. cfgcmd:: set system login radius source-address
RADIUS servers could be hardened by only allowing certain IP addresses to connect. As of this the source address of each RADIUS query can be @@ -148,12 +148,12 @@ Login Banner You are able to set post-login or pre-login banner messages to display certain information for this system. -.. cfgcmd:: set system login banner pre-login '' +.. cfgcmd:: set system login banner pre-login Configure `` which is shown during SSH connect and before a user is logged in. -.. cfgcmd:: set system login banner post-login '' +.. cfgcmd:: set system login banner post-login Configure `` which is shown after user has logged in to the system. -- cgit v1.2.3