3.11. Basic Command Reference

This command moves the context back one level of the command hierarchy. For example, if the current level is the config router mpls context, the back command moves the cursor to the config router context level.

This command clears statistics for a specified entity or clears and resets the entity.

This command echoes arguments on the command line. The primary use of this command is to allow messages to be displayed to the screen in files executed with the exec command.

This command enables the user to become a system administrator.

The enable-admin command is in the default profile. By default, all users are given access to this command.

Note: If the admin-password is configured in the config>system>security>password context, any user can enter a special administrative mode by entering the enable-admin command. Refer to the 7705 SAR System Management Guide, “Password Commands”, for information on the admin-password command.

Once the enable-admin command is entered, the user is prompted for a password. If the password matches, the user is given unrestricted access to all the commands.

The minimum length of the password is determined by the minimum-length command. The complexity requirements for the password is determined by the complexity command.

The following displays an example of the password command usage.

The following example displays the password configuration:

There are two ways to verify that a user is in the enable-admin mode:

This command executes the contents of a text file as if they were CLI commands entered at the console.

Exec commands do not have no versions.

Related commands are:

This command returns to the context from which the current level was entered. For example, if you navigated to the current level on a context by context basis, then the exit command only moves the cursor back one level.

If you navigated to the current level by entering a command string, then the exit command returns the cursor to the context in which the command was initially entered.

The exit all command moves the cursor all the way back to the root level.

This command provides a brief description of the help system. The following information is displayed:

This command lists the last 30 commands entered in this session.

Re-execute a command in the history with the !n command, where n is the line number associated with the command in the history output.

For example:

This command displays the running configuration for the configuration context. It can be used at any level under configure but not at the top configure level.

The output of this command is similar to the output of a show config command. This command, however, lists the configuration of the context where it is entered and all branches below that context level.

For example:

By default, the command only enters the configuration parameters that vary from the default values. The detail keyword causes all configuration parameters to be displayed.

The operational keyword is used to display the operational configuration of the current configuration context when the user is in candidate edit mode. The operational keyword is mandatory when using the info command while in candidate edit mode.

This command logs out of the router session.

When the logout command is issued from the console, the login prompt is displayed and any log IDs directed to the console are discarded. When the console session resumes (regardless of the user), the log output to the console resumes.

When a Telnet session is terminated from a logout command, all log IDs directed to the session are removed. When a user logs back in, the log IDs must be recreated.

This command changes a user CLI login password.

When a user logs in after the administrator forces a new-password-at-login, or the password has expired (aging), then this command is automatically invoked.

When invoked, the user is prompted to enter the old password, the new password, and then the new password again to verify the correct input.

If a user fails to create a new password after the administrator forces a new-password-at-login or after the password has expired, the user is not allowed access to the CLI.

This command is the TCP/IP utility to verify IP reachability.

This command displays the present or previous working context of the CLI session.

The pwc command provides a user who is in the process of dynamically configuring a chassis a way to display the current or previous working context of the CLI session. The pwc command displays a list of the CLI nodes that hierarchically define the current context of the CLI instance of the user.

For example:

When the previous keyword is specified, the previous context is displayed. This is the context entered by the CLI parser upon execution of the exit command. The current context of the CLI is not affected by the pwc command.

This command causes the console session to pause operation (sleep) for 1 second (default) or for the specified number of seconds.

This command opens a Secure Shell (SSH) session with another host.

This command initiates a client SSH session with the remote host and is independent from the administrative or operational state of the SSH server. However, to be the target of an SSH or SFTP session, the SSH server must be operational.

The command also allows the user to initiate an SSH session with a key re-exchange to occur after a specified number of minutes have passed or a specified number of megabytes have been transmitted. If both parameters are configured, the key re-exchange will occur at whatever limit is reached first. If neither parameter is set, key re-exchange will not occur.

Quitting SSH while in the process of authentication is accomplished by either executing a <Ctrl-c> or "~." (tilde and dot), assuming the “~” is the default escape character for the SSH session.

This command opens a Telnet session to a remote host.

Telnet servers in 7705 SAR networks limit a Telnet client to three retries to log in. The Telnet server disconnects the Telnet client session after three retries. The number of retry attempts for a Telnet client session is not user-configurable.

The TCP/IP traceroute utility determines the route to a destination address. Aborting a traceroute with the <Ctrl-c> command could require issuing a second <Ctrl-c> command before the prompt is returned.

This command displays the command hierarchy structure from the present working context.

This command sends a console message to a specific user or to all users with active console sessions.

This command enables the substitution of a command line by an alias.

Use the alias command to create alternative names for an entity or command string that are easier to understand and remember. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. The special characters “/” and “\” cannot be used as the first character inside an alias string. Only a single command can be present in the command string.

The alias command can be entered in any context but must be created in the root>environment context.

For example, to create an alias named soi to display MPLS interfaces, enter:

alias soi “show router mpls interface”

An alias can contain embedded quotes if the quote is preceded with the “\” character (for example, alias my-alias "| match \"string\""). This enables aliases to be created as shortcuts for complex commands; for example:

environment alias my-summary "| match expression \"----|Description|Interface|Admin State|Oper State|Transceiver Type|Optical Compliance|Link Length\" | match invert-match expression \"Ethernet Interface|OTU Interface\" | match invert-match expression \"----\" post-lines 1"

When applied to the show port 1/1/1 detail command, show port 1/1/1 detail my-summary will display only the output fields that match the conditions in the match expression as shown in the following examples:

Without alias:

With alias:

By default, the create command is required to create a new OS entity.

The no form of the command disables requiring the create keyword.

This command enables and disables the kernel.

This command enables per-screen CLI output, meaning that the output is displayed on a screen-by-screen basis. The terminal screen length can be modified with the terminal command.

The following prompt appears at the end of each screen of paginated output:

The no form of the command displays the output all at once. If the output length is longer than one screen, the entire output will be displayed, which may scroll the screen.

This command configures the maximum number of higher CLI context levels to display in the CLI prompt for the current CLI session. This command is useful when configuring features that are several node levels deep, which can cause the CLI prompt to become too long.

By default, the CLI prompt displays the system name and the complete context in the CLI.

The number of nodes specified indicates the number of higher-level contexts that can be displayed in the prompt.

For example, if reduced-prompt is set to 2, the two highest contexts from the present working context are displayed by name with the hidden (reduced) contexts compressed into a ellipsis (“…”).

The setting is not saved in the configuration. It must be reset for each CLI session or stored in an exec script file.

The no form of the command reverts to the default.

This command enables a saved indicator in the prompt. When changes are made to the configuration file, a “*” appears in the prompt string indicating that the changes have not been saved. When an admin save command is executed, the “*” disappears.

This command enables and disables the shell.

This command enables the suggestion of internally created objects while auto-completing in the CLI.

This command enables the context to configure the terminal screen length and width for the current CLI session. The terminal length and width cannot be configured for Telnet or SSH sessions, as the correct display size is automatically negotiated.

This command sets the terminal screen length (number of lines).

This command sets the terminal screen width (number of characters).

This command displays timestamps in the CLI session based on local time or Coordinated Universal Time (UTC).

The system keeps time internally in UTC and is capable of displaying the time in either UTC or local time based on the time zone configured.

This configuration command is only valid for times displayed in the current CLI session. This includes displays of event logs, traps and all other places where a timestamp is displayed.

In general, all timestamps are shown in the time selected. This includes log entries destined for console/session, memory, or SNMP logs. Log files on compact flash are maintained and displayed in UTC format.

This command displays timestamps before the CLI prompt, indicating the last time that the command was completed. The date and time are displayed; the time format is either local or UTC, depending on how it was set with the time-display command.

This command enables the context to configure criteria to monitor IP filter statistics.

This command enables IP filter monitoring. The statistical information for the specified IP filter entry is displayed at the configured interval until the configured count is reached.

The first screen displays the current statistics related to the specified IP filter. The subsequent statistical information listed for each interval is displayed as a delta to the previous screen output.

When the keyword rate is specified, the rate per second for each statistic is displayed instead of the delta.

Monitor commands are similar to show commands, but only statistical information is displayed. Monitor commands display the selected statistics according to the configured number of times at the interval specified.

This command enables IPv6 filter monitoring. The statistical information for the specified IPv6 filter entry is displayed at the configured interval until the configured count is reached.

The first screen displays the current statistics related to the specified IPv6 filter. The subsequent statistical information listed for each interval is displayed as a delta to the previous screen output.

When the keyword rate is specified, the rate per second for each statistic is displayed instead of the delta.

Monitor commands are similar to show commands, but only statistical information is displayed. Monitor commands display the selected statistics according to the configured number of times at the interval specified.

This command enables the context to configure criteria to monitor management access filters. Management access filters control all traffic. They can be used to restrict management of the 7705 SAR by other nodes outside specific (sub)networks or through designated ports.

This command enables IP filter monitoring. The statistical information for the specified IP filter entry is displayed at the configured interval until the configured count is reached.

The first screen displays the current statistics related to the specified IP filter. The subsequent statistical information listed for each interval is displayed as a delta to the previous screen output.

When the keyword rate is specified, the rate per second for each statistic is displayed instead of the delta.

Monitor commands are similar to show commands, but only statistical information is displayed. Monitor commands display the selected statistics according to the configured number of times at the interval specified.

This command enables IPv6 filter monitoring. The statistical information for the specified IPv6 filter entry is displayed at the configured interval until the configured count is reached.

The first screen displays the current statistics related to the specified IPv6 filter. The subsequent statistical information listed for each interval is displayed as a delta to the previous screen output.

When the keyword rate is specified, the rate per second for each statistic is displayed instead of the delta.

Monitor commands are similar to show commands, but only statistical information is displayed. Monitor commands display the selected statistics according to the configured number of times at the interval specified.

This command enables port traffic monitoring. The specified ports’ statistical information is displayed at the configured interval until the configured count is reached.

The first screen displays the current statistics related to the specified ports. The subsequent statistical information listed for each interval is displayed as a delta to the previous screen output.

When the keyword rate is specified, the rate per second for each statistic is displayed instead of the delta. The percentage of the port being used is also displayed. For Ethernet ports, the usage includes inter-frame gap and preamble.

Monitor commands are similar to show commands, but only statistical information is displayed. Monitor commands display the selected statistics according to the configured number of times at the interval specified.

This command enables the context to configure criteria to monitor statistical information for MPLS and routing protocols.

This command displays egress statistics for LDP FEC prefixes at the configured interval until the configured count is reached.

Monitor commands are similar to show commands, but only statistical information is displayed. Monitor commands display the selected statistics according to the configured number of times at the interval specified.

This command displays statistical information for LDP sessions at the configured interval until the configured count is reached.

The first screen displays the current statistics related to the specified LDP sessions. The subsequent statistical information listed for each interval is displayed as a delta to the previous screen output.

When the keyword rate is specified, the rate per second for each statistic is displayed instead of the delta.

Monitor commands are similar to show commands, but only statistical information is displayed. Monitor commands display the selected statistics according to the configured number of times at the interval specified.

This command displays statistics for an LDP instance at the configured interval until the configured count is reached.

The first screen displays the current statistics related to the LDP statistics. The subsequent statistical information listed for each interval is displayed as a delta to the previous screen output.

When the keyword rate is specified, the rate per second for each statistic is displayed instead of the delta.

Monitor commands are similar to show commands, but only statistical information is displayed. Monitor commands display the selected statistics according to the configured number of times at the interval specified.

This command monitors statistics for a PIM source group.

This command displays RSVP LSP egress statistics at the configured interval until the configured count is reached.

This command displays RSVP LSP ingress statistics at the configured interval until the configured count is reached.

This command displays statistical RIP neighbor information at the configured interval until the configured count is reached.

The first screen displays the current statistics related to the specified RIP neighbors. The subsequent statistical information listed for each interval is displayed as a delta to the previous screen output. When the keyword rate is specified, the rate per second for each statistic is displayed instead of the delta.

Monitor commands are similar to show commands but only statistical information is displayed. Monitor commands display the selected statistics according to the configured number of times at the interval specified.

This command displays statistics for a VRRP instance.

This command enables the context to configure criteria to monitor specific service SAP criteria.

This command displays statistics for a specific service, specified by the service-id, at the configured interval until the configured count is reached.

The first screen displays the current statistics related to the service-id. The subsequent statistical information listed for each interval is displayed as a delta to the previous screen output.

When the keyword rate is specified, the rate per second for each statistic is displayed instead of the delta.

Monitor commands are similar to show commands, but only statistical information is displayed. Monitor commands display the selected statistics according to the configured number of times at the interval specified.

This command displays statistics for a SAP associated with this service.

This command displays statistics for a specific SAP, identified by the port ID and encapsulation value, at the configured interval until the configured count is reached.

The first screen displays the current statistics related to the SAP. The subsequent statistical information listed for each interval is displayed as a delta to the previous screen output.

When the keyword rate is specified, the rate per second for each statistic is displayed instead of the delta.

Monitor commands are similar to show commands, but only statistical information is displayed. Monitor commands display the selected statistics according to the configured number of times at the interval specified.

This command displays the statistics for the specified SAP aggregation group that is associated with the service.

This command displays statistics for an SDP binding associated with this service.

This command enables the context to edit candidate configurations and must preface every command in the candidate CLI branch.

Commands in the candidate CLI branch, except for the edit command, are available only when in candidate edit mode.

This command enables the candidate edit mode where changes can be made to the candidate configuration and sets the edit point to the end of the candidate. The edit point is the point after which new commands are inserted into the candidate configuration. In candidate edit mode, the CLI prompt displays edit-cfg near the root of the prompt. All other commands in the candidate CLI branch are blocked until the user enters candidate edit mode.

The exclusive parameter allows the user to modify the candidate configuration and block all other users (and other sessions of the same user) from entering candidate edit mode. This parameter can only be used if the candidate configuration is empty and no user is already in candidate edit mode. Before quitting exclusive candidate edit mode, the user must either commit or discard their changes. If the user commits a candidate configuration with the confirmed option while in exclusive candidate edit mode, the exclusive lock is removed during the countdown time to allow any user to confirm the changes.

If the CLI session times out while the user is in exclusive candidate edit mode, the contents of the candidate configuration are discarded. If the user has the candidate configuration locked, the admin disconnect command can be used to forcibly disconnect them and to clear the contents of the candidate.

This command applies the changes in the candidate configuration to the active or operational configuration.

When a candidate configuration is committed, the confirmed keyword can be used to require an additional confirmation, which is useful when changes are being made that could impact management reachability to the router. The contents of the candidate configuration remain visible but cannot be edited until the timeout is completed or the commit is confirmed. If the confirmation is not given with the confirm command within the configured timeout period, the router automatically reverts to a configuration state before the candidate configuration changes were applied.

Standard line-by-line, non-transactional configuration commands (including via SNMP) are not blocked during the countdown period, but any changes made to the configuration during the countdown period will be rolled back if the timeout expires.

A rollback revert is blocked during the countdown period until the commit has been confirmed.

If the commit operation is successful, all the candidate changes take operational effect and the candidate configuration is cleared. If there is an error processing the commit, or if the candidate confirm command is not issued and an auto-revert occurs, the router automatically reverts to a configuration state before the candidate configuration changes were applied. If the automatic reversion occurs, the candidate configuration is not cleared and users can continue to edit it and try the commit later.

By default, the 7705 SAR automatically creates a new rollback checkpoint after a successful commit operation that contains the new configuration changes made by the commit. The rollback checkpoint remains available even if the commit is not confirmed. The no-checkpoint keyword allows users to commit the candidate configuration without creating a rollback checkpoint.

A commit operation is blocked if a rollback revert is currently being processed.

This command is used to confirm a candidate configuration. If the optional confirmed parameter is used with the commit command, this command must be issued before the timeout period expires; otherwise, the router automatically reverts to a configuration state before the candidate configuration changes were applied. After the automatic reversion, the candidate configuration remains available for editing and a subsequent commit.

During the countdown, the contents of the candidate remain visible with the candidate view command but changes to the candidate are blocked until the timeout is completed or this command is issued.

This command also clears the contents of the candidate configuration and allows users to enter candidate edit mode again.

This command copies the selected CLI branch, including all sub-branches, into a temporary buffer that can be used with a subsequent insert command. The contents of the temporary buffer are deleted when the operator exits candidate edit mode. Line numbers can be displayed with the candidate view command.

This command deletes the selected CLI branch, including all sub-branches. The deleted lines are also copied into a temporary buffer that can be used with a subsequent insert command. Line numbers can be displayed with the candidate view command.

This command deletes the entire contents of the candidate configuration and exits candidate edit mode. The undo command cannot be used to recover a candidate configuration that has been discarded with this command.

This command changes the edit point of the candidate configuration. The edit point is the point after which new commands are inserted into the candidate configuration as an operator navigates the CLI and issues commands in candidate edit mode. Line numbers can be displayed with the candidate view command.

This command inserts the contents of the temporary buffer (populated with a previous copy or delete command) into the candidate configuration. The operator can specify any line in the candidate configuration to be the insertion point, but by default, the contents are inserted after the current edit point. The contents of the temporary buffer are deleted when the operator exits candidate edit mode.

Insertions are context-aware. The temporary buffer always stores the CLI context (such as the current CLI branch) for each line deleted or copied. If the contents to be inserted are supported at the context of the insertion point, they are simply inserted into the configuration. If the contents to be inserted are not supported at the context of the insertion point, the following actions are automatically performed by the system:

Line numbers can be displayed with the candidate view command.

This command loads a previously saved candidate configuration into the current candidate. The edit point is set to the end of the loaded configuration lines. The current candidate configuration cannot be modified while a load is in progress.

If the current candidate configuration is empty, this command will load the file into the candidate without requiring any of the optional parameters. If the current candidate is not empty, the user must specify overwrite, insert, or append.

This command exits candidate edit mode. The contents of the current candidate configuration are not deleted and the user can continue editing them later.

This command reapplies the changes to the candidate that were previously removed using the undo command. All undo or redo history is lost when the operator exits candidate edit mode.

The redo command is blocked if another user has made changes in a CLI branch that would be impacted during the redo operation.

This command displays the specified line (a single line only) and allows it to be changed.

Line numbers can be displayed with the candidate view command.

This command saves the current candidate configuration to a file.

This command removes the most recent changes done to the candidate. The changes can be reapplied using the redo command. The undo and redo history is lost when the operator exits candidate edit mode. This command cannot be used to recover a candidate that has been discarded with a candidate discard command.

This command is blocked if another user has made changes in any of the CLI branches that would be impacted during the undo operation.

This command displays the candidate configuration along with line numbers that can be used for editing the candidate configuration.

This command enables the context to configure rollback command parameters.

This command compares two configuration files. If the compare command is entered with no parameters defined, it compares the active configuration to the most recent rollback file. If the command is entered with the source2 parameter defined, it compares the active configuration to the specified file. If the command is entered with both source parameters defined, it compares the first specified file to the second specified file.

Note: In the CLI, the source1 and source2 parameters are called checkpoint1 and checkpoint2 in the admin>rollback context for this command. For simplicity, this command description uses source1 and source2 for all contexts.

The compare command with no parameters can only be used in the admin>rollback context. The compare to source2 command can only be used in the admin>rollback or config>xx context. In the admin context, both source parameters must be specified.

Caution: A compare operation does not check authorization of each line of output. Permission to execute the compare command from the admin branch should only be given to users who are allowed to view the entire system configuration.

The defaults for the source parameters are context-dependent and differ based on the branch in which the command is executed.

This command deletes a rollback checkpoint file and decrements the suffix ID numbers of all older rollback checkpoint files.

If the config>redundancy>rollback-sync command is enabled, deleting a rollback checkpoint file also deletes the backup file and decrements the suffix ID numbers on the standby CSM.

This command initiates a CLI configuration rollback revert operation that returns the configuration state of the node to a previously saved checkpoint file or rescue file. The rollback reversion minimizes impacts to running services. Configuration parameters that have changed since the last rollback checkpoint file was created, or items on which changed configurations have dependencies, are first reset to their default values and then restored to their previous values from the rollback checkpoint file.

Performing a configuration reversion can be briefly service-impacting in changed areas. There are no service impacts to configuration areas that did not change since the rollback checkpoint file was created.

This command saves the current operational configuration as a rollback checkpoint file at the configured rollback location, using the filename specified by the rollback-location command, with the suffix *.rb. The suffixes of all previously saved rollback checkpoint files are automatically incremented by one (*.rb becomes *.rb.1, *.rb.1 becomes *.rb.2, and so on).

By default, there can be a maximum of 10 rollback checkpoint files, the latest with suffix *.rb and nine older files with suffixes *.rb.1 through *.rb.9. If the maximum number of checkpoint files is reached and a new one is saved, the oldest checkpoint file is deleted. The maximum number of rollback checkpoint files that can be saved can be configured with the local-max-checkpoints and remote-max-checkpoints commands.

If the rescue keyword is used, this command saves the current operational configuration as a rescue rollback file at the location and with the filename specified by the rescue-location command. The rescue file uses the suffix *.rc. There can be only one rescue file saved at a time. Saving a new rescue file deletes and replaces any existing rescue file.

A valid rollback checkpoint and rescue location must be configured with the rollback-location and rescue-location commands before saving a checkpoint or rescue file.

This command displays the configuration settings saved in a rollback checkpoint or rescue file, or the active operational system configuration.

This command configures the maximum number of rollback checkpoint files that can be saved to the local compact flash.

When the maximum number of files are saved, the oldest rollback checkpoint file will actually have an ID value one less than the configured maximum, because one rollback checkpoint file is always the latest file and does not have an ID number. For example, if you configure the maximum number of checkpoints as 50, after performing 50 rollback save commands, there will be a latest rollback checkpoint file with extension *.rb, and 49 older files with extension *.rb.1 to *.rb.49.

The no form of this command resets the maximum value to the default.

This command configures the maximum number of rollback checkpoint files that can be saved on a remote device.

When the maximum number of files are saved, the oldest rollback checkpoint file will actually have an ID value one less than the configured maximum, because one rollback checkpoint file is always the latest file and does not have an ID number. For example, if you configure the maximum number of checkpoints as 50, after performing 50 rollback save commands, there will be a latest rollback checkpoint file with extension *.rb, and 49 older files with extension *.rb.1 to *.rb.49.

The no form of this command resets the maximum value to the default.

This command configures the location and generic filename of the rollback rescue configuration file.

A rescue file can be saved locally on the compact flash or on a remote device. The file URL must not include a filename extension. The suffix for the rollback rescue configuration file is *.rc and is automatically appended when the file is saved.

A valid rollback rescue location must be configured before a rollback save command is executed.

This command configures the location and generic filename of rollback checkpoint files. Files can be saved locally on the compact flash or on a remote device.

The file-url or filename must not include a filename extension. The suffixes for rollback checkpoint files are *.rb and *.rb.1 to *.rb.x, and are automatically appended when the file is saved.

A valid rollback checkpoint location must be configured before a rollback save command is executed.

This command copies all existing rollback checkpoint files from the active CSM compact flash to the standby CSM compact flash on a 7705 SAR-8 Shelf V2 or 7705 SAR-18. You can also enable the system to save an automatic backup of each new rollback checkpoint file with the rollback-sync command in the config>redundancy context.

Rollback checkpoint files can only be backed up from local sources and only by using the two dedicated rollback-sync commands. The synchronize commands in the config>redundancy and admin>redundancy contexts do not apply to rollback checkpoint files.

This command enables automatic synchronization of locally saved rollback checkpoint files between the active CSM and standby CSM.

When automatic rollback synchronization is enabled, a rollback save will cause the new checkpoint file to be saved on both the active and standby CSMs if the rollback location is a local location. The suffixes of all older checkpoint files on both active and standby CSMs are incremented by one. Automatic synchronization only causes new rollback checkpoint files to be copied to both CSMs. Any rollback checkpoint files that were created before rollback-sync was enabled are not copied to the standby CSM. You can manually back up all files using the rollback-sync command in the admin>redundancy context.

Rollback checkpoint files can only be backed up from local sources and only by using the two dedicated rollback-sync commands. The synchronize commands in the config>redundancy and admin>redundancy contexts do not apply to rollback checkpoint files.

The no form of this command disables automatic synchronization of new rollback checkpoint files.

This command displays a list of existing aliases.

This command shows candidate configuration information.