summaryrefslogtreecommitdiff
path: root/interface-definitions/include
diff options
context:
space:
mode:
authorViacheslav Hletenko <v.gletenko@vyos.io>2025-01-07 23:30:14 +0000
committerViacheslav Hletenko <v.gletenko@vyos.io>2025-01-07 23:30:14 +0000
commitd7cad8ea121162dd54722f2c4db72c458dfcf02d (patch)
treed63926fbce069550b8ce7ad789901ae24b3e92b1 /interface-definitions/include
parentbb4427bfb4a8c03784dd6f097cbe521f561edaf4 (diff)
downloadvyos-1x-d7cad8ea121162dd54722f2c4db72c458dfcf02d.tar.gz
vyos-1x-d7cad8ea121162dd54722f2c4db72c458dfcf02d.zip
Add XML CLI for conf and op-mode
Diffstat (limited to 'interface-definitions/include')
-rw-r--r--interface-definitions/include/kernel-interface-tap.xml.i15
-rw-r--r--interface-definitions/include/kernel-interface-tun.xml.i15
-rw-r--r--interface-definitions/include/unformat_log2_page_size.xml.i29
-rw-r--r--interface-definitions/include/unformat_memory_size.xml.i22
-rw-r--r--interface-definitions/include/version/vpp-version.xml.i3
-rw-r--r--interface-definitions/include/vpp/iface_rx_mode.xml.i25
-rw-r--r--interface-definitions/include/vpp/vif.xml.i21
-rw-r--r--interface-definitions/include/vpp_host_resources.xml.i48
8 files changed, 178 insertions, 0 deletions
diff --git a/interface-definitions/include/kernel-interface-tap.xml.i b/interface-definitions/include/kernel-interface-tap.xml.i
new file mode 100644
index 000000000..83399f1f4
--- /dev/null
+++ b/interface-definitions/include/kernel-interface-tap.xml.i
@@ -0,0 +1,15 @@
+<!-- include start from kernel-interface-tap.xml.i -->
+<leafNode name="kernel-interface">
+ <properties>
+ <help>Kernel interface name</help>
+ <valueHelp>
+ <format>vpptapN</format>
+ <description>Kernel interface name</description>
+ </valueHelp>
+ <constraint>
+ <regex>vpptap\d+</regex>
+ </constraint>
+ <constraintErrorMessage>Kernel interface must start with vpptapN</constraintErrorMessage>
+ </properties>
+</leafNode>
+<!-- include end -->
diff --git a/interface-definitions/include/kernel-interface-tun.xml.i b/interface-definitions/include/kernel-interface-tun.xml.i
new file mode 100644
index 000000000..3cbd5ab30
--- /dev/null
+++ b/interface-definitions/include/kernel-interface-tun.xml.i
@@ -0,0 +1,15 @@
+<!-- include start from kernel-interface-tun.xml.i -->
+<leafNode name="kernel-interface">
+ <properties>
+ <help>Kernel interface name</help>
+ <valueHelp>
+ <format>vpptunN</format>
+ <description>Kernel interface name</description>
+ </valueHelp>
+ <constraint>
+ <regex>vpptun\d+</regex>
+ </constraint>
+ <constraintErrorMessage>Kernel interface must start with vpptunN</constraintErrorMessage>
+ </properties>
+</leafNode>
+<!-- include end -->
diff --git a/interface-definitions/include/unformat_log2_page_size.xml.i b/interface-definitions/include/unformat_log2_page_size.xml.i
new file mode 100644
index 000000000..240fd5bb8
--- /dev/null
+++ b/interface-definitions/include/unformat_log2_page_size.xml.i
@@ -0,0 +1,29 @@
+<!-- include start from unformat_log2_page_size.xml.i -->
+<completionHelp>
+ <list>default default-hugepage</list>
+</completionHelp>
+<valueHelp>
+ <format>default</format>
+ <description>Default</description>
+</valueHelp>
+<valueHelp>
+ <format>default-hugepage</format>
+ <description>Default huge-page</description>
+</valueHelp>
+<valueHelp>
+ <format>&lt;number&gt;K</format>
+ <description>Kilobyte</description>
+</valueHelp>
+<valueHelp>
+ <format>&lt;number&gt;M</format>
+ <description>Megabyte</description>
+</valueHelp>
+<valueHelp>
+ <format>&lt;number&gt;G</format>
+ <description>Gigabyte</description>
+</valueHelp>
+<constraint>
+ <validator name="numeric" argument="--range 0-4294967295"/>
+ <regex>(default|default-hugepage|\d+K|\d+M|\d+G)</regex>
+</constraint>
+<!-- include end -->
diff --git a/interface-definitions/include/unformat_memory_size.xml.i b/interface-definitions/include/unformat_memory_size.xml.i
new file mode 100644
index 000000000..bb8f4ae67
--- /dev/null
+++ b/interface-definitions/include/unformat_memory_size.xml.i
@@ -0,0 +1,22 @@
+<!-- include start from unformat_memory_size.xml.i -->
+<valueHelp>
+ <format>&lt;number&gt;</format>
+ <description>byte</description>
+</valueHelp>
+<valueHelp>
+ <format>&lt;number&gt;K</format>
+ <description>Kilobyte</description>
+</valueHelp>
+<valueHelp>
+ <format>&lt;number&gt;M</format>
+ <description>Megabyte</description>
+</valueHelp>
+<valueHelp>
+ <format>&lt;number&gt;G</format>
+ <description>Gigabyte</description>
+</valueHelp>
+<constraint>
+ <validator name="numeric" argument="--range 0-4294967295"/>
+ <regex>(\d+|\d+K|\d+M|\d+G)</regex>
+</constraint>
+<!-- include end -->
diff --git a/interface-definitions/include/version/vpp-version.xml.i b/interface-definitions/include/version/vpp-version.xml.i
new file mode 100644
index 000000000..96a69c92f
--- /dev/null
+++ b/interface-definitions/include/version/vpp-version.xml.i
@@ -0,0 +1,3 @@
+<!-- include start from include/version/vpp-version.xml.i -->
+<syntaxVersion component='vpp' version='1'></syntaxVersion>
+<!-- include end --> \ No newline at end of file
diff --git a/interface-definitions/include/vpp/iface_rx_mode.xml.i b/interface-definitions/include/vpp/iface_rx_mode.xml.i
new file mode 100644
index 000000000..374654b08
--- /dev/null
+++ b/interface-definitions/include/vpp/iface_rx_mode.xml.i
@@ -0,0 +1,25 @@
+<!-- include start from vpp/iface_rx_mode.xml.i -->
+<leafNode name="rx-mode">
+ <properties>
+ <help>Receive packet processing mode</help>
+ <completionHelp>
+ <list>polling interrupt adaptive</list>
+ </completionHelp>
+ <valueHelp>
+ <format>polling</format>
+ <description>Constantly check for new data</description>
+ </valueHelp>
+ <valueHelp>
+ <format>interrupt</format>
+ <description>Interrupt mode</description>
+ </valueHelp>
+ <valueHelp>
+ <format>adaptive</format>
+ <description>Adaptive mode</description>
+ </valueHelp>
+ <constraint>
+ <regex>(polling|interrupt|adaptive)</regex>
+ </constraint>
+ </properties>
+</leafNode>
+<!-- include end -->
diff --git a/interface-definitions/include/vpp/vif.xml.i b/interface-definitions/include/vpp/vif.xml.i
new file mode 100644
index 000000000..8f0e9772f
--- /dev/null
+++ b/interface-definitions/include/vpp/vif.xml.i
@@ -0,0 +1,21 @@
+<!-- include start from vpp/vif.xml.i -->
+<tagNode name="vif">
+ <properties>
+ <help>Virtual Local Area Network (VLAN) ID</help>
+ <valueHelp>
+ <format>u32:0-4094</format>
+ <description>Virtual Local Area Network (VLAN) ID</description>
+ </valueHelp>
+ <constraint>
+ <validator name="numeric" argument="--range 0-4094"/>
+ </constraint>
+ <constraintErrorMessage>VLAN ID must be between 0 and 4094</constraintErrorMessage>
+ </properties>
+ <children>
+ #include <include/generic-description.xml.i>
+ #include <include/interface/address-ipv4-ipv6-dhcp.xml.i>
+ #include <include/interface/disable.xml.i>
+ #include <include/interface/mtu-68-16000.xml.i>
+ </children>
+</tagNode>
+<!-- include end -->
diff --git a/interface-definitions/include/vpp_host_resources.xml.i b/interface-definitions/include/vpp_host_resources.xml.i
new file mode 100644
index 000000000..7f988ce44
--- /dev/null
+++ b/interface-definitions/include/vpp_host_resources.xml.i
@@ -0,0 +1,48 @@
+<!-- include start from vpp_host_resources.xml.i -->
+<node name="host-resources">
+ <properties>
+ <help>Host resources control</help>
+ </properties>
+ <children>
+ <leafNode name="nr-hugepages">
+ <properties>
+ <help>Number of pre-allocated huge pages of the default size</help>
+ <valueHelp>
+ <format>u32:0-4294967295</format>
+ <description>Pages count</description>
+ </valueHelp>
+ <constraint>
+ <validator name="numeric" argument="--range 0-4294967295"/>
+ </constraint>
+ </properties>
+ <defaultValue>1024</defaultValue>
+ </leafNode>
+ <leafNode name="max-map-count">
+ <properties>
+ <help>Maximum number of memory map areas a process may have</help>
+ <valueHelp>
+ <format>u32:0-65535</format>
+ <description>Areas count</description>
+ </valueHelp>
+ <constraint>
+ <validator name="numeric" argument="--range 0-65535"/>
+ </constraint>
+ </properties>
+ <defaultValue>3096</defaultValue>
+ </leafNode>
+ <leafNode name="shmmax">
+ <properties>
+ <help>Maximum shared memory segment size that can be created</help>
+ <valueHelp>
+ <format>u32:0-18446744073709551612</format>
+ <description>Size in bytes</description>
+ </valueHelp>
+ <constraint>
+ <validator name="numeric" argument="--range 0-18446744073709551612"/>
+ </constraint>
+ </properties>
+ <defaultValue>2147483648</defaultValue>
+ </leafNode>
+ </children>
+</node>
+<!-- include end -->