Install VCS Option Key Via Web Interface and CLI Configuration Example

Introduction

This document describes the installation of an option key on a Cisco Video Communication Server (VCS) via Web Interface and Command Line Interface (CLI).

Prerequisites

Requirements

Cisco recommends that you have knowledge of these topics:

• VCS Installation
• Have successfully installed the VCS and have applied a valid IP address that is reachable via web interface and or CLI
• Have applied for and received a release key valid for the VCS serial number
• Have access to the VCS with an admin account by web interface or CLI

Note: Installation guides can be found here: http://www.cisco.com/c/en/us/support/unified-communications/telepresence-video-communication-server-vcs/products-installation-guides-list.html

Components Used

The information in this document is based on these software versions:

• VCS Version x8.7.3
• VCS Control x7.X and x8.X releases
• VCS Expressway x7.X and x8.X releases
• PuTTY (terminal emulation software)
• Alternatively, you could use any terminal emulation software that supports Secure Shell (SSH) such as Secure CRT, TeraTerm and so on.
• Licensing email with an Option Key.
• A web browser, such as Firefox, Internet Explorer or Chrome.

The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, make sure that you understand the potential impact of any command.

Configure

Web Interface Option Key Installation Example

This web interface example video supplements this document.

Step 1. Once you have installed your VCS, have your serial number and applied for your option keys with the use of your Product Authorization Key (PAK) and serial number, you will receive a license email from the Cisco Licensing team which contains a release key and option keys. Here’s an example of what you receive and how to find the option keys.

Note: Examples of PAK are outside the scope of this document.

Example Licensing Email

Step 2. Log into web interface with an admin account, Navigate to Maintenance > Option Keys as shown in the image.

Step 3. Copy the option key from the email you received and paste it in the Add option Key field and click Add option as shown in the image.

Caution: Add the option key in the field Add Option key. It is a common mistake to add an option key in the Release key field which causes an error.

Note: When you add an option key to a VCS, it takes effect immediately. A restart is NOT required.

CLI Option Key Configuration Example

Step 1. Open a CLI SSH session as shown in the image.

Step 2. Log in with an admin account and enter the admin password when prompted.

Step 3. Enter the command, xCommand OptionKeyAdd Key: <option key> as shown in the image.

Caution: Add the option key in the field Add Option key. It is a common mistake to add an option key in the Release key field which causes an error.

Note: When you add an option key to a VCS, it takes effect immediately. A restart is not required.

Verify

Use this section in order to confirm that your configuration works properly.

Add an option key. Observe at the top of the Option Keys page, a banner is displayed that states Option key added and the key is displayed in the Key list as shown in the image.

Troubleshoot

This section provides information you can use in order to troubleshoot your configuration.

Add a key and you see an error, “Unable to add option key” as shown in the image.

• Confirm that you correctly copy the alpha-numeric chain that it is an option key value. Ensure there were no extra spaces or characters.
• Confirm that you apply the option key to the correct VCS or Expressway. The option keys are matched to the device serial number.
• Confirm you add the option key in the Add option key field and not the Release key field. The VCS accepts the option key in the Release Key field and prompt for a restart as shown in the image.

Note: When you add an option key to a VCS, it takes effect immediately. A restart is not required.

Observe after restart, a banner pops up with an error "Invalid release key" as shown in the image.

Install the release key and option key in the correct fields and restart the VCS again to correct this issue.

If you encounter errors after you confirm the procedures documented in the Troubleshoot section of this document, contact Cisco TAC.