From d2251361b9989765cfc1a32978ce5a81ca05307a Mon Sep 17 00:00:00 2001 From: An-Cheng Huang Date: Tue, 17 Aug 2010 15:30:07 -0700 Subject: update help text to use val_help --- .../wan/interface-health/node.tag/failure-count/node.def | 3 +-- .../wan/interface-health/node.tag/nexthop/node.def | 5 ++--- .../wan/interface-health/node.tag/success-count/node.def | 3 +-- .../node.tag/test/node.tag/resp-time/node.def | 3 +-- .../interface-health/node.tag/test/node.tag/type/node.def | 5 ++--- .../wan/rule/node.tag/destination/address/node.def | 13 ++++++------- .../wan/rule/node.tag/destination/port/node.def | 8 ++++---- .../wan/rule/node.tag/inbound-interface/node.def | 3 +-- .../wan/rule/node.tag/interface/node.tag/weight/node.def | 3 +-- .../load-balancing/wan/rule/node.tag/limit/burst/node.def | 2 +- templates/load-balancing/wan/rule/node.tag/limit/node.def | 2 +- .../load-balancing/wan/rule/node.tag/limit/period/node.def | 2 +- .../load-balancing/wan/rule/node.tag/limit/rate/node.def | 2 +- .../wan/rule/node.tag/limit/threshold/node.def | 2 +- .../load-balancing/wan/rule/node.tag/protocol/node.def | 9 ++++----- .../wan/rule/node.tag/source/address/node.def | 13 ++++++------- .../load-balancing/wan/rule/node.tag/source/port/node.def | 8 ++++---- 17 files changed, 38 insertions(+), 48 deletions(-) (limited to 'templates/load-balancing') diff --git a/templates/load-balancing/wan/interface-health/node.tag/failure-count/node.def b/templates/load-balancing/wan/interface-health/node.tag/failure-count/node.def index e3c3d10..3e7a9e6 100644 --- a/templates/load-balancing/wan/interface-health/node.tag/failure-count/node.def +++ b/templates/load-balancing/wan/interface-health/node.tag/failure-count/node.def @@ -2,5 +2,4 @@ type: u32 default: 1 syntax:expression: $VAR(@) >= 0 && $VAR(@) <= 10; "failure count must be between 1-10" help: Set failure count -comp_help: possible completions: -<1-10> set failure count +val_hel: u32:1-10; Failure count diff --git a/templates/load-balancing/wan/interface-health/node.tag/nexthop/node.def b/templates/load-balancing/wan/interface-health/node.tag/nexthop/node.def index a113136..c434f40 100644 --- a/templates/load-balancing/wan/interface-health/node.tag/nexthop/node.def +++ b/templates/load-balancing/wan/interface-health/node.tag/nexthop/node.def @@ -3,6 +3,5 @@ help: Outbound interface nexthop address. Can be 'dhcp or ip address' [REQUIRED] syntax:expression: exec "/opt/vyatta/sbin/vyatta-wanloadbalance.pl --valid-nexthop $VAR(@)"\ ; "Invalid nexthop [$VAR(@)]" allowed: echo "dhcp <>" -comp_help:Possible completions: - Set the nexthop - dhcp Set the nexthop via DHCP +val_help: ipv4; Nexthop IP address +val_help: dhcp; Set the nexthop via DHCP diff --git a/templates/load-balancing/wan/interface-health/node.tag/success-count/node.def b/templates/load-balancing/wan/interface-health/node.tag/success-count/node.def index 5c2f3f2..5ce0eb7 100644 --- a/templates/load-balancing/wan/interface-health/node.tag/success-count/node.def +++ b/templates/load-balancing/wan/interface-health/node.tag/success-count/node.def @@ -2,6 +2,5 @@ type: u32 default: 1 syntax:expression: $VAR(@) >= 0 && $VAR(@) <= 10; "success count must be between 1 and 10" help: Set success count -comp_help: possible completions: -<1-10> set success count +val_help: u32:1-10; Success count diff --git a/templates/load-balancing/wan/interface-health/node.tag/test/node.tag/resp-time/node.def b/templates/load-balancing/wan/interface-health/node.tag/test/node.tag/resp-time/node.def index 1636278..8d0c3ad 100644 --- a/templates/load-balancing/wan/interface-health/node.tag/test/node.tag/resp-time/node.def +++ b/templates/load-balancing/wan/interface-health/node.tag/test/node.tag/resp-time/node.def @@ -2,5 +2,4 @@ type: u32 default: 5 syntax:expression: $VAR(@) >= 0 && $VAR(@) <= 30; "response must be between 1 and 30 seconds" help: Set ping response time (seconds) -comp_help: possible completions: -<1-30> set response time (seconds) +val_help: u32:1-30; Response time (seconds) diff --git a/templates/load-balancing/wan/interface-health/node.tag/test/node.tag/type/node.def b/templates/load-balancing/wan/interface-health/node.tag/test/node.tag/type/node.def index 875eb81..bbbd548 100644 --- a/templates/load-balancing/wan/interface-health/node.tag/test/node.tag/type/node.def +++ b/templates/load-balancing/wan/interface-health/node.tag/test/node.tag/type/node.def @@ -5,9 +5,8 @@ help: Set WLB test type syntax:expression: $VAR(@) in "ping", "ttl"; "action must be either ping or ttl expired test" -comp_help: Possible completions: - ping Set rule test type to icmp echo response - ttl Set rule test type to udp ttl expired response +val_help: ping; Set rule test type to icmp echo response +val_help: ttl; Set rule test type to udp ttl expired response diff --git a/templates/load-balancing/wan/rule/node.tag/destination/address/node.def b/templates/load-balancing/wan/rule/node.tag/destination/address/node.def index a11b2ba..e242124 100644 --- a/templates/load-balancing/wan/rule/node.tag/destination/address/node.def +++ b/templates/load-balancing/wan/rule/node.tag/destination/address/node.def @@ -1,9 +1,8 @@ type: txt help: Set source IP address, subnet, or range -comp_help: Possible completions: - IP address to match - Subnet to match - - IP range to match - ! Match everything except the specified address - ! Match everything except the specified subnet - !- Match everything except the specified range +val_help: ipv4; IP address to match +val_help: ipv4net; Subnet to match +val_help: ipv4range; IP range to match +val_help: !ipv4; Match everything except the specified address +val_help: !ipv4net; Match everything except the specified subnet +val_help: !ipv4range; Match everything except the specified range diff --git a/templates/load-balancing/wan/rule/node.tag/destination/port/node.def b/templates/load-balancing/wan/rule/node.tag/destination/port/node.def index 9974fdf..760cfd0 100644 --- a/templates/load-balancing/wan/rule/node.tag/destination/port/node.def +++ b/templates/load-balancing/wan/rule/node.tag/destination/port/node.def @@ -1,9 +1,9 @@ type: txt help: Set source port -comp_help: Source port(s) can be specified as a comma-separated list of: - Named port (any name in /etc/services, e.g., http) - <1-65535> Numbered port - - Numbered port range (e.g., 1001-1005) +val_help: ; Named port (any name in /etc/services, e.g., http) +val_help: u32:1-65535; Numbered port +val_help: range; Numbered port range (e.g., 1001-1005) +comp_help: Multiple destination ports can be specified as a comma-separated list. The whole list can also be "negated" using '!'. For example: '!22,telnet,http,123,1001-1005' diff --git a/templates/load-balancing/wan/rule/node.tag/inbound-interface/node.def b/templates/load-balancing/wan/rule/node.tag/inbound-interface/node.def index 9e10e35..b405032 100644 --- a/templates/load-balancing/wan/rule/node.tag/inbound-interface/node.def +++ b/templates/load-balancing/wan/rule/node.tag/inbound-interface/node.def @@ -1,3 +1,2 @@ type: txt -help: Set inbound interface name [REQUIRED] -comp_help: Enter a network interface name, for example, "eth0" +help: Inbound interface name (e.g., "eth0") [REQUIRED] diff --git a/templates/load-balancing/wan/rule/node.tag/interface/node.tag/weight/node.def b/templates/load-balancing/wan/rule/node.tag/interface/node.tag/weight/node.def index 642ecc0..59896a5 100644 --- a/templates/load-balancing/wan/rule/node.tag/interface/node.tag/weight/node.def +++ b/templates/load-balancing/wan/rule/node.tag/interface/node.tag/weight/node.def @@ -2,5 +2,4 @@ type: u32 default: 1 syntax:expression: $VAR(@) >= 0 && $VAR(@) <= 255; "Interface weight must be between 1 and 255" help: Set load-balance weight -comp_help: possible completions: -<1-255> set interface weight +val_help: u32:1-255; Interface weight diff --git a/templates/load-balancing/wan/rule/node.tag/limit/burst/node.def b/templates/load-balancing/wan/rule/node.tag/limit/burst/node.def index 98cf81d..c83c53f 100644 --- a/templates/load-balancing/wan/rule/node.tag/limit/burst/node.def +++ b/templates/load-balancing/wan/rule/node.tag/limit/burst/node.def @@ -1,3 +1,3 @@ type: u32 help: Set burst limit for matching packets -default: 5 \ No newline at end of file +default: 5 diff --git a/templates/load-balancing/wan/rule/node.tag/limit/node.def b/templates/load-balancing/wan/rule/node.tag/limit/node.def index 7a50d14..62caf8f 100644 --- a/templates/load-balancing/wan/rule/node.tag/limit/node.def +++ b/templates/load-balancing/wan/rule/node.tag/limit/node.def @@ -1 +1 @@ -help: Enable packet limit for this rule \ No newline at end of file +help: Enable packet limit for this rule diff --git a/templates/load-balancing/wan/rule/node.tag/limit/period/node.def b/templates/load-balancing/wan/rule/node.tag/limit/period/node.def index 3049203..8dce515 100644 --- a/templates/load-balancing/wan/rule/node.tag/limit/period/node.def +++ b/templates/load-balancing/wan/rule/node.tag/limit/period/node.def @@ -1,4 +1,4 @@ type: txt help: Set time window for rate calculation default: "second" -syntax:expression: $VAR(@) in "second", "minute", "hour"; "period must be second or minute or hour" \ No newline at end of file +syntax:expression: $VAR(@) in "second", "minute", "hour"; "period must be second or minute or hour" diff --git a/templates/load-balancing/wan/rule/node.tag/limit/rate/node.def b/templates/load-balancing/wan/rule/node.tag/limit/rate/node.def index 5ea3c44..9344b22 100644 --- a/templates/load-balancing/wan/rule/node.tag/limit/rate/node.def +++ b/templates/load-balancing/wan/rule/node.tag/limit/rate/node.def @@ -1,3 +1,3 @@ type: u32 help: Set number of packets used for rate limit -default: 5 \ No newline at end of file +default: 5 diff --git a/templates/load-balancing/wan/rule/node.tag/limit/threshold/node.def b/templates/load-balancing/wan/rule/node.tag/limit/threshold/node.def index 21b395e..a837802 100644 --- a/templates/load-balancing/wan/rule/node.tag/limit/threshold/node.def +++ b/templates/load-balancing/wan/rule/node.tag/limit/threshold/node.def @@ -1,4 +1,4 @@ type: txt help: Set threshold behavior for limit default: "below" -syntax:expression: $VAR(@) in "below", "above"; "limit can apply above or below rate" \ No newline at end of file +syntax:expression: $VAR(@) in "below", "above"; "limit can apply above or below rate" diff --git a/templates/load-balancing/wan/rule/node.tag/protocol/node.def b/templates/load-balancing/wan/rule/node.tag/protocol/node.def index 12c361e..8a62643 100644 --- a/templates/load-balancing/wan/rule/node.tag/protocol/node.def +++ b/templates/load-balancing/wan/rule/node.tag/protocol/node.def @@ -2,8 +2,7 @@ type: txt help: Set protocol to match (protocol name in /etc/protocols or protocol number or "all") default: "all" syntax:expression: exec "/opt/vyatta/sbin/vyatta-validate-type.pl protocol_negate '$VAR(@)'" ; "invalid protocol \"$VAR(@)\"" -comp_help:Possible completions: - An IP protocol name from /etc/protocols (e.g. "tcp" or "udp") - <0-255> An IP protocol number - all All IP protocols - ! All IP protocols except for the specified name or number (negation) +val_help: txt; IP protocol name from /etc/protocols (e.g. "tcp" or "udp") +val_help: u32:0-255; IP protocol number +val_help: all; All IP protocols +val_help: !; All IP protocols except for the specified name or number diff --git a/templates/load-balancing/wan/rule/node.tag/source/address/node.def b/templates/load-balancing/wan/rule/node.tag/source/address/node.def index a11b2ba..e242124 100644 --- a/templates/load-balancing/wan/rule/node.tag/source/address/node.def +++ b/templates/load-balancing/wan/rule/node.tag/source/address/node.def @@ -1,9 +1,8 @@ type: txt help: Set source IP address, subnet, or range -comp_help: Possible completions: - IP address to match - Subnet to match - - IP range to match - ! Match everything except the specified address - ! Match everything except the specified subnet - !- Match everything except the specified range +val_help: ipv4; IP address to match +val_help: ipv4net; Subnet to match +val_help: ipv4range; IP range to match +val_help: !ipv4; Match everything except the specified address +val_help: !ipv4net; Match everything except the specified subnet +val_help: !ipv4range; Match everything except the specified range diff --git a/templates/load-balancing/wan/rule/node.tag/source/port/node.def b/templates/load-balancing/wan/rule/node.tag/source/port/node.def index e65cbfd..b16be4b 100644 --- a/templates/load-balancing/wan/rule/node.tag/source/port/node.def +++ b/templates/load-balancing/wan/rule/node.tag/source/port/node.def @@ -1,8 +1,8 @@ type: txt help: Set source port -comp_help: Source port(s) can be specified as a comma-separated list of: - Named port (any name in /etc/services, e.g., http) - <1-65535> Numbered port - - Numbered port range (e.g., 1001-1005) +val_help: ; Named port (any name in /etc/services, e.g., http) +val_help: u32:1-65535; Numbered port +val_help: range; Numbered port range (e.g., 1001-1005) +comp_help: Multiple source ports can be specified as a comma-separated list. The whole list can also be "negated" using '!'. For example: '!22,telnet,http,123,1001-1005' -- cgit v1.2.3