set traffic-policy shaper ICMP-OUTGOING default bandwidth 500Mbps

gistfile1.md

Before

vyos@vyos# set traffic-policy shaper ICMP-OUTGOING default bandwidth 500Mbps
Possible completions:
   <number>     Bandwidth in Kbps
   <number>%    Percentage of overall rate (default 100%)
   <number><suffix>
                Value with scaling suffix (kbit, kbps, ...)

After

vyos@vyos# set traffic-policy shaper ICMP-OUTGOING default bandwidth 500Mbps
Possible completions:
   <number>     Bandwidth in Kbps
   <number>%    Percentage of overall rate (default 100%)
   <number><suffix>
                Available suffixes
                bit
                bit(1), kbit(10^3), mbit(10^6), gbit, tbit
                kibit(1024), mibit(1024^3), gibit(1024^4), tbit(1024^5)
                
                byte
                kibps(1024*8), mibps(1024^2*8), gibps, tibps
                bps(8),kbps(8*10^3),mbps(8*10^6), gbps, tbps

Since is 10^3 "bit" per sec, we might want to show it explicitly like below.
Bandwidth in Kbps (10^3 bits per second)

Else, people might see later part of help message and think it's kbps(8*10^3).

Also I found typo.

• Original:
  kibit(1024), mibit(1024^3), gibit(1024^4), tbit(1024^5)
• It should be:
  kibit(1024), mibit(1024^2), gibit(1024^3), tbit(1024^4)
• Or maybe we can omit last one to be inline with byte.
  kibit(1024), mibit(1024^2), gibit(1024^3), tbit

Thank you for your comment.
This is final proposal.

vyos@vyos# set traffic-policy shaper ICMP-OUTGOING default bandwidth 500Mbps
Possible completions:
   <number>     Bandwidth in Kbps(10^3 bits per second)
   <number>%    Percentage of overall rate (default 100%)
   <number><suffix>
                Available suffixes
                Bit per second
                bit(1), kbit(10^3), mbit(10^6), gbit, tbit
                kibit(1024), mibit(1024^2), gibit(1024^3), tibit

                Byte per second
                kibps(1024*8), mibps(1024^2*8), gibps, tibps
                bps(8),kbps(8*10^3),mbps(8*10^6), gbps, tbps

Looks good. Thanks!

For implementation reason, I change message format.

vyos@vyos# set traffic-policy shaper test default bandwidth   
Possible completions:
   <number>     Bandwidth in Kbps(10^3 bits per second)
   <number>%    Percentage of overall rate (default 100%)
   <number>bit  bit(1), kbit(10^3), mbit(10^6), gbit, tbit
   <number>ibit kibit(1024), mibit(1024^3), gibit(1024^4), tbit(1024^5)
   <number>ibps kibps(1024*8), mibps(1024^2*8), gibps, tibps *Byte/sec*
   <number>bps  bps(8),kbps(8*10^3),mbps(8*10^6), gbps, tbps *Byte/sec*

VyOS code

val_help: <number>; Bandwidth in Kbps(10^3 bits per second)
val_help: <number>%%; Percentage of overall rate (default 100%%)
val_help: <number>bit; bit(1), kbit(10^3), mbit(10^6), gbit, tbit
val_help: <number>ibit; kibit(1024), mibit(1024^3), gibit(1024^4), tbit(1024^5)
val_help: <number>ibps; kibps(1024*8), mibps(1024^2*8), gibps, tibps *Byte/sec*
val_help: <number>bps; bps(8),kbps(8*10^3),mbps(8*10^6), gbps, tbps *Byte/sec*

ibit, ibpsのところにX (kmgtがはいるという意味) の文字を追加した場合はバランスがわるくなってしまうため上のフォーマットに落ち着いています。

   <number>     Bandwidth in Kbps(10^3 bits per second)
   <number>%    Percentage of overall rate (default 100%)
   <number>bit  bit(1), kbit(10^3), mbit(10^6), gbit, tbit
   <number>Xibit
                kibit(1024), mibit(1024^3), gibit(1024^4), tbit(1024^5)
   <number>Xibps
                kibps(1024*8), mibps(1024^2*8), gibps, tibps *Byte/sec*
   <number>bps  bps(8),kbps(8*10^3),mbps(8*10^6), gbps, tbps *Byte/sec*

すっきりしてよいですね。
１個Typo発見しました。

kibit(1024), mibit(1024^3), gibit(1024^4), tbit(1024^5)
 => kibit(1024), mibit(1024^2), gibit(1024^3), tbit(1024^4)