CHAPTER 1 This Installation and Setup Guide for Cisco E-DI 2.2 on Linux has information on installing and getting started with Linux. It has the following sections: Introduction Installing Cisco E-DI 2.2 Launching E-DI Applications Related Documentation Introduction Cisco E-DI provides a comprehensive management interface for configuration of Cisco devices. It provides interfaces with network devices through the command line interface (CLI) or through a Eclipse-based Graphical User Interface (GUI). This guide explains how to install, configure, and start using Cisco E-DI 2.2 on Linux. The software is available for download and runs on hardware as detailed in Table 1-1. Default settings are provided during installation, so that Cisco E-DI can be up and running with minimal configuration. However, the software also lets you enhance this configuration, if you need to. To install, configure and use Cisco E-DI, you must: 1. Install Cisco E-DI 2. Set up credential sets 3. Discover devices 4. Manage the network 5. Set up user accounts The procedure to install Cisco E-DI on Linux is provided in this document. For all the other procedures, see User Guide for Cisco Enhanced Device Interface, 2.2. Every time E-DI is installed, a new user is created in the local computer. The user that is already present, cannot be used. This user will be removed while uninstalling E-DI. E-DI Installation Location: This is used in this document to indicate the install location of Cisco E-DI on Linux. 1-1
Installing Cisco E-DI 2.2 Chapter 1 For the new features in this release, see the Release Notes for Cisco Enhanced Device Interface, 2.2 for Linux. Installing Cisco E-DI 2.2 This section has the following topics: System Requirements Installing Cisco E-DI How to Use Cisco E-DI on Linux Uninstalling Cisco E-DI on Linux The installation takes approximately 5 minutes. Caution You must enable SSH version 1 to connect to Device Configuration Manager or XML PI APIs. System Requirements Note gcc (Linux C Compiler) with version higher than 3.4.x must be installed in the Linux machine as a prerequisite. All the UI applications need jre 1.5. Include Java in path. Table 1-1 Hardware and OS Requirements System Requirements Linux Red Hat Enterprise Linux V 4 Red Hat Enterprise Linux V 5 Hardware IBM PC compatible computer with 1.6 GHz or faster Pentium processor CD-ROM drive 2 GB minimum memory 20 GB minimum available disk drive space Installing Cisco E-DI This section provides information about installing Cisco E-DI 2.2 on a Linux platform. You should run the installation scripts as root or administrative user. Whenever E-DI is installed, a new user for PostgreSQL is created in the local computer. This user will be removed while uninstalling E-DI. The user that already exists on the system, cannot be used. By default, E-DI listens on the 2323 port and supports only Telnet connections. 1-2
Chapter 1 Installing Cisco E-DI 2.2 To install Cisco E-DI 2.2 on Linux: Step 4 Step 5 Navigate to the location on your system, where you downloaded EDI-Linux.tar.gz. Unzip EDI-Linux.tar.gz by entering: gzip -d EDI-Linux.tar.gz. Enter tar xvf EDI-Linux.tar This creates the EDIPKG directory which contains the script install.sh which runs the E-DI installation. Enter the EDIPKG directory using this command: cd EDIPKG Enter chmod 744 *.sh Step 6 Step 7 Step 8 Run the installation program by entering./install.sh The installation begins and the license agreement text appears. Enter yes to accept the licensing agreement. If you enter no, the installation terminates. Enter the directory path for the E-DI installation or accept the default path which is /opt/ciscosystems/cisco-edi/ E-DI installs the Java Runtime Environment, the E-DI server, and the HTTP server. Before Perl is installed, the following message appears: Do you want to install Perl that comes with Cisco-EDI [yes/no] Enter yes to continue installing Perl. Or Enter no Perl if you do not want to install Perl. Even if you decide not to install Perl, the Perl samples will be installed. The Postgres database is installed. Cisco E-DI internally creates a non-admin user, edipostgres. The Postgres database runs as edipostgres user. The E-DI 2.2 installation completes and the following message appears: Do you wish to start the E-DI server? [yes/no] Step 9 Enter yes to start the E-DI server. The E-DI server starts. You can use Telnet to connect to E-DI and log in. To login, use the command telnet hostname 2323 where hostname is the name of the E-DI server. 1-3
Installing Cisco E-DI 2.2 Chapter 1 How to Use Cisco E-DI on Linux The following topics describe how to get started with E-DI: Starting the Cisco E-DI Server Stopping Cisco E-DI Server Backing Up Data Restoring Data Logging into the E-DI Server Accessing the E-DI Log file Custom Configuration Starting the Cisco E-DI Server To start the Cisco E-DI server: Navigate to the directory E-DI Install Location/Cisco-EDI/bin, where E-DI Install Location is the location where Cisco E-DI has been installed. Start the E-DI Server, by entering at the prompt,./start.sh. Messages appear indicating that the Postgres database, and the E-DI server have been started. Stopping Cisco E-DI Server To stop the Cisco E-DI server: Navigate to the directory E-DI Install Location/Cisco-EDI/bin, where E-DI Install Location is the location where Cisco E-DI has been installed. Stop the E-DI Server, by entering./stop.sh. at the prompt. Messages appear indicating that the E-DI server and the Postgres database have been stopped. Backing Up Data Before uninstalling E-DI, you may want to back up your data. To back up your data on Linux: Step 4 Navigate to the directory E-DI Install Location/Cisco-EDI/bin. Stop the E-DI Server, by entering./stop.sh. at the prompt. From the same location, back up data by entering./edidata_backup.sh. You are prompted to enter the absolute path for the data backup. Enter the pathname. The default is SystemDrive:/EDI_Backup. 1-4
Chapter 1 Installing Cisco E-DI 2.2 After the backup is complete, you will see a message confirming that the back up has completed. The data that is backed up is E-DI config archive, Postgres database, and the E-DI config.txt file. Restoring Data After installing E-DI, you can restore the data that was backed up previously. The data will be restored from the user specified directory (the directory where the backup was done). To restore your data: Step 4 Navigate to the directory E-DI Install Location/Cisco-EDI/bin. Restore the data by entering./edidata_restore.sh at the prompt. You will be prompted to enter the directory for E-DI data restore. Enter the directory for the data resotoration. The restoration proceeds. When complete, a message indicates that the data has been restored. You are prompted to start the E-DI server. Go to E-DI Install Location/Cisco-EDI/bin and enter./start.sh at the prompt. The E-DI server starts. Logging into the E-DI Server After starting the E-DI Service see Starting the Cisco E-DI Server, you can log into the E-DI Server. To do this, enter telnet Servername 2323 at the prompt in the Telnet console, where Servername is the name of your server. Accessing the E-DI Log file You can access the EDI log file at /var/log/nemos.log. nemos.log provides the runtime and startup log files. Custom Configuration After installing E-DI, if you want to increase the maximum heap size, or change ports, you can edit the ediserver file in this location: E-DI Install Location/Cisco-EDI/bin/ediserver Increasing the Maximum Heap Size By default, Java uses 512 MB (initial) to 1024 MB (maximum) RAM. If you need to manage more devices (for example, more than 200 devices) E-DI may need more resources. In this case you can change the maximum memory to a value greater than 1.5 GB by editing the ediserver file. 1-5
Installing Cisco E-DI 2.2 Chapter 1 Parameters: $JAVA -Xnoclassgc -Xms512m -Xmx1024m \ Increase the -Xms value to 1.5 GB or more. Changing the Port By default, E-DI Telnet runs at the 2323 port. If you want to change this port, edit the ediserver file. -DCONN_MGR_PORT=2323 Change the default port 2323 to the port you want. Re-installing Cisco E-DI You can re-install Cisco E-DI on Linux. To do this: Navigate to the directory E-DI Install Location/EDIPKG. Run the installation program by entering:./install.sh Before the reinstall proceeds, these messages appear: Previous install of E-DI found at 'EDI Install Location/Cisco-EDI/'. Re-install will use same directory. Cisco-EDI Server is already installed. Do you want to reinstall it (yes/no) Enter yes to proceed. Note When you are re-installing Cisco E-DI, the License Agreement does not appear. Uninstalling Cisco E-DI on Linux To uninstall on Linux: Navigate to the directory E-DI Install Location/Cisco-EDI, where E-DI Install Location is the location where Cisco E-DI has been installed. Enter./uninstall.sh at the prompt. The uninstallation begins. If the E-DI server is running, you are prompted to confirm whether the uninstallation should continue. 1-6
Chapter 1 Launching E-DI Applications Enter yes. The E-DI server shuts down and a message appears, to confirm the uninstallation. Launching E-DI Applications The following applications are packaged with E-DI: Device Configuration Manager Enables you to edit and manage configuration files. To launch this application, see Launching Device Configuration Manager (DCM). For more details about this application and its usage, see the User Guide for Cisco Enhanced Device Interface, 2.2. Macro Command Manager Enables you to define device and OS-independent command sets (macros) deploy these macros commands to devices. To launch this application, see Launching Macro Command Manager. For more details about this application and its usage, see the User Guide for Cisco Enhanced Device Interface, 2.2. Command Translator Enables you to translate Cisco Catalyst Operating System (CatOS) configurations to equivalent, supported Cisco IOS configurations. To launch this application, see Launching Command Translator. For more details about this application and its usage, see the User Guide for Cisco Enhanced Device Interface, 2.2. Command Analyzer Allows you to check commands for completeness, and enables you to compares two IOS images. To launch this application, see Launching Command Analyzer. For more details about this application and its usage, see the Programmer s Guide for Cisco Enhanced Device Interface, 2.2. Command Modeler Provides an infrastructure for generating and validating device-independent CLI models. Developers can use the generated device independent CLI models to generate device-specific Java code To launch this application, see Launching Command Modeler. For more details about this application on and its usage, see the Programmer s Guide for Cisco Enhanced Device Interface, 2.2. Operational Data Model tool The Operational Data Model (ODM tool enables you to create a unique Data Model for the operational data that is available through CLI show commands. To launch this application, see Launching Operational Data Modeler. For more details about this application on and its usage, see the Programmer s Guide for Cisco Enhanced Device Interface, 2.2. Tip Before you launch any application, we recommend that you clean the cache. (These steps are optional): Go to the command prompt and navigate to your Eclipse folder (where eclipse.exe resides). Run the command eclipse -clean This ensures that the cache is cleaned. Launching Device Configuration Manager (DCM) After you have installed Cisco E-DI, follow these steps to launch DCM. DCM is a client application that can be used to connect to any E-DI server. We recommend that you use a Windows client with a Linux server. 1-7
Launching E-DI Applications Chapter 1 Before you start DCM, ensure that the EDI Service is running. To start this service, navigate to E-DI Install Location /Cisco-EDI/bin and enter./start at the command prompt. To launch Device Configuration Manager: Navigate to E-DI Install Location/Cisco EDI/edi/dist/ui_products/configmanager. Enter./launcher E-DI prompts you to log in to the E-DI server. Log in using admin credentials. By default, DCM connects to the port 2323 on the server. If the server Telnet port is not 2323, change this value in the eclipse.ini file. This file is located at: E-DI Install Location/edi/dist/ui_products/configmanager After you log in, Device Configuration Manager opens. This has three perspectives (which appear as buttons): Config Manager This is the default perspective, and this button is highlighted. Macro Command Manager Opens the Macro Command Manager perspective. Command Translator Opens the Command Translator perspective. To display the Commnand Translator button, click on the >> symbol that appears after the Macro Command Manager Button. See Figure 1-1. After you click on >>, the Command Translator button appears. See Figure 1-2. Figure 1-1 Device Configuration Manager defualt perspectives and the >> symbol 1-8
Chapter 1 Launching E-DI Applications Figure 1-2 The Command Translator button appears Launching Macro Command Manager Macro Command Manager is packaged with Cisco E-DI, and will be available after you have installed Cisco E-DI. Before you start Macro Command Manager, ensure that the EDI Service is running. To start this service, navigate to E-DI Install Location /Cisco-EDI/bin and enter./start at the command prompt. To launch Macro Command Manager: Navigate to E-DI Install Location/Cisco EDI/edi/dist/ui_products/configmanager. Enter./launcher E-DI prompts you to log in to the E-DI server. Log in using the admin credentials. By default, DCM connects to the port 2323 on the server. If the server Telnet port is not 2323, change this value in the eclipse.ini file. This file is located at: E-DI Install Location/edi/dist/ui_products/configmanager After you log in, Device Configuration Manager opens. This has three perspectives (which appear as buttons): Config Manager This is the default perspective, and this button is highlighted. Macro Command Manager Opens the Macro Command Manager perspective. Command Translator Opens the Command Translator perspective. 1-9
Launching E-DI Applications Chapter 1 Note To display the Commnand Translator button, click on the >> symbol that appears after the Macro Command Manager Button. See Figure 1-1. After you click on >>, the Command Translator button appears. See Figure 1-2. Step 4 Select Macro Command Manager and click OK. The Macro Command Manager perspective opens. Launching Command Translator Command Translator is packaged with Device Configuration Manager of Cisco E-DI, and will be available after you have installed Cisco E-DI. Before you start Command Translator, ensure that the EDI Service is running. To start this service, navigate to E-DI Install Location /Cisco-EDI/bin and enter./start at the command prompt. To launch Command Translator: Navigate to E-DI Install Location/Cisco EDI/edi/dist/ui_products/configmanager Enter./launcher E-DI prompts you to log in to the E-DI server. Log in using the admin credentials. By default, DCM connects to the port 2323 on the server. If the server Telnet port is not 2323, you should change this value in the eclipse.ini file. This file is located at: E-DI Install Location/edi/dist/ui_products/configmanager After you log in, Device Configuration Manager opens. This has three perspectives (which appear as buttons): Config Manager This is the default perspective, and this button is highlighted. Macro Command Manager Opens the Macro Command Manager perspective. Command Translator Opens the Command Translator perspective. Note To display the Commnand Translator button, click on the >> symbol that appears after the Macro Command Manager Button. See Figure 1-1. After you click on >>, the Command Translator button appears. See Figure 1-2. Step 4 Click Command Translator. The Command Translator perspective opens. 1-10
Chapter 1 Launching E-DI Applications Launching Command Analyzer Command Analyzer is a stand-alone application.the E-DI server does not need to be running for you to be able to use Command Analyzer. To launch Command Analyzer: Navigate to the directory E-DI Install Location\ Cisco Systems\Cisco EDI\edi\dist\ui_products\cmdAnalyzer Run./launcher Command Analyzer opens. Launching Command Modeler You should install Eclipse 3.2 before you launch Command Modeler. To launch Command Modeler: Navigate to the folder E-DI Install Location/Cisco EDI/edi/dist/cmdModeler/lib. Copy the Command Modeler jar file (com.cisco.edi.cmdmodeler_buildnumber.jar) from the lib folder. Paste the jar file into the Eclipse plugins folder (Eclipse Directory/plugins). Note Step 4 Step 5 Step 6 Ensure that Eclipse is closed while the jar is copied into the plugins folder. Start Eclipse. From the Main Menu Bar, select Windows > Open Perspective > Other. The Open Perspective dialog box opens. Select Command Modeler and click OK. The Command Modeler perspective opens. Launching Operational Data Modeler The E-DI server does not need to be running for you to be able to use ODM. It is a stand-alone application. To launch ODM. Navigate to the directory E-DI Install Location\ Cisco Systems\Cisco EDI\edi\dist\ui_products\ODM Run./launcher ODM opens. 1-11
Related Documentation Chapter 1 Alternatively, copy this file and extract it to a location of your choice. Related Documentation The following documentation is available for Cisco E-DI 2.2: Also see Accessing Documentation. User Guide for Cisco Enhanced Device Interface, 2.2 Programmer s Guide for Cisco Enhanced Device Interface, 2.2 Release Notes for Cisco Enhanced Device Interface, 2.2 on Linux Online help integrated with the applications. Accessing Documentation You can access the documentation for Cisco E-DI in the following ways: PDFs of the User Guide for Cisco Enhanced Device Interface, 2.2 and the Programmer s Guide for Cisco Enhanced Device Interface, 2.2 are available in the documentation folder in the E-DI Install Location/Cisco EDI/docs. The UI applications, Command Analyzer, Operational Data Model, Command Modeler, Device Configuration have integrated Online help. For each application, from the Eclipse GUI, you can select Help > Help Contents to launch the help for that application. For the latest and updated documentation of Cisco Enhanced Device Interface, 2.2, please check Cisco.com: http://www.cisco.com/en/us/products/ps6456/tsd_products_support_series_home.html 1-12