Professional Documents
Culture Documents
Entuity Core Getting Started
Entuity Core Getting Started
Entuity® 15.5
Entuity Getting Started Guide
www.entuity.com 0000-0155-PD012_entuity_core_getting_started.rev1.fm
Entuity
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
6 Entuity Licensing
Entuity License Files .....................................................................63
Standalone and Central License Server Licensing ......................64
Standalone Entuity Server Licensing ......................................64
Entuity Central License Server ................................................65
Hosting the Central License Server ........................................66
Entuity Device and Object Licensing Models ...............................67
Assigning License Credits ............................................................67
Deallocating License Credits to Entuity Servers .....................69
Check the Entuity License ............................................................69
Running a High Level Check on the Entuity License ..............70
Viewing the Current State of the Entuity License ....................70
Running a Detailed Check on the Entuity License .................72
Identifying when a License Expires .........................................73
Upgrade the Entuity License ........................................................73
Updating the Entuity License ..................................................74
Glossary .............................................................................................96
Index ................................................................................................124
Tables
Table 1 Contents of Getting Started Guide....................................... 8
Table 2 System Requirements for Entuity installed to Linux ............ 9
Table 3 System Requirements for Entuity installed to Windows ...... 10
Table 4 System Requirements for the Entuity Web UI...................... 10
Table 5 Certified Tablet System Combinations................................. 11
Table 6 System Requirements for the Entuity Tablet........................ 11
Table 7 System Requirements for Running Component Viewer ...... 11
Table 8 Entuity Modules .................................................................... 16
Table 9 Entuity Integration Modules ................................................. 17
Table 10 Default Port Settings............................................................. 19
Table 11 Additional Packages Required for Entuity ........................... 23
Table 12 Additional Packages for Entuity BMC Integrations .............. 24
Table 13 Entuity Ports Requiring Windows Firewall Registration ....... 29
Table 14 Install and Configure Wizard Buttons................................... 40
Table 15 Database and Log Directories.............................................. 41
Table 16 Configuration Monitor........................................................... 45
Table 17 BMC Event Manager Connection Details............................. 46
Table 18 SMTP Server Details............................................................. 47
Table 19 Server Configuration............................................................. 48
Table 20 Entuity Ports ......................................................................... 51
Table 21 Configuration Monitor........................................................... 56
Table 22 Entuity Ports ......................................................................... 58
Table 23 License Health Details .......................................................... 71
Table 24 Entuity ISO Image and Patches ........................................... 76
Table 25 Mapping Entuity Version and Release Numbers ................. 79
Table 26 Information Required When Configuring Entuity ................. 82
Table 27 Additional Ports used by Entuity .......................................... 84
Table 28 Third Party Software Versions .............................................. 85
Table 29 Getting Started with Entuity.................................................. 86
Table 30 Minimum Server Specifications............................................ 92
Welcome to Entuity®, the advanced network monitoring and analysis software solution from
Entuity that can be used to monitor, troubleshoot and trend heterogeneous computer
networks. This guide describes the procedures for installing and configuring Entuity and for
placing devices under Entuity management.
You can run the install and configure programs from the command line using a series
of text-only prompts (default for Linux environments) or through a Graphical User Interface
(default for Windows environments).
h
If you have previously read through the install and configure instructions and only require a
quick reminder of the steps involved refer to Getting Started with Entuity Overview.
Entuity accepts no liability in the event of the instructions in the guide not being followed
! when the product is installed and configured.
Chapter Description
Getting Started with Entuity An overview of how to download and ready the Entuity ISO image,
Overview run the install and configure programs and use Entuity to discover
your network.
1 Entuity Network Management An overview of Entuity, its system requirements and different
Entuity server capabilities.
2 Prepare for Entuity Install and Highlights items for consideration before installing Entuity, e.g.
Configure licensing, user account privileges.
3 Install the Entuity Server How to install Entuity using the GUI wizard and from the command
line.
4 Configure the Entuity Server How to configure Entuity using the GUI wizard and from the
command line.
5 Startup, Shutdown and How to start and stop the Entuity server and check its health.
Process Checking
6 Entuity Licensing Details the Entuity licensing models, the options available with
multi-server installs and how to manage your licenses.
7 Back Up the Entuity Data A summary of backup options. See the Entuity System
Administrator Guide for details on backing up Entuity.
8 Entuity Maintenance Patches How to access and install Entuity maintenance patches.
9 Uninstall the Entuity Server Instructions on how to uninstall the Entuity server.
Chapter Description
A Entuity Configuration Entuity worksheet that you should complete before installing
Checklist Entuity.
B Entuity Install and Packages A listing of packages installed with Entuity.
Attribute Value
Compatible browser Internet Explorer 10.0 or later (32-bit and 64 bit)
Firefox 24 or later ESR (32-bit)
Google Chrome 35 or later.
JavaScript Enabled to allow the working of the Entuity menu structure.
JRE Java 7 Update 72 (JRE 1.7.0_72), and above to launch the client. See
Component Viewer and Java Compatibility.
Language Support Entuity includes internationalization of the top level menus and simple
localization, with, in addition to English, support for Mandarin Chinese,
Brazilian Portuguese, French and Spanish (Chilean).
Cookies Enabled to maintain your login status.
If you have SSL enabled and access the Entuity web UI using a browser without TLS
(Transport Layer Security protocol) enabled then the browser will raise a TLS not enabled
type error. By default TLS1.1 and TLS1.2 are not enabled in Internet Explorer 10. You can
enable TLS through the Internet Explorer 10 Internet Options settings.
Your web browser must be enabled for both JavaScript, for example to allow the working of
the Entuity menu structure, and permit access to the application cache.
Attribute Value
JavaScript Enabled to allow the working of the Entuity menu structure.
Language Support Entuity currently supports English.
Application Cache Enabled to retain and maintain application details.
Not installed, or one is installed but it is incompatible, then Java Web Start attempts to
automatically download and install the latest Java from Java.com.
If the install fails and the client fails to launch, Java Web Start raises a Java Application
error (the exact error message varies according to the environment, e.g. operating
system, JRE version). You should close the error dialog and attempt to install the Java
through the Java Compatibility page.
The Java Compatibility page (EntuityServer/EOS/cgi/EOSClient?downloadpage), is available
as a link from the web UI login page. It provides information, links to the Java website and
JRE downloads. The user can install, as their system default, an appropriate JRE by
downloading:
The latest JRE from the Java website (http://www.java.com).
From one the Entuity server. Entuity is shipped with 32-bit and 64-bit versions of the JRE.
You should use the version that corresponds to your web browser, e.g. download the
64-bit version when using Internet Explorer 64-bit.
Flow collection can be a resource intensive process and may, where the server manages
many devices, interfere with the performance of the polling engine. You should consult with
your Entuity representative on server requirements.
The flexible nature of the Entuity architecture enables the interface and access privileges to
be deployed at a very granular level. Entuity User Authentication simplifies the credential
burden for both users and administrators by supporting single sign on (SSO) and by utilizing
external authentication data stores. By using the preferred corporate authentication
credentials, Entuity helps network administrators follow company compliance policies.
Entuity User Authentication currently supports:
Internal user authentication.
External authentication through LDAP and Active Directory authentication servers.
Single sign-on (SSO), easing the credential burden for both users and administrators.
User preference storage.
Assignment of users to Entuity user groups, through which Entuity sets user permissions.
For more detail on Entuity User Authentication see the Entuity User and System Administrator
Guide.
As soon as you add devices you can start to use Entuity although it may take some time
to fully discover all device attributes and some features, for example some reports may
require at least 24 hours of data.
Flow collector role, complete the setup of the flow data collection.
SurePath is a separate licensable product to Entuity. For more details refer to the Entuity
Help, SurePath documentation, http://www.entuity.com/content/surepath or your Entuity
representative.
SurePath discovers the actual path an application takes between two endpoints in a network.
It provides live path topology and status, tracks path history and alerts on path changes in
real time. The Entuity integration with SurePath allows you to:
Use a central Entuity server to manage one remote SurePath server.
Log into the Entuity server and access all SurePath pages. This can allow you to benefit
from your Entuity setup, for example SSO, consolidated user interface, LDAP
authentication.
Place SurePath discovered paths into Entuity defined views.
View paths in the Explorer tree.
Highlight managed objects in a map that are part of a specified path.
Create a path from the results of an Integrated Flow Analyzer analysis using Top
Conversations.
Place paths into services for higher service-level monitoring.
Contacting Support
If you have problems with or questions about a BMC Software product, go to the BMC
Software Customer Support page at http://www.bmc.com/support_home. You can view and
download product documents, release notes, frequently asked questions, and related
information from the Customer Support Web site.
If you do not have access to the Web and you are in the USA or Canada, contact BMC
Software Customer Support at 800 537 1813. Outside the USA or Canada, contact your local
BMC Software office or agent.
When upgrading Entuity you should back it up before starting the upgrade. You should also
backup Entuity after upgrading Entuity, so you have a clear restore point.
Entuity recommend that linkUp and linkDown traps are configured on all interfaces on all
devices. This provides maximum port event visibility.
Check that the default TCP ports Entuity uses do not conflict with your current
environment. You can amend these defaults during the Entuity configuration but it is
recommended that the default settings are retained, when possible.
Port Purpose
80 Web server port for access to Entuity.
You must specify a different web server port if you already have another web
server on port 80.
443 Web server port for access to Entuity when using SSL.
You must specify a different web server port if you already have another web
server on port 443.
3306 Port number on which the database server, mysqld, listens.
19193 Event Request Listener IP port on which you want the event management process
to listen for incoming requests for events.
19194 Event Receiver IP port on which you want the event management process to listen
for incoming requests for events.
20202 The default port on which the Ticker server listens for client activity.
Port Purpose
10981 Server Port for the Entuity client.
12321 Single Channel Communication Port, useful when the Entuity server
communicates to the Entuity client through a firewall.
8080 Tomcat Server Port.
8005 Tomcat Server Administration Port.
9996 Flow port on which Entuity IFA receives flow information from devices sending
NetFlow, Netstream or JFlow packets. This flow collector port is configurable
through configure and flowcfg.properties.
Entuity IFA collects IPFIX flow data on port 2055 and sFlow data on port 6343.
These collector ports are not configurable, you must therefore ensure routers are
configured to send flow data to the appropriate ports otherwise Entuity IFA will not
recognize and collect the data.
12121 Flow Management port used to manage, e.g. stop, the Flow Collector process.
For managed hosts, where a device’s agent does not support 64 bit counters you should
consider upgrading the agent. Alternatively, for example, you may be able to monitor a port’s
outbound utilization and traffic data from the receiving interface, or inbound utilization and
traffic data from the sending interface.
If Entuity manages an SNMPv3 device that is reconfigured with an engine identifier already
used by another device also managed by that server Entuity raises an SNMP v3 Duplicate
Engine ID event. The event indicates that two or more devices under management now have
the same SNMPv3 engine identifier. You should reconfigure one of the devices with a new
unique engine identifier.
SSL Requirements
When using SSL you must decide who will authorize your SSL certificates. Many companies
specialize in this and they will guide you through the certificate generation process. There
are also utilities, not supplied with Entuity, that allow you to generate your own SSL files.
However the files are created, you first generate a Certificate Signing Request (CSR) using
Apache Mod_SSL/OpenSSL (consult the Apache documentation for details). This process
creates the:
SSL Private Key that you must keep safe.
CSR that must be authorized. There are two approaches to authorization:
Through a Certificating Authority. This is a recognized authority which provides you
with a CA certificate, the more established authorities are trusted by internet browsers,
Apache server, Apache Tomcat. You can then generate SSL certificates which are
authenticated as they reference the CA certificate.
You become your own certificating authority. The first time a user accesses Entuity
through a browser they are warned that the authority is unknown. Users can add the
certificate to their list of trusted certificates.
The authority generates from the CSR the SSL certificate.
Once the SSL file creation process is complete you can include these files during Entuity
configuration:
SSL Certificate.
SSL Private Key.
SSL CA Certificate is only required when you are using a Certificating Authority to
authenticate your SSL certificates. Do not use this option empty when using self certified
certificates as it may prevent Entuity from running.
The CA certificate is issued by certificating authorities, the larger authorities are
recognized by your browser. CA certificates act as the root certificate, from which you can
generate SSL Certificates.
When a browser connects to Entuity and it recognizes the certificating authority, the user
can access Entuity. When the authority is not recognized Entuity checks the validity of the
CA certificate; for:
A valid certificate Entuity prompts you to add the certificate to the browser’s list of
trusted root certificates.
An invalid certificate Entuity server runs but httpd does not.
Entuity recommends the SSL Certificate, SSL Private Key and SSL CA Certificate files are
installed to entuity_home\etc.
h
When the Entuity server starts it checks the SSL files are of the expected format. If they are
for example, corrupt or if there is an CA certificate and it is from a unrecognized authority
Entuity will not start.
Linux Packages
alsa-lib.x86_64 glibc.x86_64 libaio.x86_64 libgcc.x86_64
libgcrypt.x86_64 libgpg-error.x86_64 libICE.x86_64 libSM.x86_64
libstdc++.x86_64 libuuid.x86_64 libX11.x86_64 libXau.x86_64
libxcb.x86_64 libXext.x86_64 libXi.x86_64 libxml2.x86_64
libxslt.x86_64 libXtst.x86_64 libXt.x86_64 ncurses-libs.x86_64
nss-softokn-freebl.x86_64 rpcbind.x86_64 zlib.x86_64
When running any of the BMC integrations shipped with Entuity there are an additional four
32-bit required packages, see Table 12 Additional Packages for Entuity BMC Integrations.
You can also check all of the packages through one instruction. The following example:
Does not include the packages required for the BMC integrations.
Can be copied and pasted to the command line as it includes the multi-line indicator \ .
You should consult the Linux documentation before installing the missing required
packages.
You must install any missing packages to the server before installing Entuity:
Red Hat Linux users must register their system with Red Hat Network to receive updates.
Oracle Linux users can obtain the required packages from Oracle Public Yum Server.
You can use the command line package utility Yellowdog Updater, Modified (YUM) to install
missing packages. You can install all packages through one instruction. The following
example:
Does not include the packages required for the BMC integrations.
Can be copied and pasted to the command line as it includes the multi-line indicator \ .
rpcbind Service
The rpcbind package is the Linux RPC port mapper. Entuity uses the portmap
(rpc.portmap, portmap or rpcbind) service to obtain unused ports for its internal
communications, for example the licensing functions cannot run without access to available
ports and therefore Entuity cannot run.
After confirming the presence of, or installing the rpcbind package you should check that
the rpcbind service is running; by default rpcbind only starts when the server boots up.
You should also ensure it is started every time the server starts:
chkconfig rpcbind on
2) After you amend the parameter restart the Linux server to apply the change.
3) From the server command line you can run ulimit to check the value of max user
processes is now set to 4096.
You should also ensure it is started every time the server starts:
chkconfig nscd on
You should consult with your Linux administrator when calculating the number of arenas to
permit to Entuity.
Key: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters
Type: REG_DWORD
Value: 0x000fffe (65534).
h
Before installing Entuity ensure you have read and understood the requirements detailed in
Chapter 2 - Prepare for Entuity Install and Configure and checked that all other applications
are shut down, including any other installations of Entuity.
Through install you:
Accept the Entuity license agreement.
Specify the Entuity install folders.
Review a Summary page before starting the Entuity installation.
Can continue the installation process and configure Entuity.
You can run the install program from the command line using a series of text-only
prompts (default for Linux environments) or through a Graphical User Interface (default for
Windows environments).
Entuity is distributed as a compressed DVD ISO image. You must mount or burn the ISO
image before Entuity can be installed. (See Preparing to Install Entuity.)
Installing the Entuity server to a Linux environment is by default from the command line,
however you can call the GUI interface by from the command line entering:
./install gui
To install Entuity:
1) Run install and use the GUI install wizard. install is available at the root of the
Entuity software:
In Linux environments enter:
./install gui
In Windows environments enter:
install
In Windows environments click Start > Run, from the Run dialog browse for the
image\temporary folder root and select install.
install starts the Entuity Server Install wizard, displaying the Welcome page. Read the
Installation Welcome screen and then click Next.
2) install displays the Entuity license agreement. Read the license agreement.
Click Agree and Next to install Entuity.
4) install displays an installation progress screen and finally whether the installation has
successfully completed. If the installation:
Failed check the displayed messages. You can find the install log file in
c:\Documents and Settings\UserName\Local
Settings\temp\EYEInstall.log.
Succeeded Entuity displays the host identifier of the server machine. When you want
to purchase a license you must provide this identifier to your Entuity supplier.
However, you can configure and then run Entuity using the thirty day evaluation
license shipped with Entuity.
h
When install and then configure successfully complete, configure copies their log
files, EYEInstall.log and EYEConfigure.log, to the Entuity log folder.
After a successful installation you can continue and immediately run configure. You can
also separately run configure.
To install Entuity:
1) Run install from the command line. install is available at the root of the Entuity
software:
In Linux environments enter:
./install
In Windows environments enter:
install text
install displays the welcome and copyright messages.
2) install prompts for you to accept the license terms and proceed:
Proceed? [no]>
Enter Y to proceed.
3) install prompts you for the Destination directory, by default /Entuity. It is the
directory to which Entuity is installed, referred to in the documentation as entuity_home.
You can enter a different destination, including one that does not exist as install
should be run with a user account with permissions to create folders. The destination
location name must not include spaces.
If the specified directory:
Exists and does not contain a previous Entuity installation then, provided that the
name is valid, install continues from step 6).
Exists and Entuity was previously installed to it, install prompts you to confirm that
you want to proceed. If you answer n, you are returned to step 3). If you answer y
install continues from step 4).
Does not exist, install prompts you to confirm that you want to create the named
directory. If you answer n, you are returned to step 3). If you answer y, install
creates the directory and install continues from step 4).
6) install copies the Entuity server software components to the destination directory. It
updates the display to report the progress of the copy.
Do you want to preserve the existing data?
If you answer NO the existing working data will be completely removed.
7) Once installation is complete install displays the host identifier of the server machine.
When you want to purchase a license you must provide this identifier to your Entuity
supplier. However, you can configure and then run Entuity using the thirty day evaluation
license shipped with Entuity.
If the install fails you can find the install log file in /tmp/EYEInstall.log.
When install and then configure successfully complete, configure copies their log
files, EYEInstall.log and EYEConfigure.log, to the Entuity log folder.
You can run the configure program from the command line using a series of text-only
prompts (default for Linux environments) or through a Graphical User Interface (default for
Windows environments).
Following the initial configuration of Entuity, you can run the configuration procedure as often
as is required to customize your system.
When reconfiguring Entuity always shutdown Entuity server before starting configure. (See
! Chapter 5 - Startup, Shutdown and Process Checking.)
Button Description
Next Displays the next window.
Back Displays the previous window.
Help Displays context sensitive help.
Cancel Cancels the configuration.
Browse Opens a dialog to browse through the directory structure.
Restore Redisplays the original default.
Help Displays the context sensitive help.
To configure Entuity:
1) Run install and use the GUI install wizard. From entuity_home\install:
In Linux environments enter:
./configure gui
In Windows environments enter:
configure
In Windows environments double-click on configure.
configure checks that Entuity is not running, and would display a warning message if it
were, otherwise configure opens the Entuity Server Configuration wizard.
2) When the registry key value MaxUserPort is not set to 0x0000FFFE (65534) this risks
causing problems in Entuity performance. You can manually set the key, or when you run
configure use the Window Registry page to set this value (the default setting).
Permit or deny configure to amend MaxUserPort and click Next.
3) In the Choose Configuration Folders page specify the database and log file directories.
When you have specified the folders click Next.
Directory Description
Database installation The folder for the Entuity MySQL database. The default is
entuity_home\database\data.
Database Backup The folder for the MySQL database backup. The default is
entuity_home\database\backup.
Log The folder to where Entuity writes all of its associated log files. The default is
entuity_home\log.
6) configure displays the Integrated Flow Analyzer screen from which you can select:
Yes to configure a server which acts as both a polling and flow collector server, also
referred to as an All-in-one server.
No to configure a server which acts as only a polling server. The first time you run
configure this is the default option, also referred to as a Standard server.
Select the required capability and click Next.
7) configure displays a list of modules and against each is its current enabled and license
status. Entuity can only run modules with a valid license. Where modules are:
Enabled configure can activate the modules.
Disabled they are not activated.
Use the check box against each licensed module to select the ones you want to activate,
and click Next.
8) When you selected Configuration Monitor on the module page configure displays the
Configuration Monitor page. You should have already consulted the Entuity Configuration
Monitor documentation.
When you have specified the Entuity Configuration Monitor click Next.
Attribute Description
Transfer Server IP configure displays a list of the IP addresses on the Entuity server. Select
Address the IP address you want to use with the TFTP and/or FTP servers used in
retrieving device configurations.
Transfer Directory The directory on the Entuity server to which the TFTP and/or FTP server
writes retrieved device configurations, by default
entuity_home\cm_transfer.
You must separately configure the TFTP or FTP server to use this directory,
for example through the TFTP server initialization file.
Archive Directory Entuity moves successfully retrieved device configurations from the Transfer
Directory to device specific sub-directories of the Archive directory, which is
by default entuity_home\cm_archive.
You must separately configure remote shell, i.e. Telnet, SSHv1 or SSHv2, and transfer
servers, i.e. TFTP and/or FTP.
9) configure prompts for you to define a connection used for forwarding incidents and
events to BMC Truesight Operations Management (BMC Event Manager). This
connection is used with the Send to BMC Event Manager action which you can setup
through the Event Management System. Entuity Support recommend you send either
incidents or events but not both to the same receiver.
You can define additional BMC Event Manager connections through
entuity_home\etc\bem-connections.cfg. (See the Entuity User and System
Administrator Guide.) You should obtain the BMC Truesight Operations Management
connection details from its administrator.
h
Ensure the firewall settings in the BMC II Web Services Server allow connections from the
! Entuity Server.
Attribute Description
BMC Cell Name BMC Truesight Operations Management instance to which Entuity can
forward incidents and events.
A BMC Truesight Operations Management administrator can find the cell
name by opening:
<IIWS HOME>\Tomcat\webapps\imws\WEB-
INF\etc\mcell.dir
and locating the cell definition, for example:
cell pncell_entuity gateway.pn_server mc entuity:1828
Web Server Host Name Hostname of the server where the BMC II Web Services Server is located.
Web Server Port Port number used by the BMC II Web Services Server, by default 9080.
Number
Web Service Name Name of the web service, by default ImpactManager.
10) configure prompts for the SMTP Server details, which you only need complete when
requiring the emailing of events and/or reports, and then click Next.
Attribute Description
SMTP Server Enter a semi colon separated list of SMTP servers. You can also specify the
Hostname port number servers use, for example:
10.44.2.6;10.44.2.7:25
SMTP Username Username used with the server. When not using a username you can leave it
blank, enter a username and you must also enter a password in SMTP
Password.
SMTP Password You are only required to enter a value when you have also entered an SMTP
Username.
Show password in Select when you want the SMTP password displayed. By default it is
plain text represented by asterisks.
Sender Enter the default sender email address. You can configure spam filter
programs to permit through emails from this account. The default email
account name is Entuity@EntuityServer, where Entuity identifies the product
and EntuityServer is the hostname of the Entuity server.
Subject Provides the default subject line included with any email. When an email is
sent ${eventDescr} is replaced with the event description and ${eventStr}
is replaced with the object name for which the event was raised.
Attribute Description
Hostname Entuity by default includes the hostname of the Entuity server. This is a
mandatory field.
Use SSL Select to activate SSL for sessions between your Entuity server and browsers.
Communication This is not mandatory and is only normally required in environments requiring
a highly secure environment. Specify your SSL certificate and key files:
SSL Certificate File
SSL Private Key
SSL CA Certificate (optional).
Entuity recommend these files are installed to entuity_home/etc.
Redirect HTTP to Select for the Entuity web server to automatically redirect wrongly entered
HTTPS HTTP URLs to HTTPS.
Change Database Select to enter a new root password. You would normally only change the
Root Password database root password when mandated by a security team/department. It is
important to record the setting as it might be needed by the Entuity Support
team.
Attribute Description
Check and Repair Database Validation is not run when you first install Entuity (there is no
Database database that requires validation). However when configure is re-run you
may want to initiate a database check. Select this option and then:
Quick Check, which is the default when there is an existing database but
no mysql.error.log (which is usually the case when running an
Entuity upgrade). configure runs dbcheck -F to run a fast check for
tables that were not properly closed.
Full Check Private Key. configure runs dbcheck -E, dbcheck runs a
full key lookup for all keys for each row which ensures that the table is
100% consistent. This is an extended database check and, depending on
the size of the database, may take a significant length of time to complete.
If the Entuity database fails the validation check configure stops.
You must source your own SSL certificate and decide who will authorize it. There are
specialist companies you can use, alternatively there are utilities, not supplied with Entuity,
that allow you to generate your own SSL files.
However you create the SSL files you first generate a Certificate Signing Request (CSR)
using Apache Mod_SSL/OpenSSL (consult the Apache documentation for details). This
process creates the SSL Private Key that you must keep safe and CSR that must be
authorized. Authorization is through an outside, recognized authority or there are utilities that
allow you to become your own certification authority. The authority generates from the CSR
the SSL certificate.
12) configure displays the Ports Configuration page through which you can select:
Use preselected port numbers, that is the default setting which assigns to Entuity and
its processes the default ports.
Modify port numbers. configure subsequently displays additional pages through
which you can amend the default TCP port numbers of Entuity processes. You should
only amend the default TCP port settings with good reason.
When you have specified the ports configuration settings click Next.
13) Only when you have selected to modify the default port settings, or Entuity has identified
a port conflict, does configure display the current list of ports. Port numbers that have a
green background are valid, ports with a red background indicate a port conflict that
requires attention.
You can enter new port numbers directly into the text field, and use Test to verify the port
is available. Alternatively use Suggest and configure identifies the next available port
number.
Excluding Web Port, port numbers must be in the range 1025 to 65535. The defaults are
reasonable choices. You have another chance to change your selections when the
summary is displayed at the end of the wizard.
Attribute Description
Database Port The IP port on which you want the database server mysqld to listen. The
default is port 3306.
Web Port The IP port on which you want the web server httpd to listen. The defaults
are port 80 for non-secure access and port 443 for SSL.
Event Request IP port on which you want the event management process to listen for
Listener Port incoming requests for events, for example from the event viewer, from
subscribed third party integrations. The default is port 19193.
Event Receiver Port Event Receiver IP port on which you want the event management process to
listen for incoming requests for events, for example system events, trap-
based events, syslog events. The default is port 19194.
Ticker Port The IP port on which you want the ticker process to monitor its client ports’
activity. The default is port 20202.
Tomcat Port The port used by the application server Tomcat. The default is port 8080.
Tomcat Admin Port The port used to access and managed the application server Tomcat. The
default is port 8005.
Attribute Description
Server Port The port on which the Entuity server listens to its clients. The default is port
10981.
Single Channel To enable single channel communication between the Entuity server and its
Communication clients, i.e. communication is conducted through one connection, and so
one port. The single channel function is invisible to the Entuity client and
server, i.e. the Entuity server and client continue to receive and send
information on the same ports regardless of whether the single channel
function is activated or not.
Single Channel Port The port on which single channel communication between the Entuity server
and its clients is conducted. The default port is 12321.
Flow Port The port on which Entuity IFA receives flow information from devices sending
NetFlow, Netstream or JFlow packets. This flow collector port is configurable
through configure and flowcfg.properties.
Entuity IFA collects IPFIX flow data on port 2055 and sFlow data on port
6343. These collector ports are not configurable, you must therefore ensure
routers using those flow technologies are configured to send data to the
appropriate ports otherwise Entuity IFA will not recognize and collect the
data.
Flow Management The port used to manage, e.g. stop, the Flow Collector process. The default
Port is port 12121.
14) When installing to Linux configure prompts for the user account which is to have the
privileges required to start, stop and reconfigure Entuity, by default root.
When required enter a new username, alternatively accept the currently set username.
Click Next.
15) configure displays a summary of your configuration settings. This is the final
opportunity to amend, or cancel, your Entuity configuration selections.
Click:
Cancel to abandon the configuration.
Back to move back through the configuration wizard pages and adjust your settings.
Configure to start Entuity configuration.
16) configure displays a configuration progress page. This may take some time, with the
running of the StormWorks configuration on its own taking a couple of minutes.
18) Start Entuity. (See Chapter 5 - Startup, Shutdown and Process Checking.)
configure only displays modules that you have activated and for which you have a license.
You should refer to the particular module guide before installing the module.
To configure Entuity:
configure starts and displays the operating system and the host identifier.
2) configure prompts for the location of the Entuity database:
Database Directory [/Entuity/database/data]>
Either press <Return> to accept the default, or enter an alternative destination, without
spaces, and press <Return>. If the path does not exist, then you are prompted to
confirm that you want to create a new directory.
3) When performing a reconfiguration configure prompts you to delete the existing
database or create a new one:
Would you like to delete the existing database and create a new one?
[no]>
Either press <Return> to accept the existing database, or to create a new database
enter Yes, and press <Return>.
4) configure prompts for the location of the backup folder of the Entuity database:
Database Backup Directory [/Entuity/database/backup]>
Either press <Return> to accept the default, or enter an alternative destination, without
spaces, and press <Return>. If the path does not exist, then you are prompted to
confirm that you want to create a new directory.
5) configure prompts for the location of the log directory:
Log Directory [/Entuity/log]>
Either press <Return> to accept the default, or enter an alternative destination, without
spaces, and press <Return>. If the path does not exist, then you are prompted to
confirm that you want to create a new directory.
If the license file is empty configure prompts you to create it. If you answer n followed by
<Return>, you are returned to step 7). If you answer y followed by <Return>, then a
text editor is opened to allow you to save text into it.
configure validates the license file, raising an error if the file does not exist or is invalid.
You cannot complete Entuity configuration without a valid Entuity license.
8) configure prompts you to activate the Integrated Flow Analyzer capability. Enter:
Yes to configure a server which acts as both a polling and flow collector server, also
referred to as an All-in-one server.
No to configure a server which acts as only a polling server. The first time you run
configure this is the default option, also referred to as a Standard server.
9) configure prompts you to accept or modify the current module activation settings:
Would you like to modify the Module Selection [no]>
When you enter:
no during a new installation configure activates those modules enabled through
entuity_home/etc/modules_definition.cfg, during upgrades configure
checks, and gives precedence to, module enabled settings in entuity_home/etc/
installed_modules.cfg.
y configure displays in turn each module. For those identified as licensed you have
the option of installing, y, or not installing, n.
10) Only when you have activated the Configuration Monitor module does configure
display a series of Configuration Monitor prompts.
h
You must separately configure remote shell, i.e. Telnet, SSHv1 or SSHv2, and transfer
servers, i.e. TFTP and/or FTP.
When you have specified the Entuity Configuration Monitor click Next.
Attribute Description
Transfer Server IP configure displays a list of the IP addresses on the Entuity server. Select
Address. the IP address you want to use with the TFTP and/or FTP servers used in
retrieving device configurations.
Transfer Directory The directory on the Entuity server to which the TFTP and/or FTP server
writes retrieved device configurations, by default
entuity_home\cm_transfer.
You must separately configure the TFTP or FTP server to use this directory,
for example through the TFTP server initialization file.
Attribute Description
Archive Directory Entuity moves successfully retrieved device configurations from the Transfer
Directory to device specific sub-directories of the Archive directory, which is
by default entuity_home\cm_archive.
11) Enter the server and user profile details Entuity uses when generating emails:
SMTP Server Hostname []> DDYLONEX06.ddy.local
SMTP Username []> james.smithg@ddy.com
SMTP Password []> password
Sender []> ddy@century.ddy.local
Subject [${eventDescr} - ${eventStr}]>
12) In Hostname Entuity by default includes the hostname of the Entuity server. This is a
mandatory field.
13) By default SSL is not activated. Enter Y to the Use SSL Communication prompt, and
enter the full name and path details of your SSL key and certificate files:
Use SSL Communication? [no]> y
SSL Certificate File []> C:\Entuity\etc\ssl-server.cer
SSL Private Key File []> C:\Entuity\etc\ssl-server.key
SSL CA Certificate File (optional) []> C:\Entuity\etc\root-cacert.cer
Either press <Return> to accept the default root, or enter a valid user ID and press
<Return>.
17) configure prompts you to accept or modify the default ports used by Entuity:
Use pre-selected port numbers [Yes]>
When you enter n, configure prompts you for each port number. Ports should be in the
range 1025 to 65535 (except for the web port, which can be 80):
Database Port [3306]>
Web Port [80]>
Event Request Listener Port [19193]>
Event Receiver Port [19194]>
Ticker Port [20202]>
Tomcat Port [8080]
Tomcat Admin Port [8005]
Server Port [10981]
Flow Collector Port [9996]
Flow Management Port [12121]
Single Channel Communication [12321]>
Attribute Description
Database Port The IP port on which you want the database server mysqld to listen. The
default is port 3306.
Web Port The IP port on which you want the web server httpd to listen. The defaults
are port 80 for non-secure access and port 443 for SSL.
Event Request IP port on which you want the event management process to listen for
Listener Port incoming requests for events, for example from the event viewer, from
subscribed third party integrations. The default is port 19193.
Event Receiver Port Event Receiver IP port on which you want the event management process to
listen for incoming requests for events, for example system events, trap-
based events, syslog events. The default is port 19194
Ticker Port The IP port on which you want the ticker process to monitor its client ports’
activity. The default is port 20202.
Tomcat Port The port used by the application server Tomcat. The default is port 8080.
Tomcat Admin Port The port used to access and managed the application server Tomcat. The
default is port 8005.
Attribute Description
Flow Port The port on which Entuity IFA receives flow information from devices sending
NetFlow, Netstream or JFlow packets. This flow collector port is configurable
through configure and flowcfg.properties.
Entuity IFA collects IPFIX flow data on port 2055 and sFlow data on port
6343. These collector ports are not configurable, you must therefore ensure
routers using those flow technologies are configured to send data to the
appropriate ports otherwise Entuity IFA will not recognize and collect the
data.
Flow Management The port used to manage, e.g. stop, the Flow Collector process. The default
Port is port 12121.
Server Port The port on which the Entuity server listens to its clients. The default is port
10981.
Single Channel To enable single channel communication between the Entuity server and its
Communication clients, i.e. communication is conducted through one connection, and so
one port. The single channel function is invisible to the Entuity client and
server, i.e. the Entuity server and client continue to receive and send
information on the same ports regardless of whether the single channel
function is activated or not.
Single Channel Port The port on which single channel communication between the Entuity server
and its clients is conducted. The default port is 12321.
18) configure displays the parameter settings and prompts you to continue the
configuration:
Do you want to continue? [no]>
Either press <Return> to halt the configuration, or enter y and press <Return> to
implement it.
19) When configuration is complete configure displays:
Configure completed successfully
Press <Return> to return to the entuity_home directory.
20) The first time you complete Entuity configuration you should take an initial backup of the
system. (See Chapter 7 - Back Up the Entuity Data.)
21) Start Entuity. (See Chapter 5 - Startup, Shutdown and Process Checking.)
This chapter details the procedures for starting and shutting down Entuity, and for checking
the statuses of system processes.
Start Entuity
To start Entuity when you are running it under:
Windows, the installation default is for Entuity to automatically start when Windows starts.
It does this through the services:
Entuity which is the main Entuity service. It starts and stops the other Entuity services
and controls all Entuity functions, apart from the web server and the MySQL
processes.
Entuity Webserver which controls the Entuity web service.
Entuity Database which controls the MySQL processes.
h
Entuity Support recommend configuring Entuity to also automatically start under Linux
environments.
Windows and Linux from the command line run entuity_home\bin\starteye. For
example, in Linux enter:
./starteye
As Entuity starts, it starts the processes in this order:
Each time Entuity starts it runs dbcheck which checks that the database was previously
correctly closed down, for example a power failure may leave some tables open. dbcheck
runs before the database starts and if it identifies problems that require repairing calls
myisamchk.
The time taken to run a full check and repair of the database varies according to the size of
the managed network. A slow Entuity startup may indicate an automatic repair of the
database has taken place.
Shutdown Entuity
The Entuity system processes should only be stopped when you want to:
Perform a server reboot.
Upgrade, or during the current session have already upgraded, the Entuity software,
database, or license. (See Upgrade the Entuity License.)
There are a number of ways to stop Entuity. When you are running Entuity under:
Windows, the installation default is for Entuity to automatically stop when Windows stops.
Entuity recommend you explicitly stop Entuity and do not rely on Windows to close
Entuity down.
Windows, use the Service function, available from the Control Panel, to start and stop
Entuity while Windows is running.
all operating systems, from the command line run entuity_home\bin\stopeye. For
example, in Linux enter:
./stopeye
h
Only kill processes as a last resort and only use the TERM signal, if processes are taking a
long time to stop do not use any other command. On systems with large databases or slow
disks the data server processes can take a few minutes to terminate.
1) search 2) eosserver
3) sysLogger 4) tomcat
5) macScheduler 6) diskMonitor
7) applicationMonitor 8) prologV2
9) ticker 10) provost (Scheduler)
11) DsKernelStatic 12) viewserver
You can examine the status of the Entuity central processes through the Process Health
page, available by clicking Administration > Entuity Health > Process Health. (See the
Entuity User and System Administrator Guide.)
Entuity supports standalone and distributed (Central License Server) licensing architectures.
With Standalone licensing each Entuity server has its own license file. With Central License
Server licensing the central server license file contains all of the licensing information, the
remote servers have a license that identifies their central server.
Entuity licensing server compares the Entuity license file with the configured Entuity server. It
checks:
The version of Entuity.
If you install a major new release of Entuity you will require a new license.
The license expiry date.
Entuity raises license expiry events when the license, or modules within it, are close to
expiry which is by default from 30 days before license expiry.
The available modules and integrations.
Only licensable modules and integrations with a valid entry in the license file can be
activated.
The number of object and/or device credits available. (See Entuity Device and Object
Licensing Models.)
Whether the Entuity server machine is the expected machine. For standalone and Central
License Server licenses Entuity checks the license is:
Generated using the machine’s host identifier.
For a physical machine or a virtual machine. Entuity licenses are generated for either
virtual or physical machines, a license generated for one type of machine will not work
on the other.
Remote servers only require a license that is associated with their Central License Server,
its host identifier and whether it is a virtual or physical machine is not considered.
For Central License Servers how many remote servers it can support.
Typically, this license information remains unchanged, although you may need to increase
the number of object credits if your network expands or to install new Entuity modules.
Entuity Support recommend you do not rename the supplied licenses. If you retain the
supplied license name it will assist Entuity Support if they ever have to troubleshoot licensing
issues.
For example, if you have ten servers you require ten licenses each generated with the
specific server’s host identifier and each with a license credit allocation.
You only have to provide the host identifier of one machine, the machine hosting the
Central License Server.
Only the Central License Server is fixed to a particular machine, remote servers are only
tied to the Central License Server and not to the machine hosting them. Remote servers
are therefore fully compatible with VMware VMotion technology.
For example, if you have ten servers you are supplied with two licenses:
One central server license installed to the central server which defines the available
modules, and the pool of device and object credits from which you assign credits to
remote servers.
When you want the central server to also manage devices, you must also assign credits
to it in the same way as a remote server.
One remote license which you install to the nine remote servers. From the central license
server you assign to the remote server license credits.
the server stops. You then have seven days to install a new valid license otherwise its remote
servers will also stop managing your network.
Entuity Support recommend you do not use a Central License Server to manage network
objects or as a consolidation server.
Entuity also licenses individual modules, e.g. IFA Premium, Cisco IOS IP SLA, and
integrations, e.g. Entuity Integration Module for BMC Atrium CMDB.
Using a central licensing server allows you to allocate and re-allocate licensing credits to
remote servers as their requirements change. For example, you may have three servers each
with local licenses that support the same number of objects. These licenses may not reflect
the current loading on those servers. With a Central License Server you can assign fewer
license credits to the lighter loaded server, and more credits to the more heavily loaded
server.
4) Depending upon the license credit model you can enter the number of device and object
license credits to assign to the server.
5) Click OK.
Entuity assigns licenses to the selected server. When you have assigned credits to:
The central server or amended the number of credits assigned to a remote server, that
server continues running with the new credit allocation.
A remote server that previously did not have a credit allocation, that triggers it to
restart in a licensed mode. The Central License Server may temporarily report the
remote server state as Down.
Attribute Description
License Status Icon When the license state is:
Ok, there are no immediate issues with the license
Warning, a running subsystem has a license that expires in 30 days
or the license usage has reached 90.0%
Severe, a running subsystem has no license, the license has expired
or the license usage reaches 100.0%.
This icon is available through the Health Summary and License Health
pages.
Server Name Name of the current Entuity.
Entuity Core Expiry Expiry date of the core Entuity product. For most installs this would
coincide with individual module and integration expiry dates.
License Usage
Resources Depending on license model your license could include device and object
credits.
Total Total number of license credits available for the resource.
Used Number of credits currently used.
Available Number of credits currently available for allocation.
Expiry Expiry date of the resource credits.
Source Indicates whether license credits are allocated from a local license, or a
Central License Server.
Module / Integrations
Attribute Description
Name Name of the module or integration.
Enabled Set to Yes when enabled through configure, No when not enabled.
Expiry Expiry date of the module or integration. For most installs this would
coincide with the core Entuity product expiry dates.
You can obtain from your Entuity representative a full license. You must provide the host
identifier of that machine as the license file restricts installation of Entuity to the server for
which you provided a host identifier. The host identifier associates the Entuity license with the
physical footprint of the machine.
You can discover the host identifier by running hostIdent:
Before installation, by obtaining a copy of hostIdent from your Entuity contact.
As part of install, install displays the host identifier.
As part of configure, configure displays the host identifier.
Before running Entuity for the first time, re-installing Entuity or re-configuring Entuity you are
strongly advised to make a system backup of the installed software and data. This will ensure
that you are up and running more quickly in the event of a file system corruption, or when
upgrading Entuity and inadvertently deleting data.
Back up everything included within entuity_home. If during configuration you installed the
database directory somewhere other than entuity_home, then ensure that you back it up.
Back Up Data
When re-installing or re-configuring Entuity you should backup your data.
Entuity backup backs up the database, generating zipped backup files in directories under
the database backup directory. If during install or configure you decide to rebuild the
database then all files under entuity_home\database\data are deleted.
h
When backing-up the Entuity database files but not using the Entuity backup utility, e.g.
using standard copy and paste commands, you should stop all services including the
MySQL database. Conversely, to use Entuity backup MySQL must be running.
See the Entuity User and System Administrator Guide for details on backing up Entuity.
Entuity Customer Support issue Release Notification and Patch Notification technical
bulletins informing customers of new releases, maintenance patches and their content.
These notifications are usually the trigger for updating your software.
The process to use when applying a new patch is different to that used when installing a new
GA version of Entuity. A patch only includes changes that are applied to an existing
installation, Entuity GA is a new ISO image.
This chapter details how to install maintenance patches. To download and install the Entuity
GA ISO image see Preparing to Install Entuity.
Name Description
GA The first release of a new version of Entuity, e.g. Entuity 14.0, is the General
Acceptance (GA) release. It is delivered as a compressed ISO image.
Patches A patch may deliver fixes to issues raised by customers, improved performance
and new features. You should always apply the patches in the order they are
issued, e.g. one patch may depend upon a change delivered in a previous patch.
Entuity GA ISO image is available from the BMC Software electronic software distribution
(ESD) site as compressed files.also available from the ftp site, but stored under the Images
folder, e.g. /Images/14.0/.
3) Download to a temporary folder the required patch, associated readme and checksum
files.
4) Compare the checksum of the patch against the expected hash value in checksums.txt.
Linux operating systems include checksum utilities. In Windows environments you
require a third party tool that supports SHA-1 or SHA-2 checksum calculation.
3) After installing the patch run configure. The patch is only applied once configure
completes.
4) Restart the Entuity server.
The Entuity server is easily uninstalled from Windows and Linux systems.
h
If you want to uninstall a local version of the Entuity client use the Java webstart interface.
inst_service uses the service names which all start with EOTS and not the service display
names that all start with Entuity.
3) Delete the root folder of the Entuity installation. If the database directory was not installed
under entuity_home then you will have to separately delete that folder.
If you have called Entuity from any external scripts, or are using Entuity together with other
network management software through its integration modules, then you may have files
external to these to amend.
2) Delete the root folder of the Entuity installation. If the database directory was not installed
under entuity_home then you will have to separately delete that folder.
If you have called Entuity from any external scripts, or are using Entuity together with other
network management software through its integration modules, then you may have files
external to these to amend.
Use this checklist before running install and configure. For each item the checklist
includes a description and any default value. Enter your site values as it will assist you during
Entuity installation and configuration. You should also:
Update any firewall and security module control lists to allow Entuity appropriate access
to your network.
Disable anti-virus software from scanning the database directories. Anti-virus software
can disrupt the performance of the database, potentially resulting in its corruption.
Entuity also uses ports that are not configurable through configure.
By default all files and folders are installed below entuity_home, the Entuity installation folder.
Entuity install installs to folders under entuity_home (where entuity_home is the Entuity
install location):
Entuity server and client software and documentation.
Product Version
Apache Tomcat 7.0.62
Apache HTTPD 2.4.12
Groovy Script 2.4
JRE 1.8.0_45
MariaDB Server 10.0.16
MariaDB Library (libmariadb) 2.1.0
MariaDB Java Client 1.1.8
OpenSSL 1.0.2a
The Entuity database that is a set of MariaDB databases, each with their own folder (by
default under entuity_home\database\data). (See the Entuity User and System
Administrator Guide.)
License file, a 30 day evaluation license, i.e. license.30day.eval.dat.
You can apply for a complete license from your Entuity representative. This is the only
license you require for Entuity.
Details of third party software licenses and license terms are installed to
entuity_home\licenseTerms.
This section provides an overview of the install, configure and device management
procedures to follow when getting started with Entuity.
Tasks Actions
Preparing to Install
Download Entuity See Preparing to Install Entuity.
Review the installation Release Notes are available from the root of the temporary installation
documentation folder, and once installed the web UI Help.
Read Chapter 2 - Prepare for Entuity Install and Configure.
Check Entuity server Check you are installing to an appropriate machine. In multi-server
system requirements environments consider the role of each server, e.g. poller, flow collector,
consolidation. See Entuity System Requirements, p9.
Complete your Complete the checklist, update any firewall and security module control
configuration checklist lists to allow Entuity appropriate access to your network. Also disable
anti-virus software from scanning the database directories. See
Appendix A - Entuity Configuration Checklist.
Obtain your Entuity Entuity is supplied with a thirty day evaluation license. For a permanent
license license contact your Entuity supplier, providing them with the host
identifier of the machine to which you want to install the software. In
multi-server environments consider the licensing model that you want to
implement. Chapter 6 - Entuity Licensing.
Installing Entuity
Install Entuity Install using the install wizard or from the command line.
See Install Help and Chapter 3 - Install the Entuity Server.
Check for Patches Maintenance patches are issued at regular intervals. See Chapter 8 -
Entuity Maintenance Patches.
Configure Entuity Configure Entuity using the wizard or from the command line.
See Configure Help and Chapter 4 - Configure the Entuity Server.
After You Install
Backup Entuity Backup Entuity to provide a clear backup point.
Chapter 7 - Back Up the Entuity Data.
Start Entuity Starting Entuity. See Start Entuity, p60.
Check your install Process Health, License Health.
See the Entuity User and System Administrator Guide.
Set up user accounts Amend the default user accounts. Set up new user accounts and
groups. See Help available from the web UI.
Add Inventory to Entuity Choose method for discovering devices.
Add discovered devices to Entuity.
See the Entuity User and System Administrator Guide.
2) Unzip the compressed ISO file to a temporary, empty location that is on the Entuity server
machine, is near the root of the drive and the path does not include spaces.
Do not, for example in a Windows environment, unzip the file to a shared location on
another machine. The unzipped install program does not properly complete across share
mappings. Also in Windows use the wizard to extract files, other mechanisms, e.g. copy
and paste are not reliable.
3) Compare the checksum of the image against the expected hash value in
checksums.txt.
Linux operating systems include checksum utilities. In Windows environments you
require a third party tool that supports SHA-1 or SHA-2 checksum calculation.
4) Mount or burn the installation DVD ISO image.
The Entuity ISO file contains the complete image of an Entuity DVD disc. With the
appropriate third party tool(s) you can:
Burn the image to a DVD.
Mount the image to a virtual drive.
With either the mounted image or newly burnt DVD, you are now ready to install Entuity.
h
The first release of an Entuity version (GA) is supplied as a compressed ISO image. Entuity
maintenance patches are configured for use with installPatch, and require a different
install process. (See Chapter 8 - Entuity Maintenance Patches.)
Installing Entuity
When you have prepared the downloaded Entuity ISO image file (see Preparing to Install
Entuity), you can use the install program to start the installation.
When installing Entuity you should use the full install instructions in Chapter 3 - Install the
Entuity Server, which also includes how to install from the command line, the only option
when installing Entuity to Linux environments.
You should use a user account with administrator access rights and then:
1) Run install from the server, e.g. click Start > Run, from the Run dialog browse for the
image/temporary folder root and select install.
install displays Installation Welcome screen. Click Next.
2) install displays the Entuity license agreement. Read the license agreement.
Click Agree and Next to install Entuity.
3) install displays the Installation Location page. By default, Entuity is installed to
C:\Entuity (referred to as entuity_home). Accept, or amend the install location.
Click Next. install prompts you to confirm the creation of the install folder.
4) install displays an installation progress screen.
Entuity displays the host ID of the server machine. When you want to purchase a license
you must provide this identifier to your Entuity supplier. However, you can configure and
then run Entuity using the thirty day evaluation license shipped with Entuity.
When using Entuity as a Central License Server you are only required to provide details of
the licensing server, the license for the remote Entuity servers is linked to the central
license.
5) You can now check for, and install, Entuity maintenance patches. (See Chapter 8 - Entuity
Maintenance Patches.)
Configuring Entuity
The options available with configure vary according to the selected capabilities of the
Entuity server, i.e. Standard Server or All-in-one.
h
When configuring Entuity you should use the full instructions in Chapter 3 - Install the Entuity
Server, which also includes how to configure Entuity from the command line, the only option
when installing Entuity to Linux environments.
To configure Entuity:
1) From entuity_home\install double-click on configure. configure checks that
Entuity is not running, and would display a warning message if it were.
2) In Windows environments when the registry key value MaxUserPort is not set to
0x0000FFFE (65534), then it should be amended. You can do this manually, or permit
configure to amend MaxUserPort. Click Next.
3) In the Choose Configuration Folders page specify the database installation, database
You can:
Take an initial backup of the system. (See Chapter 7 - Back Up the Entuity Data.)
Start Entuity. (See Chapter 5 - Startup, Shutdown and Process Checking.)
When using Entuity Central License Server assign device and object credits to its remote
Entuity servers. (See Chapter 6 - Entuity Licensing.)
Discover your network. (See the Entuity User and System Administrator Guide.)
2) Entuity displays the default Inventory page, also accessed through Administration >
Inventory.
3) From the Inventory page you can:
Use Auto Discovery to automatically discover devices within set parameters.
Add individual devices.
Use a seed file to add devices defined within it.
Discovered devices are returned as candidates ready for you to add to Entuity.
4) From the inventory candidates list, click Add to Inventory. Entuity manages the devices.
5) From the Inventory page you can view the devices under Entuity management.
h
Virtual machines should be added to Entuity using the VM Platform device type, which has a
distinct set of connection parameters to all other device types. (See the Entuity User and
System Administrator Guide.)
Server Sizing
You can install Entuity to both physical and virtual machines, the hardware requirements are
the same for both. (For a list of supported virtual machines see Virtual Machines Certified to
Host Entuity.)
The number of devices and the number of ports (i.e. physical and virtual interfaces) are the
two key loading factors. They are inversely related; the maximum number of devices that can
be managed without effecting performance characteristics is inversely proportional to the
total number of objects. You can use the chart to plot your device-port combination and the
intersection identifies which sizing category banding is best for your server requirements,
Low, Intermediate or High.
2400
2000
1600
Devices
Intersection of 1000 devices and
1200 70000 ports is in the High server
specification category.
1000
800 High
Intermediate
400
Low
70000
40000 80000 120000
Ports
2) Choose the role of the server (see Entuity Server Roles), for example a server acting as a:
Central License Server and not managing devices would have a low category server
specification. A Central License Server allows you to control licensing of all of your
Entuity servers from one central server. This makes it very easy to move device
licenses between servers when required.
Consolidation Server and not managing devices would have a low category server
specification. In a multi-server environment users can log on to an Entuity
Consolidation Server Consolidation Server to access information gathered and stored
by multiple polling Servers.
Polling Server faces the most significant loading factors as the number of devices and
the number of ports. You can use the chart to identify the most suitable server
configuration based on managed device and port numbers. If the server's role is to
act additionally as a Central License Server, a Consolidation Server or a Flow
Collector (as well as a Polling Server) it is recommended that a faster processor clock
speed (closer to 3GHz) is selected.
Flow Collection Server is accommodated within the recommended server
configurations. If the server's only role is to act as a Flow Collector (without polling)
you can identify the server configuration from the chart using a port count of zero.
3) Estimate how many devices and ports you want the server to manage.
You should only include to your estimate devices which you intend to SNMP poll, Ping
Only devices have a limited impact on server resources (Entuity uses ICMP to only poll
their management IP addresses).
4) Apply these figures to the sizing chart. The intersection determines within which
device-port banding the server falls, low, intermediate or high.
5) Table 30 Minimum Server Specifications provides a by component breakdown of the
minimum requirements for each of the device-port management bands.
database traffic. Therefore the operating system and swap partition should be located on
one physical disk with Entuity including its database on another.
RAID 5 is not recommended as physical disk synchronization issues seem to cause high
latency. RAID 1 (mirroring) is acceptable but must be a hardware implementation.
Disk Performance: Entuity’s database relies on fast throughput of data to the storage
system. We recommend that systems are configured with the fastest storage system
options available.
As a guide we suggest that disk rotational speeds should be no slower than 15Krpm, and
Input/Output Operations Per Second (IOPS) is rated at 150 or above.
Amend Server Configuration Components
You can amend the default configuration of an Entuity server through
entuity_home\etc\entuity.cfg. After amending entuity.cfg you must first run
configure.
h
Before amending the configuration you should first read the section on entuity.cfg in the
! Entuity System Administrator Reference Manual; changing a setting, for example
Database.key_buffer, without the appropriate hardware components can seriously
impact server performance.
[MibServ]
workers=40
[eosserver]
javaMemory=1024M
[MibServ]
workers=60
[eyepoller]
workers=50
[eosserver]
javaMemory=3072M
Advanced Actions
Advanced Actions, also known as user menus and user actions, are defined through
configuration files. Actions may be automatically triggered through Entuity raising an
appropriate event, or interactively through advanced action menus, available both from the
menu bar and context menus.
Agent
Intelligent management software embedded in a network device. In network management
systems, agents reside in all managed devices and report the values of specified variables to
management stations.
Antenna / Radio
Each Wireless Access Point has one or more Antennas. Each Antenna is attached to an
802.11 radio within the Access Point. Wireless Hosts communicate with the network via a
wireless association with an Antenna/Radio. Each Antenna/Radio can have multiple hosts
simultaneously attached. Each Antenna/Radio operates in a chosen 802.11 compatibility
mode such as 802.11a, 802.11b or 802.11g. Additionally, each Antenna/Radio has a single
SSID assigned. Each Antenna/Radio operates on a chosen radio channel and with a
specified transmit power setting, which is measured in mW. Many controller based
installations use dynamic optimization algorithms to pick a suitable channel and power
setting. Frequent auto-adjustment of these setting indicates that there are problems being
encountered with the quality of the wireless communications.
It bridges traffic from wireless attached hosts to/from an Ethernet interface that connects to
an access layer switch port. APs provide heightened wireless security and extend the
physical range of a wireless LAN. The access layer switch will see the MAC addresses of the
individual wireless attached hosts (the MAC address of the wireless NICs) plus the MAC of
the Access Point Ethernet interface.
AR System
BMC Remedy Action Request System (AR System) is a framework within which applications
are built by AR System administrators. Applications consist of a set of AR System forms that
are linked using workflow rules designed for the application. These forms contain fields
which Entuity can be configured to populate.
ARs
Entuity integrates with AR System to generate Action Requests (ARs). The sample integration
with the Remedy Help Desk includes ARs of the type incident.
ARP
ARP (Address Resolution Protocol) is the layer 2 standard for TCP/IP. It is used to obtain a
node’s physical address when only its logical IP address is known.
ATM
ATM (Asynchronous Transfer Mode) is a packet-switching technology, that delivers
high-speed performance together with a scalable architecture. Its use of small packets (fixed
length cells of 53 bytes), provide for low latency so sound and vision arrive together. It can
also handle bursty, non time-sensitive data, translating variable length packets to fixed size
packets.
Attribute
In Entuity an attribute is a property of an object that is defined through StormWorks. Attribute
data can be charted using the Attribute Grapher and is available to Report Builder.
Backbone
The part of a network that acts as the primary path for traffic that is most often sourced from,
and destined for, other networks.
Bandwidth
The upper limit of the rate at which data can be transferred.
BMC Cell
BMC Impact Manager instance. A cell receives events from Entuity and displays them in the
BMC IX.
BMC IX
BMC IX (BMC Impact Explorer) displays events received from Entuity.
Blackout
Blackout is complete loss of the network, as opposed to a brownout, which is degradation in
the performance of the network.
BPDU
Bridge Data Protocol Units are special frames that contain spanning tree information. There
are two types of BPDU, Topology Change Notification (TCN) BPDU contains topology
change information, Configuration BDU contain configuration information.
Bridge
A device that interconnects local or remote networks. Bridges form a single logical network,
centralizing network administration. They operate at the physical and link layers of the OSI
Reference Model.
Brownout
Brownouts, also known as soft faults, are typically caused by cabling faults, faulty
transceivers, faulty NIC cards and configuration errors such as duplex/half-duplex
mismatches. These problems cause a percentage of the packets traversing that particular
area of the network to be corrupted. The total number of packets discarded as a percentage
of packets is directly related to the severity of the brownout.
Burst
Burst is the access rate of the physical connection to the Frame Relay carrier network.
Central Server
A central server is an Entuity server trusted by remote Entuity server(s). A user logged into
the central Entuity server is able to view information collected by the remote Entuity server(s),
according to their user account access rights. A remote Entuity server responds to requests
from a trusted central Entuity server, and freely shares information with it.
An Entuity server can be configured to perform both roles, be both a remote and central
Entuity Server. This allows administrators to create both hub-n-spoke and fully meshed
deployments.
A central Entuity server can also act as a central license server. From it you can allocate, and
de-allocate, license credits to its remote servers.
Configuration of central and remote servers is through the Multi-Server Administration area of
the Entuity web UI.
CI
Within BMC Atrium CMDB a Configuration Item (CI) is a collection of objects related to the
specific functionality of a larger system.
CIR
Committed Information Rate is the rate (in bps) that the network agrees to transfer
information over a permanent virtual circuit (PVC) in Frame Relay. The CIR applies to the rate
of data entering the network.
Collisions
Collisions occur when two transmitters attempt to send data at the same time. The greater
the number of collisions the poorer network performance appears.
Component Viewer
Component Viewer is the Entuity Java client, available through the web UI Tools menu.
Through it you can quickly scan the network for both current and historical performance
data. It creates an intuitive hierarchy which lets you easily view configuration settings, check
status information and launch fault, utilization and traffic volume history graphs.
Context Menus
Context menus are available from the Entuity web UI and Component Viewer. The contents
of the menu are dependent on the position of the mouse when you clicked the right button.
Core Ports
Entuity considers core ports, as WAN ports, administratively up ports which have a
configured IP addresses (i.e. layer 3 ports) on devices which are routers or have router
capability, or trunks and uplinks that are administratively up.
By default the port status event, Port Operationally Down, is only enabled for core ports.
Current Configuration
The device configuration (either startup- or running) currently being processed.
Data Path
A data direction on each PVC is a data path. For example, a PVC that connects points A and
B has two data paths, from A to B and from B to A. Frame Relay functionality analyzes the
data paths separately.
Data Rollup
Data Rollup is a method of taking polled data and bundling it into larger more manageable
units, e.g. rolling 24 hourly datapoints into one daily sample. If Entuity generated monthly
reports from live polled data then this would cause a significant increase on the processing
overhead, i.e. instead of one datapoint for each day there would be hundreds.
DE (Discard Eligibility)
DE is a bit in the header of a frame-relay frame that indicate the frame may be discarded in
preference to other frames if congestion occurs. It is usually set by a network node if the user
is offering data (frames) at a higher rate than has been negotiated. This maintains the
committed quality of service within the network. Frames with the DE bit set are considered to
be excess data.
Derived Events
IA derived event is an event derived from an existing event definition. It retains the event
identifier of the original definition, unlike a custom event which has its own unique identifier.
Derived events are defined as part of an action. They useful for adding additional information
to an incoming event, and can also be called from an incident.
Devices
In Entuity devices refers to network devices, for example switches and routers.
vendinfo identifies the vendor device support datasets available to Entuity and the
decisions made when more than one vendor file is available for a particular sysoid; which
device support dataset Entuity uses to manage that device type (as identified through its
sysoid).
Device Types
In Entuity every device has a type, which you can view through the web interface and
Component Viewer. The device type is derived from its vendor file information, and helps to
determine how Entuity manages a device. Device types include hubs, switches and routers.
There are also two Unclassified device types, Basic Management and Ping Only, and also
Full Management.
Unclassified device types have two distinct roles:
Basic Management and Ping-only, is used for those devices Entuity has taken under
management at the Basic Management and Ping-only level.
Full Management, is used for those devices Entuity has taken under management at the
Full level but for which there is no vendor file information but Entuity can generate a
suitable generic device type. These are uncertified devices.
Domains
Domains and domain filters are terms used within Component Viewer, in fact supplied
domains are now only used within Component Viewer to group objects in its Explorer tree,
e.g. the routers domain. In the web UI, where you manage views In Entuity, domain filters are
referred to by the more apt term view content filters as they determine the type of object that
can potentially appear in a view.
DHCP Operation
The IP SLA DHCP operation measures the round trip time (RTT) taken to discover a DHCP
Server and obtaining a lease from it. After obtaining an IP Address, Cisco IOS IP SLA
releases the IP address that was leased by the server.
The Dynamic Host Configuration Protocol (DHCP) is an Internet protocol for automating the
configuration of computers that use TCP/IP. DHCP can be used to automatically assign IP
addresses, to deliver TCP/IP stack configuration parameters such as the subnet mask and
default router.
Drop Box
Drop box acts as a temporary repository for objects, for example gauges, charts, links,
device metrics, that you want to include to new reports, dashboards.
Duplex
A full-duplex link with one telegrapher at each end, transmitting alternately in each direction.
Dynamic Thresholds
Dynamic thresholds enable Entuity to alert the user to deviations from what Entuity’s
previous polling has established as normal behavior for that hour on that day. Entuity
establishes normal behavior for a given attribute on a given port by maintaining the last four
weeks worth of polled data, and applying an averaging algorithm.
EIR
The Excess Information Rate (EIR) is the sustainable rate of information in excess of CIR, that
the network will deliver if there is available bandwidth. The total information rate is CIR + EIR.
Frame Relay allows data rates in excess of the CIR to be successfully used on occasions. It is
also possible that the amount of data that can be transferred per measurement interval (Tc)
may be limited to less than the burst (or access rate) of the physical connection to the carrier
network.
EIR defines how many bits per second beyond the CIR the data rate may be exceeded. This
is may be policed by the carrier ingress switch per Tc on a pro-rata basis. This means that
although data can be transmitted for periods of time at the burst rate of the physical port it
would not be possible to continue transferring data at this rate successfully on a continuous
basis if the CIR+EIR were to be less than the burst rate.
Entuity
Entuity is both the name of the network management software and the company producing
it. Entuity software is designed for networks of any size and complexity, from the smallest,
simplest corporate infrastructure to the largest multinational. Every customer can access the
full functionality of our cornerstone solution, incorporating fault, performance and inventory
management.
entuity_home
entuity_home is used within the Entuity documentation to indicate the Entuity server’s root
folder. The root folder is set by Entuity install, in Windows environments the default is
C:\Entuity. You can view its current setting through destination in
entuity_home\etc\entuity.cfg. Within Entuity configuration files it is represented by the
variable ENTUITY_HOME.
Ethernet
IEEE standard network protocol that specifies how data is placed on and retrieved from a
common transmission medium. Forms the underlying transport vehicle used by several
upper-level protocols, including TCP/IP and XNS.
Events
Events are alerts and alarms that are generated through Entuity monitoring the network.
Event Viewer displays events and they can also be reported on.
Expect
Expect is a Unix automation and testing tool, written by Don Libes as an extension to the Tcl
scripting language, for interactive applications such as telnet, ftp, passwd, fsck, rlogin, tip,
ssh, and others. It uses Unix pseudo terminals to wrap up subprocesses transparently,
allowing the automation of arbitrary applications that are accessed over a terminal. With Tk,
interactive applications can be wrapped in X11 GUIs.
automatic generation of Action Requests (ARs), derived from Entuity events, to particular
application forms on target AR System servers
interactive generation of Action Requests (ARs), initiated from Entuity. The specified
application forms on target AR System servers are opened for editing, with default data
populated from the current Entuity managed object(s) or event(s).
Entuity can also pass to AR System a URL identifying the managed object that is the source
of the AR. From AR System you can open Entuity’s Component Viewer with the focus on the
managed object.
Factory Default
The shipped values of event thresholds are the factory defaults. You can amend a factory
default, which if done at the root level effectively changes the default value for all objects
against which that threshold can be set. For example, if you amend a threshold setting for a
device event at the Entuity (system) level, all devices on that server will have a new default
value.
FEC
Forwarding Equivalence Class (FEC) is central concept to MPLS. An FEC is a set of packets
that a single router forwards to the same next hop, using the same interface and with the
same handling (e.g. queuing). The FEC is determined only once, at the ingress to an LSP,
rather than at every router hop along the path.
Filters
Filters in Entuity act by filtering in those objects specified in the filter. There are three types of
filters, view, event and Flex Report.
Entuity uses these types of filter:
View content filters are applied to the views, restricting the components available from a
view to those that meet the criteria.
Event Filters restrict the events available through a view.
Flex Report filters restrict the data included to the report.
Flow Collector
The Flow Collector is the set of processes within an Entuity Integrated Flow Analyzer
responsible for the receiving, processing and storage of flow records.
Administrators can enable/disable an Entuity server’s Flow Collector through configure, a
decision which should be made according to the role the administrator wants the server to
perform in the management of the network.
Frame Relay
A fast packet protocol that relies on physical component and higher level software reliability.
The network discards any frame with bit errors. Frame relay services include PVCs
(Permanent Virtual Circuit) and SVCs (Switched Virtual Circuit).
Full Duplex
A full-duplex link with one telegrapher at each end, transmitting alternately in each direction.
Half-Duplex
A type of communication channel using a single circuit which can carry data in either
direction but not both directions at once.
Host Identifier
Your Entuity representative requires the host identifier of the Entuity server machine before
they can generate your license. The host identifier associates the Entuity license with the
physical footprint of the machine. Entuity install and configure programs both display the host
identifier, alternatively you can run the command line program hostIdent (which is included
with the software but is also available from the Support website).
Hot Standby Router Protocol (HSRP)
Hot Standby Router Protocol (HSRP) establishes a framework between network routers to
achieve default gateway failover if the primary gateway becomes unavailable in close
association with a rapid-converging routing protocol like EIGRP or OSPF. By multicasting
packets, HSRP sends its hello messages to the multicast address 224.0.0.2 (all routers)
using UDP port 1985, to other HSRP-enabled routers, defining priority between the routers.
The primary router with the highest configured priority will act as a virtual router with its own
IP and MAC address, which the hosts on the local segment will be configured to use as a
gateway to the destination in question. If the primary router should fail, or the link to the
destination drop, the router with the next-highest priority would take over communications
through alternative routes within seconds, without major interruption to network connectivity.
HSRP and VRRP on some routers have the ability to trigger a failover if one or more
interfaces on the router go down. This can be useful for dual branch routers each with a
single serial link back to the head end. If the serial link of the primary router goes down, you
would want the backup router to take over the primary functionality and thus retain
connectivity to the head end.
Hypervisor
A hypervisor, also called virtual machine monitor (VMM), allows multiple operating systems
to run concurrently on a host computer. The hypervisor presents to the guest operating
systems a virtual operating platform and monitors the execution of the guest operating
systems. Multiple instances of a variety of operating systems may share the virtualized
hardware resources. Hypervisors are installed on server hardware whose only task is to run
guest operating systems.
Infrastructure Ports
Entuity considers infrastructure ports, as:
Entuity considers infrastructure ports, as router ports, as uplinks which are ports connecting
routers with switches and as trunk ports which are ports connecting switches together.
Router ports.
Uplinks, ports connecting routers with switches.
Trunk ports, ports connecting switches together.
Interface
This is the entity on a node which is polled, such as a physical port. Nodes are likely to have
more than one interface.
IP
In TCP/IP, the standard for sending the basic unit of data, an IP datagram, through the
Internet.
IP Link
IP links may be autoDiscovered or created manually. They represents a link of some form at
layer 3 or above e.g. a pair of IP addresses, an IP address and a URL.
IP Peering
IP Peering provides visibility into your WAN links, i.e. leased line, Frame Relay DLCIs, ATM
VCCs, using subnet masking. It also reflects any manual IP pairings you may have made in
Entuity.
ISO
International body that is responsible for establishing standards for communications and
information exchange; developed the OSI reference model. ISO is not an acronym, but the
Greek word for "equal."
hosts and servers on the same switch. The associations between the LAPs and WCs are
negotiated dynamically and can change under fault conditions.
A LAP is an AP that is designed to be connected to a wireless LAN (WLAN) controller (WLC).
The LAP provides dual band support for IEEE 802.11a, 802.11b, and 802.11g and
simultaneous air monitoring for dynamic, real-time radio frequency (RF) management. In
addition, Cisco Aironet 1000 Series LAPs handle time-sensitive functions, such as Layer 2
encryption, that enable Cisco WLANs to securely support voice, video, and data applications.
Entuity Wireless currently supports Cisco LAP, part of the Cisco Unified Wireless Network
architecture.
Leased Line
A leased line is a dedicated point-to-point connection over a WAN via a router at the
subscriber’s premises to the telecommunications provider.
Entuity identifies a leased line, by default, when both of these conditions are true:
Load Balancers
Load balancers are devices that control and optimize traffic flow over your network. For
example directing traffic away from over utilized servers to those less utilized, improving
mission critical service delivery, providing fall over protection.
Entuity delivers a similar level of fault, performance and inventory management for load
balancers as provided for other standard Entuity device types, e.g. routers, switches, hubs.
For example device reports include load balancers, you can build your own reports using
Flex Reports, device and port events apply and full load balancer details are viewable
through Component Viewer.
Entuity currently manages F5 Labs Big IP 6400 Load Balancer. Entuity delivers additional
polling of the device ports using F5 lab’s propriety MIB, returning additional port
identification, port status, port traffic and port utilization data. The full integration of this
additional data within Entuity allows administrators to set up utilization and traffic events
against this data.
Log Files
Entuity process messages are written to their individual log files, in entuity_home/log. For
example, applicationMonitor writes to applicationMonitor.log. When the log file
becomes full, it automatically wraps to another file with up to four versions, e.g.
applicationMonitor.log.1, applicationMonitor.log.2,
applicationMonitor.log.3.
Management Level
Every device under Entuity management is managed according to its management level,
which is set when the device is added to Entuity but can be subsequently amended. Each
managed device costs one license object.
These are the management levels:
Full Management (all interfaces), Entuity manages all interfaces on the device.
Full Management (management interfaces only), Entuity only manages the management
interface.
Full Management (no interfaces)
Basic Management Entuity collects only basic system information and the full IP address
table via SNMP. This management level is used when Entuity does not have the
appropriate device support dataset (vendor file), cannot generate an appropriate dataset
or you only want the device placed under basic management. Entuity does not manage
any ports or modules on the device.
Ping Only, devices only under ping management, SNMP data is not collected for these
devices.
Managing Agent
Handles requests for information or action from the management station on a node. A
protocol links the management station and the Managing Agent; for Entuity users this must
be SNMP.
Mobility Controller
An SNMP manageable hardware device, manufactured by Aruba, that controls and
coordinates the operation of a group of Aruba Wireless Access Points. In an Aruba wireless
network deployment all wireless equipment discovery and real-time monitoring is performed
via the Mobility Controllers rather than via SNMP/ping monitoring of the individual Access
Points.
Multicast
Network communication between a single sender and multiple receivers.
My Network
Supplied view that contains the entire set of managed object’s the user is permitted to view.
Different users may have different devices in their My Network view, reflecting their different
access permissions.
Node
An SNMP managed device attached to a network, from which data can be retrieved. For
example, node devices such as hubs, routers, bridges, or network printers.
OID
An Object Identifier is a sequence of integers that represent the position of an object in the
hierarchical structure of objects in a MIB.
OSI Model
A model for networks developed by International Standards Organization (ISO). The network
is divided into seven layers, each layer building on the services provided below it.
Packet
Any logical block of data sent over a network; it contains a header consisting of control
information such as sender, receiver, and error-control data, as well as the message itself.
May be fixed or variable length.
Percentile Utilization
Percentile Utilization indicates that for a defined percent of the time, e.g. 95, port utilization is
below this value. It is useful for monitoring the sustained utilization of the port.
The 95th percentile is derived by ordering the utilization data by value, from highest to
lowest. Application of a least square fit method removes spikes that would distort the
analysis. The top 5% values are discarded, leaving the 95th percentile. This value is
calculated for both inbound and outbound utilization.
Policy Group
Entuity licensing is enabled by grouping related types of managed objects into groups.
These Policy Groups are then assigned a license credit quota. Before Entuity manages an
object it first checks whether the license allows its management and then whether a credit is
required. When a license credit is required, Entuity checks that the policy group to which the
object’s type is associated has available credits. For example, before Entuity manages a
device it checks the device licensing policy group for available credits.
Polling
Devices on the network are accessed by the system at regular, pre-defined, intervals in order
to retrieve required data. This is referred to as polling the devices.
Polling Engine
The Polling Engine (or Core Management Engine) is the set of processes within an
Entuity server responsible for all general network management tasks excluding flow
collection (e.g. network discovery, inventory, monitoring, event management).
Administrators can enable/disable an Entuity server’s Polling Engine through configure, a
decision which should be made according to the role the administrator wants the server to
perform in the management of the network.
Port
Entuity considers ports as interfaces on network devices, e.g. routers, and as endpoints in
communications systems. In IP an upper-layer process that receives information from lower
layers. Ports are numbered, and each numbered port is associated with a specific process.
For example, SMTP is associated with port 25.
TCP and UDP transport layer protocols used on Ethernet use port numbers to distinguish
between (demultiplex) different logical channels on the same network interface on the same
computer.
Protocol
A set of formal rules detailing how to transmit data across a network. Example protocols
include TCP, UDP and IP.
Reachability
Availability Monitor sends an ICMP ping to the management IP address of managed devices,
by default every two minutes. Devices that respond are considered reachable, those that do
not respond, after the set number of retries, are considered unreachable. When Availability
Monitor (applicationMonitor) is not running, then the reachability of the device is
Unknown for that period, although Entuity maintains the last known state of the device.
Reboot
Entuity uses the device sysuptime to calculate when the device was last rebooted, or more
accurately when the device last came up after being rebooted.
Reconciliation Rules
Within BMC Atrium reconciliation rules are applied by the reconciliation engine to improve
accuracy and efficiency of maintaining IT environment data in the CMDB. Reconciliation is
used to identify and merge CI information and relationship form imported dataset with
production dataset.
Remote Server
A remote server is an Entuity server configured to trust another central Entuity server. A user
logged into the central Entuity server is able to view information collected by the remote
Entuity server(s), according to their user account access rights. A remote Entuity server
responds to requests from a trusted central Entuity server, and freely shares information with
it.
An Entuity server can be configured to perform both roles, be both a remote and central
Entuity Server, allowing administrators to create both hub-n-spoke and fully meshed
deployments.
Configuration of central and remote servers is through the Multi-Server Administration area of
the Entuity web UI.
Router
A device that routes data between networks. Routers connect multiple LAN segments to
each other or to a WAN.
Routers may be equipped to provide frame relay support to the LAN devices they serve.
These routers can:
encapsulate LAN frames in frame relay frames and send those frames to a frame relay
switch for transmission across the WAN.
receive frame relay frames from the WAN, strip the frame relay frame off each frame
producing the original LAN frame, and forward it to the end device.
Running-config
The configuration controlling the current operation of a piece of Cisco hardware. This may be
different to the start-up config if changes have been made since start-up and the changes
have not been saved. The running-config can be saved as the startup-config replacing any
previous start-up config. The running config is held in DRAM. If the machine is restarted
without the running-config being saved, all changes are lost.
Sample Interval
In Entuity the period between two data samples. This may be between two pollings of a port,
or between two rolled up data samples.
Server
Any computer whose function in a network is to provide user access to files, printing,
communications, and other services. Servers usually have more memory, more disk storage,
and a more advanced processor than a single-user desktop PC.
Where Entuity manages an application, Entuity can manage the application server as a
device.
Services
Services is a method of grouping together collections of ports that provide a service and
associating with them other ports which use that service. For example, a service maybe e-
mail, with one port designated as the provider of the service and all others in the group
defined as consumers.
SLA
A Service Level Agreement (SLA) is a set of rules and metrics which can be used to measure
the efficiency and performance of an object. That object may be a department, a server, a
network or any other functional component of an organization. If an object adheres to its
associated set of rules and metrics, then it can be said to be conforming to its SLA. Similarly,
if the object breaches the set of rules and metrics, then this means that it is no longer
conforming to its SLA.
SNMP
Standardized method of managing and monitoring network devices on TCP/IP based
internets. SNMP defines the formats of a set of network management messages, and the
rules by which those messages are exchanged. The network management messages are
used to make requests for performing network management functions and to report on
events that occur in the network. Also, SNMP defines the allowable data types for MIBs, they
way in which MIBs can be structured, and a set of standard objects that can be used in
implementing a MIB.
Spanning Tree
Spanning tree provides a vendor neutral technology for visibility into your network. When
correctly implemented Entuity discovers bridge links, switch to switch relationships, through
polling the Bridge MIB. Complete spanning tree connectivity relies on a contiguous set of
Entuity managed devices.
Spare Ports
By default Entuity spare port calculations include ports that have been unused for forty days
or more, include ports that have system uptime of less than forty days and are currently
unused and exclude ports that have been unused for less than forty days but have a system
uptime of forty days or more.
By default Entuity spare port calculations:
Include ports that have been unused for forty days or more.
Include ports that have system uptime of less than forty days and are currently unused.
Exclude ports that have been unused for less than forty days but have a system uptime of
forty days or more.
The forty day threshold is configurable through the reporting section of entuity.cfg. Entuity
distinguishes between physical and virtual ports using interface type. If required System
Administrators can amend the virtual port identifier.
SNMP Agent
Management code that resides in the device, controls the operation of the device, and
responds to SNMP requests.
SSL
An SSL Certificate consists of a public key and a private key. The public key is used to
encrypt information and the private key is used to decipher it. When a browser points to a
secured domain, an SSL handshake authenticates the server and the client and establishes
an encryption method and a unique session key. They can begin a secure session that
guarantees message privacy and message integrity.
Startup-config
The initial configuration when a piece of Cisco hardware starts-up. If there have been no
changes to the configuration since start-up, this will be the same as the running-config. The
startup-config is also referred to as the saved config. The startup-config is held in NVRAM.
Static Thresholds
Static threshold settings allow you to configure the trigger points which when crossed cause
Entuity to raise events. You can set thresholds against an individual event, a managed
object, view or all objects on an Entuity server.
StormWorks
StormWorks is the internal Entuity engine, also known as the Data Management Kernel
(DMK). It runs as the DsKernelStatic process.StormWorks enables the delivery of
functionality through a highly configurable set of core services. The configuration files, found
in entuity_home\etc, prefixed with sw_ define and configure StormWorks services.
Entuity assigns all of the objects it manages their own StormWorks identifier. StormWorks
identifiers are sequentially assigned, do not consider the object type and are unique within
each Entuity server. StormWorks ID is visible from the object’s web UI Advanced tab, and is
used in creating dashboards to the user, for example during Data Export, Map Export,
running of Flex Reports.
Stream Attributes
Information Entuity collects from your network is stored within Entuity as an attribute of the
managed object, for example a port’s name, a port’s utilization are stored as attributes.
Stream attributes are to maintain a history of a metric, for example Entuity maintains a history
of port utilization.
SVG
Scalable Vector Graphics (SVG) is a graphics file format and Web development language
based on XML. SVG is used by Entuity’s reports to dynamically generate, high-quality
graphics from real-time data.
Switch
A switch is a network device that selects a path or circuit for sending a unit of data to its next
destination. It is usually simpler and faster than a router, which requires knowledge about the
network to determine the route.
A switch may also include the function of the router, a device or program that can determine
the route and specifically what adjacent network point the data should be sent to.
System Capabilities
Entuity determines the switching capability of a device by checking the group dot1dtp,
specifically the mandatory scalar value dot1dTpLearnedEntryDiscards. dot1dtp is only
present when the device supports transparent bridging, which implies it has Ethernet
switching capability.
Entuity determines the routing capability of a device by checking for the ip-forwarding
variable from the ip group in the MIB of the device. When ip-forwarding has a value of 1, this
implies the device is acting as a gateway and so has routing capability.
Entuity determines whether the device type is hub by comparing its type to device types
detailed in the vendor files.
TCP
Connection-oriented protocol that provides a reliable byte stream over IP. A reliable
connection means that each end of the session is guaranteed to receive all of the data
transmitted by the other end of the connection, in the same order that it was originally
transmitted without receiving duplicates.
TCP/IP
Combination of TCP and IP protocols common to many different computer systems and so
often used for communication between them.
TFTP
Trivial File Transfer Protocol (TFTP) is a very simple file transfer protocol, with the
functionality of a very basic form of FTP. It uses UDP as its transport protocol and has no
authentication or encryption mechanisms.
Ticker
Ticker allows you to view real time output at the device and port level, viewing data changes
as they occur. You can select to view data activity for one or more client devices or ports.
For monitored:
Ports you can select from a list of MIB variables the particular variable(s) you want to use
to monitor the port. Entuity is supplied with a default number of MIB variables for use with
ports and you can also add your own MIB variables to this list.
Devices you can create your own list of MIB variables on which to monitor the device.
traceroute
Entuity includes two types of traceroute functionality, identified in the Entuity client as
TraceRoute from Client and TraceRoute from Server.
TraceRoute from Entuity Client, calls the traceroute utility installed on the Entuity client
machine and performs a live traceroute from the Entuity client to the target IP address.
TraceRoute from Entuity Server, uses data collected by applicationMonitor. This
traceroute information is updated every two minutes, so calling TraceRoute from Server does
not initiate a live traceroute but instead interrogates the data returned from the last
applicationMonitor traceroute.
Traps
Traps can be used by network components to signal abnormal conditions. Entuity can both
receive and forward SNMP traps.
Entuity can be configured to:
Generate events in Event Viewer then traps are received.
Forward traps to up to six concurrent recipients.
h
Entuity also supply a more advanced SNMP trap forwarding integration module. Contact
your Entuity sales representative for details.
Trivial Change
A difference between a current-configuration file and a previously archived one that is not
considered important by the system because it matches a set of rules codified as patterns in
an “ignore file”. Trivial changes may include comments such as timestamps in a
configuration file.
the application being unavailable as changes in state in the dependency chain are attributed
to the switch failure.
Trunk Ports
Trunk ports, i.e. ports connecting switches together.
Entuity identifies a trunk port by:
reading the MIB.
macman identifying the switch port as having more than ten MAC addresses and also
having associated VLANs.
using CDP Trunk Port Discovery, a CISCO proprietary method.
When one or more of these methods identifies a trunk port, Entuity also considers it as a
trunk port.
Unclassified Devices
Entuity managed devices for which Entuity does not have a device support dataset, provided
through individual vendor, bin.vendor or newbin.vendor files, are included to Entuity as
Unclassified devices under Full Management, or Unclassified devices under Ping-only and
Basic Management.
Unclassified generically managed devices use an Uncertified device type, created by Entuity
and held in newbin.vendor. These are Entuity managed devices and do incur a license
charge. System Administrators should contact their Entuity support representative for a
vendor file which would ensure Entuity fully manages these devices.
Unicast
Unicast is network communication between a single sender and a single receiver.
Uplink Detection
Entuity considers an uplink as trunking on a connection to a router or layer 3 switch, which is
visible through spanning tree. This technology attempts to link layer 3 with layer 2.
Where links between switches and routers are not done using VLAN trunking and spanning
tree then the spanning tree technology will not detect them. This is typically at smaller
satellite offices, which do not need the greater port density and much greater speed available
from router on a stick and even greater speed available from layer 3 switching.
Uplinks
Ports connecting routers with switches.
Uptime
By default Entuity polls devices every five minutes, retrieving device sysuptime. Entuity
checks as to whether the device has been continually up since the last poll, and modifies the
device’s uptime value accordingly.
When sysuptime indicates the device has been down during the polling interval but is now
up, from sysuptime alone Entuity cannot identify for how long the device was down. Entuity
takes this unknown time, and adds fifty percent of it to the known uptime value, with the
remaining fifty percent considered UNKNOWN. For example where sysuptime has a value of
two minutes. Entuity cannot determine the state of the device over the first three minutes of
the polling interval. Entuity adds ninety seconds to the sysuptime value, giving an uptime
value of two hundred and ten seconds and records the device state as UNKNOWN for ninety
seconds.
Device uptime is visible through Component Viewer, and is used in many reports, e.g.
Routing Summary, Switching Summary.
Utilization
In Entuity port utilization is expressed as a percentage of actual traffic volume against the
maximum volume that can be handled by the port.
Variable Binding
A variable binding, or VarBind, refers to the pairing of the name of a MIB variable to the
variable's value. A VarBindList is a simple list of variable names and corresponding values.
Some PDUs are concerned only with the name of a variable and not its value (e.g., the
GetRequest-PDU). In this case, the value portion of the binding is ignored by the protocol
entity. However, the value portion must still have valid ASN.1 syntax and encoding. It is
recommended that the ASN.1 value NULL be used for the value portion of such bindings.
Vendor Files
Entuity identifies the device type of discovered devices by matching their sysoid to that held
against the device support datasets. Device support dataset definitions are held in, listed
here in order of precedence, individual vendor files, bin.vendor file, newbin.vendor file, and
then uncertified file.
vendinfo identifies the vendor information available to Entuity and the decisions made when
more than one vendor file is available for a particular sysoid; which vendor device definition
Entuity uses to manage that device type.
View
All network objects within Entuity are displayed through views. View filters allow you to
restrict the displayed objects in the view to the ones you are interested in. You can also use
user profiles to control access to different views.
Virtual Circuit
A Virtual Circuit is a generic term for an association established between two or more
endpoints for the purpose of user-user, user-network, or network-network information
transfer. An example would be ATM’s VCC.
Virtual Port
Entuity distinguishes between physical and virtual ports using interface type. If required
System Administrators can amend the virtual port identifier.
VLAN
A logical association that allows users to communicate as if they were physically connected
to a single LAN, independent of the actual physical configuration of the network.
VM Platforms
Entuity currently manages Oracle and VMware VMs through its VM Platform device type.
Entuity communicates with VMs and their hypervisors through the VM’s SDK. This requires
specification of different connection attributes when compared to devices of other types. It
also requires that all VMs are added to Entuity with a Ping Only management level, as this
allows the selection of the VM Platform type and its connection configuration. When adding
VMs using autoDiscovery care must be taken to ensure candidate device VMs are always
added as Ping Only.
license.dat 74 N
see License File
Name Service Cache Daemon
Licensing 61, 63, 82 see nscd
see also Central License Server
NetFlow
credits
receiving port 20, 52, 59, 83
deallocate 69
license verification 69 Netstream
license.dat 63 receiving port 20, 52, 59, 83
Object Credit Scheme 67 Not Classified Devices 119
server alert 73 Notifications
upgrading 73 SMTP server setup 89
Link Layer Discovery Protocol 109 nscd 26
Linux
arena allocation 27
configure Entuity 54
O
install Entuity 35 Object Credit Scheme 67
Name Service Cache Daemon 26 objectStatusCGI 19
RPC Port Mapper 25
rpcbind 25
server timezone 27 P
setUID configuration 27 Patches 87
system requirements 9 accessing 17
Load Balancer downloading 77
device support 109 identifying what’s applied 77
install overview 76
Log Files 36
dsKernelStatic.log 54 Port Mapper 24
EYEConfigure.log 54 portmap 25
EYEInstall.log 34 Ports
Login Requirements (for Installation) 20 defaults 19
Preparation for Installation 18, 86
M Processes
MariaDB 60 checking 60
shutdown 62 proliferate
MariaDB Server SNMPv3 duplicate engine id 21
version 85 provost 60, 61
MaxUserPort 27
registry setting 40, 82 R
requirements 27
readme file 87
Multi-Server Administration
Remedy Help Desk 113
license deallocation 69
Remote Servers 15
MySQL Database Server
change password 57 Rollup
trend data 101
mysqld 60, 62
rpc.portmap 25
rpcbind 25 tablet 10
virtual machines 12
web UI 10
S Windows 9
Scheduler 60, 61
Send to BMC Event Manager action 46 T
Server
Tablet
port 20
system requirements 10
Service Desk application 113
term signal 61
Service Packs
Ticker
download site 17
listening port 19
sFlow port setting 51, 58
receiving port 20, 52, 59, 84
Time Zone Settings
SHA-1 78, 87 Linux 27
SHA-2 78, 87 TLS Error
Shutting Down Entuity 61 Internet Explorer 10
SNMP traceroute 118
supported versions 21 TraceRoute from Client 118
SNMPv3 TraceRoute from Server 118
duplicate engine id 21
Troubleshooting
SSL 15, 38, 115 Component Viewer and JRE 11
apache configuration 23
Trunk Ports
Certificate Signing Request 22
CDP discovery 99
configuration 57
Entuity fails to start 22
listening port 19 U
requirements 22 Uncertified Device 103
Standard Servers Unclassified Device Types 103
configure 43, 56
Uninstall Entuity 81
starteye 60
Upgrading
Starting the software 60, 81 licenses 73
slow startup 60
User Authentication 15
Static IP Address default user accounts 90
Entuity server 19
stopeye 61
V
StormWorks 116
Vendor Files 121
sysoids
Virtual Machines
see Device File
hypervisor 107
System Capabilities 117
VM Platforms
System Requirements Entuity, running on 12
client 11
VMware
Linux 9
supported versions 12
W
Web Server 60, 62
port setting 51, 58
Window Firewalls
live status 18
ping application 18
Windows
automatic updates, turn off 18
command line configuration 54
Entuity services 60
firewall considerations 28
port usage setting 27
system requirements 9
Wireless Access Points 97
Worksheets
installation 82