eManager User
Manual
Adding Product Nodes to a Group
Distribution Plan Editor Screen
LINCS Configuration Panels Viewer
eManager is an advanced software tool used to manage and maintain Visara products remotely. eManager allows you to make software updates and configuration changes to the products from a remote workstation. Some of the functions supported by eManager include:
· Store specific product information in the eManager database on all Visara products installed
· Automatically locate and enter Visara products into the database
· Create and store update objects for configurations and code
· Create and execute distribution plans for the update objects
· Backup configurations for all Visara products onto the centrally located eManager platform
· Shadow remote users on select desktop products
· Monitor network availability of defined nodes
eManager uses standard IP protocols to communicate with the individual product nodes through available network connections. A complete Visara network can be managed easily and efficiently from a central location using eManager. eManager works with the following Visara products:
· 1683, 1783Network Computing Terminals
· 1883, 300LX, 400LX, 500LX, 500LXe, 600LX, 600LXe Linux Thin Clients
· eTerm 300, 350, 360, 760 Windows Based Terminal (WBT)
· LINCS Communication Servers (1174 and SCON models)
· Linux Servers (SSL1000 and ICON)
If you have not installed eManager, refer to Appendix A for installation instructions, and for a list of requirements.
Once installed, you can start eManager from the Start menu, generally located at the bottom of your screen on the left side. Click Start, Program Files, Visara eManager, eManager. When eManager loads, a password prompt is displayed. You must key in the correct password to start eManager. The initial password for a new install is eman. Key eman and click OK to finish loading. When loading finishes, product node, configuration and code update names, and distributions are loaded from the database if they exist. See the discussion on the Folders/Items screen for details. Once loaded, it is recommended that you change the password to something more secure. See the eManager Configuration Panel for instructions on changing your password.
To use eManager for code or configuration management, the following steps are generally required:
Add Product Nodes to the Database (use AutoLocate or add the nodes manually)
· Create optional Distribution Groups if desired
· Create Code and Configuration Updates as needed
· Create a Distribution Plan to distribute Updates to the necessary targets
There are instructions in the Folders/Items panel discussion to accomplish each of these steps.
The Folders/Items View Panel is the initial panel displayed and is used to launch most eManager functions. The Folders View on the panels left side displays a tree structure with three primary branches: Network Nodes, Update Files, and Distribution Plans. Each branch of the tree can be expanded or collapsed by clicking the + or respectively. The Items View on the right side displays a view of items that can be node information, update or configuration files, or distribution plan information, depending upon what has been clicked in Folders view. This operation is quite similar to Window Explorer except for the type of information displayed. Information displayed in the Items View can be printed as a report by selecting Reports/Item View Report from the menu at the top of the panel.
A sample structure of the Folders tree is shown below with a description of each branch.
Network Nodes
\__Product - Product model e.g. 1783. Clicking a product branch displays all product nodes for the product type in Items View. Expanding the product branch displays the groups defined for that product type.
\__Group Name Group Name. Clicking a group branch displays all product nodes assigned to the group in Items View. Expanding the group branch lists the members of the group in Folders View.
\__Group Node Node that are members of this group
Updates
\__Product Product model e.g. 1783
\__Code All code updates for parent product are under this branch
\__ Code Object Name Name of a code revision. Clicking a code object name displays the code object's files in Item View.
\__File Name Names of all files in code revision
\__Config All configuration updates for parent product are under this branch
\__ Configuration Object Name Name of a configuration change. Clicking a configuration object name displays the configuration object's files in Item View
\__Pull All pull updates for parent product are under this branch
\__ Pull Object Name Name of a Pull update change. Clicking a pull update object name displays the pull object's files in Item View
Distributions
\__Product Product model e.g. 1783. Clicking on a product branch displays the distribution plans saved for this product
\__Name Name of distribution plan.
The information displayed in the Item View can be displayed in various formats including Icon View, Small Icon View, List View and Report View. In Report View, data is displayed in tabular columns each with a column title. Clicking the column title causes a sort to occur using data in that column. For example, clicking the Name title would sort entries in alphabetical order according to the name. Clicking again will sort in reverse alphabetical order. Another example is clicking the IL title will sort node entries by code Integration Level.
The Folders/Items panel contains a menu bar, buttons, and drop down menus to perform various functions as described below. In general, many of the buttons and menus expect you to select a branch in Folders View or the item in Item View before clicking the menu or button. Also, in some cases you may need to collapse, then expand a branch in Folders View or click on a branch to refresh the screen with changes made by the function just performed. In some cases, e.g. after an AutoLocate, you will need to click the File/Reset Menu to update the information on this screen, or just click the product type in the Folders View section.
Adding
Product Nodes to the Database
Manual
Method
Click on the desire product branch in Folders View, then right mouse click and select Add Nodes. This displays the Node Viewer Screen, which contains fields where node parameters can be entered. See the Node Viewer Screen discussion for details. Once you enter the basic information required for your node definitions (name for the node and IP address, in most cases), you can use the "Collect Data from Nodes" function to gather the remaining information from the nodes themselves. You can also click Nodes on the menu bar and Add Node to display the Node Viewer screen.
Using
AutoLocate
Click on the <AutoLocate> button to display the AutoLocate Screen which can be set up to search a range of addresses and store any Visara product nodes found. See the AutoLocate Screen discussion for details. You can also bring up the AutoLocate screen by clicking on any product branch in Folders View, then right mouse click to display the dropdown menu and select AutoLocate. You can also click Nodes/AutoLocate on the menu bar to display the AutoLocate screen.
Click on the desired product branch in Folders View to display the desired product node in Item View, then right mouse click it and select Edit Nodes. This displays the Node Edit Screen, which contains fields where node parameters can be edited. Editing node parameters does not change anything configured at the node itself, only the information stored in the eManager database. See the Node Viewer Panel discussion for details. You can also highlight the node in Items View and click Nodes / Edit Node from the menu to display the Node Viewer panel.
Click on the desired product branch in Folders View to display the desired product node in Item View, then right mouse click it and select View Node Info. This displays the Node Information Panel, which contains information specific to the selected node, as stored in the eManager database. You can also double click the node in Item View to bring up the same information.
Click on the desired product branch in Folders View to display the desired product node in Item View, then right mouse click it and select List Group Affiliation. A message box will appear listing all of the groups that the selected node is part of.
You may decide to create a group when you have product nodes in a department or location that you desire to view, update, monitor, and/or create backups as a group. To add a group name, click on the desired product branch in Folders View, then right mouse click to display the dropdown menu and select Add Group. At the prompt, enter a group name and click OK. The group name you entered is added under the selected product. You can also click Nodes on the menu bar and Add Group to display the prompt. Collapse, then expand the product branch to show the new group.
Adding
Product Nodes to a Group
Product nodes can be added to a group by editing the node using the Node Viewer Panel or with a drag drop operation. See the Node Viewer Panel discussion for details on this method. To drag and drop, click on the desired product branch in Folders view to display its product nodes in Item view. Then select the desired nodes in Item view. Multiple selections are possible by holding down the <Ctrl> key as nodes are clicked to add one at a time or holding down the <Shift> key to select a range. Double click, but stop with the mouse button down and drag the nodes to the desired group. As the mouse pointer moves over the branches in Folders view, they are highlighted so you can see the target selected. When the desired group is highlighted, release the mouse button and the nodes are added to the group. Note that product nodes can not be copied to a group in another product type. Also, if the selected target is not a group, nothing happens.
You can also add product nodes to a group as part of the AutoLocate function, by specifying which group the nodes are to be added to when detected.
You can delete a node(s) from the database, delete a node(s) from a group, or delete a group. In each case the first step is to highlight the desired selection.
To delete a node from the database, click on a product in Folders View to display its product nodes in Item View. In Item view, click on the desired node or nodes to select them, then right-click the mouse to display the dropdown menu and select delete node, or just press the delete key. After confirming the action, the node or nodes are completely removed from the database.
To delete a node from a group, click on the group in Folders View to display its product nodes in Item View. In Item View, click on the desired node to select it, then right click the mouse to display the dropdown menu and select delete node. The node is removed from this group but remains in the database.
Multiple product node selections are possible by holding down the <Ctrl> key as nodes are clicked to add one at a time or holding down the <Shift> key to select a range.
To delete a group, click on the group in Folders view, then right click the mouse to display the dropdown menu and select delete group. The group is removed from the database; however product nodes that were in the group remain in the database.
You can also click Nodes on the menu bar and the appropriate delete function.
You can rename a group by highlighting the name of the group in Folders View and right-mouse-clicking to display the pop down menu. Select Rename Group from the menu. A box with an edit field will appear to allow you to change the name. Note that the underscore character _ is not allowed as part of the name.
If your network information is current within eManager, the simplest way to update the node information in the database is to use the Collect Node Data function. eManager connects to each node selected for updating, downloads the latest information and updates the database. See the Collect Node Data Screen discussion for details.
For networks where DHCP is used, and IP addresses are constantly changing, the preferred method of updating information in the database uses the AutoLocate function to update the database. A 'Minimal Information' option on the AutoLocate panel can be used to keep the process short. See the AutoLocate Screen discussion for details.
eManager allows you to create and restore configuration backups of your network nodes, for disaster recovery situations. The backup is intended to retrieve and store only the configuration information from a node, and not the complete binary image. The backup is stored in a subdirectory of the eman3000\backups directory.
Backups can be performed on an individual basis or you can create a Backup Job to backup multiple nodes of the same node type, and schedule it to run at some convenient time. When running Backup Jobs, you may indicate the number of backups to be kept for each node, and schedule the job to repeat on a regular basis.
Some care is required to insure that the proper code level is restored or installed on a unit prior to restoring the configuration. Information about the code level that was installed on the node should be available in the eManager database.
Create Backup: Selecting this menu entry creates a copy of the selected products configuration files, and stores them in a subdirectory associated with the selected node. If a backup is already stored for the selected node, it will be overwritten by the new backup.
Restore Backup: You may select to restore the configuration backup previously created by eManager. If multiple backups have been created for a specific node, then you can select to restore the last backup or one of the previous backups by selecting which one from the menu (previous backups are identified by their date and time). In order to restore the configuration, the target node should be loaded with a stable copy of its operating system at the same code level that the backup was saved from. One exception to requiring the same code level is the LINCS server platforms. The LINCS platform only needs to be at the same or higher code level than the backup files.
Additional Backup functions are available for the LINCS Server platforms.
Create Backup Job: You can create a Backup Job capable of making backups of multiple nodes of the same type at the same time. The Backup Job is scheduled to execute on the Scheduler tab of the eManager Options panel.
Another way to retrieve and optionally store current information on a node is to use the Retrieve Vital Product Data function. To retrieve and display vital product data from a node, click on its name in Items View, right click to display the dropdown menu and select the Retrieve Vital Product Data menu. eManager connects to the selected node, downloads the parameters and displays them on the Node Viewer Panel. Information retrieved using this function is not automatically stored to the eManager database. The Node Viewer Panel permits saving the information to the existing database entry or creating a new one.
Some of the products supported by eManager keep an Update Log, giving information on the last update(s) that occurred to that device. This log is typically a log from the node's perspective as to whether an upgrade was successful or not, and what took place. Selecting this function retrieves the log from the node, stores it into the backup directory for that node, and displays it. From the viewing screen, you can print a copy of the contents of the file, save the contents to another file, or copy the contents to the clipboard for pasting into another application.
To establish a Telnet session with a product node, click on a product branch in Folders View to display its product nodes in Item View. In Item View, click on the desired node to select it, then right click the mouse to display the dropdown menu and select Telnet To Node. The Telnet connection is then made. For security reasons, in most cases, you will be prompted to enter ID and password when connecting to a node via Telnet. Not all product node types support the Telnet function. For node types that do not support Telnet, the 'Telnet to Node' option will be grayed out on the menu.
The eManager product currently supports a single Telnet connection at one time. An icon in the status bar will display any time that the Telnet client is in use.
eManager allows you to wake nodes that support Wake On LAN. To wake a node or nodes, click on a product branch in Folders View to display its product nodes in Item View. In Item View, click on the desired node(s). Right-mouse-click to display the dropdown menu and select 'Wake Sleeping Node'. If the 'Wake Sleeping Node' option is grayed out, the node type that you have selected does not support WOL. A WOL Icon should appear in the status line to indicate that the WOL process has been started. If some of the nodes that have been selected do not support Wake On LAN, they will be deselected (for example eTerm 360 and 760 models).
While the WOL icon is displayed, you can click on the icon to display the 'Wake On LAN Status' panel for the node(s) that were selected. A 'View' button on the resulting panel allows you to alternate between displaying the information in 'Icon' mode and 'Report' mode. Pressing the 'Exit' button closes the Wake On LAN Status panel.
You can Wake non-Visara products that support Wake On LAN by selecting 'Wake On LAN' from the Tools menu. A dialog box is presented, requesting the hardware or MAC address of the node, and if entered a second dialog box asks for the IP address. If both addresses are provided, eManager will attempt to wake the node up.
To Ping a product node, click on a product branch in Folders
View to display its product nodes in Item View. In Item View, click on the
desired node to select it, then right click the mouse to display the dropdown
menu and select 'Ping Node'. A prompt displays with the product nodes IP
address. If no node was selected the address is blank. You may edit or add an
address or DNS name if desired. The Ping Screen displays and attempts to
You may reset a product node (force a power on reset) using eManager on an individual or multiple node basis. If the network interface is working, and a reset is initiated with eManager, the node will immediately, and without warning to the user commence to perform a power on reset. Because of the potentially disruptive nature of this function, the eManager administrator is required to enter the eManager password at the time the request is made.
To reset one or more nodes, highlight the desired nodes in Item View and right-mouse-click to display the popup menu, and select Reset Node. A small box will appear that allows you to enter the eManager security password or to cancel the reset operation. A 'Reset' icon appears in the status line when a reset is occurring. Pressing the Reset icon, displays a list of the nodes being reset and allows you to monitor the progress.
For LINCS platforms, there are a number of additional options for the type of reset that is desired, such as whether to do a fast reboot, normal reboot, and whether to boot on the default configuration. Once the desired options have been selected proceed to do the reset or cancel the operation.
VNC, as it applies to eManager, is a product of AT&T Laboratories, designed to provide a shadowing capability to desktops running a suitable VNC server application. Screen data from the target platform is presented to the eManager platform, and keyboard and mouse input on the eManager platform is directed to the target platform as if you were directly attached. VNC is distributed and installed by eManager under the terms of the 'GNU General Public License'. You may also obtain a free copy of the VNC product, as well as the source code for VNC, by going to the AT&T Laboratories website at: http://www.uk.research.att.com/vnc/. The application reference for VNC is automatically configured for eManager, and may be reconfigured to a different location if desired on the eManager's Options panel. If properly installed and configured within eManager, you may kick off a VNC connection to a Visara 1883 from eManager. VNC connections to the eTerm 300, 360, and 760 products is supported if they are running Windows CE 4.2 Build 4026 or higher.
To accept a VNC connection on the 1883, the VNC application on the 1883 must be running. eManager will start the VNC application at the 1883 through a Telnet connection, then start the VNC connection. The Telnet session is closed as soon as the application has been started.
VNC connections can be password protected on most products. If a password is required, you will be prompted for that password when you attempt the connection.
Configuration of the VNC application path within eManager is on the Applications tab of the Options panel.
To establish a VNC connection to an 1883, click the 1883 nodes entry in the Folders View, then right-mouse-click on the desired 1883 target listed in the Item View. Next, select '1883 Utilities/VNC Connection/Start'.
Closing the VNC application window, only stops the current VNC session to the client, but does not shut the client application down on the 1883. To stop the client application as well, select the desired 1883 target in the Item View, then select '1883 Utilities/VNC Connection/Stop'. If the VNC application is still open on the eManager platform, it will close itself when the application at the client stops.
The VNC daemon is always running on the eTerm products, so eManager just kicks off the VNC application to connect to it.
Initiating this operation will cause a node to power down. For some nodes supporting Wake On LAN, the node will power down, but can be brought back to normal operation by performing the Wake On LAN function.
Because of the potential to cause a problem for a user, the Shut Down Node function is password protected (eManager Password). To cause a node to shut down, right-mouse-click on the node in Item View, and select 'Shut Down Node'. You will be prompted for the eManager password, and upon successfully giving this password the node will be remotely shut down. Only nodes supporting the Shutdown function will have a menu entry.
Phindows provides a shadowing function to the 1683 and 1783 products. The path and command line parameters are configured during installation of eManager. If you change the default location of where the Phindows product gets installed, you would need to configure this new path to use it from eManager. See the eManager Configuration Screen discussion for details.
To establish a Phindows session with a product node, click on a product branch in Folders View to display its product nodes in Item View. In Item View, click on the desired node to select it, then right click the mouse to display the dropdown menu and select Phindows To Node. A prompt displays with the product nodes IP address. If no node was selected the address is blank. You may edit or add an address if desired. The Phindows session then automatically connects to the node. If you get a connection 89 error, the node number configured at the product node is not the default. In this case, enter a space N after the IP address in the prompt. eManager will automatically determine the node number. If you know the node number, key space N and the node number after the IP address to connect more quickly. General connection information can be entered on the eManager Configuration Screen.
If the password option has been set at the target product node, Phindows will require that you enter the node's connection password (not the administrator's password).
Phindows comes standard with licensed copies of eManager on the eManager CD and is installed as part of the eManager setup. There is a separate setup program for the Phindows program, which can be found in the Phindows directory on the CD, if you wish to install it elsewhere.
One product node database entry can be designated as a master for that node type using the Node Viewer Screen. The Configuration Update Screen uses Files located on the master to create configuration updates. To view parameters for the master, Click on any branch under Network Nodes in Folders View so the node information is displayed, then right click the mouse to display the dropdown menu and select View Master Node. eManager displays the master node information in the Node Viewer Screen. Not all product types support a master node function.
Import
Database - allows you to merge the contents of
another eManager database into your database.
Refresh View eManager refreshes the data displayed in the Folders/Item View Screen.
Exit Exits eManager
AutoLocate Displays the AutoLocate Screen
Add Node - See Adding Product Nodes To The Database
Group Definitions
New Group - See Adding A Group
Delete Group - See Deleting Nodes Or Groups
Rename Group See Renaming a Group
Change Connection Password Displays the Password Change Screen
Collect Data From Node See Collect Node Data Screen
View Master Node See Viewing The Master Node
Broadcast Message - Displays the Broadcast Message Screen
View Device VPD - Displays the contents of the VPD database, displaying VPD on devices attached to LINCS platforms.
Patch Manager - Brings up the patch manager panel for LINCS platforms.
LINCS Configuration Library - LINCS Central Site Library utilities (See also the LINCS Library Backup Job.)
View Library Provides an interface
into the LINCS Central Site Library
Backup Library - Backs up the LINCS Central Site Library
Restore Library - Restores the LINCS Central Site Library
LINCS Event Code Lookup - Allows you to look up LINCS error codes online
Communicate With Node
Node Definitions
Delete Node - See Deleting Nodes Or Groups
View Node Info - See Viewing Product Nodes
Edit Node - See Editing Product Node
Designate as Remote Library Allows you to assign one of your
LINCS platforms as the LINCS Library
List Group Affiliation - See List Group Affiliation
Retrieve Vital Product Data See Retrieving Node Configuration
Backups See Backups
Create Backup See Create Backup
Restore Backup See Restore Backup
Create Backup Jog - See Backup Jobs
Retrieve Update Log - See Retrieving the
Update Log
Ping Node See Pinging A Node
Wake Sleeping Node - See Wake Sleeping Node
Telnet to Node See Telneting To A Node
Reset Node See Reset a Node
Product Specific Utilities - An additional menu item is displayed specific to the product type selected. See Product Specific Utilities.
Product Specific Utilities
1683/1783 Utilities
Phindows to Node - See Phindows to a Node
1883 Utilities
VNC Connection - See VNC Connection
Edit Configuration - See 1883 Configuration Updates
eTerm 350 Utilities
Shut Down Node - See
Shut Down
Node
eTerm 360 Utilities
Change Terminal Properties - See Change
Terminal Properties
Change Host Connections - See Change
Host Connections
Set Password to Factory Default Allows you to reset the passwords
on an individual node back to the factory defaults (includes separate control
of Terminal Properties password, Administrator password, and VNC password).
VNC Connection - See VNC Connection
Send Message to Screen Prompts you to
input a message that is then sent to an individual nodes screen.
Shut Down Node - See Shut Down Node
LINCS Utilities
Diagnostic Utilities - See Diagnostic Utilities
Force Dump - See Force Dump
Retrieve Dump - See Retrieve Dump
Delete Remote Dump - See Delete Remote Dump
Retrieve Event Log - See Retrieve Event Log
Retrieve Box Fail File - See Retrieve Box Fail File
Retrieve Existing ESCON Trace Retrieves trace file previously created, that is
on the LINCS hard drive
Stop
and Retrieve ESCON Trace Stops the ESCON trace facility, saves the
trace, and retrieves it
View ESCON Trace Allows you to view an ESCON trace that was previously retrieved
Backups - See Backups
Create Backup - See Create Backup
Restore Backup - See Restore Backup
Backup File List - See Backup File List
View Event Log - See View Event Log
View Box Fail Log - See View Box Fail Log
Configuration Panels - See Configuration Panels
Retrieve Panels - See Retrieve Panels
View Panels - See View Panels
Hardware View Provides a number of interactive utilities. See Hardware View
Device VPD
View Device VPD
Delete Device VPD
SSL1000 Utilities
HTTP
Connection initiates a secure browser connection to the SSL1000
Reset SSL
Server resets the SSL1000 server software (does not reboot the hardware)
SSL Server
Log
Retrieve
SSL Log retrieves the SSL1000 log and displays it in the eManager viewer
View
SSL Log allows you to view a previously retrieved SSL1000 log
Delete
SSL Log deletes the SSL1000 log at the SSL1000
Hardware
View See SSL1000 Hardware View
ICON Utilities
HTTP Connection
- initiates a secure browser connection to the ICON
ICON
Server Log
Retrieve
ICON Log retrieves the ICON log and displays it in the eManager viewer
View
ICON Log allows you to view a previously retrieved ICON log
Delete
ICON Log deletes the ICON log at the ICON
Hardware View See ICON Hardware View
Code Updates
Add Code Updates Displays the Code Update Screen
Edit Code Updates Displays the Code Update Screen, listing the files in the selected code update
Delete Code Updates Deletes the selected code update directory and its contents
Create/Edit Update Matrix - See Code Update Matrix Screen
Rename Update Renames a code update
View Instruction File - Brings up the instruction file associated with the Code Update into the eManager Viewer. No editing capability of the file is provided. This option applies to 1883 nodes only.
Make Floppy Disks - Allows you to create floppy disks from the Code Update (LINCS product line only)
Configuration Updates
New Configuration Update Displays the Configuration Update Screen allowing you to create a new one
Edit Configuration Update Displays the Configuration Editor Screen allowing you to change editable items
Delete Configuration Update Deletes the selected configuration update
View Configuration Update Displays the Configuration Update Screen showing the selected configuration options
Rename Update Renames a configuration update
Pull Updates - See Pull Update Screen
New Pull Update - Displays the Pull Update Screen
Edit Pull Update - Displays the selected pull update on the Pull Update Screen
Delete Pull Update - Deletes the selected pull update
Rename Update Renames a pull update
New Distribution Displays the Distribution Plan Screen
Edit Distribution Displays the Distribution Plan Screen showing the selected distribution plan
Delete Distribution Deletes the selected distribution plan
Rename Distribution - Allows you to change the name of your distribution plan
Submit Distribution Causes the selected distribution plan to be queued for execution. Execution starts when the start date and time is reached. If the start date and time is past, but the stop date and time has not, the execution will begin immediately.
Terminate Distribution Clicking this menu submits a request to terminate this distribution. The distribution will not initiate further product node updates but will finish its current tasks prior to terminating.
Verify Distribution Making this request will generate a Verify Distribution job for the Distribution Plan that is highlighted, and submit it for immediate operation. Each node in the original distribution list, will be checked to see if the distribution completed successfully or not.
View Distribution Status Displays the Distribution Monitor Screen
Start Network Monitor Starts the Pulse Network Monitor, monitoring all nodes specified by the Pulse configuration. The black on yellow Pulse symbol should appear in the status line of the main menu to indicate when the network monitor is running.
Stop Network Monitor - Stops the Pulse Network Monitor. The black on yellow Pulse symbol should disappear from the status line to indicate that the network monitor is not running.
View Network Monitor - Displays a set of icons representing the groups or subnets being monitored by Pulse. The choice of groups or subnets is determined by the Pulse configuration.
Report Generation
View Report Data - Displays the collected network monitor data, in a panel, where you can scroll through the data and perform searches.
<