Entuity Core Migration
Entuity Core Migration
Entuity® 16.5
Entuity Migration Guide
Entuity
The Entuity product and its related documentation are protected by copyright and distributed under licenses restricting
use, copying, distribution and decompilation. Unless you have negotiated with Entuity specific terms and conditions
for using its product and associated documentation, such use shall be governed by Entuity's standard licence terms, a
copy of which is distributed with the product.
Entuity may make improvements and/or changes to the product(s) and/or program(s) described in this publication at
any time. These changes will be incorporated into new editions of the relevant publication.
Entuity®, SurePath®, Eye of the Storm®, InSight Center®, Green IT Perspective™, Network Delivery Perspective™ and Service
Delivery Perspective™ are registered trademarks of Entuity. All other trademarks are the property of their respective
owners.
License terms and conditions of use for Entuity and included third party software can be found on the Entuity server at
entuity_home/licenseTerms/. A listing of these third party trademarks, references and software included with Entuity
is available through its web UI.
Contents
This migration guide covers issues for users migrating from earlier versions of the Entuity
software to Entuity 16.5 GA (General Availability).
h
Before you upgrade to Entuity 16.5 you are strongly recommended to back up your current
! installation; the Entuity 16.5 upgrade process does not include a rollback facility.
Migration Prerequisites
Before installing Entuity 16.5 you should read its accompanying:
Known Issues note which details open Issues and resolutions.
Release Notes which identifies for you new, changed and removed functionality.
This Migration Guide, the Known Issues note and the Release Notes are all available from the
Entuity Customer Portal. If you require login credentials for the Customer Portal please
contact your Entuity representative for assistance.
You can find detailed install and configure instructions in the Entuity Getting Started Guide.
The Getting Started Guide and Release Notes are available at the root of the supplied Entuity
installation DVD or ISO image.
When migrating from Entuity 15.0 or earlier you should also read the Release Notes and
Migration Guide of intermediate releases, for example Entuity 16.0.
If you require further guidance on migrating multiple Entuity servers to Entuity 16.5 please
contact your Entuity Support representative.
2) Enter the keystore password. The default keystore password is changeit although your
system administrator may have previously amended it.
3) After migrating to Entuity 16.5 import those security certificates using keytool. For
example to import the dvlz certificate enter:
keytool -keystore ..\lib\security\cacerts -import -alias dvlz -file
c:\certificates\dvlzcertfile.crt
4) Enter the keystore password. During the migration the JRE was updated and the keystore
password was reset to the default password, changeit.
5) After you have imported all of the security certificates you must ensure they are picked up
by Apache Tomcat on the Entuity server. When Tomcat starts it updates its security
certificates. You do not have to stop Entuity, you only have to stop Tomcat (and it will
automatically restart). For example from entuity_home\bin enter:
stop tomcat
Users must enable their web browsers for both JavaScript, for example to allow the working
of the Entuity menu structure, and cookies, for example to maintain their login status.
The greatest call on the resources of a client machine is the map. An Entuity map is drawn on
the client machine, the more objects you have in the map the greater the resource required
to render it. To use maps with 500 or more objects the client machine should have:
8GB or more of memory.
The equivalent, or better, of an Intel 4 Cores i5 2.8 GHz processor.
If you are upgrading to Entuity 16.5 from a version of Entuity or patch level that is different to
! the certified migration path please contact Entuity Support for guidance.
1) From the Entuity customer support site download the patch file to a temporary location.
2) Stop the Entuity server and take a backup.
3) Apply the patch using the patch installer, entuity_home\install\installPatch, for
example:
installPatch c:\temp\ENTUITY_15.5.P01.WinNT.patch
4) After installing the patch run configure. The patch is only applied once configure
successfully completes.
5) Restart the Entuity server.
This section details areas of Entuity 16.5 where there are changes in either its behavior or
management.
eyeclientrpc Removed
eyeclientrpc was deprecated in Entuity 16.0 and is now removed. The Entuity RESTful
API is enhanced to support functionality which was previously delivered through
eyeclientrpc. Any scripts run through eyeclientrpc must be re-implemented using the
Entuity RESTful API.
Annotations on Views
In Entuity 16.5 annotations are managed through the web UI. Entuity 16.5:
Migrates annotations associated with network objects to the new implementation.
Discards any annotations associated with views. Entuity 16.5 does not support view
annotations.
View-level Streams
The existing view-level reachability stream (viewReachability) is replaced by a new stream
that reflects the toponode status of devices in the view (viewDeviceStatus), i.e. give a
breakdown of the number of devices in each of the possible status categories. The new
stream has these attributes:
okDeviceCount
adminDownDeviceCount
uninitialisedDeviceCount
unknownDeviceCount
degradedDeviceCount
downDeviceCount.
The AvailMonitor Low View Device Reachability event and its associated Device Reachability
threshold are unchanged. However how view device reachability is calculated is updated.
Entuity now raises this event when the combined number of devices responding to the ICMP
ping and therefore reachable, set to Admin Down or in an Uninitialized state is, expressed as
a percentage, below the Device Reachability threshold for the view.
Any existing customer reports that use the old streams will not work and will need to be
updated.
This section details migration issues raised with the release of Entuity 16.0. Entuity 16.0
changed the behavior of these functions:
Map Migration and mapToView Utility
Physical Connections
Entuity Integration for BMC Remedy AR System
Power over Ethernet Module Removed.
mapToView Overview
mapToView creates a view and map definition for each specified map saved on the current
server. If a map contains components that are managed by remote Entuity servers it will also
create views on those remote servers (when using a valid user account with the Create Views
permission).
h
When migrating maps on a central Entuity sever that include objects managed by remote
Entuity servers then the central and remote servers should be running Entuity 16.0.
After the view is created the view owner or a member of the administrator user group can,
through the web UI, setup user group access.
If a map included:
A drill-down (i.e. a group) to another map then mapToView would create a sub-view that
included the objects in that grouping.
Entuity servers they are not included in the converted map. Entuity 16.0 maps do not
represent the Entuity server.
Hypervisors then the associated VM Platforms are migrated to the view. A VM Platform
and all of its hypervisor are included to the map.
h
Hypervisors may be dragged into maps. They do not appear in the navigation tree but are
listed in the View Summary and can be first dragged into Drop Box before dragging into a
map.
Components from remote Entuity servers then mapToView will also create views on
those remote servers.
You should ensure the server on which you are running mapToView has access to those
remote servers and that the user account to which you are assigning view ownership
exists on all of the remote servers with the appropriate Create Views permission level.
Users cannot globally convert all maps unless they write their own script from which to call
mapToView.
mapToView Parameters
The conversion utility mapToView is located in the /install directory of the Entuity server,
for example entuity_home/install.
To view the command line help run mapToView without any parameters:
maptoview
Usage: mapToView [OPTION].. [map]..
Parameters Description
-h --help Outputs to the command line a listing and brief description of the
mapToView parameters.
-u --user Converts map(s) owned by the user. If a user account name includes
spaces then enclose that name in double quotes, e.g. "James Smith".
-c --createAs The username of the Entuity user assigned ownership of the converted
map. This user account must be a member of the Administrator user
group or have the Create Views tool permission.
-p --password Password of the Entuity user assigned ownership of the converted map.
-s --shared Parameter used to identify maps that were shared, set to Public. They do
not have an owner.
-a --all Convert all maps owned by the specified owner (--user) or are public
(--shared).
-v --verbose Sends to the command line progress messages on map conversion.
If the maps saved to a server contain content from multiple servers then you should run
mapToView:
When the remote servers are available.
And ensure the user account has the appropriate permission level on all servers.
mapToView would create views and sub-views on the remote servers.
Which includes groups, Cloud_Close and Cloud_Far that are connected to each other
and c3560 using user defined links. User defined links are not migrated to Entuity 16.0
however these user defined links represent the connections that are available to the
devices within the two groups.
mapToView reports the progress of the view generation. mapToView creates views and
sub-views on all of the connected servers to which the owner of the new map currently
has access and the permission to create a view.
2) Login into the Entuity server and view the newly created view.
mapToView creates the Cloud_Close and Cloud_Far sub-views. The map shows links
between these sub-views because the devices within the views have connecting links.
The password is for NanaToure’s user account, as NanaToure’s account is used to create
the view.
Physical Connections
In Entuity 16.0 the option to disable physical connections is removed. Entuity will migrate
physical connections that are disabled and will maintain their disabled status. If you edit
those connections then they are automatically enabled and you cannot subsequently disable
them.
You can check the current status of a connection through the Physical Connections page:
1) Click Administration > Inventory/Topology > Physical Connections.
2) Position the mouse over the column titles and from the context menu click Configure
Columns.
3) Move Enabled to the Show column and click OK.
Support for PoE Midspan Injectors is retained and is now included to Entuity by default.
Entuity 15.5 included a major enhancement to views. If you are upgrading from Entuity 15.0
! or earlier you must read the following sections on view migration. If you are migrating from
Entuity 15.5 then you are already using the new view mechanism, do not have to prepare for
view migration and can safely ignore this chapter.
Entuity 15.5 included a major enhancement of views, with the content of a view being the
same for all users accessing it, with new mechanisms for building views and controlling user
access to those views, updated view tool permissions and new view reports.
The upgrade process automatically migrates your current view structure, and user access to
content in those views, to the new view structure. Before upgrading to Entuity 16.0 users are
strongly advised to:
Consult this section to understand and prepare for view migration.
Review how you are currently using Entuity views and access permissions. The more you
have used ACL and Non-ACL views to control user access to content the more carefully
you will have to consider how to prepare your current server before migrating to Entuity
16.0.
Ensure your current Entuity server is patched to the correct level.
A correctly patched server will include the View Migration report which is an important
tool in preparing your current install for migration to Entuity 16.0.
Run through the migration in a test environment.
Always take a full backup before migrating to Entuity 16.0.
Contact your Entuity Support representative if you have any questions about, or require
guidance on, the migration process.
Views Summary
The key changes to views introduced in Entuity 15.5 are:
All views now act as Access Control List (ACL) views, non-ACL views are not supported
and will be converted to ACL views during the migration process, therefore
Different users accessing the same view will always see the same objects, whereas
previously visible view content would potentially have varied according to their Access
Control List setup.
The distinction between the two view types and the terminology are dropped. The
padlock icon now represents a view that the current user cannot edit.
Reference views are not available in Entuity 16.0. The new base view facility can deliver
similar functionality.
A reference view was really a different path to the same view. For example if view1 had
the sub-view2 and viewA was then assigned a sub-view that was a reference to
sub-view2, you had not increased the number of views on your server. Instead there were
now two paths to the same sub-view, view1>sub-view2 and viewA>sub-view2.
The option to make a view Visible or Not Visible to a user group is removed. Previously an
administrator may have assigned views to a user, so they had access to objects in those
views, but not made the views themselves visible.
On migration these Not Visible views are made visible.
A new All Objects view:
Is a system view with the owner system.
Contains all objects under management of the Entuity server.
By default can only be accessed by members of the administrators user group.
Administrators can assign access and edit permissions to other user groups. Those
non administrator users with edit permission to the All Objects view can only edit it,
i.e. assign access to other user groups, if they have the Share View permission.
Contains all services under management of the Entuity server.
Is always displayed at the top of the Explorer tree and at the top of any other listing of
views in Entuity.
Has the internal view id of 1, which was previously the My Network view id. If you have
used this id, for example when specifying Flex Reports or when forwarding events and
incidents then you may see a change in behavior depending upon the permissions of
the associated user account. When used with a user that is a member of the
administrators user group there will be no change in behavior however when used
with non-administrators the view would now include all objects whereas previously it
would only have included objects to which the user had access.
A revised implementation of the My Network view, where each user has their own My
Network view:
With their username appended to it and enclosed in brackets, e.g. My Network
(jamessmith), My Network (nanatoure).
That contains all objects that a user can view. It does not determine what a user can
view, i.e. it is a union of all other views associated to the user and therefore its content
is not directly editable.
That is sorted towards the top of any view listing in Entuity but below the All Objects
view. If an administrator is viewing all private views then My Network views are sorted
alphabetically.
That is now a Private view. It is only accessible to that user (and system administrators
if they set their user preference to show private views).
Which cannot be used as a base view because the contents of a My Network view can
change dynamically and would create cyclic dependencies since a user's My Network
view is calculated by making every other view of that user a base view for it.
New concept of base views. A base view is one on which another view is based. All views
apart from My Network views can act as a base view, however Entuity will prevent circular
dependencies.
A view can be based on more than one view and users can select whether the content of
the new view is derived from the union or intersection of objects in the selected views:
Union, results in a view that contains all of the objects in the selected views.
Intersection, results in a view that contains only the objects that are in all of the
selected views.
If you alter the contents of a base view or remove a view from a union/intersection
definition this alters the resultant view. Entuity does warn when deleting a view that it may
impact other views, it does not warn if you edit a view.
A user’s default view is now a user preference setting. Factory default is the user’s My
Network view.
A user with access to a Parent view can now access all of the Child views implicitly,
whether they have explicitly been given access or not.
A user with access to a Child view will now see the Parent view in the Explorer tree, but
depending upon their permissions may not see content in that view. These parent views
allow users to navigate to the child view to which they do have access.
When Explorer is in Consolidation mode a new All Servers icon in the tree:
Indicates servers’ views are consolidated.
Provides a base from which to create new top level views and to move or copy
existing sub-views back to the top level (when in consolidated mode).
Provides a method for clearing the current selection (which is why it is available when
there is only a single server) which is not otherwise easy to do, but sometimes
desirable.
Removes the requirement for the Create new top level view icon, so it is removed.
Green It Perspective used the My Network view, which varied depending upon the user
running the perspective. In Entuity 16.0 the Green IT Perspective uses the All Objects
view and is therefore consistent for all users.
Users that previously might only have had access to a subset of objects in shared
Non-ACL views would now have access to all objects in those views (the objects in the
migrated view being determined by the permissions of the view owner).
Reference views create alternative view paths to the same view. Reference views are not
supported in Entuity 16.0 so the Entuity 16.0 migration:
Converts each reference view to a sub-view that uses the original referenced view as its
base to determine its contents. Changes in the base view therefore automatically appear
in the new migrated view.
Does not migrate sub-views of the referenced view. If you require the same view hierarchy
then before you migrate to Entuity 16.0 create a copy of the referenced view and its view
hierarchy.
The Migration Status of each view indicates the type of issue discovered, you can refer to the
first page of the report (or the following sections) for suggested actions to resolve each issue.
You can:
Run the report as often as is required.
Access the generated reports after upgrade to Entuity 16.0 through the server file
structure.
Not run the report after migrating to Entuity 16.0, however Entuity 16.0 does include a
report for you to check your view and user access control setup, the View Permissions
and User Access Control report.
Modify the view contents to only contain those objects that you wish to grant access to.
After upgrading to Entuity 16.0 through their preferences settings users can choose to hide
any combination of views they want to.
Migration Status: Ok
View will migrate without significant change of functionality. No action is required prior to
upgrade.
After migrating to Entuity 16.0 you can run the View Permissions and User Access Control
report to verify the view and user access control permissions have been migrated as you
expected. You can run the report against one or more Entuity servers. The report comprises
of a series of optional tables that detail user and user group access to views and devices that
you can select to include to the report:
Show group membership, includes to the report a table that lists for each user, by
Entuity server, the user groups of which they are members.
Show group view access, includes to the report a table that lists for each view, by
Entuity server, the devices available through that view.
Show device user access membership, includes to the report a table that lists for each
device, by Entuity server, the users that have access.
Show device access membership, includes to the report a table that lists for each
device, by Entuity server, the users that have access.
Show user’s tool permissions, includes to the report a table that lists for each user
group, by Entuity server, the tools to which they have access.