Table Of Contents
Cisco Network Building Mediator Quick Start Guide
Release 3.1.3Applying Power to the Mediator
Downloading the Installation Image File
Extracting the Installation Image File
Copying the Installation Image File
Upgrading Mediator 2400 and 4800
Upgrading Mediator 2500 and 5000
Verifying the Mediator Framework and MOE
Installing the Mediator configTOOL
Installing the Mediator perfectHOST
Purchasing Licenses for the Mediator
Downloading License Files for the Mediator
Installing Licenses for the Mediator
General Information on Licenses
Obtaining Documentation and Submitting a Service Request
Cisco Network Building Mediator Quick Start Guide
Release 3.1.3
Revised: January, 2012, OL-21278-03
1 Overview
This document describes the procedure for getting started with the Cisco Network Building Mediator (Mediator). For more information about the Mediator and the Mediator software tools, see the Cisco Network Building Mediator User Guide.
2 Prerequisites
Perform the following tasks before you connect and configure the Mediator:
•
You need a 24 VAC/VDC power supply to power on the Mediator.
When the wires are connected to the terminals, switch the power supply on or off by inserting the terminal block in to or removing it from its socket.
The Mediator ships with a 24 VDC power supply (100 VDC-240 VDC input). The leads of this power supply have already been screwed in to the Mediator socket.
•
Before connecting the power to the Mediator, you need the following:
–
A PC (Windows 2000 SP2, or Windows XP) and web browser (Internet Explorer 7.0 and 8.0, or Mozilla Firefox 3.5 and later).
–
A Serial Console cable (to connect between the PC Com1 port and the Mediator console port).
–
An Ethernet cable to connect the Mediator to the network; Cross-over and straight-through cables are supported.
–
256 MB RAM (512 MB recommended)
–
800 MB of available disk space
•
In addition, gather the following information:
–
IP and gateway addresses for the Mediator.
–
Administrator password. If you are setting up the Mediator for the first time, use the default password that is provided.
•
Before you initiate the installation process, you must ensure the following:
–
You have access to a third-party terminal communications utility such as HyperTerminal or PuTTy.
When you connect to the Mediator using a third-party terminal, it is necessary that you use the correct baud rate, such as the following:
a.
For Cisco Network Building Mediator 2400 and 4800, the baud rate is 38400 per second.
b.
For Cisco Network Building Mediator 2500 and 5000, the baud rate is 115200 per second.
–
You have access to the latest installation image file that is available on Cisco.com.
–
You have completed the Mediator setup.
3 Applying Power to the Mediator
The Mediator operates on 24 V AC or 24 V DC power and is shipped with a 24 V DC power supply (100 V DC-240 V DC input).
This section describes how you must connect the Mediator to the DC and AC power and includes the following topics:
Connecting to DC Power
This section includes the following topics:
Mediator 2400 and 4800
The 24 V DC power supply is connected to the uppermost screw terminal and the GND terminal using a 18-24 AWG wire. The positive (+) transformer wire should be connected to the uppermost terminal, and the negative (-) wire should be connected to the GND terminal. The leads of this power supply come already screwed into the terminal block. To power on the Mediator, plug the terminal block into the Mediator socket.
Mediator 2500 and 5000
The power supply uses a plug type connector instead of a terminal block. To power on the Mediator, connect the power supply to the power jack on the Mediator.
Connecting to AC Power
This section includes the following topics:
Mediator 2400 and 4800
The AC leads of a 24 V AC class 2 transformer (minimum 40 VA) are connected to the two uppermost screw terminals using a 18 - 24 AWG wire. If the transformer has a ground lead, then it is connected to the GND terminal.
Mediator 2500 and 5000
The AC leads of a 24 V AC class 2 transformer (minimum 40 VA) are connected to the two AC screw terminals using a 18 - 24 AWG wire.
Tighten the screws to the following terminal torque specifications:
•
(N-m) 0.3 - 0.5
•
(in-lbs.) 2.7 - 4.4
4 Configuring the Mediator
While the initial login to the Mediator must be done through the Mediator console port, you can also configure the Mediator remotely. You can use any third-party terminal communication utility to configure the Mediator remotely.
Note
For Mediator 2500 and 5000, both the initial login and the configuration, can be done remotely.
Table 1 lists the utilities that you could use to configure the Mediator.
The first time you log in to the Mediator 2400 and 4800, you could be forced to change the default administrator password. This does not occur when you log in to the Mediator 2500 and Mediator 5000 for the first time.
To configure the Mediator using HyperTerminal, perform the following steps:
Step 1
Connect a PC to the console port of the Mediator using a null modem cable.
Step 2
Launch HyperTerminal.
Step 3
Enter an appropriate name for the new connection, and click OK. The Connect To dialog box appears.
Step 4
From the Connect using drop-down list, choose the COM port used to connect to the Mediator. The COM Properties dialog box appears.
Step 5
Click Restore Defaults. The default values for the text boxes in the COM properties dialog box are as follows:
–
Bits per second - 38400
Note
For Cisco Network Building Mediator 2500 and 5000, the default value is 115200 bits per second.
–
Data bits - 8
–
Parity - None
–
Stop bits - 1
–
Flow control - None
Step 6
Click Apply, and then click OK.
Step 7
Press Enter twice. The Mediator system login prompt appears.
Step 8
Enter the default username and password in the username and password text boxes, and press Enter. The mpxconfig utility appears.
Note
For Mediator 2500 and 5000, prior to using the mpxconfig utility, perform the following steps:
a.
Enter ./firstboot (wait for command prompt to return).
b.
Enter the reboot command. After the Mediator reboots, log in to the Mediator and continue to Step 9.
Step 9
Enter mpxconfig at the Linux command-line prompt. The Global Settings are highlighted.
Step 10
Press Enter. The Global Settings text boxes appear.
Step 11
Enter the hostname, domain, gateway, name server, proxy server, and location in the Global Settings text boxes. By default, the IP forwarding status is disabled. Press Spacebar to enable the IP forwarding status.
Step 12
Press Enter to save changes in the global settings and return to the main menu.
Step 13
Press ESC to cancel the changes.
Step 14
Navigate to Ethernet port 0, and press Enter. The Ethernet port selection option appears.
Step 15
Press Spacebar to enable or disable DHCP.
Step 16
Scroll down to System Date and Time and press Enter. The System Time and Date settings option appears.
Step 17
Press Spacebar to select the appropriate date and time.
Step 18
Press Enter to return to the main menu.
Step 19
Repeat Step 14 to Step 18 to configure Ethernet port 1.
Step 20
Press Esc to exit. The mpxconfig window appears.
Step 21
Press Enter to save the changes or press ESC to discard the changes.
Step 22
Enter R to reboot the system, or press any other key to exit.
Note
Changes to the network settings are not effective until you reboot the Mediator.
5 Upgrading the Mediator
This section includes the following topics;
•
Downloading the Installation Image File
•
Extracting the Installation Image File
•
Copying the Installation Image File
•
Upgrading Mediator 2400 and 4800
•
Upgrading Mediator 2500 and 5000
Downloading the Installation Image File
Before you begin with the upgrade process, it is necessary that you download the latest installation image file from Cisco.com.
To download the installation image file, perform the following steps:
Step 1
Step 1 Log in to Cisco.com to download the installation image file.
If you are not a registered user of Cisco.com, obtain your Cisco.com user ID from the following website: http://tools.cisco.com/RPF/register/register.do
Step 2
Download the installation image file to a folder location on your local system.
Extracting the Installation Image File
After you download the installation image on to your local system, you must extract the installation image file contents using any Zip file utility such as WinZip. You cannot copy the installation file to the Mediator until you extract the installation image file contents.
Table 2 lists the details on the extracted installation image file contents.
Copying the Installation Image File
Table 3 describes the different methods by which you can copy the installation image files to the Mediator.
Upgrading Mediator 2400 and 4800
You can upgrade either the Mediator Framework or the Mediator Operating Environment (MOE) and the Mediator Framework.
This section describes the procedure you can use to install or upgrade the Mediator Framework or the MOE, and includes the following topics:
Mediator Framework
Before you begin with the upgrade procedure, verify that the Mediator is running a MOE that is compatible with the Mediator Framework that you want to upgrade.
To upgrade the Mediator Framework perform the following steps:
Step 1
Connect to the Mediator using an SCP and SSH client such as WinSCP and PuTTY.
Both the username and the password is mpxadmin.
Step 2
Copy the cisco.nbm-3.x.tgz file to the /usr/lib directory on the Mediator.
Step 3
Enter init 2 to shut down the Mediator Framework.
Step 4
Enter the cd /var/mpx/config command.
Step 5
Enter the mv broadway.xml broadway.orig.xml command.
Step 6
Enter the cd /usr/lib command.
Step 7
Enter ls to view the list of files in the current working folder.
Step 8
Enter rm -rf broadway to remove the existing broadway folder.
Step 9
Enter tar -xzvf cisco.nbm-3.x.tgz to unzip the file and recreate the broadway folder.
Step 10
Enter cd broadway to navigate to the new broadway folder.
Step 11
Enter the ./install cisco.nbm command.
Step 12
(Optional) Enter ./install -d cisco.nbm to view the installation steps.
Upon the completion of installation process, you are prompted to enter the next command.
Step 13
Enter the cd /var/mpx/config command.
Step 14
Enter the mv broadway.orig.xml broadway.xml command.
Step 15
Enter init 3 to restart the Mediator Framework.
Step 16
Enter msglog_viewer -f to watch the message logs.
Step 17
To verify that the appropriate Mediator Framework has been installed, see the "Verifying the Mediator Framework and MOE" section.
MOE and Mediator Framework
Before you begin with the upgrade procedure, check the MOE version that is currently running on the Mediator to determine which MOE upgrade file you must use.
To upgrade the MOE and the Mediator Framework, perform the following steps:
Step 1
Connect to the Mediator using an SCP and SSH client such as WinSCP and PuTTY.
Both the username and the password is mpxadmin.
Step 2
Copy the cisco.nbm-3.x.tgz file to the /usr/lib directory on the Mediator.
Step 3
Copy the moe-<version>to3.0.9-upgrade.tgz file to the / directory on the Mediator.
Step 4
Enter init 2 to shut down the Mediator Framework.Enter the cd /var/mpx/config command.
Step 5
Enter the mv broadway.xml broadway.orig.xml command.
Step 6
Enter the cd / command.
Step 7
Enter the tar -xzvf moe-<version>to3.0.9-upgrade.tgz command.
Step 8
Enter the cd /usr/lib command.
Step 9
Enter rm -rf broadway to remove the existing broadway folder.
Step 10
Enter tar -xzvf cisco.nbm-3.x.tgz to unzip the file and recreate the broadway folder
Step 11
Enter cd broadway to navigate to the new broadway folder.
Step 12
Enter the ./install cisco.nbm command.
Step 13
(Optional) Enter ./install -d cisco.nbm to view the installation steps.
Upon the completion of installation process, you are prompted to enter the next command.
Step 14
Enter the cd /var/mpx/config command.
Step 15
Enter the mv broadway.orig.xml broadway.xml command.
Step 16
Enter reboot to reboot the system.
Step 17
Re-connect to the Mediator using an SSH client.
Step 18
Enter mpxadmin for both, the username and the password.
Step 19
Enter msglog_viewer -f to watch the message log.
Step 20
To verify that the appropriate Mediator Framework and MOE has been installed, see the "Verifying the Mediator Framework and MOE" section.
Upgrading Mediator 2500 and 5000
Cisco Network Building Mediator 2500 and Cisco Network Building Mediator 5000 includes an nbm_install command that installs or upgrades the Mediator Operating Environment (MOE) and Mediator Framework.
To use the nbm_install command, the Mediator must download the installation image file from Cisco.com.
CautionThe nbm_install command backs up certain configuration data such as the location, hostname, and the domain name, which gets restored after the install process. We recommend that the configuration data is manually backed up before the installation and restored later. To back up and restore the data manually, see the "Backing up the Mediator" section and the "Restoring the Mediator" section.
To upgrade the MOE and the Mediator Framework, follow these steps:
Step 1
Connect to the Mediator using an SCP and SSH client such as WinSCP and PuTTY.
Both the username and the password is mpxadmin.
Step 2
Copy the new installation image to the /home/mpxadmin directory. Verify that the correct installation image has been transferred to this directory.
Note
Do not attempt to install the .iso file. The installation image is contained in the .iso file. The file name will be similar to cisco.nbm-5000-moe-1.21-fw-3.1.2-7. For more information on extracting the installation image file, see the "Extracting the Installation Image File" section.
Step 3
Enter the cd /home/mpxadmin command.
Step 4
Enter ls to view the list of files in the current working directory. This helps to ensure that the transferred file is available in the /home/mpxadmin directory.
Step 5
Enter the nbm_install image file name command to install the new MOE and Mediator Framework.
The installation process causes the Mediator to enter a state which will terminate your current SSH session. Wait approximately 15 minutes for the installation to complete and re-establish the SSH connection.
Note
Ensure that the power supply to the Mediator is not interrupted during the upgrade process.Enter mpxadmin for both, the username and the password.
Step 6
Enter the ./firstboot command.
Step 7
Enter the reboot command.
Step 8
Re-connect to the Mediator using an SSH client.
Step 9
Enter mpxadmin for both, the username and the password.
Step 10
Enter msglog_viewer -f to watch the message log.
Step 11
To verify that the appropriate Mediator Framework and MOE has been installed, see the "Verifying the Mediator Framework and MOE" section.
6 Verifying the Mediator Framework and MOE
To verify the Mediator Framework and MOE, perform the following steps:
Step 1
Open a web browser on your PC and enter the URL for the Mediator. Be sure to include the s in https:// to connect your browser to the secure URL.
Step 2
Enter the default username and password in the Username and Password text boxes.
The default username and password are as follows:
default username: mpxadmin
default password: mpxadmin
Step 3
Click System. On the Status tab, the Framework version text box displays the new image number that you have installed. If you have upgraded the MOE, then verify the correct version of the MOE.
7 Backing up the Mediator
The backup function saves all of your applications, HTTP files, schedules, trends, and persistent data in a compressed archive file (.tgz), which is stored locally on the hard disk of your PC.
To back up a Mediator, perform the following steps:
Step 1
In the Mediator web client homepage, click System.
Step 2
Click the Backup/Restore tab.
The Backup/Restore tab appears.
Step 3
Click Backup.
The file download dialog box appears prompting you to open or save the backup file, mediator_backup.tgz.
Step 4
Click Save.
The file is saved on your local drive.
8 Restoring the Mediator
You can reverse the backup operation by using the restore function of the Mediator. The restore function takes the compressed archive file (.tgz) from the hard drive of your PC and restores the data to the Mediator.
Note
We recommend that you restart the Mediator Framework to view the restored data on the web client GUI. If you do not restart the Mediator Framework, the restored data will not appear on the web client GUI, although it is restored to the Mediator.
To restore the Mediator, perform the following steps:
Step 1
In the Mediator web client homepage, click System.
Step 2
Click the Backup/Restore tab.
The Backup/Restore tab appears.
Step 3
Click Browse and navigate to the folder on your PC where the backup file is stored.
Step 4
Click Restore.
The files are restored to the Mediator and a message indicating the operation is successful is displayed.
Step 5
Launch PuTTY from your PC.
Step 6
In the PuTTY configuration window that appears, enter the Mediator IP address in the Host Name text box.
The Username and Password text boxes appear.
Step 7
Enter mpxadmin in both, the Username and Password text boxes.
Step 8
Enter Init 2 and press Enter.
Step 9
Enter Init 3 and press Enter.
Step 10
The backup of the Mediator is restored.
9 Installing the Mediator configTOOL
To install this software, access Cisco.com at the following website:
This software is available in the Support section at this website.
Note
To download this software, you need to have a valid CCO username and password.
To download and install the software on your workstation, perform the following steps:
Step 1
Click Download Software.
Step 2
Choose Smart Connected Building Software > Cisco Network Building Mediator.
Step 3
Choose the appropriate hardware platform.
Step 4
Click Network Building Mediator Configuration Software to download the configTOOL.
Step 5
Choose the appropriate release, click the release number, and then click Download Now. The Download Cart window appears.
Step 6
Click Proceed with Download. The Cisco End User Software License Agreement page appears.
Step 7
Click Agree to accept the software download rules specified in the Cisco End User Software License Agreement page. Click Disagree to cancel the download process.
The download software page appears with two options to download the configTOOL: Download Manager Option and Non-Java Download Option.
Step 8
Click Non-Java Download Option to proceed with the download.
Note
The Download Manager Option requires a working Java version of 1.4.2.xx and later. If you choose this option to download the configTOOL software, the file is saved on your PC and you are allowed to run this file to install this software.
Step 9
Click Download URL to download the configTOOL. The file download dialog box appears.
Step 10
Click Run. You see the welcome message in the configTOOL Installer window.
Step 11
Click Next and follow the instructions to install the configTOOL. Alternatively, click Cancel the download process.
10 Installing the Mediator perfectHOST
To install this software, access Cisco.com at the following website:
http://www.cisco.com/en/US/products/ps10454/index.html
This software is available in the Support section at this website.
Note
To download this software, you need to have a valid username and password.
To download and install the software on your workstation, perform the following steps:
Step 1
Click Download Software.
Step 2
Choose Smart Connected Building Software > Cisco Network Building Mediator.
Step 3
Choose the appropriate hardware platform.
Step 4
Click Network Building Mediator Programming Software to download the perfectHOST.
Step 5
Choose the appropriate release, click the release number, and click Download Now. The Download Cart window appears. The Cisco End User Software License Agreement page appears.
Step 6
Click Agree to accept the software download rules specified in the Cisco End User Software License Agreement page. Click Disagree to cancel the download process.
The download software page appears with two options to download the perfectHOST: Download Manager Option and Non-Java Download Option.
Step 7
Click Non-Java Download Option to proceed with the download.
Note
The Download Manager Option requires a working Java version of 1.4.2.xx and later. If you choose this option to download the perfectHOST software, the file is saved on your PC and you are allowed to run this file to install this software.
Step 8
Click Download URL to download the perfectHOST. The file download dialog box appears.
Step 9
Click Run. You see the welcome message in the perfectHOST Installer window.
Step 10
Click Next and follow the instructions to install perfectHOST. Alternatively, click Cancel to cancel the download process.
11 Purchasing Licenses for the Mediator
You can purchase your license either through your reseller or through Cisco Systems. There are two options to purchase the Mediator license:
•
With base product—Applies to a new Mediator order. In this option, you should purchase the license as a configurable option when you order the Mediator. In this case, the Software License Claim Certificate is shipped along with the Mediator.
Note
Please contact your reseller or Cisco account representative for details on the ordering process.
•
Standalone—Applies to a license that is ordered separately at a subsequent point of time. In this option, you purchase the license as a standalone spare. You can choose to order the license for a physical or electronic delivery. In the case of a physical delivery, the Software License Claim Certificate is shipped in hard copy form to your mailing address. If you choose an electronic delivery, a soft copy of the Software License Claim Certificate is e-mailed to you.
Note
Irrespective of the number of licenses purchased, you receive a single claim certificate with a single PAK at any point of purchase. The license registration website is linked with the sales order database, therefore, all the licenses that you have ordered are enabled in the license file.
12 Downloading License Files for the Mediator
Based on the option you select to purchase your license, you receive a Software License Claim Certificate.
To download the license file, you need to register your Mediator at Cisco.com. To register your Mediator, it is necessary to have the following:
•
The PAK—This is printed on the Software License Claim Certificate.
For example, 4XCD##V####
•
The MAC address of the Mediator—This is the address of the ETH 0 Port of you Mediator. To view this address, log in to the Mediator web client, and click System.
To download the license files for a Mediator, perform the following steps:
Step 1
Log in to Cisco.com to register your license.
If you are not a registered user of Cisco.com, obtain your Cisco.com user ID from the following website: http://tools.cisco.com/RPF/register/register.do
After you have obtained your Cisco.com user ID, log in to Cisco.com to get your license file from the following website: http://www.cisco.com/go/license
Step 2
Register your Mediator with Cisco.com using the Product Authorization Key (PAK) and the MAC address of the Mediator (ETH 0 Port) to obtain your license file.
After you have registered your Mediator with Cisco.com, you receive the license file through e-mail.
Step 3
Save the license file to a folder location on your local disk.
Note
Alternatively, you can send an e-mail message to the Cisco Licensing support team at licensing@cisco.com. You need to provide the Product Serial No., MAC address of the Mediator, and the PAK in your e-mail message to the Cisco Licensing support team. Once the licensing team receives the necessary details, you receive the license file through e-mail.
13 Installing Licenses for the Mediator
To install the Mediator license, perform the following steps:
Step 1
Launch an Internet browser (for example, Internet Explorer) and connect to the Mediator using the IP address previously configured.
The Mediator web client pane appears.
Step 2
Click System. The System pane appears.
Step 3
Click the Status tab.
Note
By default, the License Status text box reads Disabled if a license has not been installed.
Step 4
To upload a license, click Browse.
Step 5
Navigate to the license file on your local disk.
Step 6
Click Open.
Step 7
Click Upload License to upload the license file to the Mediator.
When the file upload is complete, the file upload dialog box closes.
Step 8
To verify the license status, click Refresh. The updated licensing information appears in the License Status text box and the text box reads Enabled.
If you encounter any errors, repeat Step 1 to Step 6 to license your Mediator.
14 Verifying License Details
After you install the Mediator license, you can verify the details of the licenses that you have ordered.
To see the details for the installed licenses, perform the following steps:
Step 1
Launch an Internet browser (for example, Internet Explorer) and connect to the Mediator using the IP address of the Mediator.
Step 2
Click System. The System pane appears.
Step 3
Click the Status tab.
The Status tab displays the licensing details as follows:
•
License Status—Reads Enabled if a license has been installed.
•
Intermediate Protocols—Reads Supported if an intermediate protocol license has been installed.
•
Advanced Protocols—Reads Supported if an advanced protocol license has been installed.
•
Global Management—Reads Enabled if the global management license has been installed.
•
Point Limit—Displays the number of points that can be used on your Mediator with the existing licenses installed.
•
Points Available—Displays the number of points that are yet to be used on your Mediator.
15 General Information on Licenses
This describes general information about licenses and includes the following topics:
License Types
The Mediator provides a flexible, pay-as-you-grow licensing mechanism that gives you the option to add additional points and protocols as required.
There are three types of licenses:
•
Point licenses—Each Mediator comes with a certain number of built-in points that can be configured per appliance. Additional licenses can be purchased to increase the number of points.
•
Protocol licenses—Each Mediator comes with a certain set of built-in protocols. Additional protocol licenses may be purchased based on the requirements of the project.
•
Global Management license—You can purchase this license to enable the Mediators to communicate with the Mediator Manager.
Product Configurations
Table 4 describes the Mediator product configurations.
Note
A point is a generic term used to describe a single item of information in a building control system. For example, the temperature of a room, duct pressure of an air handling unit (AHU) and the chiller water flow rate are examples of points. The number of points needed in a particular project may be provided by the customer, project consultant or a partner.
Ordering Information
Table 5 describes the licensing ordering information for the Mediator.
Licenses for Points
All points on the Mediator do not require a license. While protocol points require that you have a specified license, the following points do not require a license:
•
Aliases
•
Virtual Points
•
Alarms
•
Logs
•
Trends
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.
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)
© 2011 Cisco Systems, Inc. All rights reserved.

