Cisco Prime IP Express Jumpstart 9.0 Quick Start Guide
July 14, 2017
The Cisco Prime IP Express Jumpstart product is a complete solution for using the Cisco Prime IP Express application to manage DHCP, DNS, and Caching DNS servers. It includes the following components:
■Cisco Prime IP Express 9.0 application software
■Linux CentOS 7.2 Operating System
■VMware ESXi 5.5 or later Hypervisor
■Cisco UCS C220 M4 Hardware
These components are integrated together into a single flexible and easy to use appliance (see Cisco Prime IP Express Jumpstart Configuration).
Figure 1 Cisco Prime IP Express Jumpstart Configuration
Cisco Prime IP Express Jumpstart Configuration shows the three primary layers in the Cisco Prime IP Express Jumpstart appliance. Each of these layers has its own capabilities. Each of these layers can be controlled independently as well as remotely, and each requires its own independent connection to the network. Thus, three unique IP addresses are required.
You may only need to connect to the Cisco Prime IP Express Web UI to perform IP address management tasks, but you may also need to connect to one of the other layers to perform system management or troubleshooting tasks related to the appliance.
You can connect to each layer as described below:
■Connecting to Virtual Appliance (Open Virtual Appliance) Layer—You can connect to the Cisco Prime IP Express application layer using a web browser. Use http:// vaip :8080 for local and http:// vaip :8090, where vaip is the virtual appliance IP address (which is also the IP address of the Linux Operating System). For a secure connection to the Cisco Prime IP Express Web UI, use https:// vaip :8443.
To access the Cisco Prime IP Express Command Line Interface (CLI), you can use an SSH connection to the virtual appliance IP address using ssh -l root vaip.
You can manage the Linux OS by connecting to it using ssh -l root vaip. There is no Windows system installed on the Cisco Prime IP Express virtual appliance, but the standard Linux commands necessary to manage a networking application are all present on the Linux OS.
■Connecting to ESXi Hypervisor Layer—Connect to the ESXi hypervisor layer, identified by the IP address esxip, using the VMware vSphere client. esxip is the IP address designated to the ESXi layer.
Note: The VMware vSphere client is supported only on systems running Microsoft Windows.
■Connecting to Cisco Integrated Management Controller (CIMC) UCS Management Console—This allows you to configure and manage the ESXi layer. You can connect to the CIMC by using a browser using https:// ucsip /. ucsip is the IP address assigned to the Jumpstart. After you log into CIMC, you can start the KVM console to get access to the ESXi configuration screen and manage hardware (power, temperature, fan RPM).
This guide contains the following sections:
■Configuring the Cisco Prime IP Express Jumpstart
■Configuring Network Access on CentOS 7.2 using nmcli
■Configuring Cisco Prime IP Express to Automatically Power Up
■Licensing the ESXi Host
■How to Recover Cisco Prime IP Express Jumpstart
■Obtaining Documentation and Submitting a Service Request
The items concerning the networking environment are as follows. These are not unique to the virtual appliance, but are instead values that are determined by the environment in which you will deploy the virtual appliance:
■The IP address or DNS name of the ESXi installation on which you intend to deploy the virtual appliance.
■The IP address or DNS name of any vCenter server associated with the ESXi installation, above.
■Netmask associated with the IP address for the virtual appliance.
■Gateway address appropriate to the IP address and netmask.
■IP addresses of up to two DNS servers for the virtual appliance to use.
■Any proxy values necessary for the virtual appliance to access the Internet.
Note: Ensure that you have the Cisco Prime IP Express licenses from Cisco.com before you get started. For details, see the License Files section of Cisco Prime IP Express 9.0 Installation Guide.
Cisco Prime IP Express Jumpstart
Be ready with the following information when configuring the Cisco Prime IP Express Jumpstart:
■IP address for the CIMC port on the Cisco Prime IP Express Jumpstart.
Note: This IP address must be unique for this appliance.
■Netmask (subnetmask) for the CIMC port address.
■Gateway for the CIMC port address.
Network information for ESXi
Be ready with the following information when configuring network information for ESXi:
■IP address for the ESXi installation on the Cisco Prime IP Express Jumpstart.
Note: This IP address must be unique for this appliance.
■Netmask for the IP address for the ESXi installation.
■Gateway address for the ESXi installation on the Cisco Prime IP Express Jumpstart.
■VLAN (if any) for the ESXi installation on the Cisco Prime IP Express Jumpstart.
Cisco Prime IP Express Virtual Appliance
Be ready with the following information before you deploy the virtual appliance. These items are unique to the installation of this particular virtual appliance.
■A virtual machine name for the deployed virtual appliance.
■A root password for the operating system on the virtual appliance. You will be prompted to enter and configure the root password during your first boot.
■IP address for the Cisco Prime IP Express virtual appliance.
■DNS name (hostname) for the virtual appliance. It should be placed into DNS using the IP address you selected for the virtual appliance.
■Username and password for the administrator of the Cisco Prime IP Express installation.
Configuring the Cisco Prime IP Express Jumpstart
Configuring Cisco Prime IP Express Jumpstart requires you to do the following configuration steps to connect it to the network:
■ Configuring Cisco Prime IP Express Jumpstart
■ Configuring Network Information for ESXi
■ Configuring Cisco Prime IP Express Virtual Appliance
Configuring Network Information for ESXi
After configuring the network information for the UCS CIMC console, use the virtual KVM console that the CIMC console provides to configure the network information for the ESXi hypervisor.
1. Use a browser to connect to the IP address of the CIMC console.
2. Log into the CIMC console.
Note: The default username is admin and default password is password, but you should change the password at your earliest convenience.
3. On the Server Summary page, in the Actions pane, click Launch KVM Console. You will be asked to approve the running of the application, as this operation downloads code to run on your system. After some delay, the KVM Console window is displayed.
Note: If login fails, it may be either that someone else already has a virtual KVM console already active for this UCS C220 server or that your browser is not configured to run Java Web Start.
The initial screen on the KVM console displays VMware ESXi 5.5.0.
4. Press F2 to customize the system.
Note: The virtual KVM console needs to capture the mouse to accept input. It may be necessary on some systems to use the mouse to select the Single Cursor option from the Tools menu of the KVM Console window. If nothing happens when you press F2, select the Session Options from the Tools menu and click OK. Usually this causes the mouse to be captured, and then the functions keys will make it through to the console. If you want the mouse back, you can press F12.
5. Press F2 again to view the login window.
6. Log into the host. The default username is root and the password is password.
Select the Configure Password option and reconfigure the root password after you log in.
7. Using the arrow keys, select the Configure Management Network option and press Enter.
8. For IP configuration:
a. Use the arrow keys to select IP Configuration and press Enter.
b. Use the arrow keys to select Set Static IP address and Network Configuration.
c. Use the space bar to enable this selection.
d. Use the arrow keys to select IP Address and enter the IP address.
e. Use the arrow keys to select Subnet Mask and enter the subnet mask.
f. Use the arrow keys to select Default Gateway and enter the gateway address.
g. Press Enter to accept the IP Configuration updates.
Note: If you want to use IPv6 with Cisco Prime IP Express, use the arrow keys to select IPv6 Configuration and enter the information requested on that screen.
Configuring DNS Servers
9. To configure the DNS Servers:
a. Use the arrow keys to select DNS Configuration and press Enter.
b. Use the arrow keys to select Primary DNS Server and enter the IP address of the primary DNS server.
c. Use the arrow keys to select Alternate DNS Server and enter the IP address of the alternate DNS server.
d. Use the arrow keys to select Hostname and enter the hostname.
Note: Ensure that you enter the entire hostname, including the domain name.
e. Press Enter to accept the DNS Configuration updates.
10. If you have a VLAN configured on the switch to which the ESXi is connected, use the arrow keys to select VLAN (optional) and press Enter.
Enter the VLAN for this network connection and press Enter to accept the change.
Press Esc to exit the Configure Management Network window which you are in now.
11. Use the arrow keys to select Test Management Network and press Enter.
You can see the addresses to be pinged and the hostname to be resolved. Use the arrow keys and select the address to be pinged and press Enter. The test pings your default gateway and DNS servers and tests the connectivity. Press Enter when the test is complete.
At this point, ESXi listens on the IP address that you configured.
12. Use a browser to connect to the IP address configured for ESXi.
A window displaying VMware ESXi 5.5 Welcome appears.
Note: If a warning message about an untrusted SSL certificate appears, select the appropriate action based on your security policy.
13. If you already have downloaded VMware vSphere and have it available, go to Configuring Cisco Prime IP Express Virtual Appliance.
If you have not downloaded VMware vSphere, ensure that you are connecting to the Jumpstart from a system running Microsoft Windows.
If the system on which the browser is running is connected to the Internet, you can click on the link for Download vSphere Client. This downloads the VMware vSphere installable on your system which you can then install.
Note: The Jumpstart does not need access to the Internet for this to work, but the Windows system running the browser needs to have access to the Internet.
If you are not connected to the Internet, go to system that is connected to the Internet and go to the VMware website. You have to download the vSphere client installation kit. The simplest way to get the vSphere client is to connect to the Jumpstart with a browser running on a Windows machine which also has Internet connectivity.
After you install the vSphere client on your system, proceed to Configuring Cisco Prime IP Express Virtual Appliance.
Configuring Cisco Prime IP Express Virtual Appliance
The Cisco Prime IP Express Virtual Appliance is delivered as a virtual machine installed on the ESXi hypervisor. The virtual machine names as shipped from Cisco are “Cisco Prime IP Express Local” and “Cisco Prime IP Express Regional”.
Note: You may change the virtual machine name as per your choice, however, the underlying disk storage will remain under the name originally used to deploy the OVA (for example, Cisco Prime IP Express Local).
To manage the virtual machine containing Cisco Prime IP Express, as well as manage any other virtual machines which you may deploy on the Jumpstart, use the VMware vSphere client. See step 13 of the procedure Configuring Network Information for ESXi for instructions on how to acquire a copy of the VMware vSphere Client.
To configure the Cisco Prime IP Express Virtual Appliance:
1. After deploying the OVA files, select the virtual machine name in vSphere, right-click on it, and select Open Console.
Note: To deploy the OVA files, see the “Deploying the Regional Cluster OVA or Local Cluster OVA” subsection of Cisco Prime IP Express 9.0 Installation Guide.
2. Click the Power on button () on the console and click inside the window after clicking the Power on button. vSphere captures the mouse when you click inside the console window. If you want to release the mouse cursor, press CTRL + ALT.
During the initial boot of the newly deployed machine, you will be prompted to enter a root (system) password, which is not the Cisco Prime IP Express password.
Note: This is the root password for the underlying Linux operating system on which the Cisco Prime IP Express 9.0 application is installed. You will be asked to enter this password twice. You will need root access to the underlying Linux operating system later on, so make sure that you remember this password.
3. Read the end user license agreement and if you agree with the terms stated, accept the agreement by entering y (Yes).
4. Log in to the server as the root user.
5. To configure the network for the Virtual Appliance, see Configuring Network Access on CentOS 7.2 using nmcli.
Configuring Network Access on CentOS 7.2 using nmcli
The NetworkManager command-line tool (nmcli) provides a command line way to configure networking by controlling NetworkManager. This section provides only an overview with some examples to help you learn how to use nmcli to configure network access on the virtual appliance.
In a departure from previous approaches to network interface configuration, NetworkManager deals with both connections and interfaces (also known as devices). Connections are configured with IP addresses, gateways, DNS servers, and then applied to interfaces (devices). This is a critical change from the past way of configuring network access on CentOS Linux, and includes all aspects of nmcli operations.
First, there are two nmcli commands that are of general usefulness:
■The nmcli d command lists all available network interfaces (devices).
■The nmcli c command lists all available configurations.
Use the above two commands frequently as you are learning to use nmcli.
Follow the steps below to configure a connection for an interface on your virtual appliance. Typically these commands are typed directly into the console of the virtual appliance. If you are already connected through the network (for example, by ssh), then making changes to the network interface configuration can be problematic, as you may also lose network connectivity (and thereby your ability to issue nmcli commands) at any point in the process.
To configure the UCS Hardware to automatically power up the ESXi hypervisor:
1. Make sure that the interface does not block nmcli. The nmcli d command lists the existing interfaces. If the interface you want to configure is listed as unmanaged, then NetworkManager has been explicitly blocked from configuring this interface. Until you remove this blockage, no nmcli command will have any effect on this interface. Note that you may not need to perform this procedure unless the interface is listed as unmanaged. Follow the steps below to allow it to be managed by NetworkManager:
a. Remove the line NM_CONTROLLED-no from the file /etc/sysconfig/network-scripts/ifcfg-<interface>, where <interface> is the interface name listed in the nmcli d command. If there is no file with this name, then you do not need to perform this procedure.
b. NetworkManager must be told to read the configuration files again. To do this, give the following command:
nmcli connection reload
Note: Manual changes to any ifcfg file will not be noticed by NetworkManager until the following command is issued: nmcli connection reload
In a brand-new OVA deployment, there is no ifcfg config file until after the networking is completed.
2. Execute the nmcli c command, which lists any existing configurations. You will see the following output:
Wired connection 1
Note: Your UUID will be different.
Execute the nmcli d command, which lists any existing devices.
Wired connection 1
Since ens160 is currently attached to the connection "Wired connection 1", delete that using the following command:
nmcli con delete "Wired connection 1"
and use the DEVICE name ens160 in the following steps for both the <config> and the <interface>.
3. Create the configuration and associate it with the interface (device) in one command. This command only creates the configuration, it does not apply it to the interface.
nmcli con add type ethernet con-name <config> ifname <interface> ip4 <ip>/<netmaskwidth> gw4 <gateway>
where <config> is the name of the configuration, <interface> is the name of the interface (device), <ip> is the IPv4 address, <netmaskwidth> is the network mask width, and <gateway> is the IPv4 gateway address.
Example (type all in one line):
nmcli con add type ethernet con-name ens160 ifname ens160 ip4 10.10.24.25/24 gw4 10.10.20.174
4. Add the DNS server to the interface (device):
nmcli con mod <config> ipv4.dns <dnsip>
where <dnsip> is the IPv4 address of the DNS server and <config> is the name of the configuration.
nmcli con mod ens160 ipv4.dns 126.96.36.199
You can add two DNS addresses as given below:
nmcli con mod ens160 ipv4.dns "188.8.131.52 184.108.40.206"
Note: This will replace any previously set DNS servers. To add to an previously set DNS entry, use the + before ipv4.dns as shown below:
nmcli con mod test-lab +ipv4.dns "220.127.116.11 18.104.22.168"
5. Bring up the interface:
nmcli con up <config>
where <config> is the name of the configuration.
6. Use the following command to examine information about a connection. You may examine information about a connection by using this command:
nmcli -p con show <config>
This will typically scroll off of the console screen, leaving the beginning unreadable. To allow you to move back and forth and examine the output easily, use this command:
nmcli -p con show <config> | less
From this, you can see the entire configuration. You can modify things in the configuration with:
nmcli con mod <config> <something>.<other> <new-value>
nmcli con mod ens160 wifi-min.key-cntl wpa-psk
7. Use the command set-hostname to set the hostname for the system:
hostnamectl set-hostname <hostname>.<domain>
where <hostname> is the hostname you want to use and <domain> is the domain name, ending with.com,.org, and so on. It is important to include the domain name (along with the.com,.org, or whatever ending is appropriate), since this is used as the default for DNS lookups.
hostnamectl set-hostname my-server.gooddomain.com
Configuring Cisco Prime IP Express to Automatically Power Up
There are several layers of processing involved in running the Cisco Prime IP Express application. Each layer has choices it can make about what to do when it is first powered up after power failures.
You can configure the Cisco Prime IP Express to start automatically when power is restored to the Jumpstart.
The two places where you have to change the configurations to make this possible are:
■UCS Hardware—The UCS hardware has to be configured to power up the ESXi hypervisor when power is restored.
■ESXi Hypervisor—The ESXi hypervisor has to be configured to power up the Cisco Prime IP Express virtual appliance when power is restored to the ESXi hypervisor layer.
To configure the UCS Hardware to automatically power up the ESXi hypervisor:
1. Connect a browser to the CIMC UCS Management Console and log into the console.
2. In the Server tab on the left pane, select the Power Policies link.
3. Select Power On from the Power Restore Policy drop-down list in the Power Restore Policy area in the right pane.
If you want, you can enter a delay value in the Power Delay Value field.
4. Click Save Changes to save the updates.
To configure the ESXi hypervisor to automatically power up the Cisco Prime IP Express virtual appliance when power is restored to the ESXi hypervisor layer, see the “Configuring the Virtual Appliance to Automatically Power Up” section of Cisco Prime IP Express 9.0 Installation Guide.
Licensing the ESXi Host
The VMWare ESXi host will run on a 60-day Evaluation Mode license once it is powered up. The host license that you receive when purchasing a Jumpstart must be applied to license the server. It will be in the following format:
To license the ESXi host:
1. Connect to the ESXi host with the VMware vSphere client*.
2. Highlight the host name in the left-hand panel and choose the Configuration tab.
3. Click the Licensed Features link under the Software section on the left, and then click the Edit link on the upper right.
Figure 2 Assign License Dialog Box - Evaluation Mode
4. Choose “Assign a new license key to this host” and the following dialog box will appear:
Figure 3 Assign a New License Key Dialog Box
5. Type or paste the license key into the “New license key:” field and click OK.
* The VMware vSphere client can be downloaded by typing the ESXi server host address in the browser’s URL field. You will be presented with several security screens which you would need to acknowledge to reach the VMware ESXi Welcome screen. On the Welcome screen, there will be a Download vSphere Client link.
How to Recover Cisco Prime IP Express Jumpstart
This section describes how to recover Cisco Prime IP Express Jumpstart 9.0. It includes the following sections:
■Downloading the Recovery Kit
■Recovering the Licenses
To start the recovery process, make sure that you have:
■Internet connectivity—Internet connectivity is required to download the recovery images and to request Cisco Prime IP Express replacement licenses from Cisco.com. Ensure that you have the licenses with you before you start the recovery process.
■Recovery kit—The Recovery kit is comprised of three files which must be downloaded from www.cisco.com to your local client. For more information, see Downloading the Recovery Kit.
■Connection to CIMC UCS Management Console—Ensure that the CIMC port is configured on the Cisco Prime IP Express Jumpstart appliance. This allows you to configure and manage the ESXi layer. For more information, see Configuring Cisco Prime IP Express Jumpstart.
Downloading the Recovery Kit
To download the Cisco Prime IP Express Jumpstart recovery kit:
1. From the appropriate server host or client workstation, do the following:
2. To download the recovery kit, click the Download button.
3. Sign in with your Cisco.com user ID and password.
4. Read the Cisco End User License Agreement and accept the conditions by clicking Accept License Agreement.
5. Download the.iso and.ova files to a location that can be browsed from the host that will be used to recover the Cisco Prime IP Express Jumpstart.
Recovering Cisco Prime IP Express Jumpstart
To recover the Cisco Prime IP Express Jumpstart:
1. Use a browser to connect to the IP address of the CIMC console and log into the console.
2. On the Server Summary page, in the Actions pane, click Launch KVM Console. You will be asked to approve the running of the application, as this operation downloads code to run on your system. After some delay, the KVM Console window is displayed.
3. Select the Virtual Media tab.
4. Click Activate Virtual Devices, then choose the radio button Accept this session and click Apply.
5. Click the Virtual Media tab and choose the connected device that contains the ESXi installation ISO file (cpipe_9_0_jumpstart_appliance_recovery.iso).
Depending on what devices are attached, the choices are usually “Map CD/DVD”, “Map Removable Disk”, and “Map Floppy”.
6. After selecting the required option, click the Map Device button.
Ensure that the ISO file is attached and the same status is displayed in the Virtual Media tab.
7. In the Server tab on the left pane, click the BIOS link and ensure that the CIMC-Mapped device is listed as the first item in Configured Boot Order.
8. In the Server tab on the left pane, click the Summary link.
The Server Summary page appears.
9. Click Power Cycle Server to restart the Cisco Prime IP Express Jumpstart appliance.
10. Follow the on-screen instructions in the KVM Console window to install ESXi 5.5. This step could take several to many minutes depending on the network connection from the client where the install is being run to the server.
You may be presented with a choice to upgrade or re-install and re-partition, depending on the situation. Choose the option appropriate for your situation.
ESXi is always installed in the evaluation mode which will run for 60 days. If you do not have the ESXi 5.5 license key, call the Cisco Technical Assistance Center (TAC) and ask for the Licensing Team. For your local Cisco TAC phone number, see the Cisco Worldwide Contacts page at:
11. After the installation completes, unmap the Virtual Media drive and uncheck the Activate Virtual Devices under the Virtual Media menu before you reboot Cisco Prime IP Express Jumpstart appliance.
12. After the server reboots, configure ESXi 5.5 via the KVM Console window. For more information on how to configure the ESXi layer, see Configuring Network Information for ESXi.
13. Using VMware vSphere, connect to the IP address or hostname of the UCS (ESXi) host.
14. From the vSphere menu, choose File > Deploy OVF Template.
The Deploy OVF Template Source window appears.
15. To deploy the OVA file, click Browse and choose the OVA file (.ova) available on the location where it was previously unpacked. Choose the appropriate Local or Regional OVA in the corresponding subdirectory.
Complete the deployment following the on-screen instructions. See the “Deploying the Regional Cluster OVA or Local Cluster OVA on VMWare” subsection of Cisco Prime IP Express 9.0 Installation Guide for details.
Note: You might want to resize the data disk before starting the virtual machine since the Recovery DVD has the standard OVAs. For details regarding increasing the disk size, see the “Increasing the Size of Disk on VMWare” procedure in the “Introduction to Cisco Prime IP Express Virtual Appliance” chapter of the Cisco Prime IP Express 9.0 Administration Guide.
16. Open the console for virtual machine and click the Power on button to power up the virtual machine. For more information, see Configuring Cisco Prime IP Express Virtual Appliance.
17. Connect to Cisco Prime IP Express using http://. It prompts you to create an admin user and password for Cisco Prime IP Express.
If you encounter any issue for which you are not able to find a solution, contact the Cisco Technical Assistance Center (TAC) for help.
For assistance in troubleshooting, the appliance comes with a secure FTP server and a TAC tool.
Ensure that you send the data gathered by the TAC tool to the TAC team in case of issues. For more details regarding the TAC tool, see the Cisco Prime IP Express 9.0 Administration Guide.
You can use the FTP server (vsftpd) to transfer files to and from the virtual appliance. You have to create a user to log into the vsftpd because the 'root' user cannot be used for logging in. The vsftpd will not be up and running when you power on the appliance, so you have to manually start it.
You can start the vsftpd using the command:
You can stop the vsftpd using the command:
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service request, and gathering additional information, see What’s New in Cisco Product Documentation at: http://www.cisco.com/c/en/us/td/docs/general/whatsnew/whatsnew.html.
Subscribe to What’s New in Cisco Product Documentation, which lists all new and revised Cisco technical documentation as an RSS feed and delivers content directly to your desktop using a reader application. The RSS feeds are a free service.
This document is to be used in conjunction with the documents listed in the Related Documentation section.
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. (1110R)
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.
© 2017 Cisco Systems, Inc. All rights reserved.