1. Getting Started
This guide contains command descriptions for the classic SR OS CLI commands that are used to manage the SR OS.
In this guide, the term CLI refers to the classic CLI unless otherwise specified.
This guide does not cover clear, show, or tools commands. These commands are documented in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Clear, Show, and Tools Command Reference Guide.
 | Note: This guide generically covers Release 21.x.Rx content and may contain some content that will be released in later maintenance loads. Refer to the SR OS 21.x.Rx Software Release Notes, part number 3HE 17177 000x TQZZA, for information on features supported in each load of the Release 21.x.Rx software. |
The full set of CLI commands supported by the SR OS is documented in three related guides as shown in Table 1.
Table 1: Documentation for SR OS CLI Commands
Guide Title | Classic CLI Commands | MD-CLI Commands |
7450 ESS, 7750 SR, 7950 XRS, and VSR Clear, Show, and Tools Command Reference Guide | All clear, show, and tools commands | All clear, show, and tools commands |
7450 ESS, 7750 SR, 7950 XRS, and VSR Classic CLI Command Reference Guide | All other commands | — |
7450 ESS, 7750 SR, 7950 XRS, and VSR MD-CLI Command Reference Guide | — | All other commands |
1.1. Command Tree
The SR OS CLI command tree is a hierarchical inverted tree. The highest level is the root level. Below this level are other tree levels with the major command groups; for example, configuration commands and admin commands are levels below root.
In the tree, you can click on a command to link directly to the command description.
| Note: |
1.2. Command Descriptions
Command descriptions are listed in alphabetical order by command name.
Figure 1 shows an example of a command description.
Figure 1: Command Description Example
Table 2 describes the fields that may be shown for a command. Not all fields are applicable for all commands.
Table 2: Command Description Fields
Field | Description |
Command Name | Name of the command |
Syntax | Command syntax required to execute the command. See Table 3 for information on syntax symbols. |
Context | Path to the command as it is displayed in the CLI prompt. Clicking on [Tree] links to the command in the CLI tree. |
Full Context | Complete contextual path to perform the command |
Platforms | Hardware platforms on which the command is available, including: 7450 ESS-7, 7450 ESS-12, 7750 SR-1, 7750 SR-7, 7750 SR-12, 7750 SR-12e, 7750 SR-a4, 7750 SR-a8, 7750 SR-1e, 7750 SR-2e, 7750 SR-3e, 7750 SR-1s, 7750 SR-2s, 7750 SR-7s, 7750 SR-14s, 7950 XRS-16c, 7950 XRS-20, 7950 XRS-20e, 7950 XRS-40, VSR |
Description | Description of the command functionality and any restrictions |
Default | Command default value |
Parameters | Descriptions of command parameters |
Values | Values allowed for the parameter |
Default | Parameter default value |
| Note: Some SR OS features are platform-specific and therefore may not be available or visible on all platforms. Refer to the SR OS 21.x.Rx Software Release Notes, part number 3HE 17177 000x TQZZA, for information on platform support. All options for enumerated types and numerical ranges are listed in the command descriptions; however, not all options or ranges are valid on all platforms. |
1.3. Navigational Aids
The following aids help you navigate the guide and find specific commands.
1.3.1. Context Path
In the CLI tree section, the complete contextual path to the first command on the page is shown at the top of the page, as shown in Figure 2.
Figure 2: Command Tree Navigation
1.3.2. Searching
The Context field in each command description shows, in parentheses, the full path to the command as displayed in the CLI prompt. This form of the contextual path often abbreviates terms. For example:
(cfg>qos>qgrps>egr>qgrp>queue wred-queue)
To search this guide for a specific command using the Acrobat search function, enter the command name and append a closing parenthesis in the search window. For more efficient searching, add the previous level of the contextual path before the command name.
If you add the context and closing parenthesis, the resulting search returns only matching Context entries. It will not return instances of the same command found elsewhere in the guide. Figure 3 shows an example of a search.
Figure 3: Search Window
1.3.3. Linking to the Tree
Clicking on [Tree] in a command description context links directly to the command in the CLI tree. Figure 4 shows the [Tree] element.
Figure 4: Link to CLI Tree
