Cisco Enhanced Device Interface User's Guide, 2.0
Using Cisco E-DI

Table Of Contents

Using Cisco E-DI

Setting up the Terminal

Keyboard Shortcuts

Cisco E-DI Services

Commonly Used Commands

File System Commands

Comparing Files

Restarting the Server or a Device


Using Cisco E-DI


This chapter details how to configure and use Cisco E-DI features:

Setting up the Terminal

Keyboard Shortcuts

Cisco E-DI Services

Commonly Used Commands

File System Commands

Comparing Files

Restarting the Server or a Device

Setting up the Terminal

The commands used to set up the terminal are detailed in Table 2-1. The commands can be given in server or network mode.

Table 2-1 Commands to Setup the Terminal 

Action
Command

To set the terminal color mode.

You can also use the key combination Ctrl-T from the server EXEC level to toggle between gray and color modes.

[SRV:/server|NET:/network]#terminal 
color          

The terminal display settings can be configured to use either hostname, DNS name, or the IP address of the device.

[SRV:/server|NET:/network]#terminal 
device-id {dns-name | dns-name-short| 
ip | name}

To define the FTP Authentication credentials.

[SRV:/server|NET:/network]#terminal 
ftp-auth username {word}
Password

To define the HTTP Authentication credentials.

[SRV:/server|NET:/network]#terminal 
http-auth username {word}
Password

To make the session interactive.

[SRV:/server|NET:/network]#terminal 
interactive 

To specify the number of lines that are displayed on the terminal.

[SRV:/server|NET:/network]#terminal 
length {0-1} | {2-256}

When terminal monitor is enabled, any action on the Cisco E-DI server carried out on another session is displayed on the terminal.

[SRV:/server|NET:/network]#terminal 
monitor message filter {word}

To disable the relevant terminal mode.

[SRV:/server|NET:/network]#terminal 
no {color | http-auth | interactive | 
monitor | monitor message-filter | 
skip-locked | skip-unauth | 
status-codes | suppress-repeats}

To set the terminal environment variable value.

[SRV:/server|NET:/network]#terminal 
set {word}{word} 

To skip all devices locked by some other user.

[SRV:/server|NET:/network]#terminal 
skip-locked   

To skip all devices that are not authorized to be included in a task.

[SRV:/server|NET:/network]#terminal 
skip-unauth   

To display the status code after command implementation.

[SRV:/server|NET:/network]#terminal 
status-codes 

To set the terminal stream control type.

[SRV:/server|NET:/network]#terminal 
stream-ctl {read-file filename | 
write-file filename | 
xml-data-channel {word}}

To turn the toggle options using the Ctrl key on and off.

[SRV:/server|NET:/network]#terminal 
supress-repeats 

To unset the terminal environment variable.

[SRV:/server|NET:/network]#terminal 
unset {word} 

To specify the text width displayed on the screen.

Note The default terminal width is 24.

[SRV:/server|NET:/network]#terminal 
width {16-256} 

Keyboard Shortcuts

Table 2-2 details the keyboard shortcuts available in Cisco E-DI.

Table 2-2 Keyboard Shortcuts and Associated Actions 

Shortcut
Action

?

Opens context sensitive help

Ctrl A

The cursor goes to the beginning of the line

Ctrl B

The cursor moves one character to the left

Ctrl C

Discards the current line

Ctrl D

Deletes the character at the cursor

Ctrl E

The cursor goes to the end of line

Ctrl F

The cursor moves one character to the right

Ctrl G

Displays the devices selected, the knowledge base applied and the applicability of the command to the devices selected in device configuration mode

Ctrl K

Deletes all characters from the cursor to the end of the command line

Ctrl N

Returns more recent commands in the history buffer after recalling commands with Ctrl-P or the Up Arrow key

Ctrl P

Recalls commands in the history buffer, beginning with the most recent command

Ctrl R

Refreshes the current line

Ctrl T

Toggles between terminal color display

Ctrl U

Deletes all characters before the cursor to the beginning of the command line

Ctrl W

Deletes the word to the left of the cursor

Ctrl X

Deletes all characters before the cursor to the beginning of the command line

Ctrl Z

Exit from configuration mode

Enter

For paginated messages (more than one page), message scrolls one line up

Space bar

For paginated messages (more than one page), message scrolls one page up (equal to terminal length)

Tab

Completes a partial command


Cisco E-DI Services

Cisco E-DI includes a number of services, see Table 2-3. These services can be enabled or disabled, see Table 2-4.

Table 2-3 Cisco E-DI Services 

Service
Default
Description

asset

Enabled

Device asset collection service.

Periodically collects information on device hardware assets such as chassis, cards, slot, power-supply, and fans.

editor

Enabled

Text editor service for CLI.

Allows editing/creating files on Cisco E-DI using a vi editor.

exec-cmd

Enabled

Direct network EXEC command service.

Enables implementing commands on a device using exec-cmd command.

perl-scripting

Disabled

Perl scripting service for CLI.

Enables implementation of perl scripts using perl command.

telnet

Disabled

Enable/disable Telnet service.

Enables login to the Cisco E-DI server using Telnet.

trap-receiver

Enabled

SNMP trap receiver service.

Enables the receiving and processing of SNMP traps.


Table 2-4 Commands to Enable Cisco E-DI Services 

Action
Command

To enable the device asset collection service

[SVR:/server] (config)#service asset

To enable the text editor service for the CLI

[SVR:/server] (config)#service editor

To enable the direct network EXEC command service

[SVR:/server] (config)#service exec-cmd

To enable perl-scripting for the CLI

[SVR:/server] (config)#service perl-scripting

To enable the telnet service

[SVR:/server] (config)#service telnet

To enable the SNMP trap receiver service

[SVR:/server] (config)#service trap-receiver


Commonly Used Commands

Table 2-5 details commands which are commonly used in Cisco E-DI.

Table 2-5 Commonly Used Commands 

Action
Command

To enter the configure setup mode.

config setup

To enter the configure terminal mode.

config t

To perform various diagnostic activities on the network.

diag

To download files using HTTP or FTP onto Cisco E-DI.

download

To exit out of the configuration mode.

You can also use Ctrl-Z

end

To exit from the current configuration view and move to the parent view.

exit

To find the managed devices that match a certain criteria.

find

To show help on different topics based on the text input.

help

To put the discovered devices into the managed state.

import

To collect device(s) inventory. Used in network mode.

inventory

To logout of the server.

logout

To query a DNS server to lookup and find IP address information for a host or device.

nslookup

To ping a element in the network using its IP address or name.

ping

To synchronize the file system, device configuration and archives on the devices and the server.

sync

To trace a route to a network element using its IP address or name.

traceroute

To save the server running configuration to start-up configuration.

write

File System Commands

Cisco E-DI creates a virtual file system to represent the file systems on the managed devices. The virtual file system contains server, network and users directories in the root of the file system:

/server directory contains directories and files related to Cisco E-DI such as directories for storing configuration archives, images and temporary files.

/network directory contains the virtual file system representing file systems for all the devices currently managed.

This is a read only file system. Files can be read from the devices, but cannot be written or deleted. The file systems of the devices are learned when the device is managed and are kept up-to-date with the device whenever a device inventory is performed. The file systems can also be kept up to date with the sync filesystem command.

/users directory contains one directory for each user of Cisco E-DI, which can be used to store user specific files.

Table 2-6 details commands to manage the file system.

Table 2-6 Commands to Manage the File System 

Action
Command

To change the current directory.

[SVR:/server|NET:/network]# cd 
{/}[name{/name/name.....}]

To switch to the server root directory.

[SVR:/server]# cd  /

To switch to the user's home directory.

[SVR:/server]# cd  

To display the current working directory.

[SVR:/server|NET:/network]# pwd

To create a directory with a specified name.

[SVR:/server|NET:/network]# mkdir 
/{server/ | network/} name

To remove the specified directory.

[SVR:/server|NET:/network]# rmdir 
/{server/ | network/} name

To show the contents of the current directory.

[SVR:/server|NET:/network]# dir

To view the contents of the specified file.

[SVR:/server|NET:/network]# more 
/{server/ | network/} name

To delete the specified file.

[SVR:/server|NET:/network]# delete 
{/force | /recursive | name}

To copy a file.

[SVR:/server|NET:/network]# copy  
{source file destination file}

To rename a file.

[SVR:/server|NET:/network]# rename name

To synchronize the file system on the server with the file system on the device. You can choose to synchronize the device in the background or the foreground.

[NET:/network]# sync filesystem {bg | 
fg}


Note You can also manage the file system using perl scripts. See "Using Perl Scripts".


Comparing Files

Cisco E-DI gives the option to compare two files and deduce the differences with appropriate color codes. Table 2-7 details the commands.

Changes will be highlighted in color, if enabled. Additions are shown in green and deletions are shown in red. Else, deletions will be marked by "-" and additions by "+".


Note CTRL-T enables the color mode.


Table 2-7 Commands to Compare Files 

Action
Command

To compare files. File 1 is the reference.

[SVR:/server]# diff file-name1 file-name2

To compare the start-up and running configurations.

[SVR:/server]# show running-config diff-with 
startup-config

Restarting the Server or a Device

The commands to restart the Cisco E-DI server or a device are detailed in Table 2-8.

Table 2-8 Commands to Restart Server and Devices 

Description
Command

Restart the Cisco E-DI server.

[SVR:/server]# reload server

Restart the specified devices.

[SVR:/server]# reload device ip-address1 
[ip-address2........]