Cisco MSE Virtual Appliance Installation and Configuration Guide, Release 8.0
Cisco MSE Virtual Appliance Installation and Configuration Guide, Release 8.0
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this
URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1721R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display
output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in
illustrative content is unintentional and coincidental.
Preface v
Overview 1-1
CHAPTER 3 Installing the Cisco MSE Virtual Appliance on the VMware Virtual Machine 3-1
Overview of the Process for Installing the Cisco MSE Virtual Appliance on the VMware Virtual
Machine 3-2
Verifying Prerequisites 3-2
Configuring the Basic Settings to Start the MSE Virtual Appliance VM 3-12
Overview of the Process for Installing the Cisco MSE Virtual Appliance On a XenServer 4-1
Configuring the Basic Settings to Start the MSE Virtual Appliance VM 4-10
CHAPTER 5 Installing the Cisco MSE Virtual Appliance on a Hyper-V Platform 5-1
Overview of the Process for Installing the Cisco MSE Virtual Appliance on a Hyper-V Platform 5-1
Configuring the Basic Settings to Start the MSE Virtual Appliance VM 5-11
Audience
This publication is for experienced network administrators who plan to install the Cisco MSE virtual
appliance. This guide also describes the system requirements for the Cisco MSE virtual appliance.
Document Conventions
This document uses the following conventions:
Table 1 Conventions
Convention Indication
bold font Commands and keywords and user-entered text appear in bold font.
italic font Document titles, new or emphasized terms, and arguments for which you supply
values are in italic font.
[] Elements in square brackets are optional.
{x | y | z} Required alternative keywords are grouped in braced and separated by vertical
bars.
[x | y | z} Optional alternative keywords are grouped in braced and separated by vertical
bars.
string A nonquoted set of characters. Do not use quotation marks around the string or
the string will include the quotation marks.
courier font Terminal sessions and information the system displays appear in courier font
<> Nonprinting characters such as passwords are in angle brackets.
Table 1 Conventions
Convention Indication
[] Default responses to system prompts are in square brackets.
!, # An exclamation point (!) or a pound sign (#) at the beginning of a line of code
indicates a comment line.
Tip Means the following information will help you solve a problem.
Caution Means reader be careful. In this situation, you might do something that can result in equipment damage
or loss of data.
Warning This warning symbol means danger. You are in a situation that could cause bodily injury. Before you
work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar with
standard practices for preventing accidents. (To see translations of the warnings that appear in this
publication, refer to the appendix “Translated Safety Warnings.”)
Related Documentation
For more information about the Mobility Services Engine and related products, see the following URL:
http://www.cisco.com/c/en/us/support/wireless/mobility-services-engine/tsd-products-support-series-h
ome.html
Overview
The Cisco Mobility Services Engine (MSE) is offered as a virtual appliance, to support lower-end,
standard, and high end deployments.
The following are the MSE virtual appliance standard templates:
• Open Virtualization Format (OVF) for VMware
• Virtual Hard Disk (VHD) for Microsoft Hyper-V
• Open Virtualization Format (OVF) for Citrix XenServer
MSE Low-End Virtual Appliance MSE Standard Virtual Appliance MSE High-End Virtual Appliance
UCS-CPU-E5-2609 (qty 1) UCS-CPU-E5-2660 (qty 1) UCS-CPU-E5-2660 (qty 2)
Processor
UCS-MR-1X082RX-A (qty 1) - 8 UCS-MR-1X082RX-A (qty 2) - 16 UCS-MR-1X041RX-A
RAM GB GB (qty 4) - 24 GB
UCS-HDD300GI2F208 (qty 2, in UCS-HDD300GI2F208 (qty 4, in UCS-HDD300GI2F208 (qty 4, in
Disk RAID 1 configuration) RAID 10 configuration) RAID 10 configuration)
RAID UCS-RAID-9266CV UCS-RAID-9266CV UCS-RAID-9266CV
Table 1-2 lists example Cisco Unified Computing System™ (Cisco UCS) configurations that match the
minimum requirements.
Table 1-2 Example Cisco UCS Configurations that Match the Minimum Requirements
MSE Low-End Virtual Appliance MSE Standard Virtual Appliance MSE High-End Virtual Appliance
UCSC-C240-M3L UCSC-C240-M3L UCSC-C240-M3L
UCS C240 M3 LFF w/o CPU, UCS C240 M3 LFF w/o CPU, UCS C240 M3 LFF w/o CPU,
memory, HD, PCIe, PSU w/rail kit, memory, HD, PCIe, PSU w/rail kit, memory, HD, PCIe, PSU w/rail kit,
expdr expdr expdr
UCS-CPU-E5-2609 UCS-CPU-E5-2660 UCS-CPU-E5-2660
2.4 GHz E5-2609/80W 4C/10MB 2.20 GHz E5-2660/95W 8C/20MB 2.20 GHz E5-2660/95W 8C/20MB
Cache/DDR3 1066MHz Cache/DDR3 1600MHz Cache/DDR3 1600MHz
UCS-MR-1X082RX-A UCS-MR-1X082RX-A UCS-MR-1X041RX-A
8GB DDR3-1333-MHz 8GB DDR3-1333-MHz 4GB DDR3-1333-MHz
RDIMM/PC3-10600/2R/1.35v RDIMM/PC3?10600/2R/1.35v RDIMM/PC3?10600/1R/1.35v
UCS-HDD300GI2F208 UCS-HDD300GI2F208 UCS-HDD300GI2F208
300GB SAS 15K RPM 3.5 inch 300GB SAS 15K RPM 3.5 inch 300GB SAS 15K RPM 3.5 inch
HDD/hot plug/drive sled mounted HDD/hot plug/drive sled mounted HDD/hot plug/drive sled mounted
UCS-RAID-9266CV UCS-RAID-9266CV UCS-RAID-9266CV
MegaRAID 9266CV-8i w/TFM + MegaRAID 9266CV-8i w/TFM + MegaRAID 9266CV-8i w/TFM +
Super Cap Super Cap Super Cap
UCSC-PSU-650W UCSC-PSU-650W UCSC-PSU-650W
650W power supply for C-Series 650W power supply for C-Series 650W power supply for C-Series
rack servers rack servers rack servers
R2XX-DMYMPWRCORD R2XX-DMYMPWRCORD R2XX-DMYMPWRCORD
No power cord option No power cord option No power cord option
Resource Management
Resource management depends on the license that you want to deploy. Table 1-3 lists the different levels
at which you can configure the virtual appliance.
The Cisco MSE Virtual Appliance is downloaded from the Software Center on Cisco.com at
http://software.cisco.com/download/navigator.html. Each MSE virtual appliance instance requires an
MSE Virtual Appliance Activation license (L-MSE-7.0-K9). Without an activation license, the Mobility
Services Engine (MSE) starts in evaluation mode that is valid for 120 days. Even if service licenses are
present on the host, it rejects them if the activation license is not installed. The evaluation licenses are
limited by the AP count and the end device count. Contact the Cisco sales team for additional evaluation
licenses.
You must activate the virtual appliance using a virtual appliance activation license. You can get the
Unique Device Identifier (UDI) from the virtual appliance (run show udi on the appliance) or from
the MSE General Properties page in the Prime Infrastructure UI. Use this information to purchase the
virtual appliance activation license and permanent service licenses.
You can add a virtual appliance license to the Prime Infrastructure using the following options:
• Using the Add Mobility Service Engine page when you are installing MSE for the first time. See
Configuring MSE on the Prime Infrastructure, page 3-21 for more information.
• Using the License Center page. See the Connected Mobile Experiences Configuration Guide,
Release 8.0 for more information on adding a license file to the MSE.
Step 1 Install the MSE Virtual Appliance. For more information, see the Downloading the Cisco MSE Virtual
Appliance OVA File.
Step 2 Add the MSE to the Prime Infrastructure. For more information, see the
http://www.cisco.com/c/en/us/td/docs/wireless/mse/7-6/MSE_CAS/7_6_MSE_CAS/7_4_MSE_CAS_c
hapter_010.html#ID136.
Step 3 Choose Administration > License Center in the Prime Infrastructure UI to access the License Center
page.
Step 4 Choose Files > MSE Files from the left sidebar menu.
Step 5 Click Add to add a license.
The Add A License File dialog box appears.
Step 6 Select the MSE from the MSE Name drop-down list.
Step 7 Click Choose File to browse to the activation license file.
Step 8 Click OK.
Once you submit, the license is activated and license information appears in the License Center page.
This image shows recent changes to the License Center UI for the virtual appliance.
This chapter describes how to install the Cisco Mobility Services Engine (MSE) Open Virtual Appliance
(OVA) components and includes the following sections:
• Information About the Cisco MSE OVA, page 3-1
• Virtualization Concepts, page 3-1
• Overview of the Process for Installing the Cisco MSE Virtual Appliance on the VMware Virtual
Machine, page 3-2
Virtualization Concepts
Refer to these documents for information on virtualization:
• https://www.vmware.com/pdfvirtualization.pdf
• Virtualization Basics
• Setting Up ESXi
Process Description
1. Verify the requirements and prepare for Cisco MSE VA See the Verifying Prerequisites, page 3-2 for more
installation. information.
2. Download the Cisco MSE VA OVA file from Cisco.com. See the Downloading the Cisco MSE Virtual Appliance OVA
File, page 3-3 for more information.
3. Setting up the high end Virtual Appliance. See the Setting up the High End Virtual Appliance, page 3-3
for more information.
4. Deploy the OVA as an OVF template. See the Deploying the Cisco MSE OVA File as an OVF
Template, page 3-5 for more information.
A step-by-step template in the VSphere Client guides you
through this process. After you have completed the
step-by-step template, you can review all of the
information that you provided, make any corrections, and
then deploy the OVA.
5. Configure the basic settings. See the Configuring the Basic Settings to Start the MSE
Virtual Appliance VM, page 3-12 for more information.
6. Configure the MSE on Prime Infrastructure. See the Configuring MSE on the Prime Infrastructure,
page 3-21 for more information.
7. Synchronize the network design and tracking parameters. See Synchronizing the Network Designs, page 3-24 for more
information.
Verifying Prerequisites
Before installing the Mobility Services Engine (MSE) in a virtual machine, you must ensure the
following:
• Latest version of VMware ESX/ESXi is installed and configured on the machine you plan to use as
the MSE server host. See the VMware documentation for information on setting up and configuring
your host machine.
• The installed VMware ESXi host is reachable.
• You can use the latest version of vSphere Client to manage the small deployments.
• Latest version of vCenter Server is installed on a Windows host in order to manage the ESXi hosts.
Step 1 Access the Cisco MSE Virtual Appliance image at the following location:
http://software.cisco.com/download/navigator.html.
Step 2 In the Product/Technology Support section, choose Download Software.
Step 3 In the Select a Product section, navigate to the Wireless software by choosing Products > Wireless >
Mobility Services > Cisco Mobility Services Engine Virtual Appliance.
A list of the latest release software for Cisco Mobility Services Engine Virtual Appliance is available for
download.
Step 4 In the Latest list, choose 7.6.100.0 or the latest 7.6 Release version to download.
Step 5 You can select any of the following ova files to download:
• MSE-VA-8-0-x-x.ova—Use this file to deploy MSE on a medium and high end VMware ESXi
machine. This OVA is configured by default for the standard appliance. You need to make some
modifications for OVA to work as high end appliance. See Setting up the High End Virtual
Appliance for more information.
• MSE-VA-8-0-x-x-LowEnd.ova—Use this file to deploy MSE on a low end VMware ESXi
machine.
Step 6 Save the installer to your computer in a place that will be easy to find when you start to deploy the OVF
template.
Step 1 Follow the steps given in Deploying the Cisco MSE OVA File as an OVF Template to deploy the OVA
file.
Step 2 You must upgrade the virtual hardware on the latest ESXi server while the Virtual Machine (VM) is
powered off before increasing the CPU count. To assign more than 8 cores to the Virtual Appliance, you
need to upgrade the virtual hardware. See Figure 3-1.
Step 3 Edit the memory allocation and ensure that proper resources are assigned. See Table 3-2.
Note These levels are configurable on the virtual appliance and corresponding requirements. Allocate
dedicated cores to the appliance and not hyper threaded virtual cores. The performance is
affected if you assume host has more virtual cores and deploy more appliances.
Note Make sure that all of the system requirements are met before you deploy the OVA. Review the Verifying
Prerequisites, page 3-2.
Note After a fresh OVA deployment, you must reboot the Virtual Machine (VM) once.
Note For more information on thick and thin provision, see “Step 10” task.
Step 7 Click Next. The Name and Location window appears (see Figure 3-6).
Step 8 In the Name field, enter a template name for the new virtual appliance. If you are using the vCenter to
manage the virtual machine, then you will have the option of selecting the location of the inventory.
Step 12 For each network specified in the OVF template, select a network by right-clicking the Destination
Network column in your infrastructure to set up the network mapping.
Step 13 Click Next.
The Ready to Complete window appears (see Figure 3-7).
Step 14 Review each of the deployment settings that you have established (see Figure 3-7).
Step 15 Press Back to make any changes to the settings and click Finish to complete the deployment.
A progress bar keeps pace with your Cisco MSE virtual appliance deployment, which can take from 5
to 10 minutes to finish depending on the network latency (see Figure 3-8). When the deployment is
finished, the Deployment Completed Successfully dialog box opens.
Step 17 On the Summary tab in the VSphere Client, review the information about the Virtual Machine.
Step 18 The virtual appliance that you deployed is listed under the host, in the left pane of the VSphere Client.
Step 19 Edit the MSE virtual appliance template to map the management and data interfaces network interfaces
to the desired configuration before powering up the MSE virtual appliance.
Step 20 Proceed with installing and configuring the MSE. See Configuring the Basic Settings to Start the MSE
Virtual Appliance VM, page 3-12 for more information.
Step 1 In the VSphere Client, click the MSE virtual appliance node in the resource tree. The virtual machine
node should appear in the Hosts and Clusters tree below the host, cluster, or resource pool to which you
deployed the MSE virtual appliance.
Step 2 If you have not powered on the virtual machine while deploying the OVA file, then right-click on the
virtual appliance that is listed in the left pane of the VSphere Client, and choose Power > Power on.
The Recent Tasks window at the bottom of the VSphere Client pane indicates the status of the task
associated with powering on the virtual machine. After the virtual machine successfully starts, the status
column for the task shows Completed.
Step 3 Click the Console tab, within the console pane to make the console prompt active for keyboard input.
The VM starts booting.
Step 4 Press Enter for the login prompt to appear to initiate the MSE Installation Wizard. The following is
displayed:
------------------------------------------------------------------
Cisco Mobility Service Engine
mse login: root
Password: password
Running the Cisco Mobility Services Engine installer. It may take several minutes to
complete.
CISCO-MSE-L-K9-8-0-x-x-64bit.bin
MSE_PUB.pem
signhash.bin
Preparing to install...
Extracting the JRE from the installer archive...
Unpacking the JRE...
Extracting the installation resources from the installer archive...
Configuring the installer for this system’s environment...
Launching installer...
================================================================
Cisco Mobility Services Engine (created with InstallAnywhere by Macrovision)
----------------------------------------------------------------
Auto Startup
------------
The Cisco MSE is configured to startup automatically at system boot up. You can modify
this setting using setup.shafter installation is completed.
================================================================
Installing...
-------------
[==================|==================|==================|=============]
[------------------|------------------|------------------|-------------]
========================================================================
Database Installation
---------------------
The installer will now install the database. This may take a long time (up to 30 minutes).
Do not cancel the installer during this setup.
=======================================================================
-------------------------------------------------------------------]
Note After the initial installation, you are logged off the newly created VM and you must login to the
console panel again.
Would you like to setup initial parameters using menu options (yes/no) [yes]:
[Press Enter to use the default values (yes) to use the Menu options]
Please note that the following parameters are mandatory and must be configured at lease
once.
-> Hostname
-> Network interface eth0
-> Timezone settings
-> Root password
-> NTP settings
-> Prime Infrastructure password
You must select option 24 to verify and apply any changes made during this session.
--------------------------------------------------------------
--------------------------------------------------------------
Configure MSE:
Note It is highly recommended that all relevant items be configured during initial setup to ensure
optimum operation of the mobility services engine in your network. The hostname and either the
Ethernet-0 (eth0) or the Ethernet-1 (eth1) port must always be configured during the automatic
installation.
Note You can rerun the automatic installation script at any time to add or change parameters using this
command:
[root@mse]# /opt/mse/setup/setup.sh.
There is no need to re-enter values that you do not want to change during one of these updates.
Note If you do not want to configure an item, enter skip and you are prompted for the next
configuration step. Any setting skipped is retained and not modified.
Note Minimal configuration is done for the mobility services engine as part of installation using the
console. All configurations beyond the initial setup using the automatic installation is done with
the Cisco Prime Infrastructure.
Current Hostname=[mse]
Configure Hostname? (Y)es/(S)kip/(U)se default [Skip]: y
The host name should be a unique name that can identify
the device on the network. The hostname should start with
a letter, end with a letter or number, and contain only
letters, numbers, and dashes.
Note If your wIPS deployment consists of a Cisco MSE and other devices (such as Cisco WLCs and
access points), set the Cisco MSE and the other devices to the same time zone.
Current Timezone=[America/New_York]
Configure Timezone? (Y)es/(S)kip/(U)se default [Skip]: y
Please identify a location so that time zone rules can be set correctly.
Please select a continent or ocean.
1) Africa
2) Americas
3) Antarctica
4) Arctic Ocean
5) Asia
6) Atlantic Ocean
7) Australia
8) Europe
9) Indian Ocean
10) Pacific Ocean
11) UTC - I want to use Coordinated Universal Time.
#? 2
Please select a country.
1) Anguilla 27) Honduras
2) Antigua & Barbuda 28) Jamaica
3) Argentina 29) Martinique
4) Aruba 30) Mexico
5) Bahamas 31) Montserrat
6) Barbados 32) Netherlands Antilles
7) Belize 33) Nicaragua
8) Bolivia 34) Panama
9) Brazil 35) Paraguay
10) Canada 36) Peru
11) Cayman Islands 37) Puerto Rico
12) Chile 38) St Barthelemy
13) Colombia 39) St Kitts & Nevis
14) Costa Rica 40) St Lucia
15) Cuba 41) St Martin (French part)
16) Dominica 42) St Pierre & Miquelon
17) Dominican Republic 43) St Vincent
18) Ecuador 44) Suriname
19) El Salvador 45) Trinidad & Tobago
United States
Pacific Time
Note If you do not set the root password, a warning message is displayed when you apply the settings.
A valid password should be a mix of upper and lower case letters, digits, and other
characters. You can use an 8 character long password with characters from all of these
classes. An upper case letter that begins the password and a digit that ends it do not
count towards the number of character classes used.
Note If you do not set the password, a warning message appears when you apply the settings. The
default PI communication password is admin.
-----------------------------BEGIN----------------------------
Hostname=mse8-0
Eth0 IP address= , Eth0 network mask=255.255.254.0
Time zone=America/Los_Angeles
Enable DNS=yes, DNS servers=8.8.8.8
Enable NTP=yes, NTP servers=time.nist.gov
Time zone=America/Los_Angeles
Root password is changed.
Cisco Prime Infrastructure password is changed.
------------------------------END-----------------------------
Configuration Changed
Is the above information correct (yes or no): yes
--------------------------------------------------------------
------------
Checking mandatory configuration information...
The system is minimally configured right now. It is strongly recommended that you run the
setup script under /opt/mse/setup/setup.sh command to configure all appliance related
parameters immediately after installation is complete.
Note The next time you log in using root, only the Linux shell prompt appears and not the setup script.
You can rerun the setup script at any time to change settings by logging in as root and running
/opt/mse/setup/setup.sh.
Step 15 Log in and configure the MSE to automatically launch after boot up.
Cisco Mobility Service Engine
mse8-0 login:
Passsword:
Step 16 To configure the MSE to automatically launch after boot up, enter the following command:
[root@mse8-0]# chkconfig msed on
Note To start the MSE service manually, enter the following command:
[root@mse8-0]# service msed start
The setup script generates a log file that can be found at /opt/mse/setup/setup.log.
Step 1 Launch Mozilla Firefox 11.0 or 12.0 or Internet Explorer 8 or 9 with the Chrome plug-in releases or
Google Chrome 19.0. The Internet Explorer versions below than 8 are not recommended.
Note When you use Firefox to log in and access Prime Infrastructure for the first time, the Firefox
web browser displays a warning stating that the site is untrustable. When Firefox displays this
warning, follow the prompts to add a security exception and download the self-signed certificate
from Prime Infrastructure server. After you complete this procedure, Firefox accepts Prime
Infrastructure server as a trusted site both now and during all future login attempts.
Step 2 In the address line of browser, enter https://pi-ip-address, where pi-ip-address is the IP address of the
server on which you installed and started Prime Infrastructure. Prime Infrastructure uses interface
displays the Login page.
Step 3 Enter the username. The default username is root.
Step 4 Enter the root password you created during the PI setup and not the MSE setup and click Login.
Note If any licensing problem occur, a message appears in an alert box. If you have an evaluation
license, the number of days until the license expires is shown. You are also alerted to any expired
licenses. You have the option to go directly to the licensing page to address these problem.
Note A mobility services engine is added only if a valid IP address is entered. The Device Name helps
you distinguish between devices if you have multiple Prime Infrastructures with multiple
mobility services engines, but is not considered when validating a mobility services engine.
Note This refers to the Prime Infrastructure communication username and password created during
the setup process.If you have not specified the username and password during the setup process,
use the defaults. The default username and password are both admin.
Step 8 Select the Delete synchronized service assignments check box if you want to permanently remove all
service assignments from the mobility services engine.
This option is applicable for network designs, wired switches, controllers and event definitions. The
existing location history data is retained, however, you must use manual service assignments to perform
any future location calculations.
Step 9 Click Next.
The MSE License Summary page appears (see Figure 3-10). You can use the MSE License Summary
page to install a license, add a license, remove a license, install an activation license, and install service
license.
Step 10 Click Add License to add a license. You can install an activation license and service license.
The Add a License File dialog box appears.
Step 11 Click Choose File to browse to and select the license file.
Step 12 Click OK to add the license. The newly added license appears in the MSE license file list.
Step 13 To remove an MSE license file, click Remove License.
Step 14 Choose an MSE license file that you want to remove by selecting the MSE License File radio button,
and click Remove.
Step 15 Click OK to confirm the deletion.
Step 16 Click Next to enable services on the mobility services engine.
Step 17 To enable a service, select the check box next to the service. These are the available services:
• Context Aware Service
• WIPS
• Mobile Concierge Service
• CMX Analytics
• CMX Browser Engage
• HTTP Proxy Service
Note Select the services you need and for which you have the licenses. If you select CMX Analytics,
you must also select the Context Aware Service.
Step 18 Click Next. The Select Tracking & History Parameters page appears.
Note If you skip configuring the tracking parameters, the default values are selected.
Step 19 You can select the clients to be tracked using the Prime Infrastructure by selecting the corresponding
Tracking check box(es). Make sure that wireless clients are tracked.
The various tracking parameters are as follows:
• Wired Clients
• Wireless Clients
• Rogue Access Points
– Exclude Adhoc Rogue APs
• Rogue Clients
• Interferers
• Active RFID Tags
Step 20 You can enable the history tracking of devices by selecting the corresponding devices check box(es). The
different history parameters are as follows:
• Wired Stations
• Client Stations
• Rogue Access Points
• Rogue Clients
• Interferers
• Asset Tags
Step 21 Click Next to assign maps to the MSE and view your managed system on realistic campus, building,
outdoor area, and floor maps.
Note The Assigning Maps page is available only if you select Context Aware Service as one of the
services to be enabled on the MSE.
Table 3-3 lists the preset filters that are available in the Assigning Maps page. Choose the filter you want
to show from the Show drop-down list.
Filter Results
All Shows all maps (Campus, Building, Floor, Outdoor area).
Campus Shows only the campus maps list.
Building Shows only the building maps list.
Floor Shows only the floor area maps list.
Outdoor Area Shows only the outdoor area maps list.
In addition, you can use the filter icon ( ) to filter the maps that match the filter rules. If you want
to specify a filter rule, choose All from the Show drop-down list before you click ( ).
Step 22 To synchronize the map, select the Name check box and click Synchronize. Upon synchronization of
the network designs, the appropriate controllers that have APs assigned on a particular network design
are synchronized with the MSE automatically.
Step 23 Click Next to configure the mobile application integration.
Step 24 Click Done in the Mobile App Enablement page.
A dialog box appears.
Step 25 Click OK to save the MSE settings.
You must synchronize the network designs. See Synchronizing the Network Designs, page 3-24.
Step 15 Verify that the mobility services engine is communicating with each of the controllers for only the
chosen service. This can be done by clicking the NMSP status link in the status page.
Note After synchronizing a controller, verify that the timezone is set on the associated controller.
Note Controller names must be unique for synchronizing with a mobility services engine. If you have
two controllers with the same name, only one is synchronized. You can use the same procedure
to assign Catalyst switches or event groups to a mobility services engine.
Citrix XenServer is a complete server virtualization platform, optimized for both Windows and Linux
virtual servers with all the capabilities required to create and manage a virtual infrastructure.
Citrix XenServer runs directly on server hardware without requiring an underlying operating system,
which results in an efficient and scalable system. XenServer works by abstracting elements from the
physical machine and allocates them to the Virtual Machines (VMs) running on it.
Citrix XenCenter is the Windows-native graphical user interface for managing Citrix XenServer. Import
of MSE virtual appliance onto the XenServer is done using the XenCenter.
This chapter contains the Overview of the Process for Installing the Cisco MSE Virtual Appliance On a
XenServer, page 4-1.
Process Description
1. Verify the requirements and prepare for See Verifying Requirements, page 4-2 for more information.
Cisco MSE VA installation.
2. Download the Cisco MSE VA OVA file See Downloading the Cisco MSE Virtual Appliance OVA File, page 4-2 for
from Cisco.com. more information.
3. Importing VMs. See Importing the MSE Virtual Appliance Using the XenCenter, page 4-3 for
more information.
4. Configure the basic settings. See Configuring the Basic Settings to Start the MSE Virtual Appliance VM,
page 4-10 for more information.
5. Configure the MSE on Prime See Configuring MSE on the Prime Infrastructure, page 4-18 for more
Infrastructure. information.
6. Synchronize the network design and See Synchronizing the Network Design and Tracking Parameters, page 4-18
tracking parameters. for more information.
Verifying Requirements
Table 4-2 describes the requirements to verify.
Step 1 Access the Cisco MSE Virtual Appliance image at the following location:
http://software.cisco.com/download/navigator.html
Step 2 In the Product/Technology Support section, choose Download Software.
Step 3 In the Select a Product section, navigate to the Wireless software by choosing Products > Wireless >
Mobility Services > Cisco Mobility Services Engine Virtual Appliance.
A list of the latest release software for Cisco Mobility Services Engine Virtual Appliance is available for
download.
Step 4 In the Latest list, choose 7.6.100.0.
Step 5 You can select any of the following ova files to download:
• MSE-XEN-VA-8-0-100-0-Generic.ova—Use this file for a new MSE deployment on a Xen
platform.
• MSE-XEN-VA-8-0-100-0-LowEnd.ova—Use this file for a new MSE deployment on a low-end
Xen platform.
Step 6 Save the installer to your computer in a place that will be easy to find when you start the deployment.
Step 1 Launch XenCenter Client application on your desktop and log in using the Administrative privileges.
Step 2 Add XenServer to XenCenter if it is not added. You can skip this step if you have already connected the
XenCenter to the XenServer host. See this URL for more information:
https://support.citrix.com/servlet/KbServlet/download/32306-102-691299/QuickStartGuide_BasicVers
ion.pdf.
Step 3 Right-click on XenServer in the XenCenter client and choose Import to import the MSE OVA file.
The Import wizard appears.
Step 4 In the Import Source page, click Browse to select the MSE OVA file (see Figure 4-1).
Step 5 From the Open dialog box, locate the appropriate .ova file that you downloaded to your computer and
click Open.
Step 6 Click Next.
The Location page appears (see Figure 4-2).
Note If the package you are importing includes any EULAs, accept them and click Next to continue.
If there are no EULAs included in the package, the wizard skips this step and goes to the next
page. Review and accept End User License Agreement (EULA).
Step 7 In the Location page, choose the pool or standalone server where you want to place the VM(s). You can
also specify a Home Server within the selected pool for each imported VM.
• From the Import VM(s) to drop-down list, choose the destination pool or standalone server where
you want to place the VMs that you are importing and assign them a home server. The Add New
Server window appears.
– In the Server text box, enter the host name or IP address of the server you want add.
– In the User name text box, enter the user name for that server.
– In the Password text box, enter the password.
• To assign imported VM(s) to a home server, select the server from the list in the Home Server
column (see Figure 4-2). For more information on assigning a home server to new VMs, see the
Home Server documentation available at the Citrix Website.
• To place the imported disk images on the same SR, click Place all imported virtual disks on this
target SR radio button and select an SR from the list.
• To place the disk images of incoming VMs onto different SRs, click Place imported virtual disks
onto specified target SR radio button and select the target SR from the drop-down list in the
Storage Repository column.
Step 24 The OVA will be in shutdown state as soon as the import is completed.
Step 25 Start the Virtual Machine (VM).
Right-click on the imported file and select Start.
Step 1 In the XenCenter Client, click the MSE virtual appliance node in the resource tree.
Step 2 Click the Console tab, within the console pane to make the console prompt active for keyboard input.
The VM starts booting.
Step 3 Press Enter for the login prompt to appear to initiate the MSE Installation Wizard. The following is
displayed:
------------------------------------------------------------------
Cisco Mobility Service Engine
Xen-8-6-x-x login: root
Password: password
Running the Cisco Mobility Services Engine installer. It may take several minutes to
complete.
CISCO-MSE-K9-8-0-X-X-64bit.bin
MSE-PUB.pem
signhash.bin
Preparing to install...
Extracting the JRE from the installer archive...
Unpacking the JRE...
Extracting the installation resources from the installer archive...
Configuring the installer for this system’s environment...
Launching installer...
Preparing CONSOLE Mode Installation...
============================================================
Introduction
------------
InstallAnywhere will guide you through the installation of Cisco Mobility Services Engine.
It is strongly recommended that you quit all programs before continuing with this
installation.
Respond to each prompt to proceed to the next step in the installation. If you want to
change something on a previous step, type ‘back’.
Licensing on the Mobility Services Engine is enforced with the release of software version
6.x and greater. Please have the Product Authorization key (PAK) and refer to the
instructions in the User Guide to enable licensing.
===============================================================
Installation Check
------------------
================================================================
Cisco Mobility Services Engine Installation Message
----------------------------------------------------------------
Cisco MSE v8.0 upgrade procedure may take several hours to complete, depending on the
amount of data on the system.
During the upgrade process, please ensure that the session to the MSE is not terminated.
User action is needed at the end of the installation process.
-> 1- Exit
2- Continue
ENTER THE NUMBER OF THE DESIRED CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT: ^[
================================================================
Installing...
-------------
[==================|==================|==================|=============]
[------------------|------------------|------------------|-------------]
Database Installation
---------------------
The installer will now install the database. This may take a long time (up to 30 minutes).
Do not cancel the installer during this set up.
========================================================================
-----------------------------------------------------------------------]
Note After the initial installation, you are logged off the newly created VM and you must login to the
console panel again.
Note If the MSE does not prompt for setup, enter the following command: /opt/mse/setup/setup.sh.
Would you like to setup initial parameters using menu options (yes/no) [yes]:
[Press Enter to use the default values (yes) to use the Menu options]
Please note that the following parameters are mandatory and must be configured at lease
once.
-> Hostname
-> Network interface eth0
-> Timezone settings
-> Root password
-> NTP settings
-> Prime Infrastructure password
You must select option 24 to verify and apply any changes made during this session.
--------------------------------------------------------------
--------------------------------------------------------------
Configure MSE:
--------------------------------------------------------------
Note It is highly recommended that all relevant items must be configured during initial setup to ensure
optimum operation of the mobility services engine in your network. The hostname and either the
Ethernet-0 (eth0) or the Ethernet-1 (eth1) port must always be configured during the automatic
installation.
Note You can rerun the automatic installation script at any time to add or change parameters using this
command:
[root@mse]# /opt/mse/setup/setup.sh.
There is no need to re-enter values that you do not want to change during one of these updates.
Note If you do not want to configure an item, enter skip and you are prompted for the next
configuration step. Any setting skipped is retained and not modified.
Note Minimal configuration is done for the mobility services engine as part of installation using the
console. All configurations beyond the initial setup using the automatic installation is done with
the Cisco Prime Infrastructure.
Current hostname=[Xen-8-0-x-x]
Configure hostname? (Y)es/(S)kip/(U)se default [Skip]: y
The host name should be a unique name that can identify
the device on the network. The hostname should start with
a letter, end with a letter or number, and contain only
letters, numbers, and dashes.
Current IP address=[10.0.0.1]
Current eth0 netmask=[255.0.0.0]
Current IPv4 gateway address=[172.20.104.123]
Configure eth0 interface parameters? (Y)es/(S)kip/(U)se default [Skip]:y
Note If your wIPS deployment consists of a Cisco MSE and other devices (such as Cisco WLCs and
access points), set the Cisco MSE and the other devices to the same time zone.
Please identify a location so that time zone rules can be set correctly.
Please select a continent or ocean.
1) Africa
2) Americas
3) Antarctica
4) Arctic Ocean
5) Asia
6) Atlantic Ocean
7) Australia
8) Europe
9) Indian Ocean
10) Pacific Ocean
11) UTC - I want to use Coordinated Universal Time.
#? 2
Please select a country.
1) Anguilla 27) Honduras
2) Antigua & Barbuda 28) Jamaica
3) Argentina 29) Martinique
4) Aruba 30) Mexico
5) Bahamas 31) Montserrat
6) Barbados 32) Netherlands Antilles
7) Belize 33) Nicaragua
8) Bolivia 34) Panama
9) Brazil 35) Paraguay
10) Canada 36) Peru
11) Cayman Islands 37) Puerto Rico
12) Chile 38) St Barthelemy
13) Colombia 39) St Kitts & Nevis
14) Costa Rica 40) St Lucia
15) Cuba 41) St Martin (French part)
16) Dominica 42) St Pierre & Miquelon
17) Dominican Republic 43) St Vincent
18) Ecuador 44) Suriname
19) El Salvador 45) Trinidad & Tobago
United States
Pacific Time
Note If you do not set the root password, a warning message is displayed when you apply the settings.
A valid password should be a mix of upper and lower case letters, digits, and other
characters. You can use an 8 character long password with characters from all of these
classes. An upper case letter that begins the password and a digit that ends it do not
count towards the
number of character classes used.
Note If you do not set the password, a warning message appears when you apply the changes. The
default PI communication password is admin.
-----------------------------BEGIN----------------------------
Hostname=mse8-0
Eth0 IP address= , Eth0 network mask=255.255.254.0
Time zone=America/Los_Angeles
Enable DNS=yes, DNS servers=8.8.8.8
Enable NTP=yes, NTP servers=time.nist.gov
Time zone=America/Los_Angeles
Root password is changed.
Cisco Prime Infrastructure password is changed.
------------------------------END-----------------------------
Configuration Changed
Is the above information correct (yes or no): yes
Note The next time you log in using root, only the Linux shell prompt appears and not the setup script.
You can rerun the setup script at any time to change settings by logging in as root and running
/opt/mse/setup/setup.sh.
Step 14 To configure the MSE to automatically launch after boot up, enter the following command:
[root@Xen-8-0-x-x]# chkconfig msed on
Note To start the MSE service manually, enter the following command:
[root@Xen-8-0-x-x]# service msed start
The setup script generates a log file that can be found at /opt/mse/setup/setup.log.
Hyper-V™ is a Microsoft® technology that enables the deployment of virtual servers. Hyper-V is a role
in Windows Server 2008 and Windows Server 2012 that provides the tools and services that can use to
create a virtualized server computing environment. This type of environment is useful to create and
manage virtual machines, that allow running multiple operating systems on one physical computer and
isolate the Operating System from each other.
For more information about Microsoft Hyper-V, see this URL:
http://technet.microsoft.com/en-us/library/cc732470(v=ws.10).aspx
This chapter contains the following sections:
• Installation Requirements for Microsoft Hyper-V, page 5-1
• Overview of the Process for Installing the Cisco MSE Virtual Appliance on a Hyper-V Platform,
page 5-1
Process Description
1. Verify the requirements and prepare for Cisco See Verifying Prerequisites, page 5-2 for more information.
MSE VA installation.
2. Download the Cisco MSE VA Tar file from See Downloading the Cisco MSE Virtual Appliance Tar File, page 5-2
Cisco.com. for more information.
Process Description
3. Deploying the VHD package. See Importing MSE Appliance on the Microsoft Hyper-V, page 5-3 for
more information.
4. Configure the basic settings. See Configuring the Basic Settings to Start the MSE Virtual Appliance
VM, page 5-11 for more information.
5. Configure the MSE on Prime Infrastructure. See Configuring MSE on the Prime Infrastructure, page 5-17 for more
information.
6. Synchronize the network design and tracking See Synchronizing the Network Design and Tracking Parameters,
parameters. page 5-17 for more information.
Verifying Prerequisites
• Install Hyper-V
• Create and Set up a virtual machine
• Install the guest operating system and integration services
• Configure virtual networks
Refer to these URLs for more information:
• http://technet.microsoft.com/en-us/library/cc732470(v=ws.10).aspx
• http://technet.microsoft.com/en-in/library/gg610610.aspx
Step 1 Access the Cisco Mobility Services Engine (MSE) Virtual Appliance image at the following location:
http://software.cisco.com/download/navigator.html
Step 2 In the Product/Technology Support section, choose Download Software.
Step 3 In the Select a Product section, navigate to the Wireless software by choosing Products > Wireless >
Mobility Services > Cisco Mobility Services Engine Virtual Appliance.
A list of the latest release software for Cisco Mobility Services Engine Virtual Appliance is available for
download.
Step 4 In the Latest list, choose 8.0.x.x.
Step 5 You can select any of the following files to download:
• MSE-HYPERV-VA-8-0-x-x-Generic.tar.bz2—Use this file for a new MSE deployment on a
Hyper-V platform.
• MSE-HYPERV-VA-8-0-x-x-LowEnd.tar.bz2—Use this file for a new MSE deployment on a
low-end Hyper-V platform.
Step 6 Save the installer to your computer in a place that will be easy to find when you start the deployment.
Step 1 Download the MSE tar file as specified in this procedure: Downloading the Cisco MSE Virtual
Appliance Tar File, page 5-2.
Step 2 Extract the MSE appliance tar file using any of the extract tools that you have (see Figure 5-1).
Note Do not change the name of any files that are extracted and make sure that the absolute path does
not contain any spaces.
Step 3 You can run the MSE-HyperV-Client-Utility.ps1 file in the following ways:
• Double click the utility.ps1 file and follow Step 4 through Step 8.
• Open the Windows PowerShell Client and go to the location where the archive is extracted and then
run this file: ./MSE-hyperv-client-utility.ps1. Follow the steps from Step 9 through Step 19.
Step 4 Double click the MSE-Hyper-Client-Utility file.
Step 5 Provide the appropriate Virtual Machine (VM) name.
Enter the Virtual Machine name (Press [Enter] to choose Default[]):
Step 6 Enter the VHD location.
Enter the VHD location to be stored (Press [Enter] to choose Default
[C:\Users\Public\Documents\Hyper-V\]):
Step 7 Enter the VM location.
Enter the location to store the files for the new virtual machine (Press [Enter)
to choose Default [C:\ProgramData\Microsoft\Windows\Hyper-V\]):
Step 8 The MSE appliance is deployed in the Hyper-V server as shown below.
Step 9 Open the power shell and go to the location where the archive is extracted and run the file
./MSE-hyperv-client-utility.ps1 as shown in the figure below.
Step 12 Prompts for the location to store the VMs. Provide the path to store the virtual machine or press Enter
to store at the default location.
Step 13 The VM with attached VHD is defined into the Hypervisor and starts the VM
Step 14 The newly created MSE appliance gets imported into the Check if the VM is up and running in the
Hyper-V-Manager Client.
Step 15 Open the Hyper-V-Manager and find the newly created VM.
Step 16 The virtual machine will be in shut down state as soon as the deployment is completed.
Note If the MSE does not prompt for setup, enter the following command: /opt/mse/setup/setup.sh.
Would you like to setup initial parameters using menu options (yes/no) [yes]:
Please note that the following parameters are mandatory and must be configured at lease
once.
-> Hostname
-> Network interface eth0
-> Timezone settings
-> Root password
-> NTP settings
-> Prime Infrastructure password
You must select option 24 to verify and apply any changes made during this session.
--------------------------------------------------------------
--------------------------------------------------------------
Configure MSE:
Note It is highly recommended that all relevant items be configured during initial setup to ensure
optimum operation of the mobility services engine in your network. The hostname and either the
Ethernet-0 (eth0) or the Ethernet-1 (eth1) port must always be configured during the automatic
installation.
Note You can rerun the automatic installation script at any time to add or change parameters using this
command:
[root@mse]# /opt/mse/setup/setup.sh.
There is no need to re-enter values that you do not want to change during one of these updates.
Note If you do not want to configure an item, enter skip and you are prompted for the next
configuration step. Any setting skipped is retained and not modified.
Note Minimal configuration is done for the mobility services engine as part of installation using the
console. All configurations beyond the initial setup using the automatic installation is done with
the Cisco Prime Infrastructure.
Current hostname=[mse-kw]
Configure hostname? (Y)es/(S)kip/(U)se default [Skip]: y
The host name should be a unique name that can identify
the device on the network. The hostname should start with
a letter, end with a letter or number, and contain only
letters, numbers, and dashes.
Current IP address=[10.0.0.1]
Current eth0 netmask=[255.0.0.0]
Current IPv4 gateway address=[172.20.104.123]
Configure eth0 interface parameters? (Y)es/(S)kip/(U)se default [Skip]:y
Note If your wIPS deployment consists of a Cisco MSE and other devices (such as Cisco WLCs and
access points), set the Cisco MSE and the other devices to the same time zone.
Current timezone=[America/]
Configure timezone? (Y)es/(S)kip/(U)se default [Skip]: y
Please identify a location so that time zone rules can be set correctly.
Please select a continent or ocean.
1) Africa
2) Americas
3) Antarctica
4) Arctic Ocean
5) Asia
6) Atlantic Ocean
7) Australia
8) Europe
9) Indian Ocean
10) Pacific Ocean
11) UTC - I want to use Coordinated Universal Time.
#? 2
Please select a country.
1) Anguilla 27) Honduras
2) Antigua & Barbuda 28) Jamaica
3) Argentina 29) Martinique
4) Aruba 30) Mexico
5) Bahamas 31) Montserrat
6) Barbados 32) Netherlands Antilles
7) Belize 33) Nicaragua
8) Bolivia 34) Panama
9) Brazil 35) Paraguay
10) Canada 36) Peru
11) Cayman Islands 37) Puerto Rico
12) Chile 38) St Barthelemy
13) Colombia 39) St Kitts & Nevis
United States
Pacific Time
Note If you do not set the root password, a warning message is displayed when you apply the settings.
A valid password should be a mix of upper and lower case letters, digits, and other
characters. You can use an 8 character long password with characters from all of these
classes. An upper case letter that begins the password and a digit that ends it do not
count towards the number of character classes used.
Note If you do not set the password, a warning message appears when you apply the settings. The
default PI communication password is admin.
-----------------------------BEGIN----------------------------
Hostname=mse8-0
Eth0 IP address= , Eth0 network mask=255.255.254.0
Time zone=America/Los_Angeles
Enable DNS=yes, DNS servers=8.8.8.8
Enable NTP=yes, NTP servers=time.nist.gov
Time zone=America/Los_Angeles
Root password is changed.
Cisco Prime Infrastructure password is changed.
------------------------------END-----------------------------
Configuration Changed
Is the above information correct (yes or no): yes
--------------------------------------------------------------
------------
Checking mandatory configuration information...
The system is minimally configured right now. It is strongly recommended that you run the
setup script under /opt/mse/setup/setup.sh command to configure all appliance related
parameters immediately after installation is complete.
Note The next time you log in using root, only the Linux shell prompt appears and not the setup script.
You can rerun the setup script at any time to change settings by logging in as root and running
/opt/mse/setup/setup.sh.
Step 12 To configure the MSE to automatically launch after boot up, enter the following command:
[mse-kw]# chkconfig msed on
Note To start the MSE service manually, enter the following command:
[mse-kw]# service msed start
The setup script generates a log file that can be found at /opt/mse/setup/setup.log.
This appendix contains some of the MSE commands that you use while deploying the virtual appliance.
MSE Commands
Use these commands to monitor tasks while deploying the MSE virtual appliance.
Command Explanation
service msed status To determine the status of the MSE services.
service msed start To start the MSE service manually.
service msed stop To stop the MSE services.
rundiag To perform diagnostics. You can use this command to view MSE UDI information that is
required in order to obtain the license file for context-aware engine for clients.
ckkconfig msed on To configure the MSE to automatically launch after boot up.
show udi To get the Unique Device Identifier (UDI) from the virtual appliance.
getserverinfo To verify the configuration.
reboot To reboot the MSE.