To terminate a configuration session and discard all uncommitted changes without system confirmations, use the abort command in any configuration mode.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Any configuration mode

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the abort command to terminate a configuration session and return to EXEC mode from any configuration mode. This command discards all uncommitted configuration changes. You are prompted to commit the changes.

To enter Admin EXEC mode, use the admin command in EXEC mode.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Usage Guidelines

Use the admin command to enter Admin EXEC mode mode. Administration commands are used to configure secure domain routers (SDRs) and to execute various administration plane commands.

Note	Administration commands can be run only by entering administration mode and not by prefixing the admin command with the keyword in EXEC mode mode.

To create a command alias, use the alias command in Global Configuration mode. To delete an alias, use the no form of this command.

Command Default

No command aliases are configured.

Command Modes

Admin EXEC mode

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Cisco IOS XR software supports generic alias definitions for various entities. Any physical or logical entity can have an alias as a reference. For example, an alias can refer to a command, a partial command, a group of commands, a location, or an IP address.

An alias must first be defined. The alias can then be used in command lines in place of the defined entity.

Following is a list of properties for an alias:

• An alias can be used anywhere and in any mode.
• An alias can have zero, one, or many parameters.
• An alias can refer to those parameters with the $ sign.
• If an alias refers to more than one command, the commands must be separated by a semicolon (;).
• The size of the alias command is limited to 1024 characters.

The alias command can be used anywhere. If the content referenced by the alias is invalid or inappropriate in that context or mode, the system issues a warning message containing the substituted content.

An alias name should not be a subset of the keywords that it represents as alias. Substitution is done only when the entered input match fails completely. For instance, the attempt to define an alias with “config? as the alias name fails, as shown in the following example:

RP/0/RP0/CPU0:router(config)# alias config set_host hostname router
RP/0/RP0/CPU0:router(config)# show configuration

alias set_host hostname router
  

Use the show aliases command to display all command aliases or the command aliases in a specified mode.

Task ID

To cause the configuration commands contained in a group or multiple groups to be inherited by the router configuration within which it is applied, use the apply-group command in the appropriate configuration mode. To remove a group configuration, use the no form of this command.

Command Default

None

Command Modes

Any configuration mode

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Configuration statements in configuration groups come into effect only when the configuration groups are applied in the system configuration, and the configuration statements have the correct context and inheritance priority in the mode in which the configuration groups are applied. The maximum number of configuration groups that can be specified in a single apply-group command is eight.

To change the composition of an apply-group command, you must specify all desired groups. For example, if you used the command apply-group g10 g20 g30, and now you want to add the group g15, use the command apply-group g10 g15 g20 g30. If you now want to delete group g20, use the command apply-group g10 g15 g30. If you use the no apply-group command, all groups are removed from the configuration.

Note	From the Release 6.3.1 onwards, you are able to enter the Flexible CLI config group definition, apply-group and exclude-group command in any order as long as the entire commit has all the group definitions needed.

To apply a template to the target configuration, use the apply-template command in Global Configuration mode.

Command Default

No templates are applied to the target configuration.

Command Modes

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the apply-template command to apply a template to the target configuration. Templates allow you to create a template name that represents a group of configuration commands.

Use the template command to define a template. Use the end-template command to exit template configuration mode and return to global configuration mode. Use the show-running command with the optional template template-name keyword and argument to display the contents of a template.

Task ID

To discard a comment associated with a configuration, use the clear comment command in any configurationorGlobal Configuration mode.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Any configuration mode

Global Configuration mode

Usage Guidelines

The clear comment command clears any comments that were added for a specific configuration in the configuration file. After you enter the clear comment command, enter the configuration for which you want to delete the comment on a separate line.

To enter configuration comments, enter ! followed by the comment. The comment you enter is associated with the next configuration entered. For example:

RP/0/RP0/CPU0:router#!router1 is located in xxx
RP/0/RP0/CPU0:router# hostname router1
RP/0/RP0/CPU0:router# commit
  

The comment is displayed in the output of the show running-config command:

RP/0/RP0/CPU0:router# show running-config
...
!router1 is located in xxx
hostname router1
...
  

To delete old commit IDs from the commit database to free up disk space, use the clear configuration commits command in Admin EXEC modeor EXEC mode.

Command Default

None

Command Modes

EXEC mode

Admin EXEC mode

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the clear configuration commits command to delete the number of commit IDs available for rollback operations. The most recent 100 commits are retained by the system. As new commit IDs are added, the oldest commit IDs are discarded and are no longer available for rollback operations.

Note	The clear configuration commits command deletes commits from the commit database only. The running configuration, thus, is not changed.

Note	When a commit ID is deleted from the commit database, it is no longer available for rollback and can no longer be used to display commit changes (with the show configuration rollback changes command).

Use the rollback configuration command to roll back the current running configuration to a previous configuration. Use the show configuration rollback changes command to display a list of the commit IDs available for rollback operations or to display the changes that would be made by the rollback configuration command.

Task ID

To clear an inconsistency alarm for an SDR configuration or admin plane configuration, use the clear configuration inconsistency command in Admin EXEC mode or EXEC mode.

Syntax Description

This command has no keywords or arguments.

Command Default

Administration EXEC mode: Clears the inconsistency alarms for the admin plane configuration.

EXEC mode: Clears the inconsistency alarms for an SDR configuration.

Command Modes

Admin EXEC mode

EXEC mode

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

An inconsistency alarm is set when there is a failure to restore the configuration; this can occur during router startup, or when a line card, modular services card (MSC), or route processor (RP) card is inserted or removed.

If an inconsistency alarm is set, a message similar to the following example is displayed:

RP/0/0/CPU0:May 26 11:58:40.662 : cfgmgr-rp[130]: %MGBL-CONFIGCLI-3 
   BATCH_CONFIG_FAIL : 28 config(s) failed during startup. To view 
   failed config(s) use the command - "show configuration failed startup"
  
RP/0/0/CPU0:May 26 11:58:41.731 : cfgmgr-rp[130]: 
   %MGBL-CONFIG-3-ADMIN_INCONSISTENCY_ALARM : Admin plane configuration
   inconsistency alarm has been raised. Configuration commits will be
   blocked until an ADMIN plane 'clear configuration inconsistency' command
   has been run to synchronize persisted admin plane configuration with 
   running admin configuration.
    

When the inconsistency alarm is set, all configuration commit operations fail until the alarm is cleared using the clear configuration inconsistency command. This command clears the alarm and removes the failed configuration.

For example, the following configuration commit fails to finish due to an existing inconsistency alarm:

RP/0/RP0/CPU0:router# configure 
  
ADMIN plane running configuration is inconsistent with persistent 
  configuration.
No configuration commits will be allowed until an admin plane 
'clear configuration inconsistency' command is performed.
RP/0/RP0/CPU0:router(config)# hostname router2
RP/0/RP0/CPU0:router(config)#commit
  
ADMIN plane running configuration is inconsistent with persistent 
  configuration.
No configuration commits will be allowed until an admin plane 
'clear configuration inconsistency' command is performed.
    

Enter the clear configuration inconsistency command to clear the alarm and allow commit operations to continue.

Note	To reapply the failed configuration, you must reapply and recommit the configuration. Use the load configuration failed command with the startup keyword to populate the target configuration with the contents of the previous failed configuration from the startup configuration.

Use the show configuration history command with the alarm keyword to view the inconsistency alarm set and alarm clear events in the configuration history log.

Command Modes

To clear the inconsistency alarms for the admin plane configuration, enter the clear configuration inconsistency command in administration EXEC mode.

To clear the inconsistency alarms for an SDR configuration, enter the clear configuration inconsistency command in EXEC mode for that SDR.

To resolve configuration inconsistencies on a replica node, use the clear configuration inconsistency replica command in administration EXECorEXEC mode.

Command Default

Administration EXEC mode: Resolves any configuration inconsistencies for the admin plane configuration.

EXEC mode: Resolves any configuration inconsistencies for the SDR configuration.

Command Modes

Admin EXEC mode

EXEC mode

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

In administration EXEC mode, the replica node for the clear configuration inconsistency replica command is the standby designated system controller (DSC). In EXEC mode, the replica nodes are the route processors (RPs) or distributed route processors (DRPs) that can become the designated secure domain router shelf controller (DSDRSC) .

Use the clear configuration inconsistency replica command if there is a configuration inconsistency between the standby DSC and the current active DSC; or alternatively, if the configuration on any nodes that could become the DSC is not the same as the configuration on the current DSC. To determine if you have a configuration inconsistency, use the show configuration inconsistency replica command.

To clear configuration inconsistencies for the admin plane configuration, enter the clear configuration inconsistency replica command in administration EXEC mode.

To clear configuration inconsistencies for an SDR configuration, enter the clear configuration inconsistency replica command in EXEC mode for that SDR.

Task ID

To clear (end) an active configuration session, use the clear configuration sessions command in administration EXEC orEXEC mode.

Command Default

None

Command Modes

Administration EXEC

EXEC mode

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the clear configuration sessions command to clear a configuration session. This command can be used to end the configuration sessions of another user. Any uncommitted changes to a user’s target configuration are discarded.

Use the show configuration sessions command to identify active configuration sessions.

When a configuration session is cleared, a message is displayed on the terminal of the terminated user. For example:

RP/0/RP0/CPU0:router(config)# This configuration session was terminated by user 'user_a' from line 'aux0_0_CPU0'

To commit the target configuration to the active (running) configuration, use the commit command in any configuration Global Configuration mode Admin Configuration mode.

Command Default

The default behavior is pseudo-atomic, meaning that all changes must succeed for the entire commit operation to succeed. If any errors are found, none of the configuration changes take effect.

Command Modes

Any configuration mode

Global Configuration mode

Admin Configuration mode

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Changes made during a configuration session are inactive until the commit command is entered. By default, the commit operation is pseudo-atomic, meaning that all changes must succeed for the entire commit operation to succeed. If any errors are found, none of the configuration changes takes effect.

To replace the default numeric ID for the commit, use the optional label keyword. This label is displayed (instead of the autogenerated commit ID) in the output for the show configuration commit list command.

Enter an optional comment with the comment keyword to provide additional information about the commit action. This comment is displayed in the output for the show configuration commit list command with the detail keyword.

Use the optional confirmed minutes keyword and argument to commit a configuration on a trial basis for a minimum of 30 seconds and a maximum of 300 seconds (5 minutes). During the trial configuration period, enter the commit command to confirm the configuration. If the commit command is not entered, then the system reverts to the previous configuration when the trial time period expires. The confirmed option is not available in administration configuration mode.

You can use the commit command in conjunction with the load command. Load a new configuration with the load command, and use the commit command with the replace keyword to have the loaded configuration become the active (running) configuration.

Use the optional save-running filename file_path keywords and argument to save the running configuration to a specified file. To configure automatic saving of the configuration file on every commit, use the configuration commit auto-save command. If automatic saving of the configuration file is already enabled, specifying save-running filename file_path with the commit command has no additional effect.

Caution

Saving the running configuration to a file is CPU intensive.

Note	If you use the commit command without previously loading a target configuration, a blank configuration is committed.

Note

If you use the commit command with the replace keyword, it does not affect the mode of an 8-port E1/T1 SPA. If the mode is E1 before using the commit replace command, it remains E1. However, since the default mode is T1, the router does not recognize that the mode is E1. To change the mode to T1, you must first use the hw-module subslot cardtype e1 command to add the E1 mode into the configuration so that it correlates with the system. Then manually reload the router and it boots in T1 mode. For more information regarding the hw-module subslot cardtype command, refer to Cisco IOS XR Interface and Hardware Component Command Reference for the Cisco CRS Router.

To enable automatic saving of the running configuration to a specified file on every commit, use the configuration commit auto-save command in Global Configuration mode mode. To disable automatic saving of the running configuration to a specified file on every commit, use the no form of the command.

Caution

Saving the running configuration to a file is CPU intensive.

Command Default

None

Command Modes

Global Configuration mode

Admin Configuration mode

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

To enter global configuration mode or administration configuration mode, use the configure command inEXEC mode or Admin EXEC mode.

Command Default

If the configure command is entered without a keyword, the system is configured from the login terminal.

Command Modes

EXEC mode

Admin EXEC mode

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Configuration modes are used to enter changes to a target configuration session and commit those changes to the running configuration. A router running Cisco IOS XR software contains multiple configurations:

• The configuration for a specific secure domain router (SDR). Each SDR has its own configuration that is modified when a user logs into an SDR and enters global configuration mode . This mode is used to configure SDR- specific features such as routing protocols.
• The administration configuration for system-wide resources and settings. Some features, such as creating SDRs, can be configured only in administration configuration mode.

Global Configuration mode

Use the configure command in EXEC mode to enter Global Configuration mode and create a new target configuration for an SDR. From global configuration mode, you can enter any configuration mode. Configuration changes entered in global configuration mode impact the SDR to which the user is currently logged in.

Admin Configuration mode

Use the configure command in Admin EXEC mode to enter Admin Configuration mode and create a new target configuration. From Admin EXEC mode , you can enter any configuration mode. Configuration changes entered in Admin EXEC mode can impact resources for the entire router. See the command reference documentation for a specific command to determine the impact of commands entered in Admin EXEC mode.

Router Prompt

After you enter the configure command, the system appends “(config)” to the router prompt, indicating that the router is in a configuration mode. For example:

• The following prompt indicates that you are in global configuration mode for an SDR:

  RP/0/RP0/CPU0:router(config)#

• The following prompt indicates that you are in administration configuration mode:

  RP/0/RP0/CPU0:router(admin-config)#

Locking a Configuration Session

To lock the configuration so that no other user can commit changes to the running configuration during your configuration session, issue the configure command with the exclusive keyword.

Committing Changes and Returning to EXEC mode or Admin EXEC mode

Changes to the target configuration remain inactive until the commit command is entered. To leave global configuration or administration configuration mode and return to the EXEC mode or Admin EXEC mode prompt, issue the end or exit command; you are prompted to commit any uncommitted changes.

To leave configuration mode and return directly to EXEC mode or Admin EXEC mode without being prompted to commit changes and without saving changes to the target configuration, enter the abort command in any configuration mode.

To add a description to an interface configuration, use the description command in interface configuration mode. To remove the description, use the no form of this command.

Command Default

No description is configured.

Command Modes

Interface configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the description command to add a description to an interface configuration. The maximum number of characters is 1022.

Task ID

To execute an EXEC mode command from a configuration mode, use the do command in any configuration mode.

Command Default

None

Command Modes

Any configuration mode

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

To display the various EXEC mode commands that are available to execute with the do command, use the online help (?) function at the configuration mode prompt.

Note	The configure and describe commands are not supported with the do command.

To terminate a configuration session and return directly to EXEC modeAdmin EXEC mode , use the end command in any configuration mode.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Any configuration mode

Usage Guidelines

Use the end command to exit any configuration mode and return directly to EXEC mode Admin EXEC mode. If you enter this command without committing the changes to the target configuration, you are prompted to do so:

Uncommitted changes found, commit them before exiting(yes/no/cancel)?[cancel]: 

• Entering yes saves configuration changes to the running configuration file, exits the configuration session, and returns the router to EXEC mode Admin EXEC mode.

  If errors are found in the running configuration, the configuration session does not end. To view the errors, enter the show configuration (config) command with the failed keyword.

• Entering no exits the configuration session and returns the router to EXEC mode Admin EXEC mode without committing the configuration changes.
• Entering cancel leaves the router in the current configuration session without exiting or committing the configuration changes.

Note	Entering Ctrl-Z is functionally equivalent to entering the end command.

Use the abort command to exit the configuration session and return to EXEC mode Admin EXEC mode without being prompted to commit changes and without saving changes to the target configuration.

Task ID

To exit from configuration group submode and return to global configuration mode, use the end-group command in group configuration mode.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Group configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

To exit template configuration mode and return to Global Configuration mode, use the end-template command in template configuration mode.

Syntax Description

This command has no keywords or arguments.

Command Default

No default behavior or values.

Command Modes

Template configuration

Usage Guidelines

Use the end-template command to exit template configuration mode after you have completed the template definition.

To define a template, use the template command. To apply a template to the target configuration, use the apply-template command. To view the contents of a template, use the show running-config command with the optional template template-name keyword and argument.

Task ID

To close an active terminal session and log off the router, use the exit command in EXEC mode Admin EXEC mode.

To return the router to the next higher configuration mode, use the exit command in any configuration mode.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC mode

Any configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

To log off from a terminal session, enter the exit command in EXEC mode Admin EXEC mode.

When exiting from global or administration configuration mode to EXEC mode Admin EXEC mode, you are prompted to commit any uncommitted configuration changes.

Uncommitted changes found, commit them before exiting(yes/no/cancel)?[cancel]:
  

• Entering yes saves configuration changes to the running configuration file, exits the configuration session, and returns the router to EXEC mode Admin EXEC mode.

  If errors are found in the running configuration, the configuration session does not end. To view the errors, enter the show configuration (config) command with the failed keyword.

• Entering no exits the configuration session and returns the router to EXEC mode Admin EXEC mode without committing the configuration changes.
• Entering cancel leaves the router in the current configuration session without exiting or committing the configuration changes.

Note	Entering the exit command from global configuration is functionally equivalent to entering the end command.

To define a configuration group containing configuration statements that can be applied in the router configuration, use the group command in global configuration mode. To remove a configuration group from the running configuration, use the no form of this command.

Command Default

None

Command Modes

Global configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The group command enters group configuration mode where you can list a series of configuration statements that can then be used elsewhere in the router configuration. Most configuration commands can be used in group configuration mode. You must be in a user group associated with a task group that includes the appropriate task IDs for each of the command statements that you list within a configuration group.

The group-name argument is limited to 32 characters and is case-sensitive. It must not contain any of these special characters:

• ` - grave

• ' - single quote

• " - double quote

• < - less than

• > - greater than

• ( - open parenthesis

• ) - close parenthesis

• [ - open bracket

• ] - close bracket

• { - open brace

• } - close brace

• / - slash

• \ - backslash

• & - ampersand

• ^ - caret

• ! - exclamation point

• ? - question mark

• ~ - tilde

• * - asterisk

• % - percent sign

• = - equal sign

• , - comma

• + - plus sign

• | - vertical bar

•   - space

A configuration group can be removed from the running configuration, only if it is not used by a configured apply-group command.

To exit from configuration group submode and return to global configuration mode, use the end-group command.

Regular expressions are used within the configuration statements to make them widely applicable. POSIX 1003.2 regular expressions are supported in the names of configuration statements. Single quotes are used to delimit a regular expression. For example, to specify the regular expression GigabitEthernet.* that matches all GigabitEthernet interfaces, enter the regular expression within single quotes as 'GigabitEthernet.*'.

To display a list of available interface types for your router configuration, enter interface ? at the configuration group prompt:

RP/0/RP0/CPU0:router(config-GRP)# interface ?

  ATM              'RegExp': ATM Network Interface(s)
  BVI              'RegExp': Bridge-Group Virtual Interface
  Bundle-Ether     'RegExp': Aggregated Ethernet interface(s)
  Bundle-POS       'RegExp': Aggregated POS interface(s)
  GigabitEthernet  'RegExp': GigabitEthernet/IEEE 802.3 interface(s)
  IMA              'RegExp': ATM Network Interface(s)
  Loopback         'RegExp': Loopback interface(s)
  MgmtEth          'RegExp': Ethernet/IEEE 802.3 interface(s)
  Multilink        'RegExp': Multilink network interface(s)
  Null             'RegExp': Null interface
  POS              'RegExp': Packet over SONET/SDH network interface(s)
  PW-Ether         'RegExp': PWHE Ethernet Interface
  PW-IW            'RegExp': PWHE VC11 IP Interworking Interface
  Serial           'RegExp': Serial network interface(s)
  tunnel-ip        'RegExp': GRE/IPinIP Tunnel Interface(s)
  tunnel-mte       'RegExp': MPLS Traffic Engineering P2MP Tunnel interface(s)
  tunnel-te        'RegExp': MPLS Traffic Engineering Tunnel interface(s)
  tunnel-tp        'RegExp': MPLS Transport Protocol Tunnel interface
  

Note	Although you are required to enter only enough characters for the interface type to be unique, it is recommended that you enter the entire phrase. All interface types used in regular expressions are case-sensitive.

For example, you can use the command interface 'GigabitEthernet.*', but not interface 'gigabite.*'. To specify a subinterface, prefix the expression with the characters \. (backslash period), for example: interface 'GigabitEthernet.*\..*'. Refer to the Configuring Flexible Command Line Interface Configuration Groups module in the Cisco IOS XR System Management Configuration Guide for the Cisco CRS Router for more extensive examples.

To specify or modify the hostname for the router, use the hostname command in Global Configuration mode.

Command Default

The factory-assigned default hostname is “ios.”

Command Modes

Global Configuration mode

Usage Guidelines

The hostname is used in prompts and default configuration filenames.

No blank or space characters are permitted as part of a name. Do not expect case to be preserved. Uppercase and lowercase characters look the same to many Internet software applications. It may seem appropriate to capitalize a name the same way you might do in English, but conventions dictate that computer names appear all lowercase. For more information, see RFC 1178, Choosing a Name for Your Computer.

Task ID

To populate the target configuration with the contents of a previously saved configuration file, use the load command in global configuration or administration configuration mode.

Command Default

If the full path of the file is not specified, the present working directory is used.

Command Modes

Global configuration

Administration configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the load command to populate the target configuration with the contents of a previously saved configuration. When loading a file, you must specify the device, directory path, and filename of the configuration file.

Use the commit command in conjunction with the load command. Load a new configuration with the load command, and use the commit command with the replace keyword to have the loaded configuration become the active (running) configuration.

Use the show configuration failed (config) command with the optional load keyword to display syntax errors that occurred during the last load operation.

Task ID

To populate the target configuration with changes from previous configuration commits, use the load commit changes command in global configuration or administration configuration mode.

Command Default

None

Command Modes

Global configuration

Administration configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the load commit changes command to populate the target configuration with changes from previous configuration commits. The changes are not applied until you enter the commit command.

Use the show configuration (config) command to display the target configuration.

Task ID

To populate the target configuration with the contents of the previous failed configuration commit, use the load configuration failed command in global configuration or administration configuration mode.

Command Default

None

Command Modes

Global configuration

Administration configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the load configuration failed command to populate the target configuration with the contents of the previous failed configuration commit.

Task ID

To populate the target configuration with the contents of the previous removed configuration, use the load configuration removed command in global configuration or administration configuration mode.

Command Default

None

Command Modes

Global configuration

Administration configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the load configuration removed command to populate the target configuration with the contents of the removed configuration during installation operations.

Task ID

To populate the target configuration with the contents of a previous configuration, use the load rollback changes command in global configuration or administration configuration mode.

Command Default

None

Command Modes

Global configuration

Administration configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the load rollback changes command to load rollback configuration changes to the target configuration. This command is similar to the rollback configuration command. The difference between the commands is that the load rollback changes command copies the rollback changes to the target configuration and does not commit the changes until the changes are explicitly committed with the commit command.

Use the show configuration rollback changes command to display rollback changes.

Task ID

Cisco IOS XR software provides online help for standard command-line interface (CLI) commands using manual (man) pages. To display manual pages, use the man command in EXEC mode.

Command Default

None

Command Modes

EXEC

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

You must have the documentation PIE installed before you can use the man command. If you attempt to run this command without the documentation PIE installed, an error is displayed as shown in the following example:

RP/0/RP0/CPU0:router# man command show install

Building index table...
Warning. Unable to get directory info for '/pkg/man' :No such file or directory.
 Discarding!
man [5521656]:Building index table failed. No entries found
  

For information about installing optional software PIEs, see the Upgrading and Managing Cisco IOS XR Software module in Cisco IOS XR System Management Configuration Guide for the Cisco CRS Router.

Use the man command to display the manual pages for a specific command on the basis of the command name, a feature, or a keyword. Each man page contains the command name, syntax, command mode, usage, examples, and related commands.

The man command queries and displays command information about the router. A query can be based on keywords or a feature. The feature feature-name keyword and argument display all commands that match the feature. For example, entering man feature hfr- base-1 displays all commands that match the hfr-base-1 feature. The keyword keywords keyword and argument display all commands that contain the specified keyword. For example, man keyword ipv4 displays all commands that contain ipv4.

To display the contents of a file, use the more command in EXEC or administration EXEC mode.

Command Default

None

Command Modes

EXEC

Administration EXEC

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the more command to display any text file, especially an ASCII file stored on the router or accessible through the network. The file can be a configuration file or any other text file.

Filtering Output

Adding a Filter at the --More-- Prompt

You can also specify a filter at the --More-- prompt of a more command output. To filter output from the --More-- prompt, enter a forward slash ( / ) followed by a regular expression. The filter remains active until the command output finishes or is interrupted (using Ctrl-Z or Ctrl-C).

• A second filter cannot be specified at a --More-- prompt if a filter has already been specified at the original command or at a previous --More-- prompt.
• The minus sign (–) preceding a regular expression displays output lines that do not contain the regular expression.
• The plus sign (+) preceding a regular expression displays output lines that contain the regular expression.

Note	After you specify a filter for a more command, you cannot specify another filter at the next --More-- prompt. The first specified filter remains until the more begin command output finishes or until you interrupt the output. The use of the keyword does not constitute a filter.

Task ID

To display the current configuration submode from a configuration submode, use the pwd command in any supported configuration submode.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Any subconfiguration mode

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

To roll back the running configuration to a previous configuration, use the rollback configuration command inEXEC or administration EXEC mode.

Command Default

None

Command Modes

EXEC

Administration EXEC

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Each time the commit command is entered, a commit ID is assigned to the new configuration. You can revert the system to the configuration of a previous commit ID with the rollback configuration command:

• Use the to keyword to revert to the configuration that existed before the configuration specified with the commit-id argument.
• Use the last keyword to revert to the configuration that existed before the last number of configuration commits (specified with the number-of-commits argument) were made.
• Use show configuration commit list to display a list of the commit IDs available for rollback operations.

Note	The most recent 100 commits are retained by the system. As new commit IDs are added, the oldest commit IDs are discarded and are no longer available for rollback operations.

Use the force keyword to override commits that would fail otherwise. This is useful in the event of a low-memory condition on the router, to revert to a commit that would remove a configuration that caused the low-memory condition.

Note	The rollback operation may fail if you try to rollback two (or more) commits where the individual commits involve the configuration and removing of the configuration of the same item, and there is a dependency of one item over another in any of the individual commit operations.

Task ID

To return to configuration mode from a configuration submode, use the root command in any supported configuration submode.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Any subconfiguration mode except the following:

• The root command is not available under the route-policy submodes, because it requires the end-policy command to exit out of the configuration.
• The root command is not available in template submode, but is available in the submodes configurable under the template submode.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

To save the contents of a configuration to a file, use the save configuration command in global configuration or administration configuration mode.

Command Default

None

Command Modes

Global configuration

Administration configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

To save a configuration to a file, use the save configuration command.

To save a configuration that failed to a file, use the save configuration failed command.

Task ID

To save the changes of a configuration to a file, use the save configuration changes command in global configuration or administration configuration mode.

Command Default

None

Command Modes

Global configuration

Administration configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

To save the configuration changes to be made during a replace operation to a file, use the save configuration changes command.

Task ID

To save the changes for a commit, or a series of commits, to a file, use the save configuration commit changes command in global configuration or administration configuration mode.

Command Default

None

Command Modes

Global configuration

Administration configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the save configuration commit changes command to save the changes made in a commit operation to a file. You can specify a specific commit ID, all the changes since a specified commit ID, or the changes that occurred during the last n commits.

Task ID

To save the contents of the failed configuration, use the save configuration failed command inglobal configuration or administration configuration mode.

Command Default

None

Command Modes

Global configuration

Administration configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

To save a configuration to a file, use the save configuration command.

To save a configuration that failed to a file, use thesave configuration failed command.

To save a configuration that failed during startup to a file, use the save configuration failed command with the startup keyword.

Task ID

To save the contents of a merged configuration to a file, use the save configuration merge command in global configuration or administration configuration mode.

Command Default

None

Command Modes

Global configuration

Administration configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

To save the contents of a removed configuration to a file, use the save configuration removed command in global configuration or administration configuration mode.

Command Default

None

Command Modes

Global configuration

Administration configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When a package is deactivated, the configuration belonging to that package is removed from the running configuration and saved to a file. To save a copy of the removed configuration file, use the save configuration removed command.

Task ID

To save the rollback changes, use the save rollback changes command in global configuration or administration configuration mode.

Command Default

None

Command Modes

Global configuration

Administration configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the save rollback changes command to save the changes that would be made in a configuration rollback to a specific commit point or for a series of commits.

To set the default address family identifier (AFI) for the current session, use the set default-afi command in EXEC mode.

Command Default

The default AFI setting is set to IPv4 for all sessions.

Command Modes

EXEC

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set default-afi command to set the default AFI for the current session. This command acts as a keystroke shortcut for show commands. If the default AFI setting is set to IPv4, then you would not have to specify the ipv4 keyword for show commands that support the ipv4 keyword. For example, if the AFI setting is set to IPv4, you could issue the show route command without specifying the ipv4 keyword to display IPv4 routes in the Routing Information Base (RIB).

Use the show default-afi-safi-vrf command to display the default AFI setting.

Task ID

To set the default subaddress family identifier (SAFI) for the current session, use the set default-safi command in EXEC mode.

Command Default

The default SAFI setting is set to unicast for all sessions.

Command Modes

EXEC

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set default-safi command to set the default SAFI setting for the current session. This command acts as a keystroke shortcut for show commands. If the default SAFI setting is set to unicast, you would not have to specify the unicast keyword for show commands that support that keyword. For example, if the default SAFI setting is set to unicast, you could issue the show router command without specifying the unicast keyword to display information about unicast address prefixes in the Routing Information Base (RIB).

Use the show default-afi-safi-vrf command to display the default SAFI setting.

Task ID

To set the default VPN routing and forwarding (VRF) instance for the current session, use the set default-vrf command in EXEC mode.

Command Default

The default VRF setting is set to empty.

Command Modes

EXEC

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set default-vrf command to set the default VRF setting for the current session. This command acts as a keystroke shortcut for show commands. For example, if the default VRF is configured, you can issue the show route command without specifying the VRF name.

When the default VRF for the session is set to none, then IPv4 routes for the system default VRF are displayed.

Note	To override the default VRF setting, specify the VRF name in the show command.

Use the show default-afi-safi-vrf command to display the default VRF setting.

Task ID

To display information about the system configuration or operational state, use the show command in EXEC mode, administration EXEC mode, or any configuration mode.

Command Default

None

Command Modes

EXEC

Administration EXEC

Any configuration

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show commands display information about the system and its configuration. To display a list of the available show commands, use the question mark (?) online help function.

Filtering Output

Adding a Filter at the --More-- Prompt

You can also specify a filter at the --More-- prompt of a show command output. To filter output from the --More-- prompt, enter a forward slash (/) followed by a regular expression. The filter remains active until the command output finishes or is interrupted (using Ctrl-Z or Ctrl-C).

• If a filter is specified at the original command or a previous --More-- prompt, a second filter cannot be applied.
• The use of the begin keyword does not constitute a filter.
• The minus sign (–) preceding a regular expression displays output lines that do not contain the regular expression.
• The plus sign (+) preceding a regular expression displays output lines that contain the regular expression.

For example, the show interfaces command requires read privileges in the interface task ID.