Importing MSE Appliance on the Microsoft Hyper-V
NoteThe Microsoft® Hyper-V 2008 does not support theOpen Virtualization Format (OVF). For
Hyper-V 2012, you must extract the Virtual Hard Disk (VHD) bundle and deploy the Mobility Services Engine (MSE) appliance on the target Hyper-V.
Step 1 Download the MSE tar file as specified in this procedure: Download the Cisco MSE Virtual Appliance Tar File.
Step 2 Extract the MSE appliance tar file using any of the extract tools that you have (see Figure 5-1).
Figure 5-1 MSE Tar File
The extracted archive consists of these files (see Figure 5-2):
- HyperV client utility file (.ps1)
- MSE metadata file (.mf)
- MSE disk file (.vhd)
- MSE xml file (.ovf)
Figure 5-2 Extracted Files
NoteDo 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.
Figure 5-3 Hyper-V Deployment
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 10 Prompts for the name of the VM:
- Provide the appropriate name or press Enter for default name.
Step 11 Prompts for the location to store the .VHD file:
- Specify the location to store the .VHD file or press Enter to store the file in the default location as shown in the figure below. If you select the default location for storing, select the VHD and make sure that the default location is “C:\Users\Public\documents\Hyper-v\’ and has enough space to store the .VHD file.
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.
Figure 5-4 Deployed Appliance
Step 16 The virtual machine will be in shut down state as soon as the deployment is completed.
Step 17 Start the Virtual Machine (VM).
- Right-click on the imported file and select Start (see Figure 5-5).
Figure 5-5 Starting the Virtual Machine
Step 18 Check the network status of MSE VM.
- Right-click on the VM and select Settings (see).
Figure 5-6 Hyper-V-Manager
Step 19 In the Settings window, choose Hardware > IDE Controller 1 > Network Adapter1 to check the network that is attached to the NICs.
Figure 5-7 Settings Window
Configuring the Basic Settings to Start the MSE Virtual Appliance VM
You have completed deploying the MSE virtual appliance on a new virtual machine. A node for the virtual machine now appears in the resource tree in the HyperV-Manager window. After deployment, you need to configure basic settings for the MSE virtual appliance.
To start the MSE setup, follow these steps:
Step 1 Click the Console tab, within the console pane.
Step 2 Press Enter for the login prompt to appear to initiate the MSE Installation Wizard. The following is displayed:
------------------------------------------------------------------
Cisco Mobility Services Engine
Last login: Mon Apr 7 04:11:50 on tty1
NoteIf the MSE does not prompt for setup, enter the following command: /opt/mse/setup/setup.sh.
Enter whether you would like to set up the initial parameters manually or via the setup wizard.
Setup parameters via Setup Wizard (yes/no) [yes]: y
--------------------------------------------------------------
Welcome to the Cisco Mobility Services Engine appliance setup.
You may exit the setup at any time by typing <Ctrl+C>.
--------------------------------------------------------------
Would you like to configure MSE using menu options (yes/no): y
Mobility Services Engine Setup
Please select a configuration option below and enter the
requested information. You may exit setup at any time by
You will be prompted to choose whether you wish to configure a
parameter, skip it, or reset it to its initial default value.
Skipping a parameter will leave it unchanged from its current
Please note that the following parameters (indicated by *)
are mandatory and must be configured at least once.
-> Network interface eth0
-> NCS Communication username
-> NCS Communication password
Changes made will only be applied once all the modifications
are verified and confirmed.
--------------------------------------------------------------
NoteIt 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.
NoteYou 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.
NoteIf 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.
NoteMinimal 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.
Step 3 Configure the host name
Please enter your choice [1 - 23]: 2
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.
Enter a host name [mse-kw]:
Step 4 Configure eth0 network settings
Please enter your choice [1 - 23]: 5
Current IP address=[10.0.0.1]
Current eth0 netmask=[255.255.255.0]
Current IPv4 gateway address=[10.0.0.0]
Configure eth0 interface parameters? (Y)es/(S)kip/(U)se default [Skip]:y
Enter an IP address for first ethernet interface of this machine.
Enter eth0 IP address [10.0.0.1]:
Enter the network mask for IP address 10.0.0.1
Enter network mask [255.255.255.0]:
Enter an default gateway address for this machine.
Note that the default gateway must be reachable from
the first ethernet interface.
Enter default gateway address [10.0.0.0]:
Step 5 Configure the DNS Settings:
Please enter your choice [1 - 23]: 7
Domain Name Service (DNS) Setup
DNS is currently enabled.
No DNS servers currently defined
Configure DNS related parameters? (Y)es/(S)kip/(U)se default [Skip]: y
Enable DNS (yes/no) [no]: y
Enter primary DNS server IP address:
DNS server address must be in the form #.#.#.#, where # is 0 to 255 or hexadecimal : separated v6 address
Enter primary DNS server IP address:
Enter backup DNS server IP address (or none) [none]:
Step 6 Configure the time zone:
NoteUTC must be used when you are configuring for wIPS. For other services, you must use the same time zone as the controllers.
Please enter your choice [1 - 23]: 8
Current timezone=[America/]
Configure timezone? (Y)es/(S)kip/(U)se default [Skip]: y
Enter the current date and time.
Please identify a location so that time zone rules can be set correctly.
Please select a continent or ocean.
11) UTC - I want to use Coordinated Universal Time.
2) Antigua & Barbuda 28) Jamaica
3) Argentina 29) Martinique
5) Bahamas 31) Montserrat
6) Barbados 32) Netherlands Antilles
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
19) El Salvador 45) Trinidad & Tobago
20) French Guiana 46) Turks & Caicos Is
21) Greenland 47) United States
23) Guadeloupe 49) Venezuela
24) Guatemala 50) Virgin Islands (UK)
25) Guyana 51) Virgin Islands (US)
Please select one of the following time zone regions.
2) Eastern Time - Michigan - most locations
3) Eastern Time - Kentucky - Louisville area
4) Eastern Time - Kentucky - Wayne County
5) Eastern Time - Indiana - most locations
6) Eastern Time - Indiana - Daviess, Dubois, Knox & Martin Counties
7) Eastern Time - Indiana - Pulaski County
8) Eastern Time - Indiana - Crawford County
9) Eastern Time - Indiana - Pike County
10) Eastern Time - Indiana - Switzerland County
12) Central Time - Indiana - Perry County
13) Central Time - Indiana - Starke County
14) Central Time - Michigan - Dickinson, Gogebic, Iron & Menominee Counties
15) Central Time - North Dakota - Oliver County
16) Central Time - North Dakota - Morton County (except Mandan area)
18) Mountain Time - south Idaho & east Oregon
19) Mountain Time - Navajo
20) Mountain Standard Time - Arizona
23) Alaska Time - Alaska panhandle
24) Alaska Time - Alaska panhandle neck
25) Alaska Time - west Alaska
The following information has been given:
Therefore TZ='America/Los_Angeles' will be used.
Local time is now: Sun Apr 6 18:45:27 PDT 2014.
Universal Time is now: Mon Apr 7 01:45:27 UTC 2014.
Is the above information OK?
Step 7 Configure the NTP Setup
Please enter your choice [1 - 23]: 12
Network Time Protocol (NTP) Setup.
If you choose to enable NTP, the system time will be
configured from NTP servers that you select. Otherwise,
you will be prompted to enter the current date and time.
NTP is currently disabled.
Configure NTP related parameters? (Y)es/(S)kip/(U)se default [Skip]: y
Enter whether or not you would like to set up the
Network Time Protocol (NTP) for this machine.
If you choose to enable NTP, the system time will be
configured from NTP servers that you select. Otherwise,
you will be prompted to enter the current date and time.
Enable NTP (yes/no) [no]: y
Enter NTP server name or address [10.234.235.236]: 128.138.141.172
NTP server address must be in the form #.#.#.3, where # is 0 to 255 hexadecimal : separated v6 address.
Enter another NTP server IP address (or none) [10.245.246.247]:
Configure NTP Authentication ? (Y)es/(S)kip/(U)se default [Skip]: y
Enter NTP Auth key Number [1]:
Enter NTP Auth key Value (String) [Secret:
Do you want to continue (yes/no) [no]: y
Step 8 Configure the Root password:
Note If you do not set the root password, a warning message is displayed when you apply the settings.
Please enter your choice [1 - 23]: 18
Root password has not been configured
Configure root password? (Y)es/(S)kip/(U)se default [Skip]:
Changing password for user root.
You can now choose the new password.
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.
Step 9 Configure the NCS communication username:
Note The NCS communication username is required username for setting up the MSE in PI. This is not the PI username.
Please enter your choice [1 - 23]: 21
NCS communication username has not been configured
Configure NCS communication username? (Y)es/(S)kip/(U)se default [Skip]: y
This user is used by the NCS and other northbound systems to authenticate their SOAP/XML session with the server.
Step 10 Configure the NCS communication password:
Note If you do not set the password, a warning message appears when you apply the settings. The default PI communication password is admin.
Please enter your choice [1 - 23]: 22
NCS password has not been configured
Configure NCS communication password? (Y)es/(S)kip/(U)se default [Yes]:
Enter a password for the admin user.
The admin user is used by the NCS and other northbound systems to authenticate their SOAP/XML session with the server. Once this password is updated, it must correspondingly be updated on the NCS page for MSE General Parameters so that the NCS can communicate with the MSE.
Enter NCS communication password:
Step 11 Verify the setup information and apply the changes:
Please enter your choice [1 - 23]: 23
Please verify the following setup information.
-----------------------------BEGIN----------------------------
Eth0 IP address= , Eth0 network mask=255.255.254.0
Time zone=America/Los_Angeles
Enable NTP=yes, NTP servers=10.50.171.9
Time zone=America/Los_Angeles
Root password is changed.
------------------------------END-----------------------------
You may enter "yes" to proceed with configuration, "no" to make
Is the above information correct (yes or no): yes
The figure below shows an example of the completion screen:
Figure 5-8 Completion Screen
NoteThe 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 verify the configuration, run the getserverinfo command.
Step 13 To configure the MSE to automatically launch after boot up, enter the following command:
[mse-kw]# chkconfig msed on
Step 14 Reboot using the following command:
NoteTo 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.