Routing Protocols Configuration Guide for the SmartEdge OS ...

Table 2 Separator Characters in Command Syntax (continued)
Character Use Example Fragment
Examples
The following guidelines apply to separator characters in Table 2:
Conventions
: Separates a port from a channel and a channel from a subchannel. port[:chan-num]
ds3-chan-num[:ds1-chan-num]
- Separates starting value from ending value. start-end
| Separates output modifiers from keywords and arguments in show commands. 1 show configuration | include port
1. For more information about the use of the pipe ( | ) character, see the “Using the CLI” chapter in the Basic System Configuration Guide for the SmartEdge OS.
• The separator character between the prefix and suffix names in a structured username is configurable;
the @ character is the default and is used in command syntax throughout this guide.
• Separator characters act as one-character keywords; therefore, they are always shown in bold.
Table 3 lists the characters and formats used in command syntax statements.
Table 3 Text Formats and Characters in Command Syntax
Convention Example
Commands and keywords are indicated in bold. no ip unnumbered
Arguments for which you must supply the value are indicated in italics. banner login delimited-text
Square brackets ([ ]) indicate optional arguments, keywords, and
constructs within scripts or commands.
Alternative arguments, keywords, and constructs within commands are
separated by the pipe character ( | ).
Alternative, but required arguments, keywords, and constructs are
shown within grouped braces ({ }), and are separated by the pipe
character ( | ).
Optional and required arguments, keywords, and constructs can be
nested with grouped braces and square brackets, where the syntax
requires such format.
Examples use the following conventions:
• System prompts are of the form [context]hostname(mode)#, [context]hostname#, or
[context]hostname>.
In this case, context indicates the current context, hostname represents the configured name of the
SmartEdge system, and mode indicates the string for the current configuration mode, if applicable.
Whether the prompt includes the # or the > symbol depends on the privilege level. For further
information on privilege levels, see the “User Interface” section (in the “Overview” chapter) in the
Basic System Configuration Guide for the SmartEdge OS.
For example, the prompt in the local context on the Redback system in context configuration
mode is:
[local]Redback(config-ctx)#
show clock [universal]
enable [level]
public-key {DSA | RSA} [after-key existing-key | position
key-position] {new-key | ftp url}
debug ssh {all | ssh-general | sshd-detail | sshd-general}
ip address ip-addr {netmask | /prefix-length} [secondary]
enable authentication {none | method [method [method]]}
About This Guide xxv