CBI application does not respond to CLI commands if running-config is out of sync

book

Article ID: 168065

calendar_today

Updated On:

Products

XOS

Issue/Introduction

CBI application does not respond to CLI commands if running-config is out of syncThere are two possible symptoms:

1. The application can not be managed using the CLI application commands even though the application software is installed on the VAP group. The show application vap-group command will not list the application. In addition, the following error message appears after an application command is executed (for vpn1 in this example):

ERROR: Application "vpn1" is not available.
2. The application appears to be installed from the CLI output, but the application software is not actually installed on the VAP group. In this case, show application vap-group lists the application as installed, but all application commands fail to successfully complete.

Cause

Problem:
The problem occurs when the application metadata stored in the running-config database becomes out of sync with what is actually installed on the vap-group. This problem can only occur if the CPM was reloaded after installing or uninstalling an application without saving the running-config to startup-config. Below are the two cases which can cause this problem.

Case 1
1. Configure a vap-group
2. Save the running-config to startup-config
3. Install an application
4. Reload the CPM without saving the running-config to startup-config

The application software is installed on the VAP group, but from the CLI it appears to be not installed.

Case 2
1. Install the application
2. Save the running-config
3. Uninstall the application
4. Reload the CPM without saving the running-config to startup-config

The application software is not installed on the VAP group, but from the CLI it appears to be installed.

Resolution

Solution:
This issue can be avoided by saving the running-config to startup-config after installing or uninstalling an application. In XOS 8.5 and later, the CLI will prompt the user to save the running-config after an application install and uninstall.

If you find you have one of these problems, you can work around it with the following procedures. The workaround involves adding or removing application metadata in the running-config database to resynchronize it with the VAP group. For Case 1 described above, you must insert metadata, and for Case 2 you must delete metadata. The methods you use depend on your version of XOS.

Note: For systems with cpm-redundancy, the recovery procedure should only be executed on the primary CPM.

The procedures below show how to add or remove application metadata from the running-config database for application vpn1on a VAP group called vgv3.

Case 1 for XOS 7.3 and 8.0:

The application metadata can be inserted by running the appdb.py script. Download this script to the CPM and make sure it is executable.

Note: In the following procedures, the syntax you type is shown in bold.

1. Determine the application ID using the show application CLI command.

CBS# show application
App ID : vpn1
Name : VPN-1 Power
Version : NGXR65
Release : 1.0.2.0-5
CBI Version : 1.0.2.0

2. From the Unix prompt on the CPM, run the following command to insert the application metadata using the App ID from step 1.
# ./appdb.py --appid=vpn1 --vapgroup=vgv3 insert
Inserted metadata using vpn1-NGXR65-1.0.2.0-5.cbi
 

3. Save the running-config to startup-config to ensure the metadata is saved.
 
CBS# copy running-config startup-config
 

Case 2 for XOS 7.3 and 8.0:

The procedure to delete application metadata from the running-config database is similar to inserting metadata except that in step 2 call appdb.py with the delete argument.


1. Determine the application ID using the show application CLI command.

CBS# show application
App ID : vpn1
Name : VPN-1 Power
Version : NGXR65
Release : 1.0.2.0-5
CBI Version : 1.0.2.0
 

2. From the Unix prompt on the CPM, run the following command to delete the application metadata using the App ID from step 1.
# ./appdb.py --appid=vpn1 --vapgroup=vgv3 delete
Deleted metadata using vpn1-NGXR65-1.0.2.0-5.cbi
 

3. Save the running-config to startup-config to ensure the update is saved.

CBS# copy running-config startup-config

Case 1 for XOS 8.1:

The application metadata can be inserted by running the appmgr.py script (included with XOS 8.1) when called with the --justdb argument. The following procedure shows how to insert the application metadata.


1. Determine the application ID using the show application CLI command.

CBS# show application
App ID : vpn1
Name : VPN-1 Power
Version : NGXR65
Release : 1.0.2.0-5
CBI Version : 1.0.2.0
 

2. From the Unix prompt on the CPM, run the following command to insert the metadata using the App ID from step 1.

# /crossbeam/bin/appmgr.py --appid=vpn1 --vapgroup=vgv3 --justdb install

3. Save the running-config to startup-config to ensure the metadata is saved.

CBS# copy running-config startup-config

Case 2 for XOS 8.1:

The procedure to delete application metadata from the running-config database is similar to inserting metadata except that in step 2 call appmgr.py with the uninstall argument.


1. Determine the application ID using the show application CLI command.

CBS# show application
App ID : vpn1
Name : VPN-1 Power
Version : NGXR65
Release : 1.0.2.0-5
CBI Version : 1.0.2.0
 

2. From the Unix prompt on the CPM, run the following command to delete the metadata using the App ID from step 1.

# /crossbeam/bin/appmgr.py --appid=vpn1 --vapgroup=vgv3 --justdb uninstall
3. Save the running-config to startup-config to ensure the metadata is saved.

CBS# copy running-config startup-config

The technical bulletin is attached in PDF format, and the script file appdb.py is also attached.

Workaround

N/A