APG Centralized Management Guide
APG Centralized Management Guide
APG Centralized Management Guide
Version 6.2u1
EMC believes the information in this publication is accurate as of its publication date. The information is sub-
ject to change without notice.
The information in this publication is provided as is. EMC Corporation makes no representations or warranties
of any kind with respect to the information in this publication, and specifically disclaims implied warranties of mer-
chantability or fitness for a particular purpose. Use, copying, and distribution of any EMC software described in this
publication requires an applicable software license.
EMC2 , EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United
States and other countries. All other trademarks used herein are the property of their respective owners.
For the most up-to-date regulatory document for your product line, go to EMC Online Support
(https://support.emc.com).
Contents
Preface iii
Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
1 Access 1
2 Quick Start 3
1 Register a Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2 Tree Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3 License Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
4 Module Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
5 Services and Modules Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . 6
6 Module Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
7 Update and Removal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4 Server Management 15
1 Charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2 Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
3 Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
5 Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6 Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
5 Module Installation 21
1 Package Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6 Module Management 25
1 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2 Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3 Configuration File Access . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4 Log File Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
5 Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
6 Removal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
7 Task Management 33
8 Package Management 35
1 Package Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
2 Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Rev : 41260
9 License Management 39
1 Licensing System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
2 License Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3 Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
10 Audit Logs 43
11 SolutionPacks 45
13 Data Enrichment 53
14 User Settings 59
Purpose
This guide provides information about configuring and using Centralized Manage-
ment.
Intended Audience
This guide is for anyone who will use the Centralized Management. Although most
of the options are explained in the interface, this document covers the major tasks of
setting up and using Centralized Management.
Prerequisites
This guide assumes Centralized Management is installed and running on the web
server, and WebServiceGateway is installed and running on any servers that will be
managed by Centralized Management.
Preface Rev : 41260
To access the interface you can log on from the APGfrontend administration panel, or
go to this URL, replacing http with https and 58080 with the APG port if needed:
http://apg.webserver:58080/centralized-management/.
For logon credentials enter your APG user name and password.
Access Rev : 41260
This section provides a brief overview of the interface, and contains links to more
detailed descriptions.
1 Register a Server
The first time the interface is loaded it displays the Server Configuration panel. From
here you register the local and remote APG servers that will be managed by Central-
ized Management.
If you’re using a basic installation where all of the modules are on the same server,
you can check that the connection is successful on the top right corner of the Server
Configuration area and press Save. If a configuration does not appear or is incorrect,
enter the correct URL and credentials and validate the connection before saving.
Quick Start Rev : 41260
The first icon in the section header shows the current connection status. You can
mouse over it to see additional information.
Check the other settings, especially the Operating System to see that they are correct.
See Remote Server Configuration on page 11.
2 Tree Navigation
After you register the first server, Centralized Management connects to it and recov-
ers information such as the server status, the modules installed on it, and provides
access to it through the navigation tree on the left.
There are two types of icons for the modules in the tree. You will see for a module
that owns a service, and for others. This makes it easier to identify modules with
log files and service management tools.
You can resize the tree by dragging its right border, and hide it by double-clicking it.
The tree keeps the same size the next time you log in on the same computer.
3 License Installation
Centralized Management enables you to keep all your APG licenses in one place and
automatically dispatch them to the proper servers.
To recover the archive that contains your licenses, see page 39.
The License File Import tool uses some features that are available in the version 4.3
of the License Manager module, so make sure that version 4.3 or later is installed.
4 Module Management
You can manage modules from the Server page. The Server page gives you an
overview of the server status and its modules, services and licenses.
The area at the top of the page contains real-time charts displaying the server health.
You can configure the charts in the Server settings (see Health Values on page 13) or
User settings (see User Settings on page 59).
From the tabs you can access your currently available services, installed modules, in-
stalled licenses and scheduled tasks. Tasks requires a specific module to be installed
and started before it becomes available. For details about each page see Server Man-
agement on page 15.
The Services panel displays the state of services and the estimated time for startup
or shutdown.
On Windows systems, some services such as MySQL may not display these times.
The Modules panel displays the installed modules and their services. It also highlights
the ones that have updates.
You can click any line to see details about a module. The module information is dis-
played in a new page. You can quickly move between modules to start their services
and check their logs.
6 Module Installation
2. Select the categories for the modules you want to install and their corresponding
packages and click Launch.
The list on the left shows the installation progress. The module in green has already
been processed. The one with the star is the current one.
The installation process is the same as the one from the command line interface.
There are multiple ways to answer a question. You can:
• enter the full choice in the input field and press Enter
• enter the highlighted character using the same case and press Enter
You must answer a question within 5 minutes or the installation of the module will be
cancelled. You can install the module at a later time.
Warnings and errors are displayed in the panel, with additional details in the log files
of the Webservice Gateway on the remote server.
You must update or remove a module from the module. You can remove a module by
clicking Uninstall. When an update is available, a notification appears.
The configured servers are displayed with their connection state. You can click a sec-
tion name to display or hide its settings.
To register additional servers click the corresponding button and enter the details
about the server. Some settings are not mandatory, but may be required depend-
ing on the remote server configuration for Centralized Management to successfully
connect to the remote server.
Server Alias customizes the server display name in Centralized Management with-
out any other impact. If you do not create a Server Alias, the hostname is used.
Gateway URL contains the URL that points to the remote WebService Gateway.
The default configuration is: https://server.name.or.ip:48443/. The WebService
Gateway service must be running on the remote server for this to be working.
Username is the one from the Gateway credentials. It’s configured at its level, and
described in its own documentation. Default value is admin.
Password is the one from the Gateway credentials. It’s configured at its level, and
described in its own documentation. Default value is changeme.
SSL Validation can be checked in order to validate the SSL certification before
instantiating communication. When using a self-signed certificate, it should be left
unchecked. When using a certificate recognized by a certificate authority, it should be
checked.
Operating System will be used to select the packages to send and use on this
server. Be sure to set it to the correct value, as setting it to a wrong value causes
invalid or corrupted installations.
Health Values configures the type of data that will be recovered and displayed for
this server. Real-time data is collected through the APG Self-Monitoring Collector
which provides real-time access to the server metrics. Historical data is retrieved from
the usual APG database(s) and is also based on the metrics collected by that col-
lector. Databases are defined in the web application context file. See the section on
page 61. The physical overview displays historical data if it is enabled. The per-server
view displays real-time data if it is enabled, and if not it falls back to historical data. If
it is disabled, charts are hidden.
1 Charts
The charts on the top of the page can be configured to display a combination of
historical data and real-time data, or historical data only or can be hidden. There are
two levels of configuration for this: on a server basis (see Health Values page 13, or
per-user (see Chart Refresh page 60).
2 Tabs
Each of the initial tabs cover a specific aspect of the server management. This section
discusses the way dynamic tabs are added to the navigation bar.
The Services, Modules and Tasks tabs create dynamic tabs based on the contents of
their tables. Each line of the tables describes an item that you can click to see more
details about.
Server Management Rev : 41260
Clicking a line opens a new tab or moves the focus to it if it is already open.
A module never generates two tabs, even if you open it from the Services panel and
the Modules panel.
3 Services
The services panel displays the modules that have a service configuration, including
modules whose service entry has been removed.
The table displays the module information, its current service status, and an estimate
of its last status change. The status column can have multiple values depending on
both the service properties, and its current state.
• not installed: the service has been removed and is not available anymore
Every time the services panel is displayed, is automatically refreshed. You can man-
ually reload the Services panel by clicking Refresh on the top of the panel.
You can drill down to the Service page through the icon on the left of the module
name. This does not open another tab but replaces the current page with the new
module details.
4 Modules
The Modules panel displays a list of the installed modules and their services, and the
ones that have updates.
5 Licenses
To see the Licenses panel you must have License Manager installed on the remote
server with version 4.3 or later.
This panel contains the same level of information as the global licenses management
(see section License Management on page 39), with the server host ID and licenses
status, but only for one server. It displays the licenses that are currently installed on
the server, and not the ones in the local repository.
Refer to this panel when you are requesting licenses for the first time, as it displays
the server host ID required to generate them. Click it to select it and copy and paste
it.
6 Tasks
To see the Tasks panel you must have have a Task Scheduler running on the remote
server. It provides a summary of configured tasks and details about their execution
status.
Mouse over the status icon to see details about the status of tasks. This example
shows the pending task is configured to be launched when the first one finishes, which
explains why it is not running yet.
You can click the task to show detailed information about the task and access its
configuration and log files, and management tools. These panels are covered by
section Task Management on page 33.
You install modules from the Modules panel from a server page by clicking the Install
button, or by using the SolutionPacks dialog from the top menu bar.
1 Package Selection
Packages are displayed in categories, which makes it easier to find a specific package.
3. Click the Launch button. The Module Installation dialog box appears.
4. Specify an instance name. That field contains a default value but you can change
it. Click Launch.
You must answer each question within 5 minutes or the module installation process
will be interrupted which can cause an inconsistent state on the remote server for the
module.
If a module installation fails, click the Skip button to go to the next one.
• on the Server page, by clicking on service or module line or the drilldown icon
for a service or module
1 Properties
This section describes basic module properties: module category, name and descrip-
tion.
The module current version is one of the most important properties when requesting
information or support for a module. It is independant from the main APG release
number. The path, relative to the main APG installation directory, gives a way to
quickly find the module location.
For each modules, a link is provided to its documentation. Click it to download and
display the file or right-click it to save the document to your computer.
Module Management Rev : 41260
2 Services
If the module has a service, status information is available in that section, along with
buttons to Start, Stop and Restart the service. If the buttons are not available for a
service, the service cannot be managed through Centralized Management.
• all buttons are grayed means the Centralized Management does not have
enough rights to perform operations on this service. This can apply to any ser-
vice that requires administration privileges, such as the Collector Manager when
running the ICMP Collector.
• only a restart button occurs when looking at the Tomcat server used to run
Centralized Management. The restart command is available, but if it were to fail,
you must manually connect to the server to fix the issue.
The table displays only the files that are identified by the module as configuration files.
You can click Upload a file to select a file from your computer and upload it to the
remote server’s conf directory. If the file is not detected as a configuration file, it does
not appear in the list.
You can reload the contents of the table by clicking the Refresh icon at the top right
corner of the section. It is automatically triggered when a file is uploaded or edited.
Schemas may be needed when editing a file, or to check the validity of a configuration.
You can display them by selecting the show schema files check box.
There are two ways to edit a configuration file. To directly edit a file, you can either
select its line (click the line itself or on the corresponding checkbox), and then click
the Edit button below the table (see figure 28 on page 26, or click on the pencil icon
inside the Filename cell.
If Centralized Management does not detect the file type, you can manually specify it in
the toolbar (the second dropdown). The editing area enables you to edit configuration
files with the help of syntax highlighting. Other tools and features are available in the
toolbar, but some may not render or work properly in your browser. After you have
made your changes click Save and the file will be updated on the server.
There is currently no configuration validation at the moment, so the file will always
be saved, even if not valid. However, restarting the component that uses the file will
trigger and log an error about it.
You can select multiple files and click the global Edit button to open all files in one
editor, each in its own tab. You can then quickly switch between files to modify them.
Files are listed here in the order of the last modification, so usually the first one of
the table is the one you want to look at. The number of files is defined in the logging
configuration file, most of the times called logging.properties.
There are three ways to view log files: by clicking the icons in front of each log file-
name, or by using the file selection tool and the Download button to archive the logs
you select and display the resulting file.
To view the contents of a log file, click the View icon (see figure 35 on page 29). This
opens a viewer or downloads the file if it is bigger than the size limit of 1 MB. The view
is not updated if the file contents change on the disk.
To follow a log file that is being written to, click the Tail icon (see figure 36 on page
30). This opens a viewer and new lines are appended to the end of the file as they
are written to the log file.
If the viewed log is in a supported format (the default APG log formatter), in the log file
viewer some fields will be highlighted in different colors. For example, WARNING and
ERROR messages will be highlighted in orange and red.
5 Update
When new versions of a module are available, either by running the setup of a new
APG release, or uploading new packages to the central repository, a notification ap-
pears in the module page. At the top right corner of the module properties, the update
button is set to update to the latest version.
If different versions are available, the button will have an additional option on its right
in order to select the version to update to. For example, if a module is version 1.0, and
versions 1.1 and 1.2 are available, all of these options appear in the list, ordered by
descending version.
6 Removal
You can remove a module that has been installed by mistake, or been moved to an-
other server by clicking the Uninstall button at the bottom of the Module page.
You perform task management through the Server Management page. See Tasks
section on page 19 for the list of tasks. Click a task in the table to display its current
properties, status, and statistics. This gives an overview of the task use and its ex-
pected run time.
You can access the task configuration file, and the log files for each execution of the
task, which can help you discover why a task did not complete successfully. See
Configuration File Access page 26 and Log File Access page 29 for details about the
actions available for these files.
Task Management Rev : 41260
If a task is running, or has been launched using the on-demand Run Now button,
the run time is displayed with a progress estimate based on the average duration of
previous runs.
You can cancel a pending task execution or interrupt it once started. There is no confir-
mation and the task is immediately cancelled. See the Task Scheduler documentation
for details about APG scheduling tools.
This section explains how to manage packages using Centralized Management, and
how packages are used when installing or updating modules.
The Packages Listing displays the package names, versions and operating systems.
Operating system is important as it determines whether the package can be installed
Package Management Rev : 41260
Mouse over the Status column to see where packages are installed. You can install a
package multiple times on a same server, so the installation count can be higher than
the number of servers shown in the tooltip.
1 Package Upload
Click the Upload button to upload a package to the Centralized Management package
repository, which is usually located at Tools/Module-Repository.
You can either select the file to be uploaded or use the synchronization options.
2 Synchronization
Synchronization has these options: packages can be retrieved, cleaned up remotely,
or discarded from the repository. Most packages can be selected together in a single
synchronization action.
Retrieve the latest packages connects to each server and fetches the latest ver-
sion of their packages. This is the easiest way to install new packages as it runs the
APG installer and then runs the synchronization.
Retrieve all the packages retrieves every available package from the servers, not
just the latest ones. This is useful if you need a version that is not the most recent
one.
Remove remote packages performs a cleanup on the remote servers. For each
server, every package that is not installed on it is removed from its repository to free
the disk space on the server.
Remove old versions from repository performs a cleanup on the Centralized Man-
agement package repository and keeps the most recent version of each package,as
well as all the versions that are currently installed on the remote servers.
A summary is displayed for each server with the count of globally added or removed
packages and the file size. On the central repository, adding 2 packages and removing
5 results in a count of -3.
This section explains how licenses can be managed using Centralized Management
and how it facilitates their installation.
1 Licensing System
Starting with APG 6.0, licenses are linked to a host. To generate a license you require
a license key. You can recover your license keys from the Licenses Management page
but this requires that you have at least one available license, or from the the Server
Licenses panel see page 18, which is available for each registered server.
Click the host ID and copy it. A manual APG installation, on which the License Man-
ager or Centralized Management are installed does not require a license. So it can
be installed, and then used to know the host ID of the server before requesting the
licenses.
The host ID is a unique identifier generated by APG. It does not come from the com-
mand hostid. You can use the License Manager executable, manage-license, in the
APGbin directory to generate the host ID of the server.
The first time this page loads it is empty, but after you upload some licenses, it lists all
the available licenses, ordered by their host ID.
There is one section per host ID, with the license count and matched server. A mes-
sage appears if a set of licenses does not match the registered server. Each line has
a status icon that shows the current license status.
Licenses are stored on the Centralized Management server, under Tools, License-
Repository, which contains one directory per server host ID with the associated li-
censes. We recommend you do not manage licenses manually from this repository,
but instead manage them from Centralized Management.
License Management Rev : 41260
2 License Upload
Centralized Management can perform the automatic dispatch of licenses, which makes
it easy to install licenses on multiple servers. To add new licenses click Upload. You
can upload .lic files or .zip archives.
3 Synchronization
License synchronization is also available. This is useful when licenses have been
installed or removed while the server was not reachable or unregistered. Synchro-
nization is done based on the Centralized Management license repository. It does not
recover licenses that are already installed.
Uninstall licenses uninstalls and removes licenses that are not available in the Cen-
tralized Management license repository. You cannot recover these licenses except if
you have stored the license files elsewhere.
Install new licenses searches the licenses in the Centralized Management reposi-
tory and makes sure they are properly installed on every remote server that is reach-
able. This is the most commonly used synchronization option.
The Audit Files page connects to the registered servers and recovers the available
audit log files. They are listed in order of the last modification time, and you can view
them individually or download them as an archive.
The SolutionPacks are the easiest way to install and configure all that is needed for
a specific collect and reporting. To install a new SolutionPacks, click on the Solution-
Packs Center button in the top menu bar.
Each SolutionPack has its own details page explaining their benefits and expected
content. Choosing a SolutionPack to install will lead to the servers selection options if
all the required licenses are available.
In this page, you’ll be prompted to select an installation name that must be unique
on each selected servers. Each components can be distruted among all the available
servers and/or if needed, be installed multiple time on the same server with a different
instance name. A server may be disable for the following reasons:
• Instance already used: If the component is already installed with the same in-
stance name, the server won’t be selectable.
• Missing licences: Some servers may not be up to date in term of installed li-
censes. If a server is missing a needed license for a specific component, it
won’t be selectable.
• Server unreachable: If there’s a communication problem between the Central-
ized Management and a specific server, it won’t be selectable.
Once all the desired components are distributed on the right server, the next steps will
be a series of questions per component in order to configure them correctly.
All the installed SolutionPacks are available in the SolutionPacks node of the browsing
tree.
Each known SolutionPack will have its own entry in the top table while the unknown
installed components will be displayed on the bottom table. Selecting a SolutionPack
will lead to the page describing all the installed components and their location. For
each component, it’s possible to do the following:
The Central Configuration Repository provides a simple way to edit configuration el-
ements that are shared between several SolutionPacks and SolutionPackBlocks. For
instance, the same Event Database could be used for the SMARTS Events as well as
VMware Events.
The main page of the Central Configuration Repository contains all the editable con-
figuration elements across the registered servers. Each element is described by its
name, its parameters and the SolutionPacks referencing it. Clicking on an item of the
list opens the edition page of this particular element.
As the list size quickly increases with the installation of new SolutionPacks, it is rec-
ommended to use the search field to easily retrieve a specific configuration element.
In the figure above, a SMARTS Broker configuration is selected. Its name is Broker,
its parameters are an IP address and a port and it is referenced by two SolutionPacks.
Central Configuration Repository Rev : 41260
The top of the edition page contains the element’s parameters while the bottom con-
tains the list of SolutionPackBlocks referencing this element.
• Select the SolutionPackBlocks that will be updated with the new parameters.
The SolutionPackBlocks that are not selected will keep the previous configura-
tion.
• Click on the Apply button.
The data enrichment page allows the user to quickly add some tagging on data
coming from a collector-manager or an event-processing-manager.
To be able to tag some data the collector manager and/or the event-processing-
manager must be running, and they must contain at least one property tagging filter
(for the collector manager) and one event property tagger (for the event processing
manager).
• WS not Supported: The module is running but we cannot get a response from
the webservice. Maybe the module is too old and doesn’t support the web ser-
vice.
Register a new module allows the user to add a new property tagging filter or a new
event property tagger to the list of tagging.
After opening the Register a new module page, the user must select a server,
then a category and finally the list of property tagging filter and event property tagger
to register.
To be able to register a module, the target collector manager and/or event processing
manager must be running.
Remove allows the user to remove one or multiple tagging. First, the user must select
the tagging(s) to be removed, and then press the Remove button.
To access the tagging, the user must either click on the tagging from the list of the
data enrichment page, or directly select the node from the tree. Then the following
page will be displayed.
Save will save all the changes made to all the tagging.
Delete (small trashcan on the right) will completely remove the selected tagging.
If the property tagging filter or event property tagger configuration contains some ac-
cessors, it will not be possible to use the GUI to modify the data.
To make some change on a tagging, simply expand the tagging by clicking on it.
To modify a value, you must click on it. A textbox will appear and the user will be able
to modify the value, pressing the Enter key will commit the change. The modified
value will then be in blue italic. Example:
The user can also press the TAB key which has the same impact, except that after
the commit the focus will move on the next cell.
If you see a value in red italic, it means that the value was not correctly written in the
property tagging filter or event property tagger data file. You cannot modify that value,
but you can delete the row.
When clicking on a key value, a list of special values can be selected. The @EMPTY
and @NULL options are there to differentiate between an empty and a null value. The
@DEFAULT option represent the default-symbol attribute of the property tagging filter
or event property tagger configuration, see the documentation of those modules for
more information on that attribute.
The @NULL option is only available if the null-symbol attribute is present in the prop-
erty tagging filter or in the event property tagger configuration.
For creating and deleting rows, you must click on the small icon at the left of the
row, and then the following contextual menu will be displayed.
To add a new key or property, you must click on the appropriate button, either Add
new key or Add new property, then the following windows will be displayed.
To remove a key or property, you must click on the icon (small trashcan) beside the
column name.
This section describes the settings available for each user in Centralized Manage-
ment. To access the user settings, on the top right of the menu bar click User Settings.
Language defines the language used for the interface. The lanaguage you choose
here determines the language used for APG, so if you change the language here, it
also changes in APG.
Chart Refresh controls the refresh rate of the real-time charts shown on the server
pages.
The timeseries databases are used to retrieve and display historical health data for
the registered servers. Check that the configured sources fit your installation, or the
charts will be empty.
<?xml version="1.0" encoding="UTF-8" ?>
<Context reloadable="false">
<!-- Gives access to the users, profiles, roles and rights. -->
<ResourceLink name="jdbc/master" global="jdbc/master" type="javax.sql.DataSource" />
</Context>