-
Cisco Enhanced Device Interface User Guide 2.2.1
-
Preface
-
Introduction
-
Using Cisco E-DI
-
Maintaining the Network
-
Managing Files
-
Managing Security
-
Configuring Devices
-
Managing Inventories and Reports
-
Scheduling Jobs
-
Alarms
-
Using Perl Scripts
-
Creating and Using Macro Commands
-
Translating commands using Command Translator
-
Troubleshooting the Network
-
Frequently Asked Questions
-
Maintaining Cisco Enhanced Device Interface
-
Cisco E-DI Commands and Associated Privileges
-
Open Source Lincese Acknowledgment
-
Feedback
Table Of Contents
Configuring a Device Using the CLI
Managing Configuration Files Using the CLI
Configuring Devices Using the GUI
Launching Device Configuration Manager (DCM)
Editing a Configuration File Using the DCM GUI
Using the DCM Command Editor to Enter Commands and Check Command Syntax
Configuring Devices
Cisco E-DI supports configuration of devices, through the CLI, the GUI, and the XML programmatic interface (PI), covering a range of platform/OS combinations. Cisco E-DI uses a knowledge base which emulates each device to provide you with a virtual experience of configuring the actual device.
The knowledge base for the various platforms is learnt through the FastTrack command learning engine. Through FastTrack, Cisco E-DI is capable of providing comprehensive coverage for a given NE/OS release combination within a short period of time.
As more features are added into releases of Cisco IOS, Cisco E-DI incrementally builds upon the existing knowledge base through incremental device updates (IDU) that are available for download.The IDU feature allows Cisco E-DI to be updated with new device packages on the running system.
Cisco E-DI users can configure a group of devices using network virtualization. Cisco E-DI groups the knowledge base data applicable to all the devices in the group, and provides the common set of configuration commands to the user. In this way, the user can configure the network as if they are configuring a single device. See Network Virtualization, page 1-8 for details.
This chapter includes the following information:
•
Managing Configuration Files Using the CLI
•
•
Using the CLI
All network related configurations through the CLI are performed in the server configuration setup command mode. This mode contains commands for entering into configuration mode for selected devices or combinations of devices to save, commit, schedule or discard configuration changes.
To configure a device or devices:
Step 1
Enter the config-setup mode, enter config s.
Note
Step 2
Step 3
Step 4
This chapter includes the following information:
•
•
Configuring a Device Using the CLI
Cisco E-DI provides several ways to change the configuration of a device:
•
•
Note
Table 6-1 gives the commands available to enter the network configuration mode and configure the devices.
Table 6-1 Commands to Configure Devices
To enter network configuration setup mode.
The behavior of this command changes when session-based device authentication is enabled.
See Using Session-Based Device Authentication, page 2-7 for a full explanation of the command behavior.
To enter network configuration mode.
To enter the device configuration mode.
To exit from the current configuration view and move to the parent view.
To exit out of the configuration mode.
You can also use Ctrl-Z.
To configure an interface when only one device is selected.
To configure an interface when multiple devices are selected.
To configure an interface using an interface macro to select multiple interfaces.
Enter interface ? to see list of all macros available.
Devices can be grouped as interface macros. For example all-fast ethernet or all-VLANs.
This allows you to apply the configuration to all interfaces of the device, and also on all the devices in the selected group.
To show the list of devices selected for configuration, or to preview the configurations that will be made on the selected device.
To:
•
•
•
•
To run the script.
In network configuration mode, Cisco E-DI provides a common set of commands that apply to all selected devices and their software versions.
After exiting from network configuration mode, you must select an option from the Configuration menu as follows:
Validating Commands
Once the devices are selected for configuration, a summary table shows which devices have been selected and which versions of the knowledge base are being used to perform CLI operations.
In the network-config mode, enter CTRL-G to display the devices selected, knowledge base applied and the applicability of the command to the selected device. For example:
[NET:/network](configure)# ip name-server [CTRL-G]Device IDU Name IDU Version Version Command Status172.168.3.22 Cat3550 1.2 12.3(6a) INCOMPLETE172.168.3.21 Cisco7200 1.1 12.3(6a) INCOMPLETEManaging Configuration Files Using the CLI
Cisco E-DI archives start-up and running-config files for all devices and the server whenever there is a configuration change.
You can use the archived files later to restore the configuration of the network or server to the desired state. All the network and server configuration archives are stored in the /server/config-archive directory.
Table 6-2 gives the commands to manage the configuration files.
Table 6-2 Commands to Manage Configuration Files
To list all archives of running configuration.
A running configuration can be saved to the startup configuration.
The archived configuration files can also be viewed in the device directory, enter:
cd /network/device/<ip address>/[running-config | startup-config]To list all archives of startup configuration
To load the latest archived configuration into the running configuration, or load the filename that points to the startup configuration.
The filename is the name of the startup configuration file to be loaded.
To clear the configuration archive files from the server.
See Table A-1 for details of the options available with this command.
To clear the configuration archive files from the network.
This command is applied to all the devices in the current context; all clears the startup and running configurations, running clears the running configurations, startup clears the startup configurations
[NET:/network]# clear config-archive {all | startup | running}To clear the configuration archive files for a particular device.
[NET:/network]# clear config-archive device ip-address {all | startup | running}To clear the configuration archive older than a specific period.
[NET:/network]# clear config-archive {all | running | startup | device {ip-address} ...} older-than {days | time}To restore a server or a device or a group of devices to a state represented by a specified time or a configuration file or a labeled archive file.
file is the name of the configuration archive file that will be used for restoration.
time restores the configuration file that has a timestamp that is less than or equal to the given time.
Note
[SVR:/server|NET:/network]# restore {file file_name | time YYYY MM DD HH:MM:SS | label label_name}To create a label for server configuration.
Startup configuration archive files can be labeled using the time stamp or filename. Labels created in one context, for example server, are not displayed in the other context, that is network mode.
The label command accepts the name of the label and applies the label based on whether the command is implemented in the server or network context.
[SVR:/server]# label {label_name} [descr | file | time]To create a label for device configuration.
descr provides an option to specify a description while labeling the configuration
file applies the label to the given file name.
time creates and applies a label based on the timestamp of the configuration archive file.
[SVR:/server]# network [ip-address | group {group-name} ][NET:/network]# label {label_name} [descr | file | time]To display the label and its details including the associated file, and description.
To delete a label.
[SVR:/server]# clear label server_conf | network_conf {time YYYY MM DD HH:MM:SS descr "Server configuration as of <date> | file_name descr "name"}
Configuring Devices Using the GUI
The Cisco E-DI provides Device Configuration Manager (DCM), an Eclipse-based GUI application to view and edit a configuration before applying the changes to the device. DCM includes Command Editor.
DCM can be used to edit the contents of the startup configuration file and the running configuration file, and apply the configuration to the device.
DCM is packaged with Cisco E-DI, and will be available after you have installed Cisco E-DI. To install Cisco E-DI, see:
•
See these topics:
•
•
•
•
Launching Device Configuration Manager (DCM)
Before you launch Device Configuration Manager, from the command prompt, navigate to your Eclipse folder (where eclipse.exe resides). Run the command eclipse -clean
This ensures that the cache is cleaned.
After you have installed Cisco E-DI, follow these steps to launch DCM.
Note
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. It is recommended that you use Windows client with a Linux server.
Before you start DCM, ensure that the EDI Service is running.
To start this service, On Windows, go to Start > Programs > Cisco E-DI > E-DI Service > Start.
On Linux, navigate to E-DI Install Location /Cisco-EDI/bin and enter ./start at the command prompt.
Step 1
•
or
•
On Linux:
•
Step 2
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 in the following location:
On Windows:
E-DI Install Location\edi\dist\ui_products\configmanager.
On Linux:
E-DI Install Location/edi/dist/ui_products/configmanager
Step 3
•
•
•
For a description of the DCM views, see Understanding the DCM UI.
Right-click on a device. The context menu that appears displays the options Edit Running Config, Edit Startup Config etc.
For the complete procedure on editing configuration files using DCM, see Editing a Configuration File Using the DCM GUI.
Understanding the DCM UI
The DCM perspective is divided into these main sections:
•
Displays the network folder (Device Drawer). After you log into the E-DI server, you can expand the Network folder to view all your managed devices in this pane.
You can right-click on the Device Drawer and select Refresh Network from the context menu to view any newly managed devices in the Device Drawer.
•
When you first open Device Configuration Manager, expand the device drawer and select a device, the device inventory details appear in the Editor area.
These details include IP Address, Name, Vendor name, OS Name, OS version, Managed Status, Online Status, Device Type, Device Family, System Description, and System OID.
•
Displays the startup and running config files that you have opened, and also the Command Editor. The tabs in this view allow you to navigate between the various open files and the Command Editor.
DCM allows you to save the editing contents to a file on a user local file system for viewing later. When you open a file from the user local file system, it opens in the Editor area of DCM.
The tab header displays a text icon and devicename_running or devicename_startup. You can open multiple files and they appear in the Editor area with appropriate tab headers.
For the complete details about editing configuration files, see Editing a Configuration File Using the DCM GUI.
The Command Editor (Tools > Command Editor) can be used to edit the contents of running configuration file. The changes are saved to a file. The changes cannot be applied directly to the device from the Command Editor.
You can also change device type and IOS version for checking command syntax. The command syntax check will be done based on the device knowledge base.
Editing a Configuration File Using the DCM GUI
You can use Device Configuration Manager (DCM) to edit a running configuration file or a startup configuration file.
To use DCM for edits:
Step 1
Step 2
An asterisk (*) indicates that the device is not supported in Cisco E-DI. The Device Inventory view displays the device properties of the selected device.
Note
Step 3
The editing options are:
•
A copy of the running configuration appears in the Editor area (right central view). You can edit this copy. A tab identifies the running configuration.
•
A copy of the startup configuration appears in the Editor area (right central view). You can edit this copy. A tab identifies the startup configuration.
From the Edit option on Eclipse Menu Bar, or from context-menu that appears when you right-click in the Editor, you can use Cut, Copy, Paste, Undo, Redo, and other Edit options to make your edits.
You can lock the file so that other users cannot make changes to the device.
To lock or unlock a device:
•
•
You can search for a word or phrase, using Edit > Find/Replace from the Main Menu Bar.
The Editor includes the option to check the command syntax based on the knowledge base for that device. The CLI syntax is checked automatically as you make your edits to the running or startup config.
The content text in the Editor area is color coded to give visual feedback as follows:
The CLI syntax is also checked automatically within your open file when you choose a different Device Family and Version. The comments will be shown in a different syntax color and font as syntax checking feedback.
This is a tool for checking whether one configuration file can be applied to another device family. It can also be used as a training or learning aid, or to compare commands.
The device details and version are shown in the Status bar. A different color is used to distinguish submode blocks, for example username cisco password 0 cisco.
If you enter Ctrl <Space>, E-DI displays hints on the commands and parameters. These will help you in entering the commands correctly.
Step 4
To close the Editor, choose the cross sign on the tab. If you had made any changes, you will be asked to save your changes.
Using the DCM Command Editor to Enter Commands and Check Command Syntax
You can use the DCM Command Editor to create command sets and check any command syntax against a device family and OS version:
Step 1
Step 2
Step 3
The Command Editor opens.
Step 4
As you enter commands, the DCM syntax checker checks for your syntax. The color codes provide you with visual feedback.
Step 5
This file can be reopened in the Command Editor to check against the required the device family and OS version (selected from the top right view).
You can modify the content and verify the syntax.
You can open the running configuration file for the device using the Device Configuration Manager.You can copy commands from the Command Editor to the Device Configuration Manager to apply the translated commands to the device configuration.
Viewing Device Interfaces
You can view the details of all the interfaces on a particular device.
Step 1
Step 2
The Interface List appears.
The Interface List pop-up appears, displaying the following information:
