Reading this guide

Command entries

Each command has its own entry with a permanent link (for example l3 egress show) and is listed in the Index. The grammar uses these conventions:

<value>

A value you supply.

KeyWord

A literal keyword. As in the SDK’s own usage text, the upper-case letters are the characters an abbreviation must contain: LISTmem can be typed as list, CounTeR as ctr. Matching is case-insensitive.

[ ... ]

Optional.

{ a | b }

Choose one.

Key=<value>

Key/value argument as parsed by the SDK’s parse tables. Keys are case-insensitive and may usually be abbreviated; see Accessing the shell.

Each reference page also shows the command’s built-in help, exactly as help <command> prints it. Where the built-in help is wrong, the entry says so.

Examples

Every example is labelled with where it has been run; see Example validation. Prompts are shown as drivshell> (what bcmsh shows on SONiC); the classic SDK prompt is BCM.0>. Commands run from the host with bcmcmd are shown with a $ prompt.