From a68c9238111c6caee78bb28f8054b8f0cfa0e374 Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Thu, 24 Feb 2022 22:47:12 +0100
Subject: scripts: T4269: node.def generator should automatically add default
 values

Since introducing the XML <defaultValue> node it was common, but redundant,
practice to also add a help string indicating which value would be used as
default if the node is unset.

This makes no sense b/c it's duplicated code/value/characters and prone to
error. The node.def scripts should be extended to automatically render the
appropriate default value into the CLI help string.

For e.g. SSH the current PoC renders:

$ cat templates-cfg/service/ssh/port/node.def
  multi:
  type: txt
  help: Port for SSH service (default: 22)
  val_help: u32:1-65535; Numeric IP port
  ...

Not all subsystems are already migrated to get_config_dict() and make use of
the defaults() call - those subsystems need to be migrated, first before the new
default is added to the CLI help.
---
 interface-definitions/flow-accounting-conf.xml.in | 26 +++++++++++------------
 1 file changed, 13 insertions(+), 13 deletions(-)

(limited to 'interface-definitions/flow-accounting-conf.xml.in')

diff --git a/interface-definitions/flow-accounting-conf.xml.in b/interface-definitions/flow-accounting-conf.xml.in
index 1b57d706c..05cf5e170 100644
--- a/interface-definitions/flow-accounting-conf.xml.in
+++ b/interface-definitions/flow-accounting-conf.xml.in
@@ -14,7 +14,7 @@
               <help>Buffer size</help>
               <valueHelp>
                 <format>u32</format>
-                <description>Buffer size in MiB (default: 10)</description>
+                <description>Buffer size in MiB</description>
               </valueHelp>
               <constraint>
                 <validator name="numeric" argument="--range 0-4294967295"/>
@@ -27,7 +27,7 @@
               <help>Specifies the maximum number of bytes to capture for each packet</help>
               <valueHelp>
                 <format>u32:128-750</format>
-                <description>Packet length in bytes (default: 128)</description>
+                <description>Packet length in bytes</description>
               </valueHelp>
               <constraint>
                 <validator name="numeric" argument="--range 128-750"/>
@@ -209,7 +209,7 @@
                   </valueHelp>
                   <valueHelp>
                     <format>9</format>
-                    <description>NetFlow version 9 (default)</description>
+                    <description>NetFlow version 9</description>
                   </valueHelp>
                   <valueHelp>
                     <format>10</format>
@@ -240,7 +240,7 @@
                       <help>NetFlow port number</help>
                       <valueHelp>
                         <format>u32:1025-65535</format>
-                        <description>NetFlow port number (default: 2055)</description>
+                        <description>NetFlow port number</description>
                       </valueHelp>
                       <constraint>
                        <validator name="numeric" argument="--range 1025-65535"/>
@@ -260,7 +260,7 @@
                       <help>Expiry scan interval</help>
                       <valueHelp>
                         <format>u32:0-2147483647</format>
-                        <description>Expiry scan interval (default: 60)</description>
+                        <description>Expiry scan interval</description>
                       </valueHelp>
                       <constraint>
                         <validator name="numeric" argument="--range 0-2147483647"/>
@@ -273,7 +273,7 @@
                       <help>Generic flow timeout value</help>
                       <valueHelp>
                         <format>u32:0-2147483647</format>
-                        <description>Generic flow timeout in seconds (default: 3600)</description>
+                        <description>Generic flow timeout in seconds</description>
                       </valueHelp>
                       <constraint>
                        <validator name="numeric" argument="--range 0-2147483647"/>
@@ -286,7 +286,7 @@
                       <help>ICMP timeout value</help>
                       <valueHelp>
                         <format>u32:0-2147483647</format>
-                        <description>ICMP timeout in seconds (default: 300)</description>
+                        <description>ICMP timeout in seconds</description>
                       </valueHelp>
                       <constraint>
                        <validator name="numeric" argument="--range 0-2147483647"/>
@@ -299,7 +299,7 @@
                       <help>Max active timeout value</help>
                       <valueHelp>
                         <format>u32:0-2147483647</format>
-                        <description>Max active timeout in seconds (default: 604800)</description>
+                        <description>Max active timeout in seconds</description>
                       </valueHelp>
                       <constraint>
                        <validator name="numeric" argument="--range 0-2147483647"/>
@@ -312,7 +312,7 @@
                       <help>TCP finish timeout value</help>
                       <valueHelp>
                         <format>u32:0-2147483647</format>
-                        <description>TCP FIN timeout in seconds (default: 300)</description>
+                        <description>TCP FIN timeout in seconds</description>
                       </valueHelp>
                       <constraint>
                        <validator name="numeric" argument="--range 0-2147483647"/>
@@ -325,7 +325,7 @@
                       <help>TCP generic timeout value</help>
                       <valueHelp>
                         <format>u32:0-2147483647</format>
-                        <description>TCP generic timeout in seconds (default: 3600)</description>
+                        <description>TCP generic timeout in seconds</description>
                       </valueHelp>
                       <constraint>
                        <validator name="numeric" argument="--range 0-2147483647"/>
@@ -338,7 +338,7 @@
                       <help>TCP reset timeout value</help>
                       <valueHelp>
                         <format>u32:0-2147483647</format>
-                        <description>TCP RST timeout in seconds (default: 120)</description>
+                        <description>TCP RST timeout in seconds</description>
                       </valueHelp>
                       <constraint>
                        <validator name="numeric" argument="--range 0-2147483647"/>
@@ -351,7 +351,7 @@
                       <help>UDP timeout value</help>
                       <valueHelp>
                         <format>u32:0-2147483647</format>
-                        <description>UDP timeout in seconds (default: 300)</description>
+                        <description>UDP timeout in seconds</description>
                       </valueHelp>
                       <constraint>
                        <validator name="numeric" argument="--range 0-2147483647"/>
@@ -418,7 +418,7 @@
                       <help>sFlow port number</help>
                       <valueHelp>
                         <format>u32:1025-65535</format>
-                        <description>sFlow port number (default: 6343)</description>
+                        <description>sFlow port number</description>
                       </valueHelp>
                       <constraint>
                        <validator name="numeric" argument="--range 1025-65535"/>
-- 
cgit v1.2.3