5.9. Configuring System Management with CLI

5.9.1.1. Saving Configurations

When configuration changes are made, the modified configuration must be saved so the changes are not lost when the system is rebooted. The system uses the configuration and image files, as well as other operational parameters necessary for system initialization, according to the locations specified in the BOF parameters. See Boot Options for more information about boot option files.

Configuration files are saved by executing implicit or explicit command syntax.

Use the detail option of the save command to save both default and non-default configuration parameters.

The index option ensures that the system preserves system indexes when a save command is executed, regardless of the persistent status in the BOF. During a subsequent boot, the index file is read along with the configuration file. As a result, a number of system indexes are preserved between reboots, including the interface index, LSP IDs, and path IDs. This reduces resynchronizations of the network management system (NMS) with the affected network element.

If the save attempt fails at the destination, an error occurs and is logged. The system does not try to save the file to the secondary or tertiary configuration sources unless the path and filename are explicitly named with the save command.

5.9.3.1. System Information

This section covers the basic system information parameters to configure the physical location of the router, contact information, location information for the router (for example, an address, floor or room number), global positioning system (GPS) coordinates, and system name.

Use the CLI syntax displayed in this section to configure the following system components:

5.9.3.2. Configuring Backup Copies

The config-backup command allows you to specify the maximum number of backup versions of the configuration and index files kept in the primary location.

For example, assume the config-backup count is set to 5 and the configuration file is named xyz.cfg. When a save command is issued, the xyz.cfg file is saved with a .1 extension. Each subsequent config-backup command increments the numeric extension until the maximum count is reached. The oldest file (5) is deleted as more recent files are saved.

xyz.cfg

xyz.cfg.1

xyz.cfg.2

xyz.cfg.3

xyz.cfg.4

xyz.cfg.5

xyz.ndx

Each persistent index file is updated at the same time as the associated configuration file. When the index file is updated, the save is performed to xyz .cfg and the index file is created as xyz.ndx. Synchronization between the active and standby is performed for all configurations and their associated persistent index files.

Use the following CLI syntax to specify the maximum number of backup versions of the configuration and index files kept in the primary location.

The following example shows the command usage to set the maximum number of backup versions of the configuration and index files kept in the primary location to 7.

The following is a sample configuration output for the config-backup command.

5.9.4.1. Validating the Golden Bootstrap Image

The admin>check-golden-bootstrap command validates the current golden bootstrap image and displays its version.

Use the following syntax to validate the current golden boot strap image.

The following example shows the command usage to validate the current bootstrap image.

The following is a sample output.

5.9.4.2. Updating the Golden Bootstrap Image

The admin>update-golden-bootstrap command validates the input file and updates the golden bootstrap image with the contents of this file.

Use the following syntax to update the golden boot strap image.

The following example shows the command usage to update the bootstrap image.

The following is a sample output.

5.9.4.3. Disconnect

The disconnect command immediately disconnects a user from a console, Telnet, FTP, or SSH session.

Note: Configuration modifications are saved to the primary image file.

Use the following syntax to disconnect a user from a session.

The following example shows the command usage to disconnect a user from a session.

The following is a sample output of the disconnect command.

5.9.4.4. Set-time

Use the set-time command to set the system date and time. The time entered should be accurate for the time zone configured for the system. The system will convert the local time to UTC before saving to the system clock, which is always set to UTC. If SNTP or NTP is enabled (no shutdown), this command cannot be used. The set-time command does not take into account any daylight saving offset, if defined.

Use the following syntax to set the system date and time.

The following example shows the command usage to set the system date and time.

The following is a sample output of the set-time command.

5.9.4.5. Display-config

The display-config command displays the running configuration of the system.

Use the following syntax to display the running configuration of the system.

The following example shows the command usage to display the detailed running configuration of the system.

The following is a portion of the sample configuration output of the display-config detail command.

5.9.4.6. Tech-support

Note: This command should only be used with explicit authorization and direction from the Nokia Technical Assistance Center (TAC).

5.9.4.7. Save

The save command saves the running configuration to a configuration file. If the debug-save parameter is specified, debug configurations are saved in the configuration file; otherwise, the debug configurations are not saved between reboots.

Use the following syntax to save the running configuration and debug configurations to a configuration file.

The following example shows the command usage to save the running configuration and the debug configurations to a configuration file.

The following is a sample output of the save command.

5.9.4.8. Reboot

The reboot command reboots the router, including redundant cards in redundant systems. If the now option is not specified, you are prompted to confirm the reboot operation.

Use the following syntax to reboot the router.

The following example shows the command usage to reboot the router.

The following is a sample output of the reboot command.

When an admin reboot auto-init command is issued, the system resets the existing BOF and reboots. The system startup process after the admin reboot auto-init command is executed is the same as the first-time system boot described in System Initialization.

Note: After the BOF is reset, the system may not boot up with the last saved system configuration unless the new BOF also uses the same configuration file. If you require the system to boot up with the last saved system configuration, Nokia recommends that you should run the admin>save file-url command to save the current system configuration and modify the BOF to use this configuration.

Use the following CLI to reset the BOF and reboot.

The following is a sample output of the admin reboot auto-init command.

5.9.4.9. Post-Boot Configuration Extension Files

Two post-boot configuration extension files are supported and are triggered when either a successful or failed boot configuration file is processed. The commands specify URLs for the CLI scripts that are run following the completion of the boot-up configuration. A URL must be specified or no action is taken. The commands are persistent between router reboots and are included in the configuration saves (admin save).

Use the following syntax to specify the CLI scripts that are tun following the completion of the boot-up configuration.

The following example shows the command usage to specify the CLI scripts that are tun following the completion of the boot-up configuration.

The following is a sample command output.

5.9.5.1. CLI Command Syntax for 7210 SAS Platforms

This section describes the CLI command syntax to enable synchronous Ethernet on specific 7210 SAS platforms.

5.9.5.2. Entering Edit Mode

To enter edit mode and edit timing references, enter the begin keyword at the config>system>sync-if-timing# prompt.

Use the following CLI syntax to enter edit mode.

The following is a sample error message that is displayed if you try to modify sync-if-timing parameters without entering the begin keyword.

Note: Use commit to save or abort to discard the changes made in a session.

5.9.5.3. Configuring Timing References

On the 7210 SAS-D, ref1 must be configured to use one of ports 1/1/1 to 1/1/4 and ref2 must be configured to use either port 1/1/5 or 1/1/6. The software enforces this check. Ports 1/1/7 to 1/1/10 can be configured as either ref1 or ref2.

There is no port restriction on the 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, or 7210 SAS-K 3SFP+ 8C; any port can be configured for ref1 or ref2.

The following is a sample configuration of timing reference parameters.

Example:

The following displays the timing reference parameters.

5.9.5.4. Using the revert Command

The revert command allows the clock to revert to a higher-priority reference if the current reference goes offline or becomes unstable.

If revertive switching is enabled, the highest-priority valid timing reference is used. If a reference with a higher priority becomes valid, a switchover to that reference is initiated. If a failure on the current reference occurs, the next highest reference takes over.

If non-revertive switching is enabled, the active reference always remains selected while its valid, even if a higher priority reference becomes available. If the active reference becomes invalid, a reference switchover to a valid reference with the highest priority is initiated. The failed reference is eligible for selection once it becomes operational.

5.9.5.5. Other Editing Commands

Other editing commands are:

Use the following syntax to abort or commit changes made to a timing reference.

5.9.5.6. Forcing a Specific Reference

You can force the system synchronous timing output to use a specific reference.

Note: The debug sync-if-timing force-reference command should only be used to test and debug problems. After the system timing reference input has been forced, it will not revert to another reference unless explicitly reconfigured, if the forced reference fails, or if the received QL code is QL-DNU/DUS and QL selection is enabled.

When the debug sync-if-timing force-reference command is run, the current system synchronous timing output is immediately referenced from the specified reference input. The reference must be qualified.

Debug configurations are not saved between reboots.

Use the following syntax to reference the current system synchronous timing output from the specifies reference input.

The following example shows the command usage to reference the current system synchronous timing output from the specifies reference input.

5.9.6.1. Creating Events

The event command controls the generation and notification of threshold crossing events configured with the alarm command. When a threshold crossing event is triggered, the rmon event configuration optionally specifies whether an entry in the RMON-MIB log table will be created to record the occurrence of the event. It can also specify whether an SNMP notification (trap) will be generated for the event. There are two notifications for threshold crossing events: a rising alarm and a falling alarm.ping-address.

Creating an event entry in the RMON-MIB log table does not create a corresponding entry in the 7210 SAS event logs. However, when the event is set to trap, the generation of a rising alarm or falling alarm, a notification creates an entry in the event logs and is distributed to the configured log destinations, including: console, session, memory, file, syslog, or SNMP trap destination. The logger message includes a rising or falling threshold crossing event indicator, the sample type (absolute or delta), the sampled value, the threshold value, the rmon-alarm-id, the associated rmon-event-id, and the sampled SNMP object identifier.

The alarm command configures an entry in the RMON-MIB alarm table. The alarm command controls the monitoring and triggering of threshold crossing events. To trigger the notification or logging of a threshold crossing event, at least one associated rmon event must be configured.

The agent periodically takes statistical sample values from the MIB variable specified for monitoring and compares them to thresholds that have been configured with the alarm command. The alarm command configures the MIB variable to be monitored, the polling period (interval), sampling type (absolute or delta value), and rising and falling threshold parameters. If a sample has crossed a threshold value, the associated event is generated.

Preconfigured CLI threshold commands are available. Preconfigured commands hide some of the complexities of configuring RMON alarm and event commands and perform the same function. In particular, the preconfigured commands do not require the user to know the SNMP object identifier to be sampled. The preconfigured threshold configurations include memory warnings, alarms, and compact flash usage warnings and alarms.

To create events, use the following sample CLI configuration.

The following is a sample command output.

5.9.6.2. Configuring an Alarm Input

The 7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C do not support alarm contact inputs; instead, they provide an option to configure the console port as an alarm input pin. A single alarm input pin can be enabled for use with the console port, allowing operators to monitor external events and alert the operator.

You can configure generation of events when alarm input pins transition between the open and close states. For each generated event, you can specify the following:

The RXD and TXD pins of the console input is used to provide a single alarm input pin functionality. The RXD and TXD pins of the console port is used by software to detect external events. The operating system detects an open or closed circuit, triggers an alarm, and logs it when an event is detected.

By default, the console port does not provide alarm input pin functionality. The CLI command configure>system>console>use-console-alarm-input is used to enable the use of console port as an alarm input pin. After this command is executed, the console port can no longer be used as a console port, and the system generates a log message to convey this restriction. Additionally, the user must configure the alarm-contact-input parameters for the console by using the CLI command config> system>alarm-contact-input console-1.

Note: The user must enable a Telnet session with the node before enabling the console as an alarm input. Once the alarm input functionality is enabled, the user can configure the alarm-contact-input no shutdown using the Telnet session.