Cisco MediaSense User Guide, Release 10.5(1)_SU1

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents

Find Matches in This Book

Available Languages

Download Options

Book Title

Cisco MediaSense User Guide, Release 10.5(1)_SU1

Chapter Title

Install or Upgrade MediaSense

PDF - Complete Book (3.25 MB) PDF - This Chapter (1.44 MB)
View with Adobe Reader on a variety of devices
ePub - Complete Book (558.0 KB)
View in various apps on iPhone, iPad, Android, Sony Reader, or Windows Phone
Mobi - Complete Book (1.03 MB)
View on Kindle device or Kindle app on multiple devices

Results

Updated:: November 30, 2017

Install or Upgrade MediaSense

Install MediaSense
Upgrade MediaSense
Rollback Cluster
Install COP Files
Language Pack

Install MediaSense

This section describes how to install MediaSense and the Cisco Unified Communications Operating System (Unified OS). You install both with one program.

Preinstallation Tasks and Tools
Installation Process
Post-Installation Tasks
Unified Communications Manager Provisioning for MediaSense

Preinstallation Tasks and Tools

Before you start, verify that you are using hardware and software that Cisco supports. For a list of supported hardware and software, see the Cisco MediaSense Design Guide.

Installation and Configuration Worksheet
Answer Files for Unattended Fresh Installations
Navigate the Installation Wizard

Installation and Configuration Worksheet

Make one copy of this worksheet for every node or server in the cluster. Record the network, password, and other information that the installation and setup wizard prompts you to enter for each server. You may not need to record all the information; record only the information that is pertinent to your system and network configuration.

Store the completed worksheets in a secure location for future reference.

Installation Data	Your Entry	Notes
Platform administrator information	Username: Password:	Information used to sign in to the Unified Communications Operating System Administration and to Cisco Unified Serviceability.
MediaSense application administrator information	Username: Password:	Information used to sign in to MediaSense administration and serviceability. You can change the entry after installation by using the CLI commands: `utils reset_application_ui_administrator_name` `utils reset_application_ui_administrator_password`
MediaSense cluster deployment information	Primary server IP address: Secondary server IP address: Expansion server IP address(es):
The MTU size (in bytes) for your network. This setting must be the same on all servers in a cluster.	MTU size:	If you are unsure of the MTU setting for your network, use the default value of 1500 bytes.
Static network configuration	IP Address: IP Mask: Gateway:
DNS client configuration	Primary DNS: Secondary DNS (optional): Domain:	Provide this information when using hostnames for cluster configuration. A server hostname cannot be changed after installation. If you enable DNS, you must configure both forward and reverse lookup information.
Network Time Protocol (NTP) or hardware clock configuration for the first server. Set the NTP for other servers in the MediaSense deployment to the time on the first server.	Hostname or IP address of the NTP server(s):	You must specify at least one valid and reachable NTP server.
Enter the same security password for all servers in the MediaSense deployment.	Security password:	The security password must contain at least six alphanumeric characters. It can contain hyphens and underscores, but it must start with an alphanumeric character. You can change the entry after installation by using the CLI command: `set password security`.

Answer Files for Unattended Fresh Installations

You can perform an unattended, fresh installation of MediaSense by using a platform configuration file called an answer file. Answer files are created using a Web-based application called the Cisco Unified Communications Answer File Generator.

The Answer File Generator simultaneously validates the syntax of your data entries, saves the data, and generates the platform configuration file.

Use an answer file to create and mount a virtual image of MediaSense on a memory stick or a disk. Use this image to perform an unattended installation on the primary node, secondary node, or any expansion nodes in a cluster. You cannot use it to upgrade an installation.

To create an answer file, see Cisco Unified Communications Answer File Generator.

For more information, see How to Use the AFG with the Virtual Floppy Drive.

Navigate the Installation Wizard

Note

If you leave an installation unattended, your monitor window may go blank. If the window goes blank:

Press Escape to redisplay the current window and continue the installation.
Do not press the space bar because this action selects the default option from the current window and moves you to the next window.

The following table describes the actions that the system executes when you press certain keys during installation.

To do this...	Press this...
Move to the next field	Tab
Move to the previous field	Alt-Tab
Choose an option	Space bar or Enter
Scroll up or down in a list	Up and Down arrow
Return to the previous window	Space bar or Enter to choose Back (when available)
Get help for a window	Space bar or Enter

Installation Process

The installation process deploys the MediaSense application and the Unified Communications Operating System (Unified OS) from the provided media on the DVD disc.

Before you install the MediaSense, you must address all virtual machine (VM) requirements.

Cisco assumes that you know the VMware tool set and have completed the following tasks:

Mounted and mapped the DVD drive to the VM host DVD device (physical DVD drive with the DVD disk inserted) or you have mounted your DVD drive to the datastore ISO file.
Powered on your VM server in preparation for this installation.
Met all of the VM requirements listed in the Unified Communications Virtualization website at http://cisco.com/go/uc-virtualized.

You can install MediaSense from the installation disk and configure it with one DVD insertion. The disk contains the Unified OS and the MediaSense installer. When you run this installer, you install Unified OS and MediaSense at the same time.

Installing MediaSense is a two-step process:

Install MediaSense and Unified OS.
Set up the primary server.

Note

Before you install any secondary or expansion servers, the primary server must be running and it must be configured with information about the secondary and expansion servers.

Install MediaSense and Unified OS

Install MediaSense and Unified OS

Use one of the supported VM template options to plan your full configuration. If your plan does not match one of the supported VM template options, MediaSense defaults to unsupported mode and a limited number of recording resources become available. Cisco does not provide technical support for systems running in an unsupported mode. To view all VM requirements, see the Unified Communications Virtualization web page.
Assign the primary and secondary servers. The installation process for the primary server differs from the process for all other servers. After you assign your primary and secondary servers, you cannot change the assignment.
Place the CD or DVD device at the top of the BIOS boot order.
If you plan to perform an unattended installation, provide a configuration file on a virtual image.

Caution

The installation may fail if an invalid or incorrect IP address was entered when the MediaSense node was added to the Unified Communications Manager cluster. Refer to Troubleshooting Tips for Cisco MediaSense for information on correcting the IP address before restarting the installation.

Caution

If a critical error occurs during installation, the installer prompts you to collect log files. You may need to restart the installation of this node. For more detailed instructions, see How to Dump Install Logs to the Serial Port of the Virtual Machine.

Procedure

Step 1

If you have a configuration file for an unattended installation, confirm that it is on a virtual image, that the image is on the datastore, and that it is mounted. For more information, refer to How to use the AFG with the virtual floppy drive?

Step 2

If you are using a MediaSense installation disk, configure the virtual machine to see the physical DVD device on the host. Wait until the DVD Found window is displayed.

Step 3

You are prompted to perform a media check. The media check verifies the integrity of the installation disk. If your disk passed the media check previously, omit this step.

To perform a media check, select Yes. To omit the media check, select No and continue to step 4.

Note

During the media check, the Media Check Result window displays a progress bar. Depending on your server setup, the media check can take up to an hour to complete.

If the Media Check Result displays PASS, click OK to continue.
If the media check fails, eject the DVD to end the installation. At this point, the next step depends on your service-level agreement. You can:
- Obtain another installation disk directly from Cisco Systems.
- Contact your service provider for assistance.

The Cisco Unified Communications Product Deployment Selection window appears.

Step 4

Click OK on the Cisco Unified Communications Product Deployment Selection window to proceed.

The installation begins.

Step 5

Select Yes if you agree with the displayed information on the Proceed with Install window. If you select No, the installation is canceled.

The screen displays any preexisting version of MediaSense on the hard drive and the version that is available on the disk. For an initial installation of MediaSense, the version on the hard drive is displayed as NONE.

If you plan to perform an unattended installation and provided configuration information in Step 1 of this procedure, select Yes in the Proceed with install screen. The installer asks no more questions unless there is a diskrepancy in the configuration information. When the installation process is complete, perform the tasks in Post-Installation Tasks.

If you did not provide configuration information in Step 1, and you select Yes in the Proceed with Install window, the installation continues with the next step.

Step 6

In the Platform Installation Wizard screen, select Proceed.

The software installation begins.

Note

During the installation process, some system messages prompt you to press a key. Do not press a key.

Step 7

When the VM prompts you to eject the DVD, eject the DVD and close the tray.

Step 8

In the Basic Install screen, click Continue.

The Setup Configuration wizard launches and displays a series of screens with that apply to your MediaSense deployment.

Step 9

In the Time Zone Configuration screen, use the Up and Down arrow to select the time zone for your server location. Click OK.

Caution

Setting the time zone incorrectly can adversely affect system operation.

Step 10

In the Auto-Negotiation Configuration screen, select Continue.

Step 11

In the MTU Configuration screen, select No to keep the default setting (1500).

The MTU is the largest packet (in bytes) that this host transmits on the network. Use the default setting if you are unsure of the MTU setting for your network. If you do not want to use the default setting, contact your network administrator to identify the setting that is required for your deployment.

Caution

If you do not configure the MTU size correctly, network performance can be degraded.

Step 12

In the Static Network Configuration screen, enter the values for IP Address, IP Mask, and Gateway (GW) Address. Click OK.

Step 13

In the DNS Client Configuration screen, select Yes.

Note

If you enable DNS, you can use hostnames to configure the nodes. Hostnames cannot be changed after installation completes.
If you disable DNS, you must use IP addresses to configure the nodes.

If you enable DNS, you must provide values for Primary DNS and Domain. Optional values include Secondary DNS.

Note

If you enable DNS, you must also configure both forward and reverse lookup information in your DNS server. If you do not configure this information, the installation fails on the network check.

Step 14

In the Administrator Login Configuration screen, enter the Administrator ID for the Unified OS (platform) administrator for this deployment. Also enter and confirm the password for this administrator. Click OK.

Step 15

In the Certificate Information screen, enter values for Organization, Unit, Location, State, and Country. Click OK.

Step 16

The next step depends on if you are configuring the first (primary) server or if you are configuring a secondary or expansion server.

If you are configuring the first (primary) server for this MediaSense deployment, select Yes in the First Node Configuration screen.

Caution

After you install the primary server you cannot change your primary server assignment for this deployment.

In the Complete the Network Time Protocol Client Configuration screen, enter NTP Servers and click OK.

The first (primary) server in a MediaSense deployment can get its time from any external Network Time Protocol (NTP) server that you define. NTP or hardware clock configuration is only set for the first node. Other servers in the cluster automatically synchronize their time to the time on the first server.

Note You must specify at least one valid and reachable NTP server.
Enter the security password in the Security Configuration screen.
The security password:
- Must begin with an alphanumeric character and be at least six characters long. It can contain alphanumeric characters, hyphens, and underscores.
- Must be identical for all servers because the servers use it to authorize communications between themselves.
- Must be recorded and saved to use again when you add a secondary server or an expansion server.
- Can be changed later using the CLI command set password security.
ClickOK.
In the Application User Configuration screen, enter the user ID for the application user. Enter and confirm the password. Click OK.
To complete the installation of the first (primary) server, go to Step 21.

If you are configuring a secondary server or an expansion server, select No and continue to the next step.

Step 17

A warning indicates that if you are configuring a secondary or expansion server, you must have configured the server on the primary server first, and that the server you are configuring must have access to the primary server.

ClickOK and proceed to the next step.

The Network Connectivity Test Configuration screen appears.

Step 18

Select Yes to pause the installation and add the subsequent server information to the primary server. For instructions, see MediaSense Server Configuration. Resume the installation after the configuration is complete.

Step 19

In the First-Node Access Configuration screen, add the Host Name and IP Address of the first (primary) server. The security password is the same as the security password that you entered for the first server. Click OK to continue with the installation.

The Platform Configuration Confirmation screen appears.

Step 20

In the Platform Configuration Confirmation screen, click OK to proceed with the installation.

The installation process continues. The process may take several hours to complete. Completion time depends on the configuration setup, hardware setup, disk size, and other factors.

MediaSense restarts automatically after the installation completes. A login screen displays a successful installation message and a login prompt.

What to Do Next

Unmount the DVD drive mapped to the VM host DVD device (physical DVD drive with the DVD disk inserted) or the DVD drive mounted to the datastore ISO file.

Proceed with post-installation tasks to complete the setup for every node in the cluster.

Post-Installation Tasks

After installing MediaSense on your primary server, you must set some configuration parameters and perform other post-installation tasks before you start using the system.

Procedure

Step 1	Upgrade the VM tools. For more information on upgrading VM tools, see VMWare Tools.
Step 2	Complete the setup of the primary server. See Complete Setup for Primary Server.
Step 3	Add subsequent servers. See MediaSense Server Configuration.
Step 4	Complete the setup of each subsequent server. See Complete Setup for Primary Server.

Complete Setup for Primary Server

The Unified Communications Manager IP address and the Administrative XML Layer (AXL) administrator username and password are required to perform the post-installation setup procedure. Access to Unified Communications Manager is required to continue with the MediaSense setup.

Note

The AXL user can only be an end user in Unified Communications Manager.

For Unified Communications Manager 10.0, the AXL user must be configured with the following roles:

Standard AXL API Access
Standard CCM Admin Users

For Unified Communications Manager 9.1, the AXL user must be configured with the following roles:

Standard AXL API Access
Standard CCM Admin Users
Standard CCMADMIN Administration
Standard SERVICEABILITY Administration

For more information about Unified Communications Manager users and roles, see Cisco Unified Communications System Documentation.

See the following sections to review the considerations for your intended deployment:

Caution

After you install the primary server you cannot change your primary server assignment for this deployment.

Follow this procedure to complete the setup for the primary server in any MediaSense deployment.

Procedure

Step 1

After you complete the installation procedure, the system automatically restarts. Sign in to MediaSense Administration for the primary server.

The Welcome screen of the MediaSense First Server Setup wizard appears.

Step 2

When you are ready to proceed, click Next.

The Service Activation screen appears.

Step 3

The system internally verifies the IP address of this server and automatically begins enabling the MediaSense feature services in this server. Wait until all of the feature services show as enabled in the Service Activation screen. After all of the services are successfully enabled, click Next.

If a feature service cannot be enabled, an error message is displayed in the Status section.

Table 1 Feature Service Status Descriptions

Status

Description

Action

Enabling

This service is in the process of being enabled.

Wait for the state to moved to the Enabled.

Enabled

This service is now fully turned on and ready to function.

Wait until all the feature services for this server reach the Enabled state. The primary server requires all feature services to be enabled.

Error

The system cannot enable this service due to an error.

Warning

If the Database service or the feature services are not enabled, the system does not allow you to proceed with the setup procedure.

Your response depends on the service that failed to be enabled.

If it is the database service or the configuration service that failed, you must first correct the error and restart the initial setup.
If it is any other service that failed, you can continue with the setup and fix the errors after the setup is completed. Be aware that your system is not fully in service until you fix these issues.

After you click Next, the AXL Service Provider screen appears.

Step 4

Enter the AXL service provider (IP address) and the AXL administrator username and password in the respective fields for Unified Communications Manager that should communicate with MediaSense.

Note

You cannot change the password for the AXL user in the MediaSense application. The MediaSense application only authenticates the password configured in Unified Communications Manager. You can, however, modify the AXL server IP address. See Select AXL Service Providers.

Note

MediaSense accepts passwords upto 20 characters in length. So the AXL password should not exceed 20 characters.

If the selected AXL services cannot be enabled, an error message instructs you to reselect AXL service providers.

After the system accepts the AXL server and user information, the Call Control Service Provider screen appears.

Step 5

If the client applications using MediaSense need to make outbound recording calls, provide the Unified Communications Manager server IP address for the call control service on the Call Control Service Provider screen.

Note

Provide this information only if you know the applications using MediaSense. You can get this information by sending an AXL request to the Unified Communications Manager server that was configured as the AXL Service Provider.

Step 6

Click Finish to complete the initial setup for the primary server.

The MediaSense Setup Summary screen displays the result of the initial setup.

You have now completed the initial setup of the primary server for MediaSense.

Step 7

In Unified Communications Manager Administration, configure the SIP trunk, route group, route list, and recording profile. When you finish the post-installation process for any MediaSense server, you must access the Unified Communications Manager server for your deployment (based on the information provided during the installation and post-installation process). For more information, see Setup Call Control Service Connection.

Step 8

Before you install MediaSense on a secondary server or an expansion server, you must configure details for these servers on the primary server by using the MediaSense Administration user interface. For more information, see MediaSense Server Configuration.

MediaSense Server Configuration

To configure additional MediaSense servers, perform the following steps.

Procedure

Step 1	From the Cisco MediaSense Administration menu, select System > MediaSense Server Configuration.
Step 2	In the MediaSense Server Configuration window, click Add MediaSense Server. The Add MediaSense Server window in the primary node opens.
Step 3	If your installation uses DNS, enter the hostname of the server that you want to add. If your installation does not use DNS, enter the IP address of the server that you want to add.
Step 4	(Optional) Enter the description of the server that you want to add.
Step 5	(Optional) Enter the MAC address of the server that you want to add.
Step 6	Click Save. MediaSense displays a confirmation message near the top of the window. You see the configuration details of the server that you added in the MediaSense Server List. The server type is UNKNOWN at this stage of the installation.

Details for Secondary and Expansion Servers

After you have configured details for the secondary server or expansion server on the primary server, install the secondary server or expansion server to complete the clustering process following the Installation Process.

Note

If you have ever increased the size of the /uploadedMedia partition on your system, after you install a new node you need to increase the size of the partition on the new node as well or you may encounter errors when uploaded files propagate to the new node. For more information, see Installation Process.

Finish Setup for Subsequent Servers

The Unified Communications Manager IP address and the Administrative XML Layer (AXL) administrator username and password are required to perform the post-installation setup procedure. You need to have access to Unified Communications Manager to continue with the MediaSense setup.

See the following sections to review the considerations for your intended deployment:

Caution

After you complete the following procedure for the secondary server, you cannot change your secondary server assignment for this deployment.

Use the MediaSense Administration interface to make changes to the information that you specify during the setup procedure. For more information, see Administer and Configure MediaSense.

Procedure

Step 1

After you complete the installation procedure specified in Install MediaSense and Unified OS, the system restarts automatically and you must sign in to MediaSense Administration to install subsequent servers.

When you sign in, the Welcome screen of the MediaSense Subsequent Server Setup wizard appears.

Step 2

When you are ready to proceed, click Next.

You determine the type of server in this Welcome screen. You must decide whether this subsequent server becomes the secondary server or an expansion server. Based on your choice, the list of services to be turned on is displayed on the service activation page.

Secondary server— Enable all of the services in the Service Activation window to make this server the secondary server. After you have enabled all the services and the initial setup completes, you cannot change the secondary server assignment.

After a secondary server has been selected, any additional servers will automatically be designated as expansion servers.
Expansion servers— Only the media service, call control service, and SM Agent are enabled on expansion servers. The API service and the configuration service are not available on expansion servers.

The following table shows which features can be enabled in each type of server:

Feature	Enabled in Primary Server?	Enabled in Secondary Server?	Enabled in Expansion Servers?
Database service	Yes	Yes	No
Configuration service	Yes	Yes	No
API service	Yes	Yes	No
Media service	Yes	Yes	Yes
Call control service	Yes	Yes	Yes
SM Agent	Yes	Yes	Yes

Select the server type and click Next. The Service Activation screen is displayed.

Step 3

After the services are enabled, click Finish to complete the initial setup for a subsequent server.

If a feature service cannot be enabled, an error message is displayed in the Status section.

The MediaSense Setup Summary screen displays the result of the initial setup and MediaSense restarts.

You have now completed the initial setup of a subsequent server. This subsequent server is ready to record.

Repeat this setup procedure for each expansion server in the cluster.

System Verification

After you install MediaSense, use the following methods to verify the health of your deployment:

Sign in to MediaSense Administration on each server. See Access MediaSense Administration.
Sign in to MediaSense Serviceability Administration on each server. See Access MediaSense Serviceability.
Services described in Setup Summary that are enabled on each server. For status descriptions, see Complete Setup for Primary Server.

Unified Communications Manager Provisioning for MediaSense

When you finish the initial configuration process for any MediaSense server, you must access the Unified Communications Manager server for your deployment (based on the information provided during the installation and initial configuration process).

Perform the following task after you finish your cluster setup and before you start using the MediaSense servers.

Setup Call Control Service Connection
Disable iLBC, iSAC and Opus for Recording Device
Reorder the G.722.1 Codecs

Setup Call Control Service Connection

The call control service in MediaSense is referred to as a SIP trunk in the Unified Communications Manager interface and documentation. In Unified Communications Manager Administration, you must configure the SIP trunk, route group, route list, and recording profile to enable the call control service in MediaSense Administration to communicate with Unified Communications Manager Administration.

Note

Be sure to configure Unified Communications Manager to use TCP transport for a SIP trunk connection to MediaSense that is active on all call manager nodes.

After you have configured the SIP trunk information in Unified Communications Manager, you will need to provide this IP address in the Call Control Service Provider Configuration panel of the Unified CM Configuration screen in the MediaSense Administration.

Even if already enabled, the call control service is not in service until you have configured the call control service provider.

Use this procedure to configure the SIP trunk information in Unified Communications Manager if your installation calls for Built-in-Bridge (BiB) recording or Network-based Recording (NBR).

Procedure

Step 1

Invoke and connect to the Unified CM Administration web interface using a valid Unified Communications Manager username and password.

Step 2

If MediaSense is a single-node cluster, skip to the next step. If MediaSense is a multiple-node cluster, select Device > Device Settings > SIP Profile in the Unified CM Administration web page.

Follow the procedure specified in your Unified Communications Manager Administration documentation to enable OPTIONS Ping and save this configuration.

Add a new SIP profile.
Select the Enable OPTIONS Ping check box to monitor the destination status for SIP trunks using the None (default) Service Type.

Step 3

Select Device > Trunk on the Unified CM Administration web page.

Follow the procedure specified in your Unified Communications Manager Administration documentation to add a new SIP trunk. To configure the device:

Edit the Device Name.
Select the Device Pool.
Assign SIP information.
Enter the destination IP address and port (5060) for MediaSense.
Select the SIP trunk security profiles and SIP profile (created in Step 2)
Ensure that the Media Termination Point Required check box is unchecked.
Near the bottom of the screen, select the Run On All Active Unified CM Nodes check box.

Save this configuration.

You must create one SIP trunk for each server in the MediaSense deployment.

Note

For NBR, in the Recording Information section, select the This trunk connects to a recording-enabled gateways radio button.

Step 4

Add a new route group by selecting Call Routing > Route/Hunt > Route Group in Unified CM Administration. Set the distribution algorithm to circular.

Follow the procedure specified in your Unified Communications Manager Administration documentation to select the circular distribution algorithm.

Select all the MediaSense SIP trunks created in Step 3.

Step 5

Create a route list by selecting Call Routing > Route/Hunt > Route List on the Unified CM Administration web page. Follow the procedure specified in your Unified Communications Manager Administration documentation to associate the route list with the route group created in Step 4.

Step 6

Create a route pattern by selecting Call Routing > Route/Hunt > Route Pattern in Unified CM Administration. From the Gateway/Route List drop-down list under the newly created route pattern page, select the name of the route list configured in Step 5.

Caution

Do not include any wildcard characters when creating route patterns for the recording profile.

Step 7

Select Device > Device Settings > Recording Profile in Unified CM Administration.

Follow the procedure specified in your Unified Communications Manager Administration documentation to add a new recording profile. Configure the recording profile name, and the recording destination address (enter the route pattern number you configured in Step 6, and click Save).

Step 8

Select Device > Phone on the Unified CM Administration web page.

Follow the procedure specified in your Unified Communications Manager Administration documentation to perform the following tasks:

Find the audio forking phone.
Find the Built-In-Bridge configuration for this device and change the setting to ON.
Access the Directory Number Configuration page for the line to be recorded.
If you are using a recording partner, select either Automatic Call Recording Enabled or Application Invoked Call Recording Enabled in the Recording Option drop-down list, according to the recording partner recommendations. If you are not using a recording partner, select Automatic Call Recording Enabled.
Select the recording profile created earlier in this procedure.

Note

For NBR, select Gateway Preferred in the Recording Media Source drop-down list.

Disable iLBC, iSAC and Opus for Recording Device

Caution

MediaSense does not support Internet Low Bitrate Codec (iLBC) , Internet Speech Audio Codec (iSAC) or Opus Interactve Audio Codec. Consequently, you must disable these features in Unified Communications Manager before you proceed with the MediaSense configuration.

Procedure

Step 1	Invoke and connect to the Unified CM Administration web interface using a valid Unified Communications Manager username and password.
Step 2	Select System > Service parameters in Unified CM Administration.
Step 3	On the Service Parameter Configuration web page, select the required server and service (Cisco CallManager) from the Select Server and Service drop-down list.
Step 4	Go to the Cluster-wide Parameters (Location and Region) section and locate the iLBC Codec Enabled parameter. iSAC Codec Enabled parameter and the Opus Codec Enabled parameter.
Step 5	Set the value for both of these parameters as Enable for All Devices Except Recording-Enabled Devices and save your configuration.

Reorder the G.722.1 Codecs

Caution

MediaSense does not support the G.722.1 codecs, which are not the same as G.722. However, you cannot disable the G.722.1 codecs in Cisco Unified Communications Manager.

For recording Jabber-to-Jabber calls (clients with BiB) where one of these is either a Mac or Windows Jabber client, you must place G722.1 codecs lower than all the G711 and G729 codecs in the Audio Codec Preference List Configuration window of Cisco Unified Communications Manager. To do this, see the Edit Audio Codec Preference List section of the Cisco Unified Communications Manager Administration Guide.

Upgrade MediaSense

This section contains information on how to upgrade MediaSense. MediaSense can only be upgraded from one release to the next supported release. If you are running an earlier release, you may have to upgrade more than once to bring your system up to the current release.

Note

To check which releases can be directly upgraded to the current release, see the MediaSense Release Notes at http://www.cisco.com/c/en/us/support/customer-collaboration/mediasense/products-release-notes-list.html.

Each successive release contains minor changes to the MediaSense API that are always upward compatible with one exception. The exception is between Release 8.5(4) and 9.0(1), in which security enhancements were introduced. Those enhancements require that client software be modified in order to provide HTTP-BASIC credentials and to handle a 302 redirect. HTTP-BASIC credentials must now be provided with all RTSP and HTTP download requests.

If an upgrade does not complete, you can rollback to the previous release and begin the upgrade again.

Note

Upgrading MediaSense from versions prior to 10.5 to 10.5 (including its ES and SU releases) or 11.0 (including any ES & SU) will fail if the RecordingSession table has more than 2.5 million records unless a workaround is applied. For more information on the workaround, refer to https://bst.cloudapps.cisco.com/bugsearch/bug/CSCup30602/?reffering_site=dumpcr

A node can take several hours to upgrade depending on the number and size of recordings it holds. When you upgrade a node with very large data sets, it takes around 90 additional minutes per 1 million recordings.

Upgrade Considerations
Upgrade Cluster to Release 10.x(x)
Node Upgrade Procedures

Upgrade Considerations

Consider these guidelines when you upgrade MediaSense:

Full Loads—You cannot run a full call load until after you complete the upgrade on all servers in the cluster.
Upgrade Sequence—When you upgrade a cluster, you must upgrade the primary server first. You can upgrade the remaining nodes one at a time or upgrade them all at the same time.
VM Snapshots—You must take a VM snapshot of each node before you begin the upgrade. If an error stops the upgrade process, you can restore these VM snapshots to roll back the nodes to their previous states.
- You do not need to stop each node to take its VM snapshot.
- You must delete the VM snapshot from each node after the upgrade. MediaSense should not run on a node with a VM snapshot for more than a few days.
Rollback to Previous Version— If you have taken a VM snapshot of each node before initiating an upgrade, you can revert to a previous software version that was running before the upgrade. However, MediaSense does not support the CLI Command, utils system switch-version, to revert to the older version.

Note

There is no other way to rollback to the previous version.
Temporary Outages—You experience a temporary server outage while the software is being upgraded. How long this outage lasts depends on your configuration and the size of the data that is stored in the database.
Aborted Calls—Nodes in the MediaSense cluster stop taking new calls and API requests when you begin the upgrade process. If any calls are in progress when you begin the upgrade, recordings of those calls end in a CLOSED_ERROR state. After the upgrade, each node in the cluster resumes accepting calls when it come back online.
Incomplete Upgrades—If you decide to back out of an upgrade before it completes, you must restore the VM snapshots on all nodes in the cluster to their previous version.
Potential Data Loss—During the upgrade process, do not make any configuration changes to any server. After all nodes have been upgraded and returned to service, you can resume making configuration changes. However, even then, if you need to roll back the upgrade, you lose these configuration changes.

Note
To avoid the potential loss of configuration changes or recording data, upgrade only when the cluster is idle.
Restarting an Upgrade on a Subsequent Server—If an upgrade on a subsequent server fails, correct the errors which caused the upgrade failure. Verify the network connectivity of the servers in your cluster. Restore the snapshot on the subsequent server and ensure that its memory and CPU usage are not too high. Upgrade the subsequent server again.

COP File Installation—Remember to install any required COP files (including the language pack COP) after each upgrade.

Note

In case customers want to upgrade directly from MediaSense 9.1(1) to MediaSense 10.5(1), then they need to first install the mcp-rsa3-key-preupgrade_9.1.cop.sgn COP file available at http://software.cisco.com/download/type.html?mdfid=283613140&catid=null.

When upgrading from previous releases, consider this information:

A new VMware VM template was provided in Release 9.1(1) that provisions 16 GB of memory rather than the 8 GB that was required in release 9.0(1) and earlier. For any server being upgraded to or through Release 9.1(1), the VM configuration must be manually adjusted to reserve this increased amount of memory.
A new feature was added in Release 9.1(1) that permits recorded media storage to be increased in size after installation. However, this feature is not available in systems upgraded from prior releases; it only functions in systems that have been fresh-installed with Release 9.1(1) or 10.0(1), or systems upgraded to Release 10.0(1) from 9.1(1). The new uploaded media partition is automatically created during upgrade and does support the capability to be increased in size after installation.
If you upgrade a MediaSense cluster from Release 9.0(1) to 9.1(1) or 10.0(1) and then want to add nodes to your cluster, be aware that although the new nodes are installed with expandable recorded media storage, we do not support that flexibility. Provision approximately the same amount of recording space on each new node as is available on each upgraded node. Although storage space disparity across nodes in the cluster does not present a problem for MediaSense, it could result in pruning ahead of the configured retention period on smaller nodes. Administrators may find this behavior unpredictable.

Upgrade Cluster to Release 10.x(x)

This procedure describes a cluster where one or more individual nodes (servers) are upgraded. To upgrade individual nodes, see Node Upgrade Procedures.

Note

For Release 10.x(x), customers should upgrade their hosts to a newer version of ESXi that is supported before they can upgrade to MediaSense Release 10.x(x).

If you are running an earlier release of MediaSense, you must upgrade to Release 9.1(1) before you can upgrade to Release 10.x(x). Refer to the Cisco MediaSense User Guide for Release 9.1(1) at http://www.cisco.com/en/US/products/ps11389/products_user_guide_list.html to upgrade to Release 9.1(1) before using the procedure in this document to upgrade to Release 10.x(x).

Before you upgrade the cluster, you may want to review some of the following information sources:

For information about supported upgrades, see the Cisco MediaSense Design Guide at http://www.cisco.com/en/US/products/ps11389/products_implementation_design_guides_list.html.
For information about VM snapshots, see the VMware Documentation.

When you upgrade a cluster:

You do not need to stop each node to take its VM snapshot.
You can upgrade the expansion nodes one at a time or upgrade them all at the same time.

Note

After you begin the upgrade process on a given node, you cannot cancel it using the Cancel button that appears on some screens. The proper way to cancel the upgrade on a particular node is to restore its VM snapshot.

Procedure

Step 1	Take a VM snapshot of each node.
Step 2	Upgrade the primary node and wait for it to restart.(See Node Upgrade Procedures.)
Step 3	Upgrade the secondary node (if applicable) and wait for it to restart.
Step 4	Upgrade all expansion nodes (if applicable) and wait for them to restart.
Step 5	Upgrade the virtual hardware of each node by selecting Upgrade virtual hardware in the vSphere client.
Step 6	After all of the nodes have been successfully upgraded, delete the VM snapshot on each node.

Node Upgrade Procedures

This section provides procedures for upgrading nodes using software from these sources:

Local source
Remote sources using either the command line interface (CLI) or Unified OS Administration

Upgrade Nodes From a Local Source
Remote Sources

Upgrade Nodes From a Local Source

Note

Before you begin this procedure, be aware that just copying the .iso file to the DVD in the first step will not work. Most commercial disk burning applications can create ISO image disks.

Procedure

Step 1	If you do not have a Cisco-provided upgrade disk, create an upgrade disk by burning the upgrade file that you downloaded onto a DVD as an ISO image.
Step 2	Insert the new DVD into the physical DVD device on the host and configure your virtual machine to use that device.
Step 3	Sign in to the web interface for the Unified OS Administration.
Step 4	Navigate to Software Upgrades > Install/Upgrade. The Software Installation/Upgrade window appears.
Step 5	From the list, choose DVD.
Step 6	Enter a slash (/) in the Directory field.
Step 7	Click Next.
Step 8	Choose the upgrade version that you want to install and click Next.
Step 9	In the next window, monitor the progress of the download. MediaSense automatically takes these actions: Upgrades to the release specified. Switches versions and reboots. Starts taking calls.

Remote Sources

Cisco certifies certain SFTP products through the Cisco Developer Network (CDN).

CDN partners certify their products with specified versions of Cisco Unified Communications Manager. See GlobalSCAPE (http://www.globalscape.com/gsftps/cisco.aspx) for more information. For issues with third-party products that have not been certified through the CDN process, contact the corresponding third-party vendor for support.

Cisco does not support using the free FTDP SFTP product because of the 1 GB file size limit on this product.

Cisco uses the following servers for internal testing. You may use one of these servers, but you must contact the vendor directly for support:

Open SSH (http://sshwindows.sourceforge.net)
Cygwin (http://www.cygwin.com)
Titan (http://www.titanftp.com)

You can upgrade nodes from a remote source using one of two methods:

Upgrade Nodes Using Unified OS Administration
Upgrade Nodes Using Unified OS CLI

Upgrade Nodes Using Unified OS Administration
Upgrade Nodes Using Unified OS CLI

Upgrade Nodes Using Unified OS Administration

Note

You can also use the Unified OS command line interface (CLI) to upgrade a node from a network location or to upgrade a node from a remote server. For instructions, see the Upgrade Nodes Using Unified OS CLI section.

Procedure

Step 1

Put the upgrade file on an FTP server or SFTP server that the node that you are upgrading can access.

Step 2

Step 3

Navigate to Software Upgrades > Install/Upgrade. The Software Installation/Upgrade window is displayed.

Step 4

From the list, choose Remote Filesystem.

Step 5

In the Directory field, enter the path to the directory that contains the patch file on the remote system. If the upgrade file is located on a Linux or Unix server, you must enter a forward slash at the beginning of the directory path.

For example, if the upgrade file is in the patches directory, enter /patches

If the upgrade file is located on a Windows server, remember that you are connecting to an FTP or SFTP server, so use the appropriate syntax, including the following:

Begin the path with a forward slash (/) and use forward slashes throughout the path.
The path must start from the FTP or SFTP root directory on the server, so you cannot enter a Windows absolute path (for example, C:).

Step 6

In the Server field, enter the server name or IP address.

Step 7

In the User Name field, enter your user name on the remote server.

Step 8

In the User Password field, enter your password on the remote server.

Step 9

Select the transfer protocol from the Transfer Protocol field.

Step 10

To continue the upgrade process, click Next.

The option to "Switch to new version after upgrade" may safely be ignored.

Step 11

Choose the upgrade version that you want to install and click Next.

Note

If you lose your connection with the server or close your browser during the upgrade process, you may see the following message when you try to access the Software Upgrades menu again.

Another session is installing software, click Assume Control to take over the installation. If you are sure you want to take over the session, click Assume Control. If Assume Control does not display, you can also monitor the upgrade with the Real Time Monitoring Tool.

Step 12

In the next window, monitor the progress of the download.

MediaSense automatically take these actions:

Upgrades to the release specified.
Switches versions and reboots.
Starts taking calls.

Upgrade Nodes Using Unified OS CLI

Note

You can also use the web interface of Unified OS Administration to upgrade a node from a network location or to upgrade a node from a remote server. For instructions, see Upgrade Nodes Using Unified OS Administration.

Procedure

Step 1	Put the upgrade file on an FTP or SFTP server that the server that you are upgrading can access.
Step 2	Sign in to the Unified OS console. See CLI Access for more information.
Step 3	Enter `utils system upgrade initiate` at the CLI prompt. The following options appear in the window: 1) Remote Filesystem Via SFTP 2) Remote Filesystem Via FTP 3) DVD/CD 4) Quit
Step 4	Enter 1 or 2 to select the remote file system containing your upgrade file.
Step 5	Enter the path to the directory that contains the upgrade file on the remote system. If the upgrade file is located on a Linux or Unix server, you must enter a forward slash at the beginning of the directory path. For example, if the upgrade file is in the patches directory, enter`/patches` If the upgrade file is located on a Windows server, remember that you are connecting to an FTP or SFTP server, so use the appropriate syntax, including the following: Begin the path with a forward slash (/) and use forward slashes throughout the path The path must start from the FTP or SFTP root directory on the server, so you cannot enter a Windows absolute path (for example, C:).
Step 6	Enter the server name or IP address.
Step 7	Enter your user name on the remote server.
Step 8	Enter your password on the remote server.
Step 9	Enter the SMTP host server or press Enter to continue.
Step 10	Select the transfer protocol.
Step 11	Choose the upgrade version that you want to install and press Enter.
Step 12	Answer Yes to the prompt to start the installation.
Step 13	Monitor the progress of the download. MediaSense automatically takes these actions: Upgrades to the release specified. Switches versions and reboots. Starts taking calls.

Rollback Cluster

All nodes in a MediaSense cluster must run the same software version. If an upgrade fails, restore the VM snapshots on the nodes to roll the software back to a previous version. After you rollback the software on the nodes in a cluster, you lose all recordings, all configuration changes, and all metadata changes that were made after the upgrade. You regain all recordings that were deleted after the upgrade.

MediaSense clusters cannot run a full call load until you complete the final step in this rollback procedure.

Note

Be sure that you use MediaSense Serviceability Administration to perform this procedure. Do not use Unified Serviceability Administration. You can find MediaSense Serviceability Administration in the Navigation menu.

Procedure

Step 1	Stop all nodes in the cluster.
Step 2	Restore and delete the VM snapshots from all nodes in the cluster.
Step 3	Using a web browser, sign into MediaSense Serviceability Administration.
Step 4	Restart the primary node and wait for it to come back into service.
Step 5	Restart the remaining nodes either one at a time or all together. After each node comes back into service, it begins taking calls again.

Install COP Files

The Cisco Options Package (COP) file provides a generic method to deploy Cisco software outside the normal upgrade process. You can use a COP file to install new language packs, patch fixes, and virtualization tools. You must download and save the COP file before you install it on the nodes in a MediaSense cluster.

The procedure for installing a COP file on a node is the same as the procedure for upgrading MediaSense on that node, but you download a COP file instead of downloading an upgrade (ISO) file.

COP files can generally be installed on an active, running system in a shorter time frame than an upgrade file. However, unlike upgrades, COP files cannot be removed or rolled back.

The following guidelines apply to installing COP files:

Install the COP file on every node (server) in a MediaSense cluster.
Restart each node after you install a COP file on it.

Note

This procedure provides general guidelines for installing COP files. Before you use this procedure, check the Readme file for the specific COP file that you want to install. If the instructions in the Readme file differ from these general guidelines, follow the instructions in the Readme file instead.

Procedure

Step 1	Go to the MediaSense Download Software Website at http://www.cisco.com/cisco/software/type.html?mdfid=283613140&catid=null.
Step 2	Download and save the MediaSense COP file to a local source or to an SFTP server that can be accessed by the MediaSense server.
Step 3	If you downloaded and saved the COP file to a local source, follow the instructions in Upgrade Nodes From a Local Source. (Remember to replace the upgrade filename with the COP filename.)
Step 4	If you downloaded and saved the file to an SFTP server, follow the instructions in Remote Sources. (Remember to replace the upgrade filename with the COP filename.)
Step 5	After you install the COP file on all nodes in the cluster, go to the web interface for Cisco Unified OS Administration. To verify the COP file installation, navigate to Show > Software. The Software Packages window displays the installed Partition Version and the additionally Installed Software Options with its corresponding status.

Language Pack

Download and install a language pack only if you want to see the MediaSense interface in a language other than English.

The language pack for MediaSense is delivered as a single COP file, the same way that MediaSense delivers COP files for patches. The files is available to download from Cisco.com and contains a single installer for all language variants. The filename is of the format:

ora-language-pack_18-10.0.1.10000-x.cop.sgn

where 10.0.1 is the release identifier.

Follow the instructions in Install COP Files to install the language you want on your interface.

Was this Document Helpful?

Feedback

Contact Cisco

Open a Support Case
(Requires a Cisco Service Contract)