`TXBeacon`

txbeacon tests

TXBeacon

Shortest form: txb.

Test TX beacons: packets that the switch firmware transmits periodically by itself. Standard SONiC on Trident 3 has no firmware for this, and the commands then fail with Command failed.

Sub-command words ignore case but cannot be abbreviated. PORT is a port number, not a port name. The built-in help lists only init and add; the shell also has get, start, stop, destroy and scan. The help writes the key as PKTID; the key is PKT_ID, and PKTID= is accepted as an abbreviation of it.

Safety: get and scan are read-only. init, add, start, stop and destroy change firmware state, and start makes the switch transmit test packets on a port. Do not use them on a production switch.

Unvalidated

drivshell> txbeacon scan

TXBeacon init

Initialise the TX beacon module; prints TXBeacon module initialized.

Unvalidated

drivshell> txbeacon init

TXBeacon add [PORT=<port>] [FLAGS=<flags>] [LEN=<len>] [MAXLEN=<maxlen>] [PKT_ID=<id>] [INTERVAL=<n>] [COUNT=<n>] [DATA=<byte>]

Set up a beacon packet. The payload is LEN bytes counting up from DATA.

Unvalidated

drivshell> txbeacon add PORT=1 LEN=64 PKT_ID=1 INTERVAL=1000 COUNT=10

TXBeacon get [MAXLEN=<maxlen>] [PKT_ID=<id>]

Print a beacon’s settings: Got flags=%x len=%x port=%x interval=%x count=%x pkt_data=%x. Read-only.

Unvalidated

drivshell> txbeacon get MAXLEN=128 PKT_ID=1

TXBeacon start [PKT_ID=<id>]

Start transmitting a beacon.

Unvalidated

drivshell> txbeacon start PKT_ID=1

TXBeacon stop [PKT_ID=<id>]

Stop a beacon.

Unvalidated

drivshell> txbeacon stop PKT_ID=1

TXBeacon destroy [PKT_ID=<id>]

Delete a beacon.

Unvalidated

drivshell> txbeacon destroy PKT_ID=1

TXBeacon scan

List all beacons. Read-only.

Unvalidated

drivshell> txbeacon scan

Built-in help

txbeacon init
txbeacon add [PORT=<id>] [FLAGS=<flags>] [LEN=<len>] [MAXLEN=<maxlen>]
                 [PKTID=<pkt_id>] [INTERVAL=<int>] [COUNT=<count>]
                 [DATA=<repeat val>]