Using the TUI Upgrade Utility to Update an Existing Release 2.4 Server
First Published: November 4, 2011
Note Do not use the information in this module to perform an upgrade from Cisco StadiumVision Director Release 2.3 to Release 2.4. For more information about how to perform that upgrade, see the "Upgrading a Cisco StadiumVision Director Server From Release 2.3 to Release 2.4" module.
This module describes how to upgrade an existing server already running Cisco StadiumVision Director Release 2.4 to a more recent 2.4 version, including installation of service packs. This procedure is also referred to generally as an ISO upgrade to refer to both the service pack and upgrade ISO process.
This module includes the following topics:
•Best Practices
•Prerequisites
•Information About Using the TUI Upgrade Utility to Update an Existing Release 2.4 Server
•Upgrade Tasks
•Verifying the Upgrade
•What to Do Next
Best Practices
Before you begin upgrading a Cisco StadiumVision Director server from an existing Release 2.4 version to a more recent 2.4 version, consider the following best practices:
•Choose an appropriate down time to perform the upgrade on the Cisco StadiumVision Director server when there is adequate time to complete and verify the upgrade before any scheduled events and to allow time to resolve any unexpected issues that might occur.
•Refer to the Release Notes for Cisco StadiumVision Director Release 2.4 for the latest information about hardware and software requirements, changes, important notes, and caveats for your software release.
•Pay particular attention to the required hardware and software versions for other devices supporting your Cisco StadiumVision solution and be sure that you upgrade those devices as needed. For example, generally only certain firmware versions are supported for the DMP hardware, or a new firmware version is needed to provide additional functionality supported by the Cisco StadiumVision Director software.
•Perform a backup and restore of the primary and secondary servers:
–Perform a backup of the currently active primary server.
–Restore the backup data onto the standby secondary server.
–Promote the secondary server to primary.
–Access the promoted secondary server to perform the upgrade.
For more information about performing a backup and restore on a Cisco StadiumVision Server running release 2.4, see the Backing Up and Restoring Cisco StadiumVision Director Servers, Release 2.4 guide.
Prerequisites
Note If you are upgrading from Cisco StadiumVision Director Release 2.4.0-118, be sure that you login to the Cisco StadiumVision Director server as a sudo root user and run the following command before you upgrade to a later version of Release 2.4:
$ sudo yum clean all
Be sure that the following requirements are met before you upgrade your server:
•Your server is running a minimum of Cisco StadiumVision Director Release 2.4.0-118 or higher.
Note If you are installing a service pack for release 2.4, you must be running a minimum of Cisco StadiumVision Director Release 2.4.0-147.
•You have the IP address for the Cisco StadiumVision Director server where you want to upload the ISO upgrade image. You will need to use this information as part of the URL to access the ISO upload utility.
•You have a supported browser version for Cisco StadiumVision Director. For more information about the latest supported browsers, see the Cisco StadiumVision Release Notes for Release 2.4.
•You have an installer account on the Cisco StadiumVision Director server.
Information About Using the TUI Upgrade Utility to Update an Existing Release 2.4 Server
The ISO upgrade procedure for Cisco StadiumVision Director Release 2.4 includes the following tasks:
1. Downloading an ISO service pack or upgrade file from the software download site on Cisco.com.
2. Uploading the ISO file from your laptop to the Cisco StadiumVision Director server using the upload utility through your browser.
3. Installing the ISO image using the upgrade utility in the Text Utility Interface (TUI).
ISO Upgrade Files
The ISO upgrade files are stored in the following location:
/var/www/cgi-bin/ISOupload
You can store multiple ISO upgrade files on a Cisco StadiumVision Director server. The files will be displayed with a sequence number and the ISO filename in the TUI upgrade utility for you to select which file to install.
Disk Maintenance
There is no automatic aging of ISO upgrade files or any utility to remove files from the Cisco StadiumVision Director server.
You should periodically maintain your disk storage by manually removing any ISO upgrade files that you no longer need.
Upgrade Tasks
To upgrade your Cisco StadiumVision Director server from Release 2.4 to a newer version of Release 2.4, or a service pack, complete the following tasks:
•Downloading ISO Upgrade Files From Cisco.com (required)
•Uploading an ISO Upgrade File to the Cisco StadiumVision Director Server (required)
•Installing the ISO Upgrade Image on the Cisco StadiumVision Director Server (required)
•Disabling the AIM Software (optional)
•Verifying the Upgrade (required)
Downloading ISO Upgrade Files From Cisco.com
Be sure to download the upgrade files to a location, such as a laptop computer, where you can access them for installation onto the Cisco StadiumVision Director server.
To download an ISO upgrade file, complete the following steps:
Step 1 Go to the Cisco StadiumVision Director software download site at:
http://www.cisco.com/cisco/software/release.html?mdfid=283489263&flowid=25361&softwareid=283866237&release=2.4.0-147
Note This site page is also available from the Cisco StadiumVision Director product support page by clicking Download Software > Cisco StadiumVision Director.
Step 2 Select the ISO service pack or upgrade file for your server model (32- or 64-bit) and optionally, ther companion MD5 checksum file, and download them.
Table 1 shows the filename conventions used for service pack (SP) upgrades for each server model.
Table 1 SP Filename Conventions by Server Hardware 1
|
|
64-bit Model SV-DIRECTOR-K9 or SV-PLATFORM2= |
•SV-DIRECTOR-SPx-2.4.0.x86_64.iso •SV-DIRECTOR-SPx-2.4.0.x86_64.iso.md5sum |
32-bit Model CADE-2140-K9 |
•SV-DIRECTOR-SPx-2.4.0.i386.iso •SV-DIRECTOR-SPx-2.4.0.i386.iso.md5sum |
Table 2 shows the filename conventions used for upgrades for each server model.
Table 2 Upgrade Filename Conventions by Server Hardware
|
|
64-bit Model SV-DIRECTOR-K9 or SV-PLATFORM2= |
•SV-DIRECTOR-UPGRADE-2.4.0-nnn.x86_64.iso •SV-DIRECTOR-UPGRADE-2.4.0-nnn.x86_64.iso.md5sum |
32-bit Model CADE-2140-K9 |
•SV-DIRECTOR-UPGRADE-2.4.0-nnn.i386.iso •SV-DIRECTOR-UPGRADE-2.4.0-nnn.i386.iso.md5sum |
You can download the files using one of the following methods:
•Download both files at one time—Select each file and click Add to Cart. Then at the top of the download page, click the "Download Cart (2 items)" link.
•Download each file independently—Click the Download Now button in the file selection box for each file.
Step 3 (Optional) To verify the integrity of your upgrade file from the download, you can use a command-line or GUI utility on your laptop to calculate the checksum on the .iso file. Open the .md5sum file to compare the value that you calculated with the expected value provided in the .md5sum file.
The values should match. If they do not, retry the download.
Uploading an ISO Upgrade File to the Cisco StadiumVision Director Server
After you have downloaded the ISO upgrade file from Cisco.com, you need to upload the file to the Cisco StadiumVision Director server using a URL from a browser to access the ISO uploader utility. Once you have uploaded the software to the server, then you will use the TUI to install the upgrade image.
Prerequisites
Be sure that you know the IP address of the Cisco StadiumVision Director server where you want to upload the file, and you have a supported browser version for Cisco StadiumVision Director.
To upload an ISO upgrade file to the Cisco StadiumVision Director server, complete the following steps:
Step 1 Open your browser, and to go the following URL, where x.x.x.x is replaced by the IP address of the server where you want to upload the upgrade software (Figure 1):
http://x.x.x.x/cgi-bin/isoupload.cgi
Figure 1 ISO Updater Utility
Step 2 Click Browse (Figure 1).
Step 3 From the File Upload dialog box, navigate to the location of the ISO upgrade file that you downloaded from Cisco.com. Select the file that you want to upload and click Open. Figure 2 shows an example of selection of a 32-bit ISO upgrade file, but you need to upload the appropriate image for your server.
Figure 2 File Upload Dialog Box
Step 4 Click the Upload ISO button (Figure 3). The file is sent to the server.
Caution
The upload might take several minutes. Do
not refresh or reload the ISO Updater page while the upload process is running. Any interruption will corrupt the ISO image being uploaded.
Figure 3 ISO File Selection and Upload
When the ISO upload is complete, one of the following occurs:
•Image integrity is verified before an image is stored on the server. When the image is validated and uploaded successfully, a message is displayed stating that the ISO image has been uploaded.
•The image upload failed for some reason and you will need to retry the upload again.
Installing the ISO Upgrade Image on the Cisco StadiumVision Director Server
To install the ISO upgrade image on the Cisco StadiumVision Director server, complete the following steps:
Step 1 Use a directly connected console, or use an SSH client from a laptop computer that is connected to the Cisco StadiumVision Server network to run a secure login to the Cisco StadiumVision Director server using the IP address for your server.
Step 2 When the login prompt appears, enter the installer userid followed by the installer password at the password prompt.
Step 3 When the StadiumVision Director Configuration menu appears, type q and press Enter (Figure 4):
Figure 4 TUI Main Menu Option for Upgrade of Cisco StadiumVision Server
Step 4 When the upgrade configuration confirmation prompt appears, type c to continue (Figure 5):
Figure 5 TUI Upgrade Configuration Confirmation
Step 5 All of the ISO upgrade files that you have uploaded are displayed with a sequence number and the image name. Type the sequence number that corresponds to the image that you want to install, and press Enter. Figure 6 shows an example of selection of a 64-bit ISO upgrade file for installation.
Figure 6 ISO Upgrade Image File List
The upgrade process begins (Figure 7).
Caution
Wait until the upgrade process completes.
Do not close the terminal while the upgrade is in progress. You will get notification once the installation is complete.
Figure 7 Start of ISO Upgrade Process
Step 6 When the "Upgrade complete" message appears, press any key. (Figure 8):
Figure 8 End of ISO Upgrade Process
Note There is no need to reboot the Cisco StadiumVision Director server. The server is restarted automatically after the upgrade is complete.
Step 7 Exit the TUI, and do one of the following:
•If you are upgrading from a 2.4 image later than 2.4.0-118, go on to the "Verifying the Upgrade" section.
•If you are upgrading from 2.4.0-118, go on to Step 8.
Only if you are upgrading from Cisco StadiumVision Director Release 2.4.0-118, complete the following steps:
Step 8 Login to the Cisco StadiumVision Director server as a sudo root user.
Step 9 Stop and start the processes using the following commands:
sudo service liferay restart
Step 10 Log out and go on to the "Verifying the Upgrade" section.
Disabling the AIM Software
If your site does not use the Ad Insertion Manager (AIM), you can remove it from the Cisco StadiumVision Director software and main menu by commenting out the menu code lines.
To disable the AIM software if it is not being used, complete the following steps:
Step 1 Exit the Cisco StadiumVision Director home page using the following command:
sudo vi /opt/sv/servers/config/webapps/StadiumVision/index.jsp
Step 2 Comment out lines 141-146. Go to line 141 in the vi editor and insert comment mark <!-- at the beginning of the line 141, and --> at the end as shown in the following example:
<td><img src="cues_images/new-window_link_icon.gif" alt=""></td>
<a href="/AIMWeb/home.html" target="_blank">Ad Insertion Manager</a>
Step 3 Write the change using the following command:
Step 4 Exit the vi editor using the following command:
Step 5 Remove the AIM package using the following command:
sudo rpm -e sv-aim svd-server-aim --nodeps
Note When Cisco StadiumVision Director starts, it will show a process named svd-aim running. You can ignore this process as it does not run the AIM web application.
Verifying the Upgrade
To verify the upgrade, complete the following tasks:
•Clearing the Browser Cache (required)
•Importing the Security Certificate in Microsoft IE (required)
•Logging Into Cisco StadiumVision Director (required)
•Verifying the Control Panel and Other Menus (required)
•Checking for Duplicate MAC Address Entries (required)
•Configuring the DMP 4310 Assigned VLAN Property for VLAN Compliance Check (required)
•Verifying DMPs, Groups, and Zones in the Management Dashboard (required)
•Verifying the Multicast Configuration (required)
Clearing the Browser Cache
After you perform the Cisco StadiumVision Director Release 2.4 software upgrade, you must clear the browser cache to be sure that you are viewing the latest version of Cisco StadiumVision Director.
To clear the browser cache in Mozilla FireFox, complete the following steps:
Step 1 From the menu bar, go to Tools > Clear Recent History.
The Clear Recent History dialog box appears.
Step 2 In the "Time range to clear:" box, select Everything.
Step 3 Open the Details drop-down list and select the Cache checkbox if it does not have a checkmark.
Step 4 Click Clear Now.
To clear the browser cache in Microsoft Internet Explorer, complete the following steps:
Step 1 From the menu bar, go to Tools > Delete Browsing History.
Step 2 Select the Temporary Internet Files checkbox if it does not have a checkmark.
Step 3 Click Delete.
Importing the Security Certificate in Microsoft IE
When you access a Cisco StadiumVision Director 2.4 server for the first time using Microsoft Internet Explorer, a security certificate warning will appear. Some Cisco StadiumVision Director functionality requires that the certificate is imported in IE.
To import the security certificate in Microsoft Internet Explorer, complete the following steps:
Step 1 When you see the warning page with the title "There is a problem with this website's security certificate," click the "Continue to this website..." option.
Step 2 Next to the URL bar on the top of the browser window, click Certificate Error and then click the "View certificates" link.
Step 3 In the Certificate dialog box, click Install Certificate... .
Step 4 In the Certificate Import Wizard dialog box, click Next>.
Step 5 In the next step of the wizard, select "Place all certificates in the following store" radio button and then click Browse... .
Step 6 In the Select Certificate Store dialog box, select the "Trusted Root Certification Authorities" store and click Ok.
Step 7 Click Next> in the Certificate Import Wizard dialog.
Step 8 Click Finish.
Step 9 In the Security Warning dialog box, click Yes.
Confirm that a dialog stating "The import was successful." appears.
Step 10 Close all Microsoft IE windows.
You should now be able to access the Cisco StadiumVision Director server using Microsoft IE without any security certificate warnings.
Logging Into Cisco StadiumVision Director
To verify that the upgrade was successful, and that Cisco StadiumVision Director is up and operating, complete the following steps:
Step 1 Open a browser window and type the URL for the Cisco StadiumVision Director server, in the following sample format, where ipaddress is the IPv4 address of the Cisco StadiumVision Director server:
http://ipaddress:8080/StadiumVision/
The Cisco StadiumVision Director login screen appears (Figure 9).
Figure 9 Cisco StadiumVision Director Login Screen
Step 2 Verify that the Version 2.4 is displayed.
Tip If your window is not displaying Version 2.4, be sure that you have cleared the browser cache as describe in the "Clearing the Browser Cache" section.
Step 3 Type your Cisco StadiumVision Director administrator login credentials and click Log In.
Note When you first log into Cisco StadiumVision Director, the default administrator username and password is admin.
The Cisco StadiumVision Director Main Menu screen appears (Figure 10).
Figure 10 Cisco StadiumVision Director Main Menu
Verifying the Control Panel and Other Menus
To verify the control panel, complete the following steps:
Step 1 From the Cisco StadiumVision Director Main Menu, click Control Panel.
After a few moments of loading resources, the Cisco StadiumVision Control Panel Setup screen will open in a new window (Figure 11).
Figure 11 Cisco StadiumVision Control Panel
Step 2 Confirm the version and build number of your Cisco StadiumVision Director software in the lower right corner of the Control Panel window.
Tip If your window is not displaying the appropriate version and build that you loaded, be sure that you have cleared the browser cache as describe in the "Clearing the Browser Cache" section.
Step 3 Verify that you can open the other Cisco StadiumVision Director screens and menus.
Checking for Duplicate MAC Address Entries
Cisco StadiumVision Director does not support duplicate MAC addresses for the DMPs. After you have upgraded your software, check the following file for any duplicates:
/var/sv/db/mysql/upgrade-invalidmac.csv
Configuring the DMP 4310 Assigned VLAN Property for VLAN Compliance Check
A new VLAN compliance check for DMPs has been added to Cisco StadiumVision Director Release 2.4. Therefore, after you upgrade to release 2.4, you need to go to the Management Dashboard and change the Assigned VLAN property under Global DMP Settings for both the 4310 and 4310 v5.2.3 settings according to your DMP VLAN configuration.
Configuring this property in the Management Dashboard settings for the DMP 4310s will ensure that the Dashboard value can be checked for compliance with the value being sent by the DMP:
•If all of your DMPs are located on the same VLAN (recommended)—Type the number of the VLAN and save the configuration.
•If all of your DMPs are not located on the same VLAN, or you want to bypass any VLAN compliance checking—Type "$svd_ignore" and save the configuration.
The value in the Assigned VLAN property in the Management Dashboard settings for the DMP 4310s is checked against what is being sent by the DMP, unless you have configured $svd_ignore.
Caution
DMP auto-registration support requires that the VLAN value is correctly set or "$svd_ignore" is used.
Figure 12 shows how to configure the Assigned VLAN property under the 4310 Settings for DMPs that are not located on the same VLAN using the "$svd_ignore" string.
Note You need to set a value for the Assigned VLAN property for both the 4310 Settings and the 4310 v5.2.3 Settings under Global DMP Settings in the Management Dashboard..
To configure the Assigned VLAN Property, complete the following steps:
Step 1 Go to the Management Dashboard, and click SV Director Configuration > System Configuration > Global DMP Settings.
Step 2 Complete both of the following steps, as shown in Figure 12:
a. Click 4310 Settings. Find the Assigned VLAN property. In the box, type either the VLAN number where the DMP resides, or $svd_ignore.
b. Click 4310 v5.2.3 Settings. Find the Assigned VLAN property. In the box, type either the VLAN number where the DMP resides, or $svd_ignore
Figure 12 Assigned VLAN Property Configuration for DMPs
Step 3 Click the Save icon.
Verifying DMPs, Groups, and Zones in the Management Dashboard
Note Before you verify DMP status, be sure that you have set the Assigned VLAN property for your DMP 4310s so that the VLAN compliance check can be performed. For more information, see the "Configuring the DMP 4310 Assigned VLAN Property for VLAN Compliance Check" section.
To check DMPs, groups, and zones after you upgrade your software, complete the following steps:
Step 1 Go to the Management Dashboard and verify that all of your groups, zones and DMPs are present and in the green state.
Step 2 From the DMP and TV Controls dashboard drawer, run a Get Status on all DMPs to update Cisco StadiumVision Director's record of DMP MAC addresses using the following dashboard command path:
DMP and TV Controls > Monitoring > Get Status.
Step 3 Run an Initial Config to enable the Video Distribution Manager (VDM) configuration using the following dashboard command path:
DMP and TV Controls > DMP Install > Initial Config.
Step 4 Run Get Status to confirm that all DMPs have successfully rebooted.
Step 5 Stage the Flash template using the following dashboard command path:
DMP and TV Controls > DMP Install > Stage Template.
Step 6 Send Global DMP Settings to the DMPs using the following dashboard command path:
DMP and TV Controls > Global > Global DMP Settings.
Note You must send the Global DMP Settings command twice to reboot the DMPs due to an issue with enabling Medianet services for the first time.
Step 7 Run Get Status to confirm that the DMPs are in good health.
Note This will also update the MAC address for the DMPs.
Step 8 (Optional) Change the DMP State of healthy DMPs to "Production" using the following dashboard command path:
DMP and TV Controls > Auto Registration > Change DMP State.
Step 9 Run Get Status to check the DMP state after the change.
Step 10 Investigate any DMPs that are not in "Normal" state.
Verifying the Multicast Configuration
Cisco StadiumVision Director Release 2.4 uses both unicast and multicast communications for DMP control-plane operation. The Cisco Connected Stadium design requires that Cisco StadiumVision Director uses the 239.193.0.0 multicast group address range.
The multicast group address for Cisco StadiumVision Director is configured in the "MulticastHostPort" registry.
To verify or configure the multicast addressing for Cisco StadiumVision Director, complete the following steps:
Step 1 From the Management Dashboard, select Tools > Advanced > Registry.
Step 2 Scroll to the "MulticastHostPort" registry key in the Parameters list and confirm the entry for the registry.
Step 3 To change the value, click on the value field and specify a multicast address in the range 239.193.0.0/24.
Step 4 Click Apply.
What to Do Next
Use the "Appendix A: Post-Upgrade Checklist" to be sure that you have completed the required verification steps.