2.2.1. CLI Contexts

Use the CLI to access, configure, and manage Nokia routers. CLI commands are entered at the command line prompt. Access to specific CLI commands is controlled by the permissions set by your system administrator. Entering a CLI command makes navigation possible from one command context (or level) to another.

When the user enters a CLI session, the user is in the operational root context. Navigate to another level by entering the name of successively lower contexts. For example, at the command prompt (#), enter configure or config. See Command Completion for alternative syntax for the same command.The active context displays in the command prompt.

In a CLI context, enter commands at that context level by entering the text. Press <Enter> to move to a lower context. The user can also include commands from lower context at one context level as long as the command and parameter syntax is correct.

The following example shows two methods to navigate to a service SDP ingress level.

Method 1:

Method 2:

The CLI returns an error message if the syntax is incorrect. For example, if the user enters rooter for the root command, it would result in an error.

The command parameter is the means by which a value is passed to the command processing program. The user must enter the value according to the syntax rules and, where applicable, the defined range. In the previous example, “6” and “2:6” are the parameter values that the user must enter to execute the command. The value “6” is the value for the Epipe service identifier parameter. For the value “2:6”, “2” is the value for the SDP identifier parameter and “6” is the value for the virtual circuit identifier.

2.2.2. Operational Root and Global Commands

The commands in Table 4 are available at the operational root level of the CLI hierarchy. For the command descriptions, see the respective command sections in this guide. For descriptions of the clear, monitor, show, and tools commands, refer to the 7450 ESS, 7750 SR, 7950 XRS, and VSR Clear, Monitor, Show, and Tools Command Reference Guide.

Global commands are commands that can be entered at any level in the CLI hierarchy. To display the list of all system global commands, enter help globals in the CLI.

The global commands are listed in Table 5. For the command descriptions, see the respective command sections in this guide.

2.2.3. CLI environment Commands

The CLI environment commands listed in Table 6 are found in the environment context of the operational root of the CLI tree. These commands control session preferences for a single CLI session. For more information on the commands, see the respective command sections in this guide.

2.8.1. Command Completion

The CLI supports both command abbreviation and command completion. If the keystrokes entered are enough to match a valid command, the CLI displays the remainder of the command syntax when the <Tab> key or spacebar is pressed. When typing a command, the <Tab> key or spacebar invokes auto-completion. If the keystrokes entered are sufficient to identity a specific command, auto-completion completes the command. If the letters are not sufficient to identify a specific command, pressing the <Tab> key or spacebar displays commands matching the letters entered.

System commands are available in all CLI contexts.

2.8.2. Unordered and Unnamed Parameters

In a command context, the CLI accepts command parameters in any order as long as the command is formatted in the proper command keyword and parameter syntax. Command completion works as long as enough recognizable characters of the command are entered.

The following output shows the command syntax for static-route-entry.

Some SR OS CLI commands have multiple unnamed parameters. For example, the subrate csu-mode rate-step command has both a csu-mode parameter and a rate-step parameter that do not have leading keywords. SR OS uses a best-match algorithm to select which parts of the user input are intended to be used for each unnamed parameter. This best-match algorithm depends on the specific command.

In some cases, it is not possible for the algorithm to be 100% accurate, and the SR OS may assign an unintended value to a parameter when two unnamed parameters have similar constraints and syntax. For example, the environment alias alias-name alias-command-name command may reverse the alias-name and alias-command-name parameters if the first parameter entered is more than 80 characters.

2.8.3. Editing Keystrokes

When entering a command, special keystrokes allow for editing of the command. Table 8 lists the command editing keystrokes.

2.8.4. Absolute Paths

CLI commands can be executed in any context by specifying the full path from the CLI root. To execute an out-of-context command, enter a forward slash (/) or backward slash (\) at the beginning of the command line. The commands are interpreted as absolute paths. Spaces between the slash and the first command return an error.

The “/” or “\” cannot be used as an absolute path at the beginning of the command string of the environment alias command. The command may change the current context depending on whether it is a leaf command. This is the same behavior the CLI performs when CLI commands are entered individually; for example:

or

An absolute path command behaves in the same way as manually entering a series of command line instructions and parameters.

For example, beginning in an IES context service ID 4 (IES 4):

behaves in the way same as the following series of commands:

If the command takes you to a different context, the following occurs:

becomes:

2.8.5. History

The CLI maintains a history of the most recently entered commands. The history command shows the most recently entered CLI commands.

2.8.6. Entering Numerical Ranges

The SR OS CLI allows the use of a single numerical range as an argument in the command line. This range can be a set or a sequence of numbers, or a combination of both.

A set is a range of numerical values, from a minimum to a maximum, incremented by 1. For example:

A sequence is a list of discrete integer elements, in any order. For example:

A sequence can contain sets as well as integer elements. For example:

For example, it is possible to shut down ports 1 through 10 on an XMA/MDA 1 in chassis slot 1. A port can be denoted by “slot/mda/port”, where slot is the slot number, mda is the XMA/MDA number and port is the port number. To shut down ports 1 through 10 on an XMA/MDA 1 in slot 1, the command is entered as follows:

<Ctrl-c> can be used to abort the execution of a range command.

CLI commands can contain ranges of hexadecimal values. This allows ranges to be used when working with data normally expressed in hexadecimal instead of decimal, such as IPv6 or MAC addresses. For example:

A range can also be a reference to a previous range in the same command. This reference takes the form [$x], where x is an integer between 0 and 5. For example:

This gives vprn 11 the router-id "10.20.11.1", vprn 12 the router-id "10.20.12.1", and so on.

Specifying a range in the CLI does have limitations. These limitations are summarized in Table 9.

2.8.7. Pipe/Match

SR OS supports the pipe feature to search one or more files for a character string or pattern.

When using the pipe or match command, the variables and attributes must be spelled correctly. The attributes follow the command and must come before the expression or pattern. The following are examples of how to use the pipe/match command to complete different tasks:

Command syntax:

match pattern context {parents | children | all} [ignore-case] [max-count lines-count] [expression]

match pattern [ignore-case] [invert-match] [pre-lines pre-lines] [post-lines lines-count] [max-count lines-count] [expression]

where:

For example:

Table 10 describes regular expression symbols and their interpretation (similar to what is used for route policy regexp matching). Table 11 describes character class expressions.

Character class expressions must be enclosed within brackets. The expression [[:digit:]] is treated as a regular expression containing the character class “digit”, while [:digit:] is treated as a regular expression matching “:”, “d”, “i”, “g”, or “t”.

2.8.8. Pipe/Count

The SR OS supports a pipe/count command (...| count) that provides a count of the number of lines that would have otherwise been displayed. The pipe/count command is particularly useful when used in conjunction with the pipe/match command in order to count the number of output lines that match a specified pattern.

For example:

2.8.9. Pipe/reverse-dns

The SR OS supports a command pipe/reverse-dns (...| reverse-dns) that processes the input to the pipe by performing a reverse DNS lookup on any IPv4 or IPv6 address strings. For each line where an address string is identified and where the reverse DNS lookup locates a match, the output of the lookup is inserted as the next line in the display. If no match is found, nothing is printed. If the output line is more than 80 characters, the line is truncated.

For example:

2.8.10. Range Operator Support of Regular Expression Match

The user can include a regular expression inside the range operator of any clear, config, show, or tools CLI commands. The beginning and ending of the regular expression must be delimited with the "/" symbol.

SR OS performs the following steps:

Note: The order of execution is the same as the order in which the names are listed in the output display of the CLI info command or in the output display when you invoke the auto-complete function using the <Tab> key. If the execution of the command fails for one of the matching object names, the execution is aborted and the remaining matching object names are not processed.

For example (assume the following SR-TE LSP names are configured on the router):

The following command displays the subset of all SR-TE LSPs with names that include the expression "LSP":

show router mpls sr-te-lsp [/LSP/]

The SR OS expands this command into the following individual commands:

show router mpls sr-te-lsp RENO194_DET190_LSP1_Profile10

show router mpls sr-te-lsp RENO194_DET190_LSP3

show router mpls sr-te-lsp RENO194_ATL224_LSP1

The output of the three show commands is displayed in the following example:

2.8.10.1. Regular Expression Symbols in a Regular Expression Match Operation

The user can use all the regular expression symbols listed in Table 10 and Table 11 inside the regular expression to match.

For example, the user can list all LSP names that begin with the string "RENO194_" followed by the string "ATL" as follows:

*A:bkvm35# show router mpls sr-te-lsp [/^RENO194_\['ATL'\]/]

===============================================================================

MPLS SR-TE LSPs (Originating)

===============================================================================

LSP Name                       To              Tun      Protect     Adm    Opr

                                               Id       Path         

-------------------------------------------------------------------------------

RENO194_ATL224_LSP1            38.120.48.224   4        N/A         Up     Dwn  

-------------------------------------------------------------------------------

LSPs : 1

===============================================================================

Note: The following conventions are used in the previous example. Use the character "^", which matches the start of the string, directly inside the regular expression to indicate a match at the start of the string. However, if you want to match it as a character, enter it as "\\^". Use the range delimiter with the escape symbol in front "\[" inside the regular expression because the range delimiter encloses the regular expression.

Table 12 summarizes special rules governing the use of some of the regular expression symbols inside a regular expression match operation. Any symbol from Table 10 or Table 11 that is not listed in Table 12 can be used directly inside a regular expression match operation.

Table 12:  Rules Governing Regular Expression Symbols  

String	Description
?	[/\?/] if using as a regular expression and [/\\\?/] if using to match the character ?
[ ]	[/\[\]/] if using as a regular expression and [/\\\[\\\]/] if using to match the characters []
$	[/$/] if using as a regular expression and [/\\$/] if using to match the character $
\	[/\\\\/] if using to match the character \
/	[/\//] if using to match the character /
‘	[/\'/] if using to match the character '
*	[/\\*/] if using to match the character *
.	[/\./] if using as a regular expression and [/\\\./] if using to match the character .
+	[/\\+/] if using to match the character +
,	[/\,/] if using to match the character ,
^	[/\\^/] if using to match the character ^
(	[/\\(/] if using to match the character (
)	[/\\)/] if using to match the character )
space	[/\ /] if using to match the character space

The SR OS does not support the combination of a partial string with a regular expression match operation.

For example, if the operator wants to display the SR-TE LSP names that begin with the string "RENO194_ATL", if part of the string is entered directly and the rest of the string is entered inside a regular expression, the command returns no match. The following example demonstrates the incorrect syntax:

*A:bkvm35# show router mpls sr-te-lsp RENO194_[/ATL/]

To obtain a match, the entire string must be inside the regular expression. The following example demonstrates the correct syntax for finding a match:

*A:bkvm35# show router mpls sr-te-lsp [/^RENO194_ATL/]

===============================================================================

MPLS SR-TE LSPs (Originating)

===============================================================================

LSP Name                       To              Tun      Protect     Adm    Opr

                                               Id       Path         

-------------------------------------------------------------------------------

RENO194_ATL224_LSP1            38.120.48.224   4        N/A         Up     Dwn  

-------------------------------------------------------------------------------

LSPs : 1

===============================================================================

2.8.11. Redirection

The SR OS supports redirection (>), which allows the operator to store the output of a CLI command as a local or remote file.

For example:

In some cases, only part of the output might be applicable. The pipe/match and redirection commands can be combined:

This records only the RTT portion (including the word “time”).

2.9.1. Summary of vi Commands

The vi editor operates in two modes:

2.9.2. Using the vi Commands

Use the commands in the following tables to start and end vi edit sessions, move around in a file, enter new text, modify, move, and delete existing text, and read from and write to other files.

Table 13 describes the commands to cut, paste, and delete text.

Table 14 describes the commands to insert new text.

Table 15 describes the commands to move the cursor within the file.

Table 16 describes the commands to move the cursor around the screen.

Table 17 describes the commands to replace text.

Table 18 describes the commands to search for text or characters in the file.

Table 19 describes the commands to manipulate character and line formatting.

Table 20 describes the commands to save and quit.

Table 21 describes miscellaneous commands.

2.9.3. EX commands

The vi editor is built upon another editor, called the EX. The EX editor only edits by line. From the vi editor you use the : command to start entering an EX command. The following list is not complete; however, it includes the most commonly used commands. If more than one line is to be modified by certain commands (such as :s and :w ), the range must be specified before the command. For example, to substitute lines 3 through 15, the command is :3,15s/from/this/g.

Table 22 describes the EX commands.

2.10.1. Feature Behavior

The following list describes detailed behavior of the rollback feature, including the applicable CLI commands.

2.10.2. Rollback and SNMP

The SR OS has SNMP support for rollback status and control. See the TIMETRA-SYSTEM-MIB for details (for example, items such as tmnxSysRollbackStarted).

When the router is doing a rollback revert, SNMP managers see a tmnxSysRollbackStarted trap, then a rapid set of “config change” traps, and finally, the tmnxSysRollbackStatusChange trap.

During the period when a router is processing a rollback revert, both CLI commands from other users and SNMP commands continue to be processed.

2.10.3. Rescue Configuration

A special rescue configuration checkpoint can be created that an operator can revert to at any time. The rescue configuration has its own keyword (rescue) and does not use the same rolling suffix indices as the normal rollback checkpoints. This allows the operator to easily return to the rescue configuration state without having to consider a checkpoint index, and ensures that the rescue checkpoint is always available and does not roll off the bottom of the list of checkpoints.

The operator should define a basic rescue configuration that is known to work and give appropriate management access to the node.

The location and filename of the rescue file are configurable. The SR OS appends the .rc suffix to the specified rescue filename.

2.10.4. Operational Guidelines

The following points offer some operational guidance on the use of rollback.

2.11.1. Basic Operation

In order to edit the candidate configuration, the operator must first enter the candidate edit mode (edit-cfg) with the candidate>edit command. The operator can enter and quit the configuration mode as many times as they wish before finally committing the candidate configuration.

In edit-cfg mode, the operator builds a set of candidate configuration changes using the same CLI tree as the standard line-by-line, non-transactional configuration. Tab completion and keyword syntax checking is available.

Just as there is a single operational active configuration that can be modified simultaneously by multiple users in the SR OS, there is also a single global candidate configuration instance. All users make changes in the same global candidate configuration, and a commit operation by any user commits the changes made by all users.

Users can exclusively create a candidate configuration by blocking other users and sessions of the same user from entering edit-cfg mode by specifying the exclusive parameter. The config>system>management-interface>cli>classic-cli>allow-immediate command can be used to enforce the use of candidate configuration, instead of allowing immediate line-by-line configuration changes.

If a commit operation is successful, all of the candidate changes take operational effect and the candidate is cleared. If there is an error in the processing of the commit, or a commit confirmed is not confirmed and an auto-revert occurs, the router returns to a configuration state with none of the candidate changes applied. The operator can then continue editing the candidate and try a commit later.

All commands in the candidate configuration must be in the correct order for a commit to be successful. Configuration that depends on other candidate objects must be placed after those objects in the candidate. A set of candidate editing commands (copy, insert, and so on) are available to correct and reorder the candidate configuration.

The edit-cfg mode is primarily intended for building a candidate configuration while navigating the configure branch of the CLI. Many CLI commands in branches other than configure are supported while in edit-cfg mode, but access to some CLI branches and commands are blocked, including:

The candidate configuration can be saved to a file and subsequently loaded into a candidate configuration. A saved candidate is similar to, but not the same as, an SR OS configuration file generated with an admin save command. The saved candidate cannot be used in general as a configuration file and may not exec without failures.

There is no SNMP access to the candidate configuration and no SNMP management of candidates, although any configuration changes made using transactional configuration are reported via the standard SR OS SNMP change traps and basic candidate status information is available via SNMP.

A commit may fail for a number of reasons, including:

Error messages are provided for commit failures to help the operator take the necessary actions to correct the candidate.

Standard line-by-line, non-transactional CLI and SNMP commands are not blocked during the creation or editing of a candidate or the processing of a commit. These commands take immediate operational effect when <Enter> is pressed.

2.11.2. Transactions and Rollback

By default, the SR OS automatically creates a new rollback checkpoint after a commit operation. The rollback checkpoint includes the new configuration changes made by the commit. An optional no-checkpoint keyword can be used to prevent the auto-creation of a rollback checkpoint after a commit. If the commit fails, no new rollback checkpoint is created.

When the commit confirmed option is used, a rollback checkpoint is created after the processing of the commit and exists whether the commit is automatically reverted or not.

Transactional configuration relies on the rollback mechanism to operate. Any commands and configurations that are not supported in a rollback revert are also not supported in edit-cfg mode; for example, changes to chassis-mode.

2.11.3. Authorization

Authorization works transparently in edit-cfg mode and no unique or new local profile or TACACS+ permissions rules are required other than allowing access to the candidate branch. For example, if an operator has permission to access the configure filter context, they automatically also have access to the configure filter context when in edit-cfg mode.

If the operator’s profile allows access to the candidate load and save commands, the operations load and save only those items that the user is authorized to access.

The candidate view only displays the items that the user is authorized to access.

The candidate editing commands (such as adding lines, removing lines, and delete operations) only allow operations on items that the user is authorized to access.

The candidate commit and discard commands, along with admin rollback revert, operate on the entire candidate and impact all items; authorization does not apply.