summaryrefslogtreecommitdiff
path: root/docs/documentation.rst
diff options
context:
space:
mode:
authorrebortg <github@ghlr.de>2022-08-12 10:54:10 +0200
committerrebortg <github@ghlr.de>2022-08-12 10:59:13 +0200
commit1205c1e7806d4e84e03aafc94831248cbfa9b1c8 (patch)
tree05e620761cdfc775bab1729bfbfe289c0d7339a1 /docs/documentation.rst
parenta9346a61a4a879376032d1e71b81e365b1416afa (diff)
downloadvyos-documentation-1205c1e7806d4e84e03aafc94831248cbfa9b1c8.tar.gz
vyos-documentation-1205c1e7806d4e84e03aafc94831248cbfa9b1c8.zip
add :defaultvalue: option
(cherry picked from commit b09f2222ed6181ba377a41de37a3997559a234c8)
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 a89b6079..2a1b390f 100644
--- a/docs/documentation.rst
+++ b/docs/documentation.rst
@@ -244,6 +244,21 @@ For a 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
"""""