Installation Guide For Cisco Unity Express Virtual 9.0.x: Americas Headquarters
Installation Guide For Cisco Unity Express Virtual 9.0.x: Americas Headquarters
x
First Published: 2016-12-24
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 SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
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.
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.
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: http://
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. (1110R)
CHAPTER 4 Cisco Unity Express Virtual Software Support for ESXi on Cisco UCS and Cisco UCS E-Series
Server Modules 13
Overview of Installation Steps 13
Hardware Requirements for Cisco Unity Express Virtual 14
Virtual Machine Requirements for Cisco Unity Express Virtual 14
Set up the VMware ESXi Environment 15
VMware Tools 15
Download the Cisco Unity Express Virtual OVA file 15
Deploy the Cisco Unity Express Virtual OVA 16
Configure Cisco Unity Express Virtual after Deployment 17
Example for Configuring the Cisco Unity Express Virtual 18
Verify Cisco Unified Communication Manager Express and Cisco Unity Express Virtual on
ESXi 23
Verify Cisco Unified Communication Manager and Cisco Unity Express Virtual on ESXi 23
CHAPTER 5 Cisco Unity Express Virtual Software Support on Cisco 4000 Series Integrated Services Routers
KVM Service Containers 25
Overview of OVA Installation Steps on KVM Service Container 25
Hardware Requirements for Cisco Unity Express Virtual KVMs on Cisco 4000 Series Integrated
Services Routers 26
Install and Configure the Cisco Unity Express Virtual OVA on KVM Service Containers 26
Deactivate and Uninstall Cisco Unity Express Virtual from KVM Service Containers 30
Upgrade Cisco Unity Express Virtual 9.0 or 9.0.1 to 9.0.2 32
Example for Accessing and Configuring the Cisco Unity Express Virtual in Cisco 4000 Series
Integrated Services Routers Service Container 32
Restoring Files 55
CHAPTER 12 Troubleshooting Cisco Unity Express Virtual Service on KVM Service Containers 57
Example for Verifying Installation Failure of Cisco Unity Express Virtual Service 57
Example for Verifying Activation Failure of Cisco Unity Express Virtual Service 59
Check Memory Present on Cisco 4000 Series Integrated Services Routers 60
9.0.5 Support for Cisco Smart Provides support for Cisco Unity Express
Software Licensing Cisco Smart Software Virtual Licensing, on
Licensing. CSL licensing page 41
is no longer supported.
9.0.3 Support for Cisco Unified Provides support for Cisco Unity Express
Communications Cisco Unified Virtual Compatibility
Manager 11.5 Communications Matrix
Manager 11.5 and later
versions.
9.0.3 End of Support for The commands license Cisco Unity Express
License Activation activate voicemail Virtual Licensing, on
Commands mailboxes, and license page 41
activate ports are not
supported from Cisco
Unity Express Virtual
9.0.3 onwards. The
license for mailboxes and
ports are enabled by
default.
9.0 Configure Cisco Unity Provides support to Install and Configure the
Express Virtual using CLI configure Cisco Unity Cisco Unity Express
Express Virtual using the Virtual OVA on KVM
Command Line Interface Service Containers, on
(CLI), with your SSH page 26
user credentials. For
example: ssh adminUser
@CUE-IP.
Cisco Unity Express Virtual application supports all the features that were supported on a bare-metal
installation of Cisco Unity Express on the SRE Module. You can install the Cisco Unity Express Virtual
application in the following ways:
For information about installing Cisco Unity Express Virtual within a VMWare ESXi environment, see Cisco
Unity Express Virtual Software Support for ESXi on Cisco UCS and Cisco UCS E-Series Server Modules,
on page 13.
Note Cisco Unity Express Virtual is supported starting on Cisco IOS XE Release 3.17 and later.
Note This section applies to a new installation of Cisco Unity Express Virtual.
If you are using Cisco Unified Communications Manager Express (Cisco Unified CME) with your Cisco
Unity Express Virtual system, Cisco Unified CME must be installed before you configure Cisco Unity Express
Virtual. If you did not perform the Cisco Unified CME installation, contact the designated installer to ensure
that the following procedures are completed:
Step 1 Verify that the version of Cisco Unified CME is compatible with Cisco Unity Express Virtual. See the Cisco Unity
Express Compatibility Matrix.
Step 2 Install all Cisco Unified CME and Cisco Unity Express Virtual hardware and verify functionality.
a) Attach the IP Phones so that they register with the Cisco Unified CME router. Configure the IP Phones and subscribers
and save them to the Cisco Unified CME database. The Cisco Unity Express Virtual initialization wizard allows you
to copy this data to the Cisco Unity Express Virtual database. You can create more subscribers and IP Phones later
using the Cisco Unity Express Virtual CLI commands or GUI options.
Use the following sample voice register dn and voice register pool configurations to configure the IP Phones and
subscribers manually:
voice register dn 24
number 8124
shared-line max-calls 6
!
voice register pool 124
id mac 0017.E033.0284
type 7965
number 1 dn 24
!
b) Verify that Cisco Unity Express Virtual will be installed and configured on a router that supports the hardware
modules that you are using.
Step 3 Install and verify Cisco Unified CME software functionality.
Depending on the version of Cisco Unified CME, you can perform some configuration using the Cisco Unified CME
graphical user interface. If the version of Cisco Unified CME does not support the GUI, see Cisco Unified Communications
Manager Express Administrator Guide. If your version of Cisco Unified CME supports the GUI, proceed with the
following steps:
Note Cisco Unified CME does not support SIP phones via the
GUI.
a) Verify that you have web connectivity to the Cisco Unified CME configuration web page. For example,
http://cisco-unified-cme-router-ipaddress/ccme.html.
b) Verify that the Cisco Unified CME router flash memory has the following files, which control the functionality of
the Cisco Unity Express Virtual GUI:
• CiscoLogo.gif
• Delete.gif
• Plus.gif
• Tab.gif
• admin_user.html
• admin_user.js
• dom.js
• downarrow.gif
• ephone_admin.html
• logohome.gif
• normal_user.html
• normal_user.js
• sxiconad.gif
• telephony_service.html
• uparrow.gif
• xml-test.html
• xml.template
Example:
Router(config)# ip http path flash:
d) Verify the path with the show running-config command.
e) Verify that a SIP dial peer is configured to point to the Cisco Unity Express Virtual module, that it specifies G.711
u-law and SIP Notify for DTMF Relay, and that VAD is turned off. This step is required to have an incoming call
directed to Cisco Unity Express Virtual. The following is an example configuration:
dial-peer voice 6000 voip ! SIP dial peer pointing to Cisco Unity Express Virtual
destination-pattern 6...
session protocol sipv2
dtmf-relay sip-notify
session target ipv4:172.16.0.1 ! Cisco Unity Express Virtual IP address
codec g711ulaw
no vad
f) Configure the appropriate number of SIP dial peers to support your dial plan.
g) Verify that a Cisco Unified CME web administrator is configured with a username and password, for example:
voice register global
.
.
.
web admin system name admin password user1
OR
Step 4 The FTP server that communicates with Cisco Unity Express Virtual must support passive FTP requests. To configure
this functionality on the FTP server, see your FTP server documentation.
Step 5 (Optional) If no subscribers were created in the Cisco Unified CME interface, create a list of all subscribers, groups, and
their extensions to simplify the task of configuring many subscribers and extensions.
Step 1 Verify that the version of Cisco Unified Communications Manager is compatible with Cisco Unity Express Virtual. See
Cisco Unity Express Compatibility Matrix.
Step 2 Install all Cisco Unified Communications Manager and Cisco Unity Express Virtual hardware and verify functionality.
See Cisco Unity Express Documentation for the hardware installation documentation for your module.
a) Attach the telephones so that they register with the Cisco Unified Communications Manager server.
b) On the Cisco Unified Communications Manager, configure up to 32 CTI ports for a Cisco Unity Express Virtual
system with a Cisco UCS E-Series module. You can configure up to 20 ports for the Cisco 4000 Series Integrated
Services Routers configured with Kernel Virtual Machine Service Containers. Use the Cisco Unified Communications
Manager option Device > Phones > Add new Phone. These ports will be used by the Cisco Unity Express Virtual
applications (voice mail, auto attendant, and Administration through Telephone [AvT]) to terminate calls.
Note Do not configure extra CTI ports on Cisco Unified Communications Manager. Doing so will impact the
scalability of your Cisco Unified Communications Manager and will limit the number of other devices it
can support.
c) Configure at least two Cisco Unified Communications Manager route points on Cisco Unified Communications
Manager using Device > CTI Route Point. The Cisco Unity Express Virtual voicemail application uses one route
point, and the auto attendant application uses one route point. If you plan to use the Cisco Unity Express Virtual
AvT, configure a third route point on Cisco Unified Communications Manager. You need as many route points as
the number of call-in numbers on Cisco Unity Express Virtual.
Note Do not configure extra route points on Cisco Unified Communications Manager. Doing so will impact the
scalability of your Cisco Unified Communications Manager and will limit the number of other devices that
Cisco Unified Communications Manager can support.
d) Create a Cisco Unified Communications Manager JTAPI user by choosing User > Add new user. Use the Device
Association option to associate the CTI ports and route points with this JTAPI user. (The JTAPI user is not assigned
a Cisco Unity Express Virtual voice mailbox. It is a placeholder for Cisco Unity Express Virtual to establish a
connection with Cisco Unified Communications Manager.) Verify that the Enable CTI Application Use check box
is checked for this JTAPI user. Verify that the JTAPI user is able to perform Standard CTI Enable by selecting the
appropriate option or group on the Unified Communications Manager.
e) Verify that the AXL service is active. To do this, go to the Cisco Unified Communications Manager serviceability
website, click Tools > Service Activation. Look for Cisco AXL Web service.
f) For efficient call processing, configure access lists on the default router of Cisco Unity Express Virtual to prioritize
JTAPI traffic. For example:
class-map match-all jtapi
match access-group 110
class-map match-all voice
match access-group 100
policy-map jtapi
class jtapi
set dscp cs3
bandwidth 20
class voice
set dscp af31
priority 320
class class-default
fair-queue
interface Serial0/1
ip address 172.16.0.1 255.255.0.0
service-policy output jtapi
clockrate 256000
no cdp enable
access-list 100 permit udp host 172.16.0.1 any range 16383 32727
access-list 110 permit tcp host 172.16.0.1 any eq 2748
where 172.16.0.1 is the IP address of the module that contains Cisco Unity Express Virtual software. The output
from the show policy-map interface command should indicate that the marked packets number is increasing. For
example:
Match: access-group 110
QoS Set
dscp cs3
Packets marked 334 <-----This number should increase.
Step 3 The FTP server that communicates with Cisco Unity Express Virtual must support passive FTP requests. To configure
this functionality on the FTP server, see your FTP server documentation.
Step 4 (Optional) If no subscribers were created in the Cisco Unified Communications Manager interface, create a list of all
subscribers, groups, and their extensions to simplify the task of configuring many subscribers and extensions.
Step 1 Select and install a server on which to operate the Cisco Unity Express Virtual.
See Hardware Requirements for Cisco Unity Express Virtual, on page 14.
Step 3 Download the Cisco Unity Express Virtual OVA file from: http://www.cisco.com.
See Download the Cisco Unity Express Virtual OVA file, on page 15.
Step 5 Configure the networking and other Cisco Unity Express Virtual settings, according to the details of your network.
See Configure Cisco Unity Express Virtual after Deployment, on page 17.
Step 6 Set up communication between Cisco Unity Express Virtual and the Unified Communications Manager.
See Cisco Unity Express Virtual Software Support for ESXi on Cisco UCS and Cisco UCS E-Series Server Modules,
on page 13.
Table 3: Virtual Machine Requirements for Cisco UCS E-Series Servers Platform, on page 15 provides
hardware recommendations for Cisco Unity Express Virtual on Cisco UCS E-Series servers platform.
Table 3: Virtual Machine Requirements for Cisco UCS E-Series Servers Platform
VMware Tools
VMware tools are drivers installed in a guest operating system, providing support for a variety of system
functions. The VMware tools are included in the OVA template used for installing Cisco Unity Express
Virtual.
Note The VMware Tools included in the Cisco Unity Express Virtual installation OVA template are the correct
version for the Cisco Unity Express Virtual release. Do not upgrade the VMware Tools.
Step 1 Open the Cisco Unity Express Virtual Server site: https://software.cisco.com/download/
navigator.html?mdfid=278535672&selMode=null.
Step 2 If prompted, log in using your Cisco.com user name and password.
Step 3 Locate the OVA in “Download Software” section and download the file.
Step 1 In the vSphere Client GUI, select File > Deploy OVF Template…
The Deploy OVF Template dialog box appears.
Step 2 Browse to the location where Cisco Unity Express Virtual server OVA file is downloaded. Click Next.
Step 3 Review and confirm the OVF Template details. Click Next.
Step 4 Enter the name of the device in Name field. The name provided determines how the device appears in the left pane of
the vSphere window.
Step 5 Click Next.
Note If there are multiple server hosts running ESXi, select the host on which you want Cisco Unity Express Virtual
server to run.
Step 6 Select any of the following Thick provisioning format and click Next.
• Thick Provision Lazy Zeroed
• Thick Provision Eager Zeroed
Step 1 In the vSphere Client GUI, in the left pane, select the Cisco Unity Express Virtual device. The name of the device is the
name configured during installation.
Step 2 To open the console, click the Console icon in the vSphere toolbar.
A console window appears for the selected CUE instance.
Step 3 In the console window, click the Power On icon (appears as a green “Play” button).
The device boots, displaying the boot output in the console. When the start-up is complete, the console displays a message,
prompting you to start configuration.
Step 4 At the prompt in the console window, confirm that you want to start the configuration process.
• y: If you enter y, the system asks you to confirm, then begin the interactive post installation configuration process.
• n: From Cisco Unity Express Virtual Release 9.0.3 onwards, if you select n, the initial setup wizard is skipped,
and you are prompted to enter the administrator user ID and password. The default call agent is set to Unified CME.
• Timeout: If you do not enter any input for two minutes, the initial setup wizard is skipped, and you are prompted
to enter the IP address, netmask, and default gateway address.
Step 6 When prompted, enter the default gateway address. Confirm that the configuration is correct.
Step 7 When prompted for the host name, enter the name by which Cisco Unity Express Virtual appears within your network.
Use a name that conforms to the fully qualified domain name (FQDN) rules.
Step 8 When prompted for a domain, enter a domain.
Note Configuring DNS server is optional. If DNS server is not configured, Cisco Unity Express Virtual gets the
mapping of IP address to hostname and vice-versa, from “Extension: SubjectAltName” section of Unified
Communications Manager certificate.
Step 9 When prompted regarding using DNS, enter y to configure Cisco Unity Express Virtual to use DNS.
Step 10 Enter the IP for the primary DNS server.
Step 11 Enter the IP for a secondary DNS server, if one is available. Otherwise, press Enter.
Step 12 When prompted for the primary network time protocol (NTP) server, enter the server domain name or the IP address.
In some Cisco Unity Express Virtual software cases, a default server IP address appears automatically, and press Enter.
Note Cisco Unity Express Virtual requires a NTP
server.
Step 13 When prompted for the secondary NTP server, enter the server domain name or IP if you have a secondary NTP.
Otherwise, press Enter.
Step 14 When prompted for time zone information, use the menus to set your local time zone, and confirm when prompted.
Cisco Unity Express Virtual restarts.
***********************************
* Service Engine IP configuration *
***********************************
Please enter the IP address of your Module: 172.16.0.1
Please enter the netmask of your Module: 255.255.0.0
Please enter the default gateway for your Module: 172.31.255.254
IP : 172.16.0.1
NETMASK:255.255.0.0
GATEWAY: 255.255.0.0
Enter Hostname
(my-hostname, or enter to use Router): Enter
Using Router as default
Please identify a location so that time zone rules can be set correctly.
Please select a continent or ocean.
1) Africa 4) Arctic Ocean 7) Australia 10) Pacific Ocean
2) Americas 5) Asia 8) Europe
3) Antarctica 6) Atlantic Ocean 9) Indian Ocean
#? 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
STARTED: cli_server.sh
STARTED: ntp_startup.sh
STARTED: LDAP_startup.sh
STARTED: SQL_startup.sh
STARTED: dwnldr_startup.sh
STARTED: HTTP_startup.sh
STARTED: probe
STARTED: fndn_udins_wrapper
STARTED: superthread_startup.sh
STARTED: /bin/products/cusp/smartAgent_startup.sh
Waiting 49 ...
IMPORTANT::
IMPORTANT:: Administrator Account Creation
IMPORTANT::
IMPORTANT:: Create an administrator account.
IMPORTANT:: With this account, you can log in to the
IMPORTANT:: Cisco Unity Express Virtual
IMPORTANT:: GUI and run the initialization wizard.
IMPORTANT::
SYSTEM ONLINE
Installed Packages:
- Installer (Installer application) (9.0)
- Thirdparty (Service Engine Thirdparty Code) (9.0)
- Infrastructure (Service Engine Infrastructure) (9.0)
- Global (Global manifest) (9.0)
- GPL Infrastructure (Service Engine GPL Infrastructure) (9.0)
- Voice Mail (Voicemail application) (9.0)
- Bootloader (Primary) (Service Engine Bootloader) (9.0)
- Core (Service Engine OS Core) (9.0)
- Auto Attendant (Service Engine Telephony Infrastructure) (9.0)
Installed Plug-ins:
- CUE Voicemail Language Support (Languages global pack) (9.0)
- CUE Voicemail US English (English language pack) (9.0)
Router-Module>
The following is a sample configuration if n is selected (applicable to Cisco Unity Express Virtual Release
9.0.3 and later):
IMPORTANT::
IMPORTANT:: Welcome to Cisco Systems Service Engine
IMPORTANT:: post installation configuration tool.
IMPORTANT::
IMPORTANT:: This is a one time process which will guide
IMPORTANT:: you through initial setup of your Service Engine.
IMPORTANT:: Once run, this process will have configured
IMPORTANT:: the system for your location.
IMPORTANT::
IMPORTANT:: If you do not wish to continue, initial setup will be skipped
IMPORTANT:: and you need to manually configure the system
IMPORTANT::
Waiting 49 ...
IMPORTANT::
IMPORTANT:: Administrator Account Creation
IMPORTANT::
IMPORTANT:: Create an administrator account. With this account,
IMPORTANT:: you can log in to the Cisco Unity Express GUI and
IMPORTANT:: run the initialization wizard.
IMPORTANT::
(INIT)se-0-0-0-0#
(INIT)se-0-0-0-0#
INIT)se-0-0-0-0#
(INIT)se-0-0-0-0# conf t
Enter configuration commands, one per line. End with CNTL/Z.
(INIT)se-0-0-0-0(config)# inter
(INIT)se-0-0-0-0(config)# interface Fast
(INIT)se-0-0-0-0(config)# interface FastEthernet 0
(INIT)se-0-0-0-0(config-interface)# ip add
(INIT)se-0-0-0-0(config-interface)# ip address 8.39.19.15 255.255.0.0
(INIT)se-0-0-0-0(config-interface)# exit
(INIT)se-0-0-0-0(config)# def
(INIT)se-0-0-0-0(config)# default gat
(INIT)se-0-0-0-0(config)# ip de
(INIT)se-0-0-0-0(config)# ip default-gateway 8.39.19.14
(INIT)se-0-0-0-0(config)# end
SYSTEM ONLINE
se-0-0-0-0# conf t
Enter configuration commands, one per line. End with CNTL/Z.
se-0-0-0-0(config)# hostn
se-0-0-0-0(config)# hostname se-8-39-19-15
se-8-39-19-15(config)# end
se-8-39-19-15# wr
se-8-39-19-15#
Step 1 Verify that the Cisco Unified Communication Manager Express is configured to support the Cisco Unity Express Virtual
software.
Step 2 Configure IP connectivity between the router and the Cisco Unity Express Virtual module. Use the following procedure
to configure Cisco Unity Express Virtual module with a double-wide E-Series Server: Configuration Options.
Note This step is applicable only for the Cisco UCS E-Series
Servers.
Step 3 To configure IP connectivity between the router and the Cisco Unity Express Virtual module, perform the following
step to configure Cisco Unity Express Virtual module with a Cisco UCS Server: ip route cue-ip-address subnet mask
FastEthernetslot/port—creates a static route for the Cisco UCS Series Server.
Example:
Router# configure terminal
Router(config)# interface FastEthernet0/0
Router(config-if)# ip address 10.0.0.1 255.0.0.0
Router(config-if)# no shut
Router(config-if)# end
Step 1 After installing and verifying Cisco Unified Communications Manager software functionality, you must be able to access
the Cisco Unified Communications Manager configuration web page.
Step 2 Configure IP connectivity between the router and the Cisco Unity Express Virtual module. Use the following procedure
to configure Cisco Unity Express Virtual module with a double-wide E-Series Server: Configuration Options.
Note This step is applicable only for the Cisco UCS E-Series
Servers.
Step 3 To configure IP connectivity between the router and the Cisco Unity Express Virtual module, perform the following
step to configure Cisco Unity Express Virtual module with a Cisco UCS Server: ip route cue-ip-address subnet mask
FastEthernetslot/port—creates a static route for the Cisco UCS Series Server.
Example:
Router# configure terminal
Router(config)# interface FastEthernet0/0
Router(config-if)# ip address 10.0.0.1 255.0.0.0
Router(config-if)# no shut
Router(config-if)# end
Step 1 Download and copy the Cisco Unity Express Virtual software OVA file from the FTP server to Cisco 4000 Series
Integrated Services Routers (Cisco 4000 Series ISR) hard disk or boot flash drive.
Step 2 Install, Configure, and Activate virtual service.
Step 3 Connect to the installed virtual service.
For more information on how to install and configure, see Install and Configure the Cisco Unity Express Virtual OVA
on KVM Service Containers, on page 26.
If you want to re-install the OVA, you must first deactivate the installed virtual service and then uninstall the Cisco Unity
Express Virtual. For more information on deactivating and uninstalling Cisco Unity Express Virtual, see Deactivate and
Uninstall Cisco Unity Express Virtual from KVM Service Containers, on page 30.
Table 4: Kernel Virtual Machine Requirements for Cisco 4000 Series ISR Service Container
Mailboxes CPU RAM Hard Disk Flash External Interface Recording hours
1-200 As per Cisco 8 GB 50 GB 8 GB 1 Gigabit Interface 120
4000 Series
ISR platform
Note The Cisco Unity Express Virtual uses hard disk with a maximum ceiling limit of 20 GB only. Hence,
when you execute the show version CLI command on the Cisco Unity Express Virtual prompt, the hard
disk capacity displays as 20 GB, even when your router hard disk capacity may be 50 GB or higher.
Note You need a minimum of 8 GB memory to configure the virtual-service commands while installing and
configuring the Cisco Unity Express Virtual Software.
Note Note that the virtual service upgrade and installation procedures are the same for Cisco Unity Express
Virtual. Ensure that you take backup of the system if you want to upgrade or re-install. For more
information, see Manually Backing Up Files, on page 53.
SUMMARY STEPS
1. telnet ip-address
2. enable
3. copy tftp {flash | harddisk}
4. virtual-service install name service-name package uri/package-location: .ova
5. show virtual-service list
6. configure terminal
7. interface VirtualPortGroup number
8. ip unnumbered type number
9. virtual-service service-name
10. vnic gateway VirtualPortGroup instance-number
11. guest ip address vm ip-address
12. end
13. configure terminal
14. ip route vm-ip | subnet mask | VirtualPortGroup Interface
15. virtual-service service-name
16. activate
17. virtual-service connect name service-name console
DETAILED STEPS
Example:
Router> enable
Step 4 virtual-service install name service-name package uri/package-location: Installs the virtual service.
.ova Note The command virtual-service name
is case-sensitive. For example, if you
Example: configure virtual-service vCUE and
Router# virtual-service install name cue package
bootflash:CUE-Virtual-9-0-ISR4K.ova virtual-service vcue, two different
instances of Cisco Unity Express
Installing package 'bootflash:/CUE-Virtual-9-0-ISR4K.ova' for Virtual is created.
virtual-service 'cue'.
Once the install has finished, the VM may be activated.
Use 'show virtual-service list' for progress.
Step 5 show virtual-service list Lists the service package name and the
installation status.
Example:
Router# show virtual-service list
Example:
Router# configure terminal
Step 7 interface VirtualPortGroup number To configure the installed service, you must
first configure the VirtualPortGroup
Example: interfaces.
Router(config)# interface VirtualPortGroup 1
Note From Cisco Unity Express Virtual
9.0.2 Release onwards, you must
configure two VirtualPortGroup
interfaces. For example,
Router(config)# interface
VirtualPortGroup 1
Router(config)# interface
VirtualPortGroup 2
The VirtualPortGroup forms a bridge and is
configured as the default gateway between
the installed VM and the host router.
virtual-service cue
vnic gateway VirtualPortGroup
1
vnic gateway VirtualPortGroup
2
Step 11 guest ip address vm ip-address Allows you to specify ip address of the virtual
machine.
Example:
Router(config-virt-serv-vnic)# guest ip address 172.16.0.1
Example:
Router# configure terminal
Step 14 ip route vm-ip | subnet mask | VirtualPortGroup Interface Allows you to add static IP route for the guest
VM instance.
Example: The VirtualPortGroup forms a bridge and a
Router(config)# ip route 10.0.25.64 255.255.255.255
VirtualPortGroup1 gateway between the host router and the
installed VM using this ip route.
Example:
Router(config)# virtual-service cue
Step 17 virtual-service connect name service-name console Allows you to connect to the virtual service.
The service-name is the same service name
Example: given in the previous step.
Router# virtual-service connect name cue console
Connected to appliance. Exit using ^c^c^c
SUMMARY STEPS
1. enable
2. configure terminal
3. virtual-service service-name
4. no activate
5. end
6. show virtual-service list
7. virtual-service uninstall name service-name
8. exit
DETAILED STEPS
Example:
Router# enable
Example:
Router# configure terminal
Example:
Router(config)# virtual-service cue
Example:
Router(config-virt-serv)# no activate
Example:
Router(config-virt-serv)# end
Step 6 show virtual-service list To view the service activation status, enter the show
virtual-service list command after exiting from the
Example: virtual service configuration.
Router# show virtual-service list
Example:
Router# virtual-service uninstall name cue
Example:
Router# exit
Example:
Router# virtual-service upgrade name cue package bootflash:CUE-Virtual-9-0-2-ISR4K.ova
Prior to Cisco Unity Express Virtual Release 9.0.3, if you enter n, the system halts. From Cisco Unity Express
Virtual Release 9.0.3 onwards, if you enter n, the initial setup wizard is skipped, and you are prompted to
enter the administrator user ID and password.
If you do not enter any input for two minutes, the initial setup wizard is skipped, and you are prompted to
enter the IP address, netmask, and default gateway address.
The following is a sample configuration if y is selected:
IMPORTANT::
IMPORTANT:: Welcome to Cisco Systems Service Engine
IMPORTANT:: post installation configuration tool.
IMPORTANT::
IMPORTANT:: This is a one time process which will guide
IMPORTANT:: you through initial setup of your Service Engine.
IMPORTANT:: Once run, this process will have configured
IMPORTANT:: the system for your location.
IMPORTANT::
IMPORTANT:: If you do not wish to continue, the system will be halted
IMPORTANT:: so it can be safely removed from the router.
IMPORTANT::
***********************************
* Service Engine IP configuration *
***********************************
Please enter the IP address of your Module: 172.16.0.1
Please enter the netmask of your Module: 255.255.0.0
Please enter the default gateway for your Module: 172.31.255.254
IP : 172.16.0.1
NETMASK:255.255.0.0
GATEWAY: 255.255.0.0
Enter Hostname
(my-hostname, or enter to use Router): Enter
Using Router as default
Please identify a location so that time zone rules can be set correctly.
Please select a continent or ocean.
1) Africa 4) Arctic Ocean 7) Australia 10) Pacific Ocean
2) Americas 5) Asia 8) Europe
3) Antarctica 6) Atlantic Ocean 9) Indian Ocean
#? 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
20) French Guiana 46) Turks & Caicos Is
21) Greenland 47) United States
22) Grenada 48) Uruguay
23) Guadeloupe 49) Venezuela
24) Guatemala 50) Virgin Islands (UK)
25) Guyana 51) Virgin Islands (US)
26) Haiti
#? 47
Please select one of the following time zone regions.
1) Eastern Time
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
11) Central Time
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)
17) Mountain Time
18) Mountain Time - south Idaho & east Oregon
19) Mountain Time - Navajo
20) Mountain Standard Time - Arizona
21) Pacific Time
22) Alaska Time
23) Alaska Time - Alaska panhandle
24) Alaska Time - Alaska panhandle neck
25) Alaska Time - west Alaska
26) Aleutian Islands
27) Hawaii
#? 21
The following information has been given:
United States
Pacific Time
#? 1
Waiting 49 ...
IMPORTANT::
IMPORTANT:: Administrator Account Creation
IMPORTANT::
IMPORTANT:: Create an administrator account.
IMPORTANT:: With this account, you can log in to the
IMPORTANT:: Cisco Unity Express Virtual
IMPORTANT:: GUI and run the initialization wizard.
IMPORTANT::
SYSTEM ONLINE
Installed Packages:
- Installer (Installer application) (9.0)
- Thirdparty (Service Engine Thirdparty Code) (9.0)
- Infrastructure (Service Engine Infrastructure) (9.0)
- Global (Global manifest) (9.0)
- GPL Infrastructure (Service Engine GPL Infrastructure) (9.0)
- Voice Mail (Voicemail application) (9.0)
- Bootloader (Primary) (Service Engine Bootloader) (9.0)
- Core (Service Engine OS Core) (9.0)
- Auto Attendant (Service Engine Telephony Infrastructure) (9.0)
Installed Plug-ins:
- CUE Voicemail Language Support (Languages global pack) (9.0)
- CUE Voicemail US English (English language pack) (9.0)
Router-Module>
The following is a sample configuration if n is selected (applicable to Cisco Unity Express Virtual Release
9.0.3 and later):
IMPORTANT::
Waiting 49 ...
IMPORTANT::
IMPORTANT:: Administrator Account Creation
IMPORTANT::
IMPORTANT:: Create an administrator account. With this account,
IMPORTANT:: you can log in to the Cisco Unity Express GUI and
IMPORTANT:: run the initialization wizard.
IMPORTANT::
(INIT)se-0-0-0-0#
(INIT)se-0-0-0-0#
INIT)se-0-0-0-0#
(INIT)se-0-0-0-0# conf t
Enter configuration commands, one per line. End with CNTL/Z.
(INIT)se-0-0-0-0(config)# inter
(INIT)se-0-0-0-0(config)# interface Fast
(INIT)se-0-0-0-0(config)# interface FastEthernet 0
(INIT)se-0-0-0-0(config-interface)# ip add
(INIT)se-0-0-0-0(config-interface)# ip address 8.39.19.15 255.255.0.0
(INIT)se-0-0-0-0(config-interface)# exit
(INIT)se-0-0-0-0(config)# def
(INIT)se-0-0-0-0(config)# default gat
(INIT)se-0-0-0-0(config)# ip de
(INIT)se-0-0-0-0(config)# ip default-gateway 8.39.19.14
(INIT)se-0-0-0-0(config)# end
SYSTEM ONLINE
se-0-0-0-0# conf t
Enter configuration commands, one per line. End with CNTL/Z.
se-0-0-0-0(config)# hostn
se-0-0-0-0(config)# hostname se-8-39-19-15
se-8-39-19-15(config)# end
se-8-39-19-15# wr
se-8-39-19-15#
Note Configuring Cisco Unity Express Virtual using service-module command from Unified CME is not
supported.
Installation Sequence
Cisco Unity Express Virtual software licenses are installed in the following order:
1 Mailbox licenses
2 Voice Port licenses
3 IVR licenses
Note From Cisco Unity Express Virtual Release 9.0.3 onwards, the licenses for mailboxes and ports are enabled
by default. Moreover, the number of licenses for mailboxes and ports are set to platform maximum.
For activating your evaluation license, see Activate Evaluation Licenses, on page 42.
Caution If you use the IVR functionality, then make sure to enable the number of total ports license is more than
the IVR sessions license. If the number of ports is equal to or less than the IVR sessions, then voicemail
will be disabled.
Caution If you do not use the IVR functionality, then make sure to either disable the IVR license or set the count
to 0. To disable the IVR session license, use the command no license activate ivr sessions. If you wish
to set the IVR count to 0, then use the command license activate ivr sessions 0.
Note We recommend that you install and activate the permanent licenses before the expiration of your evaluation
licenses. From Cisco Unity Express Virtual 9.0.2 Release onwards, you do not need to install permanent
license.
SUMMARY STEPS
DETAILED STEPS
Step 2 license activate voicemail mailboxes Use this command to activate the license for
mailboxes. It presents the End User License
Example: Agreement if it was not accepted earlier.
cue# license activate voicemail mailboxes 275
Note The license activate voicemail mailboxes
Evaluation licenses are being activated in the device for command is not supported from Cisco Unity
the following feature(s): Express Virtual Release 9.0.3 onwards. The
Feature Name: VMIVR-VM-MBX
license for mailboxes are enabled by default.
PLEASE READ THE FOLLOWING TERMS CAREFULLY. INSTALLING THE
LICENSE OR
LICENSE KEY PROVIDED FOR ANY CISCO PRODUCT FEATURE OR USING
SUCH
PRODUCT FEATURE CONSTITUTES YOUR FULL ACCEPTANCE OF THE
FOLLOWING
TERMS. YOU MUST NOT PROCEED FURTHER IF YOU ARE NOT WILLING
TO BE BOUND
BOUND BY ALL THE TERMS SET FORTH HEREIN.
Step 3 license activate ports Use this command to activate the license for ports.
The output is similar to the output for activating the
Example: license for mailboxes as shown in the previous step.
cue# license activate ports 4
Note The license activate ports command is not
supported from Cisco Unity Express Virtual
Release 9.0.3 onwards. The license for ports
are enabled by default.
Step 4 license activate ivr sessions Use this command to activate the license for IVR
sessions. The output is similar to the output for
Example: activating the license for mailboxes as shown in the
cue# license activate ivr sessions 2 previous step.
Step 1 Go to www.cisco.com/go/ordering and choose one of the ordering processes (via partner, Cisco direct, etc.) to order
licenses. The SKU is used in the ordering process to specify the desired licenses for the Cisco Unity Express Virtual
features that you want. When you purchase a license, you will receive a product activation key (PAK), which is an
alphanumeric string that represents the purchase.
Step 2 To get your license file, go to the Cisco Product License Registration Portal at www.cisco.com/go/license and enter the
appropriate information.
You must enter the PAK and the unique device identifier (UDI) of the device where the license will be installed. The
UDI can be viewed via software using the show license udi command in privileged EXEC mode. The UDI has two main
components: the product ID (PID) and the serial number (SN).
Step 3 Download the license file or receive the license file by e-mail.
Step 4 Repeat the appropriate steps above for each device you want to obtain a license.
Step 5 Copy the license file(s) to a FTP or TFTP server.
• Migrate Cisco Software Licensing (CSL) to Cisco Smart Software Licensing, page 47
• Migrate Cisco Unity Express 8.6.12 (SRE) to Cisco Unity Express Virtual 9.0.5, page 48
• Migrate Cisco Unity Express Virtual 9.0.x to Cisco Unity Express Virtual 9.0.5, page 49
Step 1 Request for a smart account and a virtual account using the Cisco portal. Once you get a smart account, proceed to step
2.
Step 2 Add your devices in your virtual account using the SRE or Cisco Unity Express Virtual product activation keys (PAKs)
in the Product License Registration portal.
Step 3 Select the PAKs that you have added, and convert them to smart license entitlements.
You can view the licenses in your virtual account.
Note We recommend that you back up your configuration files whenever changes are made to the system or
application files. Because data files contain voice messages, back them up daily to minimize data loss,
such as from a hardware failure.
For more detailed information about backing up files, including configuring scheduled backups, see Cisco
Unity Express Voice-Mail and Auto-Attendant CLI Administrator Guide for 3.0 and Later Versions and the
GUI online help.
Cisco Unity Express Virtual automatically numbers and dates the backup files and identifies the revision
number in a backupid field.
Performing different backup types at various times causes different backup IDs for data backups and
configuration backups. For example, the last data backup ID might be 3, and the last configuration backup
might be 4. Performing an “all” backup might result in a backup ID of 5 for data, historical data, and
configuration.
When restoring the files, see the backup ID for the backup file that you want to use. Use the show backup
server command for a list of backup IDs.
SUMMARY STEPS
DETAILED STEPS
Example:
Router(offline)# backup category all
Router(offline)# backup category configuration
Router(offline)# backup category data
Router(offline)# backup category historicaldata
Example:
Router(offline)# continue
Step 3 show backup history Displays the backup and restore procedures and the
success or failure of those attempts.
Example:
Router# show backup history
Step 4 show backup server Displays the backup files available on the backup
server, the date of each backup, and the backup file ID.
Example:
Router# show backup server
Restoring Files
After the backup files are created, you can restore them when needed. Restoring is done in offline mode.
Active calls, IMAP, and VoiceView sessions are terminated, and no new calls are accepted (auto attendant
calls are permitted). You should consider doing the restore when telephone subscribers are least likely to be
on the telephone.
Use the show backup server command to locate the backup ID of the file to restore.
Note From Cisco Unity Express 9.0.5 Release onwards, if you are using Interactive Voice Response (IVR)
applications, and you need to restore Cisco Unity Express 9.0.5 backup on a new Cisco Unity Express
9.0.5, perform the following steps:
1 Enable IVR license.
2 Restore the backup files. You will be prompted for a reload.
3 Register the Cisco Unity Express product instance with the Cisco Smart Software Manager or Smart
Software Manager satellite using the license smart register idtoken force CLI command.
If you are not using IVR, you do not need to register the product instance again.
For more detailed information about restoring files, see Cisco Unity Express Voice-Mail and Auto-Attendant
CLI Administrator Guide for 3.0 and Later Versions and the GUI online help.
SUMMARY STEPS
DETAILED STEPS
Step 2 offline Enters offline mode. All active voicemail calls are terminated.
Example:
Router# offline
Step 3 restore id backupid category {all | configuration | Specifies the backup ID backupid value and the file type to
data} be restored.
Example:
Router(offline)# restore id 22 category all
Router(offline)# restore id 8 category
configuration
Router(offline)# restore id 3 category data
Step 4 reload Resets the Cisco Unity Express Virtual module so that the
restored values take effect.
Example:
Router(offline)# reload
Step 5 show backup history Displays the backup and restore procedures and the success
or failure of those attempts.
Example:
Router# show backup history
...................................
...................................
Router(config-virt-serv-vnic)# activate
% Activating virtual-service 'vcue', this might take a few minutes. Use 'show virtual-service
list' for progress.
Router(config-virt-serv)# end
Router# show virtual-service list
Virtual Service List:
OR
Router# show platform software status control-processor brief
Load Average
Slot Status 1-Min 5-Min 15-Min
RP0 Healthy 0.01 0.07 0.11
Memory (kB)
Slot Status Total Used (Pct) Free (Pct) Committed (Pct)
RP0 Healthy 16262244 2304168 (14%) 13958076 (86%) 1919520 (12%)