Software Management Operations

This chapter provides information about software management operations on the system. Software management sections include:

Understanding the Local File System

The System Management Card provides control and management for the system.

The local file system is made up of files that are stored on one or more of the following:
  • /flash - A CompactFlash card, located on the circuit board of the SMC, is the default storage media for the operating system software image, CLI configuration, and crash log files used by the system.
  • /pcmcia1 - This device is available when an ATA Type I or Type II PCMCIA card is inserted into PC-Card Slot on the front panel of the SMC.
  • /hd-raid - This is the hard drive installed on the SMC. Disk names “hd-local1” and “hd-remote1” are used on ASR 5000s. An XFS-formatted RAID disk is mounted on “/mnt/hd-raid”. Users can gain access to part of it from either “/hd-raid” or “/mnt/user/hd-raid”.

    IMPORTANT:

    For this release, local filesystem access is via the master SMC only.

File Types Used by the Local File System

The following file types can be located in the local file system:
  • Operating System Software Image File: This binary file type is identified by its .bin extension. The file is the operating system that is loaded by the system upon startup or reloading. This is an executable, read-only file that cannot be modified by end users.
  • CLI Configuration File: This file type is identified by its .cfg extension. These are text files that contain CLI commands that work in conjunction with the operating system software image. These files determine services to be provided, hardware and software configurations, and other functions performed by the system. The files are typically created by the end user. You can modify the files both on and off-line and use descriptive long filenames.
  • System File: Only one file identified by a .sys extension is used by the system. The boot.sys file contains system-specific information, which describes how the system locates, and in what priority it loads, file groups (paired .bin and .cfg files) from its boot stack.
  • Abridged Crash Log: The abridged crash log, identified by its crashlog filename, contains summary information about software or hardware failures that occur on the system. This file is located in the /flash/crsh2/ directory on the device. You can view the contents of this file through the CLI, but you cannot modify the file.

Understanding the boot.sys File

The system uses the boot.sys file to store the prioritized boot stack parameters and file groups the system uses during startup. Modify this file only through system CLI commands and not through external means. Boot parameters contain information the system needs to locate the operating system image file, including:
  • bootmode: This setting is typically configured to normal, and identifies how the system starts.
  • network interface configuration: Use these optional boot method settings when you configure the system to obtain its operating system image from an external network server that is using one of the management LAN interfaces on the SPIO card.
  • terminal-speed configuration: This parameter identifies the data transfer rate at which a serial interface communicates on the console port. The default setting for this parameter is 115200 bps (115.2 Kbps). You can change this and other settings with RS-232 Port Configuration Mode commands.
  • boot stack information: The boot stack is made up of prioritized file group entries that designate the operating system image file and the CLI configuration file to load.

When a system is unpacked and started for the first time, the boot.sys file is configured to use the normal boot mode and load the operating system software image from the /flash directory.

There is no CLI configuration file contained on the local file system. This causes the system to automatically start its CLI-based Quick Setup Wizard upon the first successful boot. Refer to Getting Started for more information on using the Quick Setup Wizard.

Maintaining the Local File System

Use CLI commands to manage and maintain the devices that make up the local file system. Execute all the commands described in this section in the Exec Mode. Unless otherwise specified, you must have security administrator or administrator privileges to execute these commands.

IMPORTANT:

For complete information about the commands listed below, see the Exec Mode Commands chapter of the Command Line Interface Reference.

File System Management Commands

Use the commands in this section to manage and organize the local file system.

Synchronizing the File System

Commands are supported for mirroring the local file systems from the active SMC to the standby SMC in systems containing two cards. Use these commands to synchronize any or all of the local devices.

IMPORTANT:

Crash log files are not synchronized when these commands are executed.

The following command synchronizes the file systems between two SMCs:
[local]host_name# filesystem synchronize { / flash | /pcmcia1 | all } [checkonly] [from | to] } [-noconfirm ]
The following command synchronizes the file systems on two SMC /flash devices.
[local]host_name# filsystem synchronize /flash

Creating Directories

Use the mkdir command to create a new directory on the specific local device. This directory can then be incorporated as part of the path name for any file located in the local file system.

[local]host_name# mkdir { /flash | /pcmcia1 | /hd-raid } /dir_name
Use the following command to create a directory named configs:
[local]host_name# mkdir /flash/configs

Renaming Files and Directories

Use the rename command to change the name of a file from its original name to a different name. Remember to use the same file extension, if applicable, to ensure that the file type remains unchanged.

[local]host_name# rename { /flash | /pcmcia1 | /hd-raid } /src_filename { /flash | /pcmcia1 | /hd-raid } /dst_filename [-noconfirm]
Use the following command to rename a file named iot_test.cfg to iot_accept.cfg on the /flash local device.
[local]host_name# rename /flash/iot_test.cfg /flash/iot_accept.cfg -noconfirm

IMPORTANT:

Use the rename command only within the same local device. You cannot rename a file and place it onto another local device at the same time. To move a renamed file, you must use the copy command.

Copying Files

These instructions assume that you are at the root prompt for the Exec mode. To copy files, enter the following command:

[local]host_name# copy from_url to_url [-noconfirm]
To copy a configuration file called system.cfg from a directory that was called cfgfiles to a directory named configs_old on the CompactFlash in the SMC, enter the following command:
[local]host_name# copy /flash/cfgfiles/system.cfg /flash/configs_old/system_2011.cfg
To copy a configuration file called simple_ip.cfg from a directory called host_name_configs to an FTP server with an IP address of 192.168.34.156, on which you have an account with a username of administrator and a password of secure, use the following command:
[local]host_name# copy /flash/host_name_configs/simple_ip.cfg
ftp://administrator:secure@192.168.34.156/host_name_configs/ simple_ip.cfg
To copy a configuration file called init_config.cfg to the root directory of a TFTP server with a hostname of config_server, enter the following command:
[local]host_name# copy /flash/cfgfiles/init_confg.cfg
tftp://config_server/init_config.cfg

Deleting Files

The delete command removes a designated file from its specified location on the local file system. This command can only be issued to a local device on the SMC. Note that this command does not allow for wildcard entries; each filename must be specified in its entirety.

CAUTION:

Do not delete the boot.sys file. If deleted, the system will not reboot on command and will be rendered inoperable.

[local]host_name# delete { /flash | /pcmcia1 | /hd-raid } /filename [-noconfirm]
The following command deletes a file named test.cfg from the /flash directory.
[local]host_name# delete /flash/test.cfg

Removing Directories

The rmdir command deletes a current directory on the specific local device. This directory can then be incorporated as part of the path name for any file located in the local file system.

IMPORTANT:

The directory you want to remove (delete) must be empty before executing the rmdir command. If the directory is not empty, the CLI displays a “Directory not empty” message and will not execute.

[local]host_name# rmdir url /dir_name

url specifies the location of the CLI configuration file to be removed. It may refer to a local or a remote file.

The following command deletes an empty directory named configs in the /flash directory.
[local]host_name# rmdir /flash/configs

Formatting Local Devices

The format command performs a low-level format of a local device. This operation formats the device to use the FAT16 formatting method, which is required for proper read/write functionality with the operating system.

IMPORTANT:

Local devices that have been formatted using other methods such as NTFS or FAT32 may be used to store various operating system, CLI configuration, and crash log files. However, when placing a new local device into the SMC for regular use, you should format the device via the system prior to use. This ensures that the FAT16 file allocation table format is used, preventing any possible discrepancies between other formats used with other operating systems.

CAUTION:

The filesystem format command removes all files and information stored on the device.

To format a local device for use by the local file system, enter the following command:

[local]host_name# filesystem format { /flash | /pcmcia1 | /hd-raid }

Applying Pre-existing CLI Configuration Files

A pre-existing CLI configuration file is any .cfg file created to provide utility functions (such as clearing all statistics during testing) or created off-line using a text editor. There may be pre-existing configuration files stored on the local file system that can be applied to a running system at any time.

CAUTION:

If a configuration file is applied to a system currently running another CLI configuration, any like contexts, services, logical interfaces, physical ports, IP address pools, or other configured items will be overwritten if the same command exists in the configuration file being applied. Take caution to ensure that you are knowledgeable of the contents of the file being applied and understand what the service ramifications are if a currently running command is overwritten. Also note that changes will not be saved automatically.

A CLI configuration file, or script containing CLI commands, can be applied to a running system by entering the following command at the Exec mode prompt.
[local]host_name# configure url [ verbose ]

url specifies the location of the CLI configuration file to be applied. It may refer to a local or a remote file.

The following command applies a pre-existing CLI configuration file named clearcmds.cfg in the /flash directory.
[local]host_name# configure /flash/clearcmds.cfg

Viewing Files on the Local File System

This section describes how to view a variety of files.

Viewing the Contents of a Local Device

The contents, usage information, and file system directory structure of any local device can be viewed by entering the following command at the Exec mode prompt:

[local]host_name# directory { /flash | /pcmcia1 | /hd-raid }

Viewing CLI Configuration and boot.sys Files

The contents of CLI configuration and boot.sys files, contained on the local file system, can be viewed off-line (without loading them into the OS) by entering the following command at the Exec mode prompt:

[local]host_name# show file url { /flash | /pcmcia1 | /hd-raid } /filename

Where: url is the path name for the location of the file and filename is the name of the file, including any extension.

IMPORTANT:

Operator and inspector-level users can execute the show file command but cannot execute the directory command.

Validating an Operating System File

The operating system software image file, identified by its .bin extension, is a non-readable, non-editable file that executes on the system, creating its runtime operating system (OS).

It is important to verify a new operating system image file before attempting to load it. To accomplish this, a proprietary checksum algorithm is used to create checksum values for each portion of the application stored within the .bin file during program compilation.

This information can be used to validate the actual file against the checksum values stored within the file during its compilation. If any portion of the image file has become corrupted (for example, the file was truncated or was transferred using ASCII mode instead of binary mode), then this information is reported and the file is deemed unusable.

To validate an operating system software image file, enter the following command at the Exec mode prompt:

[local]host_name# show version { /flash | /pcmcia1 | /hd-raid } /[directory]/filename [all]]
The output of this command displays the following information:
  • Version number
  • Description
  • Date
  • Boot Image
  • Size
  • Flags
If an invalid file is found, the system displays a failure message similar to these:
Failure: Image /flash/image_version.bin
CRC check failed!
Failure: /flash/image_version.bin, has a
bad magic number

Configuring the Boot Stack

The boot stack consists of a prioritized listing of operating system software image-to-CLI configuration file associations. These associations determine the software image and configuration file that gets loaded during system startup or upon a reload/reboot. Though multiple associations can be configured, the system uses the association with the highest priority. In the event that there is an error processing this association (for example, one of the files cannot be located), the system attempts to use the association with the next highest priority. Priorities range from 1 to 100, with 1 being the highest priority. The maximum number of boot stack entries that may be configured in the boot.sys file is 10.

Boot stack information is contained in the boot.sys file, described in Understanding the boot.sys File. In addition to boot stack entries, the boot.sys file contains any configuration commands required to define the system boot method as explained in the section that follows.

System Boot Methods

The local-boot method uses software image and configuration files stored locally on the system. Upon system startup or reboot, the system looks on one of its local devices or /hd-raid located on the active SMC for the specific software image and accompanying configuration text file. When using the local-booting method, you only need to configure boot stack parameters.

The system can also be configured to obtain its software image from a specific external network server while it is paired with a configuration text file that resides on the system. When using network booting, you need to configure the following:
  • Boot stack parameters, which define the files to use and in what priority to use them
  • Boot interface and network parameters defining the SPIO management LAN interface and the methods to use to reach the external network server
  • Network booting delay time and optional name server parameters defining the delay period (in seconds) to allow for network communications to be established, and the IP address of any Domain Name Service (DNS) name server that may be used

Detailed information on how to configure the system to use the network booting method appears in Network Booting Configuration Requirements.

Viewing the Current Boot Stack

To view the boot stack entries contained in the boot.sys file run the Exec mode show boot command.

IMPORTANT:

Operator and inspector-level users can execute the show boot command.

The examples below shows the command output for a local booting configuration. Notice that in these examples both the image file (operating system software) and configuration file (CLI commands) are located on the /flash device.

IMPORTANT:

The StarOS image filename scheme changed with release 16.1. Pre-16.1, format = “production.image.bin”. For 16.1 onwards, format = “asr5500-image_number.bin”. This change is reflected in the examples provided below.

Example 1 – StarOS releases prior to 16.1:
boot system priority
18 \
    image /flash/15-0-builds/production.45666.bin \
    config /flash/general_config.cfg
 
boot system priority
19 \ 
    image /flash/15-0-builds/production.45717.bin \
    config /flash/general_config_3819.cfg
 
boot system priority
20 \
    image /flash/15-0-builds/production.45069.bin \
    config /flash/general_config_3665.cfg
Example 2 – StarOS release 16.1 onwards:
boot system priority
18 \
    image /flash/16-1-builds/asr5000-16.1.3.bin \
    config /flash/general_config.cfg
 
boot system priority
19 \ 
    image /flash/16-1-builds/asr5000-16.1.1.bin \
    config /flash/general_config_3819.cfg
 
boot system priority
20 \
    image /flash/16-1-builds/asr5000-16.1.0.bin \
    config /flash/general_config_3665.cfg

The example below shows the output for a combination network booting and local booting configuration. Notice in this example that the first two boot stack entries (Priorities 18 and 19) load the image file (operating system software) from an external network server using the Trivial File Transfer Protocol (TFTP), while all configuration files are located on the /flash device.

Also notice the boot network interface and boot network configuration commands located at the top of the boot stack. These commands define what SPIO management LAN interface(s) to use and information about communicating with the external network server that hosts the operating system software image file.
boot interface local-eth1
medium auto media rj45
boot networkconfig
static ip address spio24 192.168.1.150 netmask
255.255.255.0
boot delay 15
boot system priority
18 image tftp://192.168.1.161/tftpboot/image_version.bin \config /flash/general_config.cfg
boot system priority
19 image tftp://192.168.1.161/tftpboot/image_version.bin \config /flash/general_config.cfg
boot system priority
20 image /flash/image_version.bin \config /flash/general_config.cfg
To identify the boot image priority that was loaded at the initial boot time enter:
show boot initial-config
The example below displays the output:
[local]host_name# show boot initial-config
Initial (boot
time) configuration:
      image tftp://192.168.1.161/tftpboot/image_version.bin \
       config /flash/config_name.cfg
      priority 1

Adding a New Boot Stack Entry

IMPORTANT:

Before performing this procedure, verify that there are less than 10 entries in the boot.sys file and that a higher priority entry is available (i.e. that minimally there is no priority 1 entry in the boot stack). Refer to Viewing the Current Boot Stack for more information.

If priority 1 is in use, then you must renumber the existing entry(ies) to ensure that at least that priority is available. The maximum number of boot stack entries that can be contained in the boot.sys file is 10. If there are already 10 entries in the boot stack, you must delete at least one of these entries (typically, the lowest priority) and, if necessary, renumber some or all of the other entries before proceeding. Refer to Deleting a Boot Stack Entry for more information.

This procedure details how to add new boot stack entries to the boot.sys file. Make sure you are at the Exec mode prompt and enter the following commands:
configure
   boot system priority number image image_url config cfg_url

For complete information about the above command, see the Global Configuration Mode Commands chapter of the Command Line Interface Reference.

The following command creates a new boot stack entry, using a boot priority of 3.
boot system priority
3 image /flash/image_filename.bin config /flash/config_name.cfg

IMPORTANT:

Boot stack changes saved to the boot.sys file are not executed until the system is rebooted.

Synchronize the local file systems on the SMCs by the following command:

[local]host_name# fielsystem synchronize all

Deleting a Boot Stack Entry

This procedure details how to remove an individual boot stack entry from the boot.sys file. Make sure you are at the Exec mode prompt and enter the following commands:

configure
   no boot system priority number

Where number specifies the boot priority used for the boot stack entry. This command removes that specific entry from the boot stack, causing the boot.sys file to be overwritten.

Network Booting Configuration Requirements

Configuring the Boot Interface

Boot interface parameters define the SPIO management LAN interface that the system will use to communicate with the management network when using the network booting method.

IMPORTANT:

Booting a dual-SMC chassis with SPIO port redundancy enabled requires that both SMCs have CFE1.1.0 or greater in flash. If CFE1.1.0 or greater is not present on both cards, the standby SMC may not be able to boot from the network in certain circumstances.

This procedure details how to configure the boot interface for reliable communications with your network server. Make sure you are at the Exec mode prompt:

[local]host_name#
  1. Enter the Global Configuration mode by entering the following command:
    configure
    
    The following prompt appears:
    [local]host_name(config)#
    
  2. Enter the following command:
    [local]host_name(config)# boot interface { local-eth1 | local-eth2 } medium { auto | speed { 10 | 100 | 1000 } duplex { full | half } } media { rj45 | sfp }
    
    for complete information on the above command, see the Global Configuration Mode Commands chapter of the Command Line Interface Reference.
  3. Save the configuration as described in the Verifying and Saving Your Configuration chapter.

Configuring the Boot Network

Boot network parameters define the protocols and IP address information for SPIO interfaces used to reach the external network server that hosts the operating system software image file. To configure boot network parameters, make sure you are at the Exec mode prompt:

[local]host_name#
  1. Enter the Global Configuration mode by entering the following command:
    [local]host_name# configure
    
    The following prompt appears:
    [local]host_name(config)#
    
  2. Enter the following command:
    [local]host_name(config)# boot networkconfig { dhcp | { { dhcp-static-fallback | static } ip address
    spio24 ip_address24 [ spio25 ip_address25 ] netmask subnet_mask [ gateway gw_ip_address  ] } }
    
    For complete information about the above command, see the Global Configuration Mode Commands chapter of the Command Line Interface Reference. The following command configures the boot network to communicate using DHCP, with a static-fallback IP address for SPIO in slot 24 of 192.168.206.101 and a Class C netmask.
    boot networkconfig
    dhcp-static-fallback ip address spio24 192.168.206.101
    netmask 255.255.255.0
    
    The next example uses static IP addresses for SPIOs in both slots 24 and 25, which can access the external network server through a gateway whose IP address is 135.212.10.2.
    boot networkconfig
    static ip address spio24 192.168.206.101
    spio25 192.168.206.102 netmask 255.255.255.0
    gateway 135.212.10.2
    
  3. Save the configuration as described in the Verifying and Saving Your Configuration chapter.

Configuring Boot Network Delay Time

An optional delay period, in seconds, can be configured for systems booting from a network. The purpose of this parameter is to allow time for external devices, such as switches, that use the Spanning Tree Protocol (STP) to determine the network route to a specified IP address.

To configure a boot network delay, enter the following command from the Global Configuration mode prompt.
[local]host_name(config)# boot delay time

Where time is an integer from 1 to 300 seconds before attempting to contact the external network server. If your network uses STP, a typical delay time of 30 seconds should suffice.

IMPORTANT:

Save your configuration as described in the Verifying and Saving Your Configuration chapter.

Configuring a Boot Nameserver

To enter the hostname of the network server that hosts the operating system software image, first configure the IP address of the Domain Name Service (DNS) server, referred to as a name server, that can resolve the host name for the machine.

To configure a boot nameserver address, enter the following command from the Global Configuration mode prompt.
[local]host_name(config)# boot nameserver ip_address

Where ip_address is the IP address of the DNS server entered in IPv4 dotted-decimal notation.

IMPORTANT:

Save the configuration as described in the Verifying and Saving Your Configuration chapter.

Upgrading the Operating System Software

The following information is required prior to performing a software upgrade:

  • Current operating system version
  • New operating system version
  • Upgrade method

Identifying OS Release Version and Build Number

The operating system can be configured to provide services and perform pre-defined functions through commands issued from the CLI or through the Web Element Manager application.

The operating system software is delivered as a single binary file (.bin file extension) and is loaded as a single instance for the entire system.
  • For StarOS releases prior to 16.1, the image filename is identified by its release version and corresponding build number. For example: production.build_number.asr5000.bin.
  • For StarOS release 16.1 onwards, the image filename is identified by its platform type and release number. For example, asr5000-release_number. bin.
The software version information can be viewed from the CLI in the Exec mode by entering the show version command.
[localhost_name# show version

Verify Free Space on the /flash Device

Verify that there is enough free space on the /flash device to accommodate the new operating system image file by entering the following Exec mode command:
[local]host_name# directory /flash
The following is an example of the type of directory information displayed:
-rwxrwxr-x    1 root     root         7334
May  5 17:29 asr-config.cfg
-rwxrwxr-x    1 root     root          399
Jun  7 18:32 system.cfg
-rwxrwxr-x    1 root     root        10667
May 14 16:24 testconfig.cfg
-rwxrwxr-x    1 root     root        10667
Jun  1 11:21 testconfig_4.cfg
-rwxrwxr-x    1 root     root         5926
Apr  7 16:27  tworpcontext.cfg
-rwxrwxr-x    1 root     root        15534
Aug  4 13:31 test_vlan.cfg
-rwxrwxr-x    1 root     root         2482
Nov 18 11:09 gateway2.cfg
-rwxrwxr-x    1 root     root    159106048
Dec 31  2011 image_filename
1136352 /flash
Filesystem           1k-blocks      Used
Available Use% Mounted on
/var/run/storage/flash/part1
31154688   1136352  30018336
  4% /mnt/user/.auto/onboard/flash
Note the “Available” blocks in the last line of the display. After displaying the directory information, the CLI returns to root and the following prompt appears:
[local]host_name#

Download the Software Image from the Support Site

Access to the Cisco support site and download facility is username and password controlled. You must have an active customer account to access the site and download the StarOS image.

Download the software image to a network location or physical device (PCMCIA card) from which it can be uploaded to the /flash device.

Contact your Cisco representative or Cisco TAC for additional information.

Transfer StarOS Image to /flash on the Chassis

Transfer the new operating system image file to the /flash device on the SMC using one of the following methods:
  • Copy the file from a network location or local device plugged in into the SMC by entering the following command:
    [local]host_name# copy from_url
    to_url [-noconfirm]
    
  • Transfer the file to the /flash device using an FTP client with access to the system.

    IMPORTANT:

    Whenever transferring a operating system software image file using the file transfer protocol (FTP), the FTP client must be configured to transfer the file using binary mode. Failure to use binary transfer mode will make the transferred operating system image file unusable.

  • Transfer the file to the /flash device using an SFTP client with access to the system.
Verify that the image file was successfully transferred to the /flash device by running the following Exec mode command:
[local]host_name# directory /flash

The image filename should appear in the displayed output.

Run the show version /flash/image_filename command to verify the build information.
[localhost_name# show version /flash/image_filename.bin

Saving a Copy of the Current Configuration File

Prior to upgrading to a new software release, you should copy and rename the current configuration file to the /flash device and to an off-chassis location (external memory device or network URL). This renamed copy assures that you will have a fallback, loadable configuration file should a problem be encountered during the upgrade.

IMPORTANT:

Configuration files created and saved in StarOS release 12.2 and higher cannot be shared across multiple chassis due to a change in the encryption algorithm for passwords and secrets. These release 12.2 + changes modify encrypted data in the configuration file so that it cannot be recognized by software builds prior to 12.2. If it is necessary to revert to a previous build, the chassis must be booted with the copy of the original configuration file. If this copy is not available, then the chassis must be loaded as if it is a new chassis.

Preparing for a Software Downgrade

Downgrading from Release 12.2 to 12.0

If a software upgrade to release 12.2+ fails, you may need to downgrade to a previous software release, such as 12.0. Since the encryption algorithm for passwords and secrets is difference from 12.0 to 12.2+, you must save the 12.0 configuration file using the obsolete-encryption keyword to preserve passwords and secrets that used the earlier algorithm.

IMPORTANT:

You must save the configuration prior to upgrading to release 12.2+.

The general sequence for a software downgrade in this scenario is as follows:
  • Develop a downgrade plan with the assistance of Cisco support personnel.
  • Save the pre-12.2 configuration using the obsolete-encryption keyword in conjunction with the Exec mode save configuration command as shown in the example.
    [local]host_name# save configuration /flash/v120_system.cfg
    obsolete-encryption
    
    Warning: Use
    of weaker encryption significantly reduces the security of the system 
    
    Are you sure? [Yes|No]: Yes
    
  • To reboot the system using the old configuration, change the boot configuration via the Global Configuration mode to use the old boot image and its previously saved configuration. See the example below.
    [local]host_name(config)# boot system priority
    1 image /flash/v120_asr5000.bin
    config /flash/v120_system.cfg
    
  • Reload the system using the pre-12.2 image and configuration.
  • Once the system has reloaded, verify that the configuration is correct.
  • Save the current configuration as a backup once the configuration has been validated.

Downgrading from Release 15.0 to 14.0

Release 14 and Release 15 chassis IDs use different encryption formats. Release 15 will recognize a Release 14 chassis ID and consider it as valid. Upgrading from 14.x to 15.0 will not require changing the chassis ID or configuration file.

However, if the chassis key is reset in Release 15 through the setup wizard or chassis-key CLI command, a new chassis ID will be generated in Release 15 format (44 instead of 16 characters). Release14 builds will not recognize the 44-character chassis ID. If the chassis is subsequently downgraded to Release 14, a new 16-character chassis ID will be generated. To accommodate the old key format, you must save the configuration file in pre-v12.2 format before the downgrade. If you attempt to load a v15 configuration file on the downgraded chassis, StarOS will not be able to decrypt the password/secrets stored in the configuration file.

Software Upgrade Methods

Occasional software upgrades are required to add features and/or functionality, and to correct any previous defects. There are two software upgrade methods used to add features, functionality, and correct known software defects. They are:

A brief overview accompanies each upgrade procedure.

On-Line Software Upgrade

This method is used to perform a software upgrade of the entire operating system.

IMPORTANT:

This method is not supported for the SGSN or for PDIF. Refer to the appropriate Administration Guide for upgrade information.

This method allows active sessions to be maintained until they are either self-terminated (subscriber ends session) or meet the optionally defined upgrade limit values.

This method upgrades all standby packet processing cards simultaneously, then upgrades any active cards simultaneously.

No new sessions will be accepted by the system during an on-line software upgrade. For PDSN and GGSN: All new session requests are blocked from entering the system through the use of an overload policy. Failure to configure this policy to redirect calls elsewhere can result in a significant service outage.

CAUTION:

To minimize the risk of service outages, the on-line software upgrade should be performed during a planned maintenance window.

An on-line software upgrade is performed in five stages, where each stage is limited to performing only specific functions until the system is prepared to move to the next stage. Each stage is explained below.

System Requirements to Support the On-line Software Upgrade Method

A system requires a minimal amount of hardware to support this software upgrade method. The minimum required application cards are:
  • Two SMCs (one Active and one Standby)
  • Two RCCs (required to support packet processing card migrations)
  • Three packet processing cards (one must be a standby, but two standby cards are recommended)

If your system does not meet this minimal system requirement, then this method of software upgrade cannot be supported and you must use the Off-line Software Upgrade method.

CLI Verification and System Preparation

After initiating the upgrade command, before beginning Stage 1 of the on-line software upgrade process the system performs a series of checks and procedures. These include:
  • Verifying that an open boot priority is available in the boot stack.
  • Ensuring that the current local file system is synchronized.
  • Creating the new boot stack entry using the new operating system image, boot priority, and configuration file information.
  • Performing an SMC synchronization of the new local file system.
  • Creating a temporary copy of the configuration that is currently running on the system. This configuration may or may not match the saved CLI configuration file that is named in the boot stack entry. This temporary copy is re-applied to the system during Stage 5 of the on-line software upgrade process.

If any errors are detected during this verification process, the on-line software upgrade is aborted and an error message is displayed.

Stage 1 - Soft Busy-out

The system remains in this Stage 1 until either all current sessions are self-terminated by users or the configured session upgrade limits are reached. In the latter case, when one of the two upgrade limits are reached, the system will automatically terminate all sessions that meet the time limit (maximum session life) or, when the usage limit (minimum number of sessions) on the system is met and all sessions are terminated.

For PDSN and GGSN: During this stage, all Session Manager tasks on the system are busied out and incoming session requests are redirected to other systems or rejected by the system, based on the configured overload policy for each service.

IMPORTANT:

This is the only stage in which the abort upgrade command may be used. Once Stage 2 is entered, the on-line software upgrade should not be cancelled unless an emergency exists. After Stage 1, the only way that an on-line software upgrade can be terminated is to issue the reload command. This causes a system restart that could leave the system in an abnormal state, requiring manual intervention. Issuing the reload command should be avoided, and only used as a last resort.

Once all the calls on the system are terminated, the software upgrade enters Stage 2.

Stage 2 - Stand-alone Operation

In stage 2, the system switches from normal call operations, leaving only a minimal set of system-level tasks running on the packet processing cards to ensure that any errors are detected and that the re-directors used by the defined overload policy for each service remain in effect.

At this point, the SMCs are fully operational, but each packet processing card in the system is running independently of the others, with no communications occurring between them. In this stage, the network processor units (NPUs) are placed into global bypass mode, wherein the redirector tasks are supported to deny any new session requests to access the system by redirecting them to other devices.

While in global bypass mode, Line Card (LC) ports will be limited to the following services:
  • Respond to Ethernet ARP requests
  • Respond to ICMP echo requests
  • Session rejections or redirection
The following list defines LC features or services that will be unavailable:
  • No AAA packets or logs will be sent for each session reject or redirect
  • All other packets are discarded
  • Port counters will be unavailable
  • Port redundancy operations, if configured, will not be operational
  • All routing protocols, if enabled and configured, will be disabled
  • Routing tables will remain fixed (no updates) throughout the upgrade
  • PCF monitoring will be unavailable

    IMPORTANT:

    Once Stage 2 has begun, no CLI configuration mode commands, except end and exit (if this stage is entered while a management user is in a configuration mode) will be accepted by the system. Only non-configuration commands within the Exec mode, such as show commands may be executed. You can monitor the progress of the on-line software upgrade by entering the show upgrade command.

Once all of the packet processing cards are operating in stand-alone mode, the on-line software upgrade can proceed.

Stage 3 - Management Card Upgrade

During this stage, the system performs an SMC switchover, wherein all tasks running on the active SMC are transferred to the standby SMC, which then becomes active and takes control of the system.

The new standby SMC is then restarted and the new operating system software image is loaded onto that SMC. It is important to note that the full CLI configuration that was temporarily saved by the system is not loaded at this point. Instead, only minimal commands used to control the system are loaded.

Once this SMC is operational, another SMC switchover occurs and the second SMC is restarted, loading the new software version. During this period, since both SMC are effectively now running the new operating system software image, the system can continue to perform the on-line software upgrade process without waiting until the last SMC finishes booting up and is placed into its normal standby operational mode.

Stage 4 - Reboot All Packet Processing Cards

In this stage, the active SMC is aware of all system and card-level states and tasks. All packet processing cards that are in standby operational mode are restarted simultaneously, and after passing their Power On Self Test (POST) diagnostics, their control processors (CPs) are loaded with the new operating system software image.

The remaining packet processing cards, which may be enforcing overload policies that prevent any new sessions from entering the system, are then migrated to the cards that are running the new operating system software. The overload policies and minimal system tasks continue running on the newly upgraded packet processing cards. The original active packet processing cards are then restarted, all at once, and upgraded to the new operating system software image.

IMPORTANT:

The system will only migrate as many active packet processing cards as there are standby cards. If this is not a 1:1 correlation, the system will repeat this procedure of migrating - updating - migrating back until all normally active packet processing cards have been upgraded.

Once all of the cards have been upgraded and returned to their desired (normal) operating states, the system can proceed to the final stage of the on-line software upgrade procedure.

Stage 5 - Return System to Normal Operation

In this stage, all cards are running the new operating system software, but the full CLI configuration file that was created at the beginning of the upgrade has not yet been re-loaded and all network processor units (NPUs) are still operating in global bypass mode.

The system begins loading the temporary CLI configuration file that was created at the beginning of the on-line software upgrade. This process can take over a minute to complete, depending on the size and complexity of the configuration file. As this process begins, the NPUs are programmed and all normal tasks are brought on-line, even though they are still in global bypass mode.

Once the configuration is fully loaded, returning the system to its pre-upgrade configuration, the system will switch the NPUs from global bypass mode. This cancels all redirection tasks configured by the overload policies, and the system can once again begin accepting new sessions.

Performing an On-line Software Upgrade

This procedure describes how to perform a software upgrade using the on-line software upgrade method. This procedure assumes that you have a CLI session established and are placing the new operating system image file onto the local file system.

Optional for PDSN: If you want to use the IP Pool Sharing Protocol during your upgrade, refer to Configuring IPSP Before the Software Upgrade in the PDSN Administration Guide.

To begin, make sure you are at the Exec mode prompt.
[local]host_name# 

  1. Verify that there is enough free space on the device to accommodate the new operating system image file by entering the following command:
    directory { /flash | /pcmcia1 | /hd-raid }
    
    The following is an example of the type of directory information displayed:
    -rwxrwxr-x
       1 root     root         7334 May  5  2012 startconfig.cfg
    
    -rwxrwxr-x
       1 root     root          399 Jun  7 18:32 system.cfg
    
    -rwxrwxr-x
       1 root     root        10667 May 14 16:24 testconfig.cfg
    
    -rwxrwxr-x
       1 root     root        10667 Jun  1 11:21 testconfig_4.cfg
    
    -rwxrwxr-x
       1 root     root         5926 Apr  7  2012 tworpcontext.cfg
    
    -rwxrwxr-x
       1 root     root        15534 Aug  4  2012 test_vlan.cfg
    
    -rwxrwxr-x
       1 root     root         2482 Nov 18  2011 gateway2.cfg
    
    94844   /flash
    
    Filesystem        
      1k-blocks      Used Available Use% Mounted on
    
    /dev/hda1
                  124778     94828     29950  76% /flash
    
    Note the “Available” blocks in the last line of the display. After displaying the directory information, it again returns to the root and the following prompt appears:
    [local]host_name#
    
  2. View the boot stack entries and note the name and location (local device) of the CLI configuration file for the first entry (highest priority) by entering the following command:
    [local]host_name# show boot
    
  3. Verify that there are less than 10 boot stack entries in the boot.sys file and that a higher priority in the boot stack is available (minimally there is no priority 1 entry in the boot stack). Refer to Configuring the Boot Stack for more information. The system will automatically create a new boot stack entry for this software, using the <N-1> method, wherein the new entry will have a priority of one less than the previous entry (currently used).
  4. Using either an FTP client or the copy command, transfer the new operating system software image file to the location (network server or local device from where it will be loaded by the system). For information on how to use the copy command, please reference the Copying Files and Directories section.

    CAUTION:

    When transferring an operating system software image file via file transfer protocol (FTP), the FTP client must be configured to transfer the file using binary mode. Failure to use binary transfer mode will render the transferred operating system image file unusable.

  5. Back up the current CLI configuration file by entering the following command:
    [local]host_name# copy from_url to_url [-noconfirm]
    
    For information on using the copy command, please see the Copying Files and Directories section. The following command example creates a backup copy of a file called general.cfg located on the /flash device to a file called general_3652.cfg:
    [local]host_name# copy /flash/general.cfg /flash/general_3652.cfg
    
  6. Synchronize the local file systems on the management cards by entering the following command:
    [local]host_name# filesystem synchronize all
    
  7. Enter the Global Configuration mode by entering the following command:
    configure
    
    The following prompt appears:
    [local]host_name(config)#
    
  8. For PDSN and HA services, configure an overload policy for each service that redirects new session requests to other devices or rejects them as given procedure below.
    1. Enter the Context Configuration mode by entering the following command:
      [local]host_name(config)# context context_name
      
      The following prompt appears:
      [context_name]host_name(config-ctx)#
      
    2. Enter the Service Configuration mode for the service to be configured by entering the following command:
      [context_name]host_name(config-ctx)# { pdsn-service | ha-service } service_name
      
      The following prompt appears:
      [context_name]host_name(config-service_type-service)#
      
    3. Configure the overload policy for this service by entering the following command:
      [context_name]host_name(config-service_type-service)# policy { overload { redirect ipv4_address [ weight weight_num ] [ ipv4_address2 [ weight weight_num ]...ipv4_address16 [ weight weight_num ] ] | reject [use-reject-code
      insufficient-resources] } 
      
      For complete information about the above command, see the Context Configuration Mode Commands chapter of the Command Line Interface Reference.

      IMPORTANT:

      An overload policy must be defined for each service configured in the system.

    4. Repeat step c to configure the overload policy for another configured service.
  9. Return to the Exec mode prompt by entering the following command:
    end
    
    The following prompt appears:
    [local]host_name#
    

    CAUTION:

    Once the software upgrade process has started, any failure that results in the reboot of the system prior to the upgrading of both SMCs may result in unexpected behavior by the system that requires manual intervention to correct.

  10. Save your configuration as described in the Verifying and Saving Your Configuration chapter.
  11. Begin the on-line software upgrade by entering the following command:
    [local]host_name# upgrade online image_url config cfg_url [-noconfirm]
    
    The SMCs within the system load the new operating system image and the local file system is synchronized. The system then updates all standby packet processing cards. Next, it begins to update each active packet processing card, one at a time. The system monitors all sessions being processed by active packet processing cards. When all sessions facilitated by a specific Session Manager task are either self-terminated or automatically terminated based on the thresholds configured in step 8, the system migrates the packet processing cards in active mode to standby mode. Each new standby packet processing card is upgraded and rebooted. Once booted, the card is placed back into service as an active packet processing card. For complete information about the above command, see the Exec Mode Commands chapter of the Command Line Interface Reference.
  12. Optional: To view the status of an on-line software process, enter the following command from the Exec mode prompt:
    [local]host_name# show upgrade
    
    This command displays the status of the on-going on-line software upgrade. Once all SMCs have been upgraded, the full configuration file is loaded, the NPUs are taken out of global bypass mode, and the system is returned to normal operation. When the on-line software upgrade has been completed, all sessions on the system will be new and all system statistics will have been reset.Upon completion of the software upgrade, the system will automatically begin accepting new sessions, using the pre-existing configuration that was running. All system statistical counters will have been reset to zero.

Aborting an On-line Software Upgrade

Abort the on-line software upgrade process by entering the following command:

[local]host_name# abort upgrade [-noconfirm]

IMPORTANT:

The abort upgrade command can only be used during Stage 1 (busy-out) of an on-line software upgrade.

Restoring the Previous (Pre-online Upgrade) Software Image

If for some reason you need to restore the system to the software image that was running before the online upgrade process, perform the On-Line Software Upgrade again and specify the locations of the original software image and configuration files.

Off-line Software Upgrade

An off-line software upgrade can be performed for any system, upgrading from any version of operating system software to any version, regardless of version number. This process is considered off-line because while many of the steps can be performed while the system is currently supporting sessions, the last step of this process requires a reboot to actually apply the software upgrade.

This procedure assumes that you have a CLI session established and are placing the new operating system image file onto the local file system. To begin, make sure you are at the Exec mode prompt:
[local]host_name#

Configure a Newcall Policy

Configure a newcall policy from the Exec mode to meet your service requirements. When enabled the policy redirects or rejects new calls in anticipation of the chassis reload that completes the upgrade process. This reduces the amount of service disruption to subscribers caused by the system reload that completes the upgrade.

IMPORTANT:

Newcall policies are created on a per-service basis. If you have multiple services running on the chassis, you can configure multiple newcall policies.

The syntax for newcall policies is described below:
[local]host_name# newcall policy { asngw-service | asnpc-service | sgsn-service } { all | name  service_name } reject
[local]host_name# newcall policy cscf-service { all | name service_name }  { redirect target_ip_address [ weight weight_num ] [ target_ipaddress2 [ weight weight_num ] ... target_ip_address16 [ weight weight_num ] | reject }
[local]host_name# newcall policy { fa-service | lns-service | mipv6ha-service } { all | name service_name } reject
[local]host_name# newcall policy { ha-service | pdsn-service} { all | name service_name }  { redirect target_ip_address [ weight weight_num ] [ target_ipaddress2 [ weight weight_num ] ... target_ip_address16 [ weight weight_num ] |reject}
[local]host_name# newcall policy ggsn-service { apn name apn_name |  all | name service_name} reject
[local]host_name# newcall policy hnbgw-service { all | name service_name} reject
[local]host_name# newcall policy { pcc-af-service | pcc-policy-service } {all | name service_name} reject
[local]host_name# newcall policy {pcc-af-service | pcc-policy-service } { all | name service_name } reject
[local]host_name# newcall policy mme-service { all | name
 service_name } reject

For complete information about the above command, see the Exec Mode Commands chapter of the Command Line Interface Reference.

Configure a Message of the Day Banner

Optional: Configure a “Message of the Day” banner informing other management users that the system will be rebooted by entering the following command from the Global Configuration mode prompt.
[local]host_name(config)# banner motd “banner_text”

banner_text is the message that you would like to be displayed and can be up to 2048 alphanumeric characters. Note that banner_text must begin with and end in quotation marks (“ “). For more information in entering CLI banner information, see the CLI Reference. The banner is displayed when an administrative user logs onto the CLI.

Back up the Current CLI Configuration File

Back up the current CLI configuration file by entering the following command:
[local]host_name# copy from_url to_url [-noconfirm]

This creates a mirror-image of the CLI configuration file linked to the operating system defined in the current boot stack entry.

The following command example creates a backup copy of a file called general.cfg located on the /flash device to a file called general_3652.cfg:
[local]hcopost_name# copy /flash/general.cfg /flash/general_3652.cfg

Create a New Boot Stack Entry

Create a new boot stack entry for the new file group, consisting of the new operating system image file and the currently used CLI configuration file by entering the following Global Configuration command:
[local]host_name(config)# boot system priority number image image_url /flash/filename config cfg_url /flash/filename

Assign the next highest priority to this entry, by using the <N-1> method, wherein you assign a priority number that is one number less than your current highest priority.

IMPORTANT:

Run the Exec mode show boot command to verify that there are less than 10 entries in the boot.sys file and that a higher priority entry is available (minimally there is no priority 1 entry in the boot stack).

If priority 1 is in use, you must renumber the existing entries to ensure that at least that priority is available.

The maximum number of boot stack entries that can be contained in the boot.sys file is 10. If there are already 10 entries in the boot stack, you must delete at least one of these entries (typically, the lowest priority) and, if necessary, renumber some or all of the other entries before proceeding. Use the no boot system priority command to delete a book stack entry.
[local]host_name# configure
[local]host_name(config)# no boot system priority number
To add new boot stack entries to the boot.sys file enter the following commands:
[local]host_name# configure
[local]host_name(config)# boot system priority number image image_url config cfg_url

For information on using the boot system priority command, refer to the Adding a New Boot Stack Entry section.

Synchronize File Systems

Synchronize the local file systems on the management cards by entering the following command:
[local]host_name# filesystem synchronize
all 

Save the Running Configuration

Save the currently running, upgraded configuration prior to rebooting the chassis.

To save the running configuration to the current configuration file:
[local]host_name# save configuration /flash

Reboot the Chassis

Reboot the chassis by entering the following command:
[local]host_name# reload [-noconfirm]

As the system reboots, it loads the new operating system software image and its corresponding CLI configuration file using the new boot stack entry configured earlier.

After the system reboots, establish a CLI session and enter the show version command to verify that the active software version is correct.

Optional for PDSN: If you are using the IP Pool Sharing Protocol during your upgrade, refer to Configuring IPSP Before the Software Upgrade in the PDSN Administration Guide.

Verify the Running Software Version

After the system has successfully booted, verify that the new StarOS version is running by executing the Exec mode show version command.
[local]host_name# show version

Restoring the Previous Software Image

If for some reason you need to undo the upgrade, perform the upgrade again except:

  • Specify the locations of the upgrade software image and configuration files.
then
  • Specify the locations of the original software image and configuration files.

Upgrading ICSR Chassis

The procedure for upgrading primary and backup ICSR chassis is described in the Interchassis Session Recovery chapter. Essentially the procedure requires upgrading the primary and standby chassis using the off-line method while each is in standby mode.

Performing Dynamic Software Updates

StarOS allows the runtime loading of plugins. All StarOS builds include a “default” baseline plugin.

This feature is currently used to dynamically update the detection logic used to filter P2P applications via the Application Detection and Control (ADC) feature.

Patching is the process used to install a plugin as an incremental update to a StarOS release. One plugin can be provided to multiple, compatible, concurrent product releases. A plugin is distributed in the form of a compressed distribution kit via the internet or by other means (USB stick, CD, etc.).

A plugin is a functional software entity that provides incremental updates to a pre-existing StarOS software component. Plugins have the characteristic of being dynamically loadable at runtime and do not require a system restart. A plugin has a name and one or more versions. All plugin names are known to the system at product release.

For complete information on the Dynamic Software Update process, refer to the ADC Administration Guide.

Managing License Keys

License keys define capacity limits (number of allowed subscriber sessions) and available features on your system. Adding new license keys allows you to increase capacity and add new features as your subscriber base grows.

New System License Keys

New systems are delivered with no license keys installed. In most cases, you receive the license key in electronic format (usually through mail).

When a system boots with no license key installed a default set of restricted session use and feature licenses is installed. The following Exec Mode command lists the license information:
[local]host_name# show license information

IMPORTANT:

With no license key installed, the session use licenses for PDSN, HA, GGSN, and L2TP LNS are limited to 10,000 sessions.

SMCs are shipped with a CompactFlash card installed. A single license key is generated using the serial numbers from the CompactFlash cards. If two SMCs are installed, the license key is generated from the serial numbers of both CompactFlash cards. This allows the license to be distributed across both SMCs, ensuring that licensed capacity and features remain available during a switchover event.

Session Use and Feature Use Licenses

Session use and feature use licenses are software mechanisms that provide session limit controls and enable special features within the system. These electronic licenses are stored in the system's configuration file that is loaded as part of the system software each time the system is powered on or restarted.
  • Session use licenses limit the number of concurrent sessions that a system is capable of supporting per service type and are acquired on an as-needed basis. This allows carriers to pay only for what they are using and easily increase capacity as their subscriber base grows.
  • Feature use licenses enable specific features/functionality within the system and are distributed based on the total number of sessions supported by the system.

Installing New License Keys

Use the instructions below to install a new license key.

Cutting and Pasting the Key

If you have a copy of the license, use the following configuration to cut and paste just the license key part:

  1. From the Exec mode, enter the following:
    configure
    
       license key license
    
       exit
    
    license is the license key string. The license can be an alphanumeric string of 1 through 1023 characters that is case sensitive. Copy the license key as shown in the example below, including the “\ (double-quote slash). Please note: this is not a functional license.
    "\
    
    VER=1|C1M=000-0000-00|C1S=03290231803|C2M=11-1111-11-1|C2S=\STCB21M82003R80411A4|DOI=0000000000|DOE=00000000|ISS=1|NUM=13459|0000000000000|LSP=000000|LSH=000000|LSG=500000|LSL=500000\|FIS=Y|FR4=Y|FPP=Y|FCS=Y|FTC=Y|FMG=Y|FCR=Y|FSR=Y|FPM=Y|FID=Y|SIG=MCwCF\Esnq6Bs/XdmyfLe7rHcD4sVP2bzAhQ3IeHDoyyd6388jHsHD99sg36SG267gshssja77
    
    end
    
  2. Verify that the license key just entered was accepted by entering the following command at the Exec mode prompt:
    [local]host_name# show license key
    
    The new license key should be displayed. If it is not, return to the Global configuration mode and re-enter the key using the license key command.
  3. Verify that the license key enabled the correct functionality by entering the following command:
    [local]host_name# show license information
    
    All license keys and the new session capacity or functionality enabled should be listed. If the functionality or session capacity enabled by the new key is incorrect, please contact your service representative.
  4. Save your configuration as described in the Verifying and Saving Your Configuration chapter.

    CAUTION:

    Failure to save the new license key configuration in the current CLI configuration file will result in the loss of any of the new features enabled by the license key once the system is reloaded.

Adding License Keys to Configuration Files

License keys can be added to a new or existing configuration file.

IMPORTANT:

License key information is maintained as part of the CLI configuration. Each time a key is installed or updated, you must re-save the configuration file.

  1. Open the configuration file to which the new license key commands are to be copied.
  2. Copy the license as shown in the example, including the “\ (double-quote slash). Please note: this is not a functional license.
    "\
    
    VER=1|C1M=000-0000-00|C1S=03290231803|C2M=11-1111-11-1|C2S=\STCB21M82003R80411A4|DOI=0000000000|DOE=00000000|ISS=1|NUM=13459|0000000000000|LSP=000000|LSH=000000|LSG=500000|LSL=500000\|FIS=Y|FR4=Y|FPP=Y|FCS=Y|FTC=Y|FMG=Y|FCR=Y|FSR=Y|FPM=Y|FID=Y|SIG=MCwCF\Esnq6Bs/XdmyfLe7rHcD4sVP2bzAhQ3IeHDoyyd6388jHsHD99sg36SG267gshssja77
    
    end
    
  3. Paste the license key into the configuration

    IMPORTANT:

    Paste the license key information at the beginning of the configuration file to ensure the system has the expected capacity and features before it configures contexts.

  4. Save your configuration as described in the Verifying and Saving Your Configuration chapter.

License Expiration Behavior

When a license expires, there is a built-in grace period of 30 days that allows normal use of the licensed session use and feature use licenses. This allows you to obtain a new license without any interruption of service.

The following Exec mode command lists the license information including the date the grace period is set to expire:
[local]host_name# show license information  

Requesting License Keys

License keys for the system can be obtained through your Cisco account representative. Specific information is required before a license key may be generated:

  • Sales Order or Purchase Order information
  • Desired session capacity
  • Desired functionality
  • CompactFlash detail
To obtain the model and serial number of a CompactFlash card, enter the following command at the Exec mode prompt:
[local]host_name# show card hardware slot_number 

Where slot# is either 8 or 9, depending on the chassis card slot where the SMC is installed.

Look under the “Compact Flash” heading for “Serial Number” as shown in the example below:
  Compact Flash            : Present
    Type                   : 128M
disk
    Model                  : TOSHIBATHNCF128MBA 
    Serial number          : RSTCB21M82003R80411A4 

Viewing License Information

To see the license detail, enter the following command from the Exec mode:

[local]host_name# show license information [ full | key [ full ] ] 

Deleting a License Key

Use the procedure below to delete the session and feature use license key from a configuration. You must be a security administrator or administrator.

configure
   no license key
   exit
[local]host_name# show license key

The output of this command should display: “No license key installed”.

Management Card Replacement and License Keys

In the event that an individual SMC is replaced, the CompactFlash card on the new SMC must be exchanged with the CompactFlash from the original SMC because the license key was generated based on the serial number of the CompactFlash card associated with the original SMC.

Exchanging the two CompactFlash card modules ensures that license redundancy is maintained, as the license key will continue to match both CompactFlash serial numbers on both SMCs.

IMPORTANT:

Failure to provide license key redundancy can result in the loss of session capacity and enhanced features should a failover or manual switchover occur.

Instructions for the removal and installation of the CompactFlash on SMCs can be found in the ASR 5000 Installation Guide.

Managing Local-User Administrative Accounts

Unlike context-level administrative accounts which are configured via a configuration file, information for local-user administrative accounts is maintained in a separate file in flash memory and managed through the software’s Shared Configuration Task (SCT). Because local-user accounts were designed to be compliant with ANSI T1.276-2003, the system provides a number of mechanisms for managing these types of administrative user accounts.

Configuring Local-User Password Properties

Local-user account password properties are configured globally and apply to all local-user accounts. The system supports the configuration of the following password properties:
  • Complexity: Password complexity can be forced to be compliant with ANSI T1.276-2003.
  • History length: How many previous password versions should be tracked by the system.
  • Maximum age: How long a user can use the same password.
  • Minimum number of characters to change: How many characters must be changed in the password during a reset.
  • Minimum change interval: How often a user can change their password.
  • Minimum length: The minimum number of characters a valid password must contain.

Refer to the local-user password command in the Global Configuration Mode Commands chapter of the Command Line Interface Reference for details on each of the above parameters.

Configuring Local-User Account Management Properties

Local-user account management includes configuring account lockouts and user suspensions.

Local-User Account Lockouts

Local-user accounts can be administratively locked for the following reasons:
  • Login failures: The configured maximum login failure threshold has been reached. Refer to the local-user max-failed-logins command in the Global Configuration Mode Commands chapter of the Command Line Interface Reference for details
  • Password Aging: The configured maximum password age has been reached. Refer to the local-user password command in the Global Configuration Mode Commands chapter of the Command Line Interface Reference for details.

Accounts that are locked out are inaccessible to the user until either the configured lockout time is reached (refer to the local-user lockout-time command in the Global Configuration Mode Commands chapter of the Command Line Interface Reference) or a security administrator clears the lockout (refer to the clear local-user command in the Exec Mode Commands chapter of the Command Line Interface Reference).

IMPORTANT:

Local-user administrative user accounts could be configured to enforce or reject lockouts. Refer to the local-user username command in the Global Configuration Mode Commands chapter of the Command Line Interface Reference for details.

Local-User Account Suspensions

Local-user accounts can be suspended as follows:

configure
   suspend local-user name
A suspension can be removed by entering:
configure
   no suspend local-user name

Changing Local-User Passwords

Local-user administrative users can change their passwords using the password change command in the Exec mode. Users are prompted to enter their current and new passwords.

Security administrators can reset passwords for local-users by entering the following command from the root prompt in the Exec mode:
[local]host_name# password change username name

name is the name of the local-user account for which the password is to be changed. When a security administrator resets a local-user’s password, the system prompts the user to change their password the next time they login.

All new passwords must adhere to the password properties configured for the system.