summaryrefslogtreecommitdiff
path: root/docs/documentation.rst
diff options
context:
space:
mode:
authorrebortg <github@ghlr.de>2022-08-12 10:54:10 +0200
committerrebortg <git@ghlr.de>2022-08-16 15:38:16 +0200
commite9236755bb544c43c9949926ad4a3b85223612f5 (patch)
tree0438f6d468d625bb4c4bf9c52bb8298d19e13ca8 /docs/documentation.rst
parent656cc5732a99525f381974a9a912f2538f0acd88 (diff)
downloadvyos-documentation-e9236755bb544c43c9949926ad4a3b85223612f5.tar.gz
vyos-documentation-e9236755bb544c43c9949926ad4a3b85223612f5.zip
add :defaultvalue: option
(cherry picked from commit b09f2222ed6181ba377a41de37a3997559a234c8) (cherry picked from commit 1205c1e7806d4e84e03aafc94831248cbfa9b1c8)
Diffstat (limited to 'docs/documentation.rst')
-rw-r--r--docs/documentation.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/documentation.rst b/docs/documentation.rst
index 77cd5cc4..2d530439 100644
--- a/docs/documentation.rst
+++ b/docs/documentation.rst
@@ -295,6 +295,21 @@ For an inline configuration level command, use ``:cfgcmd:``
:cfgcmd:`set interface ethernet eth0`
+
+To extract a defaultvalue from the XML definitions add a ``:defaultvalue:``
+to ``.. cfgcmd::`` directive.
+To have this feature locally, the vyos-1x submodule must be initialized before.
+Please be aware to not update the submodule in your PR.
+
+.. code-block:: none
+
+ .. cfgcmd:: set system conntrack table-size <1-50000000>
+ :defaultvalue:
+
+ The connection tracking table contains one entry for each connection being
+ tracked by the system.
+
+
opcmd
"""""