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

Merge pull request #150 from rebortg/cfgcmd

Browse Source 
cfgcmd for better typing feeling
This commit is contained in:
Christian Poessinger 2019-11-24 21:40:39 +01:00 committed by GitHub
commit d497d30747
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/conf.py
View File

@ -170,4 +170,4 @@ texinfo_documents = [
def setup(app): def setup(app):
app.add_object_type('opcmd', 'opcmd') app.add_object_type('opcmd', 'opcmd')
app.add_object_type('cfcmd', 'cfcmd') app.add_object_type('cfgcmd', 'cfgcmd')

2
docs/contributing/documentation.rst
View File

@ -132,7 +132,7 @@ Please don't use other public address space.
Specific Sphinx-doc Markup Specific Sphinx-doc Markup
^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^
When documenting CLI commands use the ``.. cfcmd::`` directive for When documenting CLI commands use the ``.. cfgcmd::`` directive for
the configuration mode and the ``.. opcmd::`` directive for operational mode the configuration mode and the ``.. opcmd::`` directive for operational mode
commands. commands.
Under the command a short exlaination should be provide. Under the command a short exlaination should be provide.

8
docs/interfaces/geneve.rst
View File

@ -30,15 +30,15 @@ Geneve Header:
| Variable Length Options | | Variable Length Options |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
.. cfcmd:: set interfaces geneve gnv0 address '192.0.2.2/24' .. cfgcmd:: set interfaces geneve gnv0 address '192.0.2.2/24'
Create GENEVE tunnel listening on local address `192.0.2.2/24`. Create GENEVE tunnel listening on local address `192.0.2.2/24`.
.. cfcmd:: set interfaces geneve gnv0 remote '172.18.204.10' .. cfgcmd:: set interfaces geneve gnv0 remote '172.18.204.10'
Specify the IP address of the other end of the tunnel. Specify the IP address of the other end of the tunnel.
.. cfcmd:: set interfaces geneve gnv0 vni '1000' .. cfgcmd:: set interfaces geneve gnv0 vni '1000'
:abbr:`VNI (Virtual Network Identifier)` is an identifier for a unique element :abbr:`VNI (Virtual Network Identifier)` is an identifier for a unique element
of a virtual network. In many situations this may represent an L2 segment, of a virtual network. In many situations this may represent an L2 segment,
@ -47,6 +47,6 @@ packets. The VNI MAY be used as part of ECMP forwarding decisions or MAY be
used as a mechanism to distinguish between overlapping address spaces contained used as a mechanism to distinguish between overlapping address spaces contained
in the encapsulated packet when load balancing across CPUs. in the encapsulated packet when load balancing across CPUs.
.. cfcmd:: set interfaces geneve gnv0 mtu .. cfgcmd:: set interfaces geneve gnv0 mtu
Set interface :abbr:`MTU (Maximum Transfer Unit)` size. Set interface :abbr:`MTU (Maximum Transfer Unit)` size.

2
docs/interfaces/wireless.rst
View File

@ -25,7 +25,7 @@ its MAC address) and configured to run in monitor mode.
To be able to use the wireless interfaces you will first need to set a To be able to use the wireless interfaces you will first need to set a
regulatory domain with the country code of your locaion. regulatory domain with the country code of your locaion.
.. cfcmd:: set system wifi-regulatory-domain DE .. cfgcmd:: set system wifi-regulatory-domain DE
Configure system wide Wi-Fi regulatory domain. A reboot is required for this Configure system wide Wi-Fi regulatory domain. A reboot is required for this
change to be enabled. change to be enabled.

2
docs/routing/arp.rst
View File

@ -19,7 +19,7 @@ implemented.
Configure Configure
========= =========
.. cfcmd:: set protocols static arp 192.0.2.100 hwaddr 00:53:27:de:23:aa .. cfgcmd:: set protocols static arp 192.0.2.100 hwaddr 00:53:27:de:23:aa
This will configure a static ARP entry always resolving `192.0.2.100` to This will configure a static ARP entry always resolving `192.0.2.100` to
`00:53:27:de:23:aa` `00:53:27:de:23:aa`

4
docs/vpn/openvpn.rst
View File

@ -446,13 +446,13 @@ all users can benefit from it.
If you are a hacker or want to try on your own we support passing raw OpenVPN If you are a hacker or want to try on your own we support passing raw OpenVPN
options to OpenVPN. options to OpenVPN.
.. cfcmd:: set interfaces openvpn vtun10 openvpn-option 'persistent-key' .. cfgcmd:: set interfaces openvpn vtun10 openvpn-option 'persistent-key'
Will add ``persistent-key`` at the end of the generated OpenVPN configuration. Will add ``persistent-key`` at the end of the generated OpenVPN configuration.
Please use this only as last resort - things might break and OpenVPN won't start Please use this only as last resort - things might break and OpenVPN won't start
if you pass invalid options/syntax. if you pass invalid options/syntax.
.. cfcmd:: set interfaces openvpn vtun10 openvpn-option 'push "keepalive 1 10"' .. cfgcmd:: set interfaces openvpn vtun10 openvpn-option 'push "keepalive 1 10"'
Will add ``push "keepalive 1 10"`` to the generated OpenVPN config file. Will add ``push "keepalive 1 10"`` to the generated OpenVPN config file.