summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/appendix/examples/dmvpn.rst4
-rw-r--r--docs/configuration-overview.rst2
-rw-r--r--docs/interfaces/dummy.rst8
-rw-r--r--docs/interfaces/ethernet.rst30
-rw-r--r--docs/routing/bgp.rst10
-rw-r--r--docs/routing/static.rst32
-rw-r--r--docs/services/dhcp.rst26
-rw-r--r--docs/services/ssh.rst10
-rw-r--r--docs/services/tftp.rst2
-rw-r--r--docs/services/udp-broadcast-relay.rst8
-rw-r--r--docs/system/config-management.rst2
-rw-r--r--docs/system/default-route.rst4
-rw-r--r--docs/system/flow-accounting.rst30
-rw-r--r--docs/system/host-information.rst10
-rw-r--r--docs/system/ntp.rst8
-rw-r--r--docs/system/proxy.rst8
-rw-r--r--docs/system/serial-console.rst6
-rw-r--r--docs/system/task-scheduler.rst8
-rw-r--r--docs/system/time-zone.rst2
-rw-r--r--docs/system/user-management.rst26
20 files changed, 118 insertions, 118 deletions
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 '<nhrp secret key>'
+ set protocols nhrp tunnel tun100 cisco-authentication <secret>
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 '<secretkey>'
+ set vpn ipsec profile NHRPVPN authentication pre-shared-secret <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 '<removed>'
+ 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 '<interface>' address <address | dhcp | dhcpv6>
+.. cfgcmd:: set interfaces dummy <interface> address <address | dhcp | dhcpv6>
Configure dummy interface `<interface>` with one or more interface
addresses.
@@ -40,12 +40,12 @@ Address
Link Administration
-------------------
-.. cfgcmd:: set interfaces dummy '<interface>' description '<description>'
+.. cfgcmd:: set interfaces dummy <interface> description <description>
Assign given `<description>` to interface. Description will also be passed
to SNMP monitoring systems.
-.. cfgcmd:: set interfaces dummy '<interface>' disable
+.. cfgcmd:: set interfaces dummy <interface> disable
Disable given `<interface>`. 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 '<interface>'
+.. opcmd:: show interfaces dummy <interface>
Show detailed information on given `<interface>`
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 '<interface>' address <address | dhcp | dhcpv6>
+.. cfgcmd:: set interfaces ethernet <interface> address <address | dhcp | dhcpv6>
Configure ethernet interface `<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 '<interface>' ipv6 address autoconf
+.. cfgcmd:: set interfaces ethernet <interface> 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 '<interface>' ipv6 address eui64 '<prefix>'
+.. cfgcmd:: set interfaces ethernet <interface> ipv6 address eui64 <prefix>
: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 '<interface>' duplex <auto | full | half>
+.. cfgcmd:: set interfaces ethernet <interface> duplex <auto | full | half>
Configure physical interface duplex setting.
@@ -67,7 +67,7 @@ Speed/Duplex
VyOS default will be `auto`.
-.. cfgcmd:: set interfaces ethernet '<interface>' speed <auto | 10 | 100 | 1000 | 2500 | 5000 | 10000 | 25000 | 40000 | 50000 | 100000>
+.. cfgcmd:: set interfaces ethernet <interface> speed <auto | 10 | 100 | 1000 | 2500 | 5000 | 10000 | 25000 | 40000 | 50000 | 100000>
Configure physical interface speed setting.
@@ -88,27 +88,27 @@ Speed/Duplex
Link Administration
-------------------
-.. cfgcmd:: set interfaces ethernet '<interface>' description '<description>'
+.. cfgcmd:: set interfaces ethernet <interface> description <description>
Assign given `<description>` to interface. Description will also be passed
to SNMP monitoring systems.
-.. cfgcmd:: set interfaces ethernet '<interface>' disable
+.. cfgcmd:: set interfaces ethernet <interface> disable
Disable given `<interface>`. It will be placed in administratively down
state.
-.. cfgcmd:: set interfaces ethernet '<interface>' disable-flow-control
+.. cfgcmd:: set interfaces ethernet <interface> disable-flow-control
Disable Ethernet flow control (pause frames).
-.. cfgcmd:: set interfaces ethernet '<interface>' mac '<mac-address>'
+.. cfgcmd:: set interfaces ethernet <interface> mac <mac-address>
Configure user defined :abbr:`MAC (Media Access Control)` address on given
`<interface>`.
-.. cfgcmd:: set interfaces ethernet '<interface>' mtu '<mtu>'
+.. cfgcmd:: set interfaces ethernet <interface> mtu <mtu>
Configure :abbr:`MTU (Maximum Transmission Unit)` on given `<interface>`. 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 '<interface>' ipv6 router-advert send-advert <true | false>
+.. cfgcmd:: set interfaces ethernet <interface> ipv6 router-advert send-advert <true | false>
Enable or disable router advertisements in this `<interface>`.
-.. cfgcmd:: set interfaces ethernet '<interface>' ipv6 router-advert prefix '<prefix>'
+.. cfgcmd:: set interfaces ethernet <interface> ipv6 router-advert prefix <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 '<interface>'
+.. opcmd:: show interfaces ethernet <interface>
Show detailed information on given `<interface>`
@@ -161,7 +161,7 @@ Operation
TX: bytes packets errors dropped carrier collisions
5601460 62595 0 0 0 0
-.. opcmd:: show interfaces ethernet '<interface>' physical
+.. opcmd:: show interfaces ethernet <interface> physical
Show information about physical `<interface>`
@@ -200,7 +200,7 @@ Operation
supports-register-dump: yes
supports-priv-flags: no
-.. opcmd:: show interfaces ethernet '<interface>' transceiver
+.. opcmd:: show interfaces ethernet <interface> 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 '<ASN>'
+.. cfgcmd:: set protocols bgp <asn>
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 '<ASN>' parameters router-id
+.. cfgcmd:: set protocols bgp <asn> 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 '<ASN>' parameters bestpath as-path confed
+.. cfgcmd:: set protocols bgp <asn> 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 '<ASN>' parameters bestpath as-path multipath-relax
+.. cfgcmd:: set protocols bgp <asn> 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 '<ASN>' parameters bestpath as-path ignore
+.. cfgcmd:: set protocols bgp <asn> 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 '<subnet>' next-hop '<address>'
+.. cfgcmd:: set protocols static route <subnet> next-hop <address>
Configure next-hop `<address>` for an IPv4 static route. Multiple static
routes can be created.
-.. cfgcmd:: set protocols static route '<subnet>' next-hop '<address>' disable
+.. cfgcmd:: set protocols static route <subnet> next-hop <address> disable
Disable this IPv4 static route entry.
-.. cfgcmd:: set protocols static route '<subnet>' next-hop '<address>' distance '<distance>'
+.. cfgcmd:: set protocols static route <subnet> next-hop <address> distance <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 '<subnet>' next-hop '<address>'
+.. cfgcmd:: set protocols static route6 <subnet> next-hop <address>
Configure next-hop `<address>` for an IPv6 static route. Multiple static
routes can be created.
-.. cfgcmd:: set protocols static route6 '<subnet>' next-hop '<address>' disable
+.. cfgcmd:: set protocols static route6 <subnet> next-hop <address> disable
Disable this IPv6 static route entry.
-.. cfgcmd:: set protocols static route6 '<subnet>' next-hop '<address>' distance '<distance>'
+.. cfgcmd:: set protocols static route6 <subnet> next-hop <address> distance <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 '<subnet>' next-hop-interface '<interface>'
+.. cfgcmd:: set protocols static interface-route <subnet> next-hop-interface <interface>
Allows you to configure the next-hop interface for an interface-based IPv4
static route. `<interface>` will be the next-hop interface where trafic is
routed for the given `<subnet>`.
-.. cfgcmd:: set protocols static interface-route '<subnet>' next-hop-interface '<interface>' disable
+.. cfgcmd:: set protocols static interface-route <subnet> next-hop-interface <interface> disable
Disables interface-based IPv4 static route.
-.. cfgcmd:: set protocols static interface-route '<subnet>' next-hop-interface '<interface>' distance '<distance>'
+.. cfgcmd:: set protocols static interface-route <subnet> next-hop-interface <interface> distance <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 '<subnet>' next-hop-interface '<interface>'
+.. cfgcmd:: set protocols static interface-route6 <subnet> next-hop-interface <interface>
Allows you to configure the next-hop interface for an interface-based IPv6
static route. `<interface>` will be the next-hop interface where trafic is
routed for the given `<subnet>`.
-.. cfgcmd:: set protocols static interface-route6 '<subnet>' next-hop-interface '<interface>' disable
+.. cfgcmd:: set protocols static interface-route6 <subnet> next-hop-interface <interface> disable
Disables interface-based IPv6 static route.
-.. cfgcmd:: set protocols static interface-route6 '<subnet>' next-hop-interface '<interface>' distance '<distance>'
+.. cfgcmd:: set protocols static interface-route6 <subnet> next-hop-interface <interface> distance <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 '<subnet>' blackhole
+.. cfgcmd:: set protocols static route <subnet> 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 '<subnet>' blackhole distance '<distance>'
+.. cfgcmd:: set protocols static route <subnet> blackhole distance <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 '<subnet>' blackhole
+.. cfgcmd:: set protocols static route6 <subnet> 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 '<subnet>' blackhole distance '<distance>'
+.. cfgcmd:: set protocols static route6 <subnet> blackhole distance <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 '<name>' subnet 192.0.2.0/24 default-router '<address>'
+.. cfgcmd:: set service dhcp-server shared-network-name <name> subnet 192.0.2.0/24 default-router <address>
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 '<name>' subnet 192.0.2.0/24 dns-server '<address>'
+.. cfgcmd:: set service dhcp-server shared-network-name <name> subnet 192.0.2.0/24 dns-server <address>
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 '<name>' subnet 192.0.2.0/24 domain-name '<domain-name>'
+.. cfgcmd:: set service dhcp-server shared-network-name <name> subnet 192.0.2.0/24 domain-name <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 '<name>' subnet 192.0.2.0/24 domain-search '<domain-name>'
+.. cfgcmd:: set service dhcp-server shared-network-name <name> subnet 192.0.2.0/24 domain-search <domain-name>
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 '<name>' subnet '<v6net>' lease-time {default | maximum | minimum}
+.. cfgcmd:: set service dhcpv6-server shared-network-name <name> subnet <prefix> 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 '<name>' subnet '<v6net>' nis-domain '<domain-name>'
+.. cfgcmd:: set service dhcpv6-server shared-network-name <name> subnet <prefix> nis-domain <domain-name>
A :abbr:`NIS (Network Information Service)` domain can be set to be used for
DHCPv6 clients.
-.. cfgcmd:: set service dhcpv6-server shared-network-name '<name>' subnet '<v6net>' nisplus-domain '<domain-name>'
+.. cfgcmd:: set service dhcpv6-server shared-network-name <name> subnet <prefix> nisplus-domain <domain-name>
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 '<name>' subnet '<v6net>' nis-server '<address>'
+.. cfgcmd:: set service dhcpv6-server shared-network-name <name> subnet <prefix> nis-server <address>
Specify a NIS server address for DHCPv6 clients.
-.. cfgcmd:: set service dhcpv6-server shared-network-name '<name>' subnet '<v6net>' nisplus-server '<address>'
+.. cfgcmd:: set service dhcpv6-server shared-network-name <name> subnet <prefix> nisplus-server <address>
Specify a NIS+ server address for DHCPv6 clients.
-.. cfgcmd:: set service dhcpv6-server shared-network-name '<name>' subnet '<v6net>' sip-server-address '<address>'
+.. cfgcmd:: set service dhcpv6-server shared-network-name <name> subnet <prefix> sip-server-address <address>
Specify a :abbr:`SIP (Session Initiation Protocol)` server by IPv6 address
for all DHCPv6 clients.
-.. cfgcmd:: set service dhcpv6-server shared-network-name '<name>' subnet '<v6net>' sip-server-name '<fqdn>'
+.. cfgcmd:: set service dhcpv6-server shared-network-name <name> subnet <prefix> sip-server-name <fqdn>
Specify a :abbr:`SIP (Session Initiation Protocol)` server by FQDN for all
DHCPv6 clients.
-.. cfgcmd:: set service dhcpv6-server shared-network-name '<name>' subnet '<v6net>' sntp-server-address '<address>'
+.. cfgcmd:: set service dhcpv6-server shared-network-name <name> subnet <prefix> sntp-server-address <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 '<interface>'
+.. cfgcmd:: set service dhcp-relay interface <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 '<number>'
+.. cfgcmd:: set service ssh port <port>
-Enabling SSH only requires you to specify the port ``<number>`` you want SSH to
+Enabling SSH only requires you to specify the port ``<port>`` you want SSH to
listen on. By default, SSH runs on port 22.
-.. cfgcmd:: set service ssh listen-address '<address>'
+.. cfgcmd:: set service ssh listen-address <address>
Specify IPv4/IPv6 listen address of SSH server. Multiple addresses can be
defined.
-.. cfgcmd:: set service ssh ciphers '<cipher>'
+.. cfgcmd:: set service ssh ciphers <cipher>
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 '<mac>'
+.. cfgcmd:: set service ssh macs <mac>
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 '<address>'
+.. cfgcmd:: set service tftp-server listen-address <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 '<n>' description '<description>'
+.. cfgcmd:: set service broadcast-relay id <n> description <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 '<n>' interface '<interface>'
+.. cfgcmd:: set service broadcast-relay id <n> interface <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 '<n>' port '<port>'
+.. cfgcmd:: set service broadcast-relay id <n> port <port>
The UDP port number used by your apllication. It is mandatory for this kind
of operation.
-.. cfgcmd:: set service broadcast-relay id '<n>' disable
+.. cfgcmd:: set service broadcast-relay id <n> 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 `<number>`, the default setting for
this value is to store 20 revisions locally.
-.. cfgcmd:: set system config-management commit-archive location '<url>'
+.. cfgcmd:: set system config-management commit-archive location <url>
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 '<address>'`), this is no longer supported
+(:cfgcmd:`set system gateway-address <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 '<address>'
+.. cfgcmd:: set protocols static route 0.0.0.0/0 next-hop <address>
Specify static route into the routing table sending all non local traffic
to the nexthop address `<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 '<interface>'
+.. cfgcmd:: set system flow-accounting interface <interface>
Configure and enable collection of flow information for the interface
identified by `<interface>`.
@@ -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 '<buffer size>'
+.. cfgcmd:: set system flow-accounting buffer-size <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 '<facility>'
+.. cfgcmd:: set system flow-accounting syslog-facility <facility>
Flow Export
@@ -85,7 +85,7 @@ exported them to a collection server.
NetFlow
^^^^^^^
-.. cfgcmd:: set system flow-accounting netflow version '<version>'
+.. cfgcmd:: set system flow-accounting netflow version <version>
There are multiple versions available for the NetFlow data. The `<version>`
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 '<address>'
+.. cfgcmd:: set system flow-accounting netflow server <address>
Configure address of NetFlow collector. NetFlow server at `<address>` can
be both listening on an IPv4 or IPv6 address.
-.. cfgcmd:: set system flow-accounting netflow source-ip '<address>'
+.. cfgcmd:: set system flow-accounting netflow source-ip <address>
IPv4 or IPv6 source address of NetFlow packets
-.. cfgcmd:: set system flow-accounting netflow engine-id '<id>'
+.. cfgcmd:: set system flow-accounting netflow engine-id <id>
NetFlow engine-id which will appear in NetFlow data. The range is 0 to 255.
-.. cfgcmd:: set system flow-accounting netflow sampling-rate '<rate>'
+.. cfgcmd:: set system flow-accounting netflow sampling-rate <rate>
Use this command to configure the sampling rate for flow accounting. The
system samples one in every `<rate>` packets, where `<rate>` 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 '<interval>'
+.. cfgcmd:: set system flow-accounting netflow timeout expiry interval <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 '<number>'
+.. cfgcmd:: set system flow-accounting netflow max-flows <n>
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 '<address>'
+.. cfgcmd:: set system flow-accounting sflow server <address>
Configure address of sFlow collector. sFlow server at `<address>` 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 '<rate>'
+.. cfgcmd:: set system flow-accounting sflow sampling-rate <rate>
Enable sampling of packets, which will be transmitted to sFlow collectors.
-.. cfgcmd:: set system flow-accounting sflow agent-address '<address>'
+.. cfgcmd:: set system flow-accounting sflow agent-address <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 '<interface>'
+.. opcmd:: show flow-accounting interface <interface>
Show flow accounting information for given `<interface>`.
@@ -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 '<interface>' host '<address>'
+.. opcmd:: show flow-accounting interface <interface> host <address>
Show flow accounting information for given `<interface>` 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 '<hostname>'
+.. cfgcmd:: set system host-name <hostname>
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 '<domain>'
+.. cfgcmd:: set system domain-name <domain>
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 '<hostname>' inet '<address>'
+.. cfgcmd:: set system static-host-mapping host-name <hostname> inet <address>
Create a static hostname mapping which will always resolve the name
`<hostname>` to IP address `<address>`.
-.. cfgcmd:: set system static-host-mapping host-name '<hostname>' alias '<alias>'
+.. cfgcmd:: set system static-host-mapping host-name <hostname> alias <alias>
Create named `<alias>` for the configured static mapping for `<hostname>`.
Thus the address configured as :cfgcmd:`set system static-host-mapping
- host-name '<hostname>' inet '<address>'` can be reached via multiple names.
+ host-name <hostname> inet <address>` 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 '<address | fqdn>'
+.. cfgcmd:: set system ntp server <address>
- 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 '<address>'
+.. cfgcmd:: set system ntp listen-address <address>
Setup VyOS as an NTP responder, you must specify the `<address>` and
optionally the permitted clients. Multiple listen addresses can be
configured.
-.. cfgcmd:: set system ntp allow-clients address '<address>'
+.. cfgcmd:: set system ntp allow-clients address <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 '<url>'
+.. cfgcmd:: set system proxy url <url>
Set proxy for all connections initiated by VyOS, including HTTP, HTTPS, and
FTP (anonymous ftp).
-.. cfgcmd:: set system proxy port '<port>'
+.. cfgcmd:: set system proxy port <port>
Configure proxy port if it does not listen to the default port 80.
-.. cfgcmd:: set system proxy username '<username>'
+.. cfgcmd:: set system proxy username <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 '<password>'
+.. cfgcmd:: set system proxy password <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 '<device>'
+.. cfgcmd:: set system console device <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 '<device>' speed '<speed>'
+.. cfgcmd:: set system console device <device> speed <speed>
The speed (baudrate) of the console device. Supported values are:
@@ -44,6 +44,6 @@ Network Console
TBD.
-.. cfgcmd:: set system console network '<netconXX>'
+.. cfgcmd:: set system console network <netconXX>
... 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 '<task>' interval '<interval>'
+.. cfgcmd:: set system task-scheduler task <task> interval <interval>
Specify the time interval when `<task>` 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 '<task>' crontab-spec '<spec>'
+.. cfgcmd:: set system task-scheduler task <task> crontab-spec <spec>
Set execution time in common cron_ time format. A cron `<spec>` of
``30 */6 * * *`` would execute the `<task>` at minute 30 past every 6th hour.
-.. cfgcmd:: set system task-scheduler task '<task>' executable path '<path>'
+.. cfgcmd:: set system task-scheduler task <task> executable path <path>
Specify absolute `<path>` to script which will be run when `<task>` is
executed.
-.. cfgcmd:: set system task-scheduler task '<task>' executable arguments '<args>'
+.. cfgcmd:: set system task-scheduler task <task> executable arguments <args>
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 '<timezone>'
+.. cfgcmd:: set system time-zone <timezone>
Specify the systems `<timezone>` 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 '<name>' full-name "<string>"
+.. cfgcmd:: set system login user <name> full-name "<string>"
Create new system user with username `<name>` and real-name specified by
`<string>`.
-.. cfgcmd:: set system login user '<name>' authentication plaintext-password '<password>'
+.. cfgcmd:: set system login user <name> authentication plaintext-password <password>
Specify the plaintext password user by user `<name>` 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 '<name>' authentication encrypted-password '<password>'
+.. cfgcmd:: set system login user <name> authentication encrypted-password <password>
Setup encrypted password for given username. This is usefull for
transferring a hashed password from system to system.
-.. cfgcmd:: set system login user '<name>' group '<group>'
+.. cfgcmd:: set system login user <name> group <group>
Specify additional group membership for given username `<name>`.
@@ -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 '<username>' authentication public-keys '<identifier>' key '<key>'
+.. cfgcmd:: set system login user <username> authentication public-keys <identifier> key <key>
Assign the SSH public key portion `<key>` identified by per-key
`<identifier>` to the local user `<username>`.
-.. cfgcmd:: set system login user '<username>' authentication public-keys '<identifier>' type '<type>'
+.. cfgcmd:: set system login user <username> authentication public-keys <identifier> type <type>
Every SSH public key portion referenced by `<identifier>` requires the
configuration of the `<type>` 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 '<username>' '<location>'
+.. cfgcmd:: loadkey <username> <location>
SSH keys can not only be specified on the command-line but also loaded for
a given user with `<username>` from a file pointed to by `<location>.` Keys
@@ -113,17 +113,17 @@ Dial-In User Service)` servers as backend for user authentication.
Configuration
-------------
-.. cfgcmd:: set system login radius server '<address>' secret '<secret>'
+.. cfgcmd:: set system login radius server <address> secret <secret>
Specify the `<address>` of the RADIUS server user with the pre-shared-secret
given in `<secret>`. Multiple servers can be specified.
-.. cfgcmd:: set system login radius server '<address>' port '<port>'
+.. cfgcmd:: set system login radius server <address> port <port>
Configure the discrete port under which the RADIUS server can be reached.
This defaults to 1812.
-.. cfgcmd:: set system login radius server '<address>' timeout '<timeout>'
+.. cfgcmd:: set system login radius server <address> timeout <timeout>
Setup the `<timeout>` 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 '<address>'
+.. cfgcmd:: set system login radius source-address <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 '<message>'
+.. cfgcmd:: set system login banner pre-login <message>
Configure `<message>` which is shown during SSH connect and before a user is
logged in.
-.. cfgcmd:: set system login banner post-login '<message>'
+.. cfgcmd:: set system login banner post-login <message>
Configure `<message>` which is shown after user has logged in to the system.
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-28 14:18:37 +0000