Table: Command Syntax Symbols lists command syntax symbols. Differences between the syntax used in the CLI and in the Command Reference sections of the 7705 SAR guides is noted in the table.
Symbol |
Description |
Example |
---|---|---|
| |
A vertical bar represents an OR, indicating that only one of the parameters in the brackets or braces can be selected |
tcp-ack {true | false} |
[ ] |
Brackets indicate optional parameters |
router [router-name] |
< > |
Angle brackets indicate that the user must enter a value for the parameter inside the brackets (Note: angle brackets are not used in the 7705 SAR guides but are used on the CLI; italics are used in these guides to indicate the same rule) |
interface <interface-name> |
{ } |
Braces indicate that one of the parameters must be selected |
default-action {drop | forward} |
[{ }] |
Braces within square brackets indicate that the parameters are optional, but if one is selected, the information in the braces is required; for example, if the user selects the peer parameter, they must enter the keyword peer (ip-address is optional) |
discovery [{peer [ip-address]} | {interface [ip-int-name]}] |
Bold |
In the 7705 SAR guides (not on the CLI), bold indicates commands and keywords that the user must enter exactly as shown |
scope {inclusive | template} |
Italic |
In the 7705 SAR guides (not on the CLI), italics indicate parameters that the user must enter a value for |
dscp dscp-name |
n/a |
In the Command Reference section, n/a in the Default field of a command indicates that a default value is not applicable for the command |
— |