ESA Installation Instruction
Ericsson SNMP Agent 16.0

Contents

1About This Document
1.1Purpose
1.2Target Group
1.3Prerequisites
1.4Typographic Conventions

2
System Requirements
2.1Overview
2.2Hardware
2.3Operating Systems
2.4Java Virtual Machine

3
ESA Software
3.1Overview
3.2ESA Basic Package
3.3IBM Netcool SSM

4
Overview
4.1Installation Procedure
4.2Default Configuration

5
Installation ESA Basic Package
5.1Introduction
5.2GUI Mode Installation
5.3Console Mode Installation
5.4Silent Mode Installation
5.5Linux RPM Installation

6
Installation IBM Netcool SSM
6.1Introduction
6.2Installation SSM

7
Uninstallation ESA Basic Package
7.1Introduction
7.2GUI Mode Uninstallation
7.3Console Mode Uninstallation
7.4Silent Mode Uninstallation
7.5Linux RPM Uninstallation

8
Uninstallation IBM Netcool SSM

9
Scala-library 3PP license text

Glossary

Reference List

1   About This Document

1.1   Purpose

The purpose of this document is to describe the installation procedure for the Ericsson SNMP Agent (ESA). Also, this document describes how to uninstall the ESA.

1.2   Target Group

The target group for this document is personnel responsible for the installation of the ESA.

1.3   Prerequisites

It is assumed that the user of this document fulfils the following prerequisites.

1.4   Typographic Conventions

The typographic conventions used in this document are described in Reference [1].

2   System Requirements

2.1   Overview

To be able to install the ESA a few system requirements have to be fulfilled. The system requirements are related to:

2.2   Hardware

The hardware specifications as such are no issue for the ESA. The modern hardware of today is more than enough for running the ESA.

However, the following architectures are required to run the ESA:

2.3   Operating Systems

The figure below shows the operating environments supported by ESA

Figure 1   An overview of the ESA supported platforms.

If other platforms are of interest, please contact the ESA Support.

2.4   Java Virtual Machine

In order to run the ESA, a Java Virtual Machine is required. The following are supported.

Other vendor's Java or lower versions of JVMs than the ones listed above are not supported by the ESA. Keep in mind that the ESA might work on other Java variants and versions, but it is not verified and therefore not officially supported by the ESA.

Use the following instructions to check the java version and vendor of the installed JVM on your system.

Linux/Unix # java -version
Windows C:\> java -version

Example output:

java version "1.8.0_66"
Java(TM) SE Runtime Environment (build 1.8.0_66-b18)
Java HotSpot(TM) 64-Bit Server VM (build 25.66-b18, mixed mode)

3   ESA Software

3.1   Overview

The ESA software consist of software packages for the ESA Basic Package and software packages for the optional component; IBM Netcool SSM.

Figure 2   The ESA Product Package.

The IBM Netcool SSM package has to be separately purchased.

3.2   ESA Basic Package

The following software packages are for the ESA Basic Package.

3.3   IBM Netcool SSM

If the SSM option has been purchased, one or several of the following packages are also to be considered during installation.

The following software packages are for the IBM Netcool SSM option. They shall be deployed in the order of appearance.

Please not that if available fix packs and/or patches for the IBM Netcool SSM component, they need to be installed separately.

4   Overview

4.1   Installation Procedure

The ESA deployment operations are executed depending on what options have been purchased.

The following figure visualizes the deployment paths to execute.

Figure 3   The deployment procedure for the ESA

Go to the following sections in this document for the following tasks.

4.2   Default Configuration

During the different installation procedures a number of questions are asked. The Custom installation has more questions than the Default installation. The Silent installation has no questions, but can take a response file that can contains any number of parameters. The less questions that are asked, the more default values are given to the ESA being installed.

The following default values are used for the parameters asked for during any installation procedure.

5   Installation ESA Basic Package

5.1   Introduction

The installer application can run in three different modes; GUI, Console and Silent.

The following modes are the manual installation methods, which means they require human interaction.

The following modes are unattended installation methods, which means human interaction is not needed.

Attention!

In order to run ESA 16 on Red Hat Enterprise Linux version 7.2, the following ERRATA needs to be installed: https://rhn.redhat.com/errata/RHBA-2016-0199.html.

5.2   GUI Mode Installation

The GUI installation provides three different procedures.

The GUI mode installation procedure:

  1. Login to the server where the ESA is to be installed.
  2. Prepare the ESA software package(s) to install. See Section 3.2.
  3. Start the installer application in GUI mode.
    Unix # sh esa-<version>.sh
    Windows C:\> esa-<version>.exe

    The installer application is preparing to install.

  1. The ESA installation application starts and the ESA software information is displayed.

    Throughout the installation process, where needed, click Back to return to the previous window or Cancel to stop the installation and leave the installation process.

    Click Next to continue the installation process.


  1. The license text is displayed.

    Read the license text, make the selection I accept the agreement and click Next.


  1. The following GUI installation types can be selected.
    • Default Installation

      The ESA parameters are given default values. See Section 4.2, which presents the default values used.

    • Custom Installation

      The ESA parameter values can be customized.

    • Create Response File

      This installation type does not install the ESA. It is a Custom Installation type which ends creating a response file holding all ESA parameters and the specified values. The response file can be used in the Silent Installation mode.

    Click Next to continue.

    If Default Installation is selected, click Next and go to Step 16

    If Custom Installation or Create Response File is selected, click Next and go to Step 7.


  1. This step is applicable for Custom Installation and Create Response File.

    Enter the ESA installation directory.

    Click Next to continue.


  1. Enter the ESA log directory.

    Click Next to continue.


  1. Enter the directories for the ESA configuration files and the generated 3GPP XML files.

    Click Next to continue.


  1. Configure the IP addresses and ports for the ESA.

    It is recommended to keep the default values. In order to avoid port collisions in the system, ensure that already used ports are not chosen for the ESA.

    Please note that when selecting to bind an interface to 127.0.0.1 it means that the interface allows local access only.

    For more information about configuring the ESA interfaces, see Reference [2].

    Master Agent

    SNMP The Master Agent binds to the selected IP address for two reasons. It will listen on the selected port for only the selected IP address. And, it will use the selected IP address as the trap sender IP address. By selecting "All interfaces" the Master Agent will listen on the specified port on all IP addresses and use the default IP address as sender IP address.

    Default port: 161

    AgentX Select the IP address and enter port number for the AgentX interface to bind to. Binding AgentX to an IP address means the subagents can only register themselves on the specified IP address even though there are multiple interfaces in the system. By selecting "All interfaces" the subagents can register themselves on the specified port on all IP addresses.

    Default port: 705

    RMI The Master Agent binds to this IP address for handling the Master Agent API RMI interface. By selecting "All interfaces" the Master Agent will receive API operations on the specified port on all IP addresses.

    Default port: 7666

    FM Agent

    SNMP The FM Agent binds to this IP address for reception of SNMP traps to translate. By selecting "All interfaces" the FM Agent will receive traps on the specified port on all IP addresses.

    Default port: 8162

    RMI The FM Agent binds to this IP address for handling the FM API RMI interface. By selecting "All interfaces" the FM Agent will receive API operations on the specified port on all IP addresses.

    Default port: 8666

    PM Agent

    RMI The PM Agent binds to this IP address for handling the PM API RMI interface. By selecting "All interfaces" the PM Agent will receive API operations on the specified port on all IP addresses.

    Default port: 9666

    Click Next to continue.


  1. Activate or deactivate the alarm handling controllers.

    • Activate Alarm Flooding Control (AFC)

      Check the box "On" to make the AFC option active.

    • Activate Alarm Clear Control (ACC)

      Check the box "On" to make the ACC option active.

    For more information about alarm controllers, see Reference [2].

    Click Next to continue.


  1. Enter community strings for the ESA.

    Define the SNMP v2c community strings for the ESA by entering the values for the following parameters. It is recommended to keep the default values.

    For more information about community strings, see Reference [2].

    ReadOnly Enter the community string allowing read-only access.

    Default value: ESA-PC

    ReadWrite Enter the community string allowing read and create access.

    Default value: ESA-PE

    Click Next to continue.


  1. Enter one or several trap destinations.

    This step is optional. The trap destination is the address to where to send the SNMP alarms from the ESA. Specify the trap destinations by entering the desired values for the following parameters. If trap destinations are not defined, the ESA can still execute normally, but there are no SNMP traps sent.

    For more information about trap destinations, see Reference [2].

    Host / IP Enter the host name or the IP address of the trap destination. No default value is assigned.
    Port Enter the port number of the trap destination host.

    Default value: 162

    Click Next to continue.


  1. Enter system information.

    This step is optional. Specify system information by entering the desired values for the following parameters.

    For more information about ESA Information Agent configuration, see Reference [2].

    System Vendor Enter the vendor name of the system where the ESA resides.
    System Name Enter the system name of the system where the ESA resides.
    System Abbreviated Name Enter the abbreviated system name of the system where the ESA resides.
    System Version Enter the version of the system where the ESA resides.

    Click Next to continue.


  1. Make the selection to start the ESA after installation or not.

    Check the box for an automatic start of the ESA after the installation is finished. Unchecking the start of the ESA after installation option, results in that the ESA is not started and must be started manually.

    However, it does not affect the default setting that automatically starts the ESA after a restart of the entire system. For more information about ESA startup settings, see Reference [2].

    Click Next to continue.


  1. This step is applicable for all installation types.

    All parameter values are presented in an installation summary.

    Scroll through the installation summary to review the parameter settings. If anything has to be corrected, go back to the former window of interest, by clicking Back the required number of times, change the setting(s), and then click Next until returning to the installation summary.

    If Create Response File is selected, click Next and go to Step 17.

    If Default Installation or Custom Installation is selected, click Next to start the installation and go to Step 20.


  1. This step is applicable for Create Response File only.

    Select target directory and file name for the response file.

    Click Next to create the response file.


  1. Summary of response file creation.

    The response file is created. Click Finish to end the installation.

  2. This is the end of installation type Create Response File.

  1. The ESA is being installed and configured on the system.

    Please wait for the process to finish!

  2. The ESA is installed.

    Click Finish to end the installation.

  3. An installation log file is created at {esa basedir}\.install4j\installation.log.

    A response file, which is holding all installation parameters, is created at {esa basedir}\.install4j\response.varfile.

  4. The ESA is ready for operation.

    If the option to start the ESA automatically after the installation was not selected, the ESA can be started manually. See the start/stop instructions in Reference [2].

  5. This is the end of installation types Default Installation and Custom Installation.

5.3   Console Mode Installation

The console mode is a manual installation method using no GUI. It mimics the GUI Mode installation steps and uses standard input and output (keyboard and monitor).

The Console mode installation procedure:

  1. Login to the server where the ESA is to be installed.
  2. Prepare the ESA software package(s) to install. See Section 3.2.
  3. Start the installer application in Console mode.
    Unix # sh esa-<version>.sh -c
    Windows C:\> start /wait esa-<version>.exe -c

    The installation can at any time be stopped by using the operating environment key combination for stop process, such as using key combination CTRL+C.

    C:\>This will install Ericsson SNMP Agent on your computer.
OK [o, Enter], Cancel [c]

    Press Enter to continue the installation process.

  4. From this point the installation flow is the same as for the GUI mode installation. Please follow the GUI mode installation procedure in Section 5.2 to proceed with the Custom mode installation.

5.4   Silent Mode Installation

5.4.1   Introduction

The silent mode is an unattended installation method, which means it installs the ESA with a single command line and no human interaction is required.

In silent mode, the installer application runs without any user interaction. Instead, it runs either on the default values, or by providing a response file from which the installer application retrieves the values for various variables used to control the installation. If no response file is given, the silent mode will use the default values.

The silent mode is fully supported on all platforms.

5.4.2   Recording an Installation Response File

The response file is created by running the installation in GUI Mode or in Console Mode. Both modes support the option "Creation of response file", which means a normal installation flow is executed, but instead of installing the ESA it ends with creating a ready-to-use response file on the file system.

Go to Section 5.2 and follow the steps for "Create Response File".

5.4.3   Installation Response File Parameters

The response file can manually be created or edited after a recording. It utilizes a simple "key=value" format. Any basic text editor can be used to work with the response file.

All parameters in the response file are described in more detail in Reference [2].

Caution!

On Unix and Linux; Do not use character [space] in the install path! If you do, the installation will fail.

On Windows; It is allowed to use character [space] in the install path.
Do!

For all parameters indicating a directory on Windows the characters ":" and "\" require an additional "\" in front of it.

Example: c\:\\Program Files\\Ericsson\\Ericsson SNMP Agent

The following parameters can be specified in the response file. Parameters that are not specified in the response file are given default values according to Section 4.2.

5.4.4   Example Installation Response File

The following is an example installation response file. It is ready to be used as is. The parameters in the response file can be added in any order. Please note that this example file does not come with a defined trap destination.

#install4j response file for Ericsson SNMP Agent <version>.
#Mon Feb 23 12:00:00 CEST 2015
sys.installationDir=/opt/esa
directories.configuration.fmAlarmDefinitions=/opt/esa/conf/fmAlarmDefinitions
directories.configuration.fmAlarmTranslations=/opt/esa/conf/fmAlarmTranslations
directories.configuration.pmCounters=/opt/esa/conf/pmCounters
directories.configuration.pmJobs=/opt/esa/conf/pmJobs
directories.configuration.pmThresholds=/opt/esa/conf/pmThresholds
directories.output.log=/var/log/esa
directories.output.pm3gppXml=/var/log/esa/pm3gppXml
interfaces.snmp.masterAgent.ip=
interfaces.snmp.masterAgent.port=161
interfaces.agentx.ip=
interfaces.agentx.port=705
interfaces.rmi.ma.ip=
interfaces.rmi.ma.port=7666
interfaces.snmp.fmAgent.ip=
interfaces.snmp.fmAgent.port=8162
interfaces.rmi.fm.ip=
interfaces.rmi.fm.port=8666
interfaces.rmi.pm.ip=
interfaces.rmi.pm.port=9666
community.readonly=ESA-PC
community.readwrite=ESA-PE
trapdest=
fm.controllers.acc=on
fm.controllers.afc=on
infoSystem.name=
infoSystem.nameAbb=
infoSystem.vendor=
infoSystem.version=
startAfterInstall=no

5.4.5   Silent Installation Procedure

The silent mode is an automated installation method using no GUI, which means it uses no standard input and output (keyboard and monitor). Instead a response file can be used as input data to the installation procedure. If the Silent mode installation is executed with no response file or with a response file holding only a few parameters, the installation enters default values where applicable (see Section 4.2).

The Silent mode installation procedure:

  1. Login to the server where the ESA is to be installed.
  2. Prepare the ESA software package(s) to install. See Section 3.2.
  3. Installation on Unix: Execute the Silent mode installation.
    • ...with response file.

      # sh esa-<version>.sh -q -varfile <filename>

    • ...without response file.

      # sh esa-<version>.sh -q

  4. Installation on Windows: Execute the Silent mode installation.
    • ...with response file.

      C:\> start /wait esa-<version>.exe -q -console -varfile <filename>

    • ...without response file.

      C:\> start /wait esa-<version>.exe -q -console

    Note:  
    Argument -console only provides the option to output the installation text to the console. It can be left out.

  5. The installation is performed in one single operation. This is the end of the Silent mode installation.

5.5   Linux RPM Installation

The Linux RPM installation does not follow the GUI, Console and Silent mode installation procedures and also it does not come with the flexibility provided by the others. Instead, the RPM installation provides a basic installation with default values.

The Linux RPM installation procedure:

  1. Login to the server where the ESA is to be installed.
  2. Prepare the Linux RPM software package. See Section 3.2.
  3. Install the ESA Linux RPM package.

    # rpm -ivh esa-<version>.rpm

  4. The Linux RPM package is installed.

Please note that setting the ESA configuration parameters is done after the RPM installation.

6   Installation IBM Netcool SSM

6.1   Introduction

The IBM Netcool SSM is installed separately from the ESA Basic Package, which means the SSM binaries, configuration files and log files are not found in the ESA directories.

The SSM installer application can run in two different modes; Console and Silent. A GUI mode installation procedure is only supported on Windows.

6.2   Installation SSM

The installation procedure:

  1. Login to the server where the SSM is to be installed.
    Linux/Unix Login as user root.
    Windows Login as the system administrator.
    Note:  
    The reason for installing as user root is that the SSM requires access to system resources for efficient and proper system monitoring.

  2. Prepare the SSM software package(s) to install. See Section 3.3.
  3. Install the SSM main software package.

    The following command line format is used for Unix/Linux.

    ./netcool-ssm-<version>-<xxxx>-<platform>-<arch>.installer [install|upgrade] [silent|record] [<param>=<value> ...]

    The SSM installation is a bit different on Windows from Linux/Unix. Both interactive and unattended (silent) installation methods are however supported on all platforms. An SSM installation can be recorded, which means creating a response file.

    The installation takes a number of parameters. The following requires special attention.

    1. Port Number

      Since the ESA Master Agent normally uses port 161, it is recommended to choose port 7161 for the SSM. Port 7161 is predefined in the ESA proxy configuration.

    2. Community String

      Community string "private" is predefined in the proxy configuration. If another community string is used, the ESA proxy configuration must be changed as well.

    3. Trap Version

      It is recommended to use SNMP version v2c for the alarms sent from the SSM to the ESA.

    The following is a frequently used installation command line example for installing the SSM using the silent installation procedure.

    ./netcool-ssm-<version>-<xxxx>-<platform>-<arch>.installer install silent CONF_UDPPORT=7161 CONF_TRAPVER=2

    See SSM documentation Reference [3] for further details and options about installing the SSM.

  4. Installation log file ssminstall.log is found in the {ssm basedir}/log/.
  5. Install the Fix Pack patch package.

    See SSM documentation Reference [5] for further details and options about installing the SSM Fix Pack.

  6. Install additional patch packages.

    See SSM documentation Reference [5] for further details and options about installing the patches.

  7. Installation is finished.

7   Uninstallation ESA Basic Package

7.1   Introduction

This section describes how to uninstall the ESA on the different platforms using the different uninstallation modes.

Warning!

Please note that the uninstallation deletes all the configurations files and log files from the ESA install directory!

7.2   GUI Mode Uninstallation

Uninstall the ESA by executing the following procedure:

  1. Login to the server where the ESA is installed.
  2. Uninstall the ESA.
    Unix # {esa basedir}/uninstall
    Windows Uninstall the ESA using the Windows Control Panel.
  3. The ESA is uninstalled.

7.3   Console Mode Uninstallation

Uninstall the ESA by executing the following procedure:

  1. Login to the server where the ESA is installed.
  2. Uninstall the ESA.
    Unix # {esa basedir}/uninstall -c
    Windows C:\> start /wait {esa basedir}/uninstall.exe -c
  3. Confirm uninstallation.

    Are you sure you want to completely remove Ericsson SNMP Agent
and all of its components?
Yes [y, Enter], No [n]

    Press Enter to continue uninstallation.

  4. The ESA is uninstalled.

7.4   Silent Mode Uninstallation

Uninstall the ESA by executing the following procedure:

  1. Login to the server where the ESA is installed.
  2. Uninstall the ESA.
    Unix # {esa basedir}/uninstall -q
    Windows C:\> {esa basedir}/uninstall.exe -q
  3. The ESA is uninstalled.

7.5   Linux RPM Uninstallation

Uninstall the ESA by executing the following procedure:

  1. Login to the server where the ESA is installed.
  2. Uninstall the ESA.
    Linux # rpm -e esa
  3. The ESA is uninstalled.

8   Uninstallation IBM Netcool SSM

Uninstall the SSM by executing the following procedure:

Linux/Unix

  1. As the root user, verify that the SSM agent is not running. If the agent is running, stop it.
  2. Move to the SSM bin directory.

    # cd {ssm basedir}/bin

  3. At the shell prompt, enter the command:

    # ./remove-ssmagent

  4. The SSM and its directory tree are removed.

Windows

  1. Use the Windows Control Panel to initiate an uninstallation.
  2. The SSM uninstaller removes all files and directories in the SSM installation.
  3. The SSM and its directory tree are removed.

See SSM documentation Reference [3] for further details and options about uninstalling the SSM Main Package.

9   Scala-library 3PP license text

"Copyright (c) 2002-2016 EPFL Copyright (c) 2011-2016 Typesafe, Inc. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."


Glossary

Glossary
ESA Glossary of Terms and Acronyms, 0033-CSH 109 532

Reference List

ESA Documentation
[1] ESA Library Overview, DIRECTIONS FOR USE, 1/1553-CSH 109 532
[2] ESA Setup and Configuration, SYSTEM ADMINISTRATION GUIDE, 1/1543-CSH 109 532
SSM Documentation
[3] IBM Netcool/System Service Monitors Version 4.0.1, Administration Guide
[4] IBM Netcool/System Service Monitors Version 4.0.1, Reference Guide
[5] IBM Netcool/System Service Monitors Version 4.0.1, Patch Installation Guide


Copyright

© Ericsson AB 2004-2016 – All Rights Reserved

Disclaimer

No part of this document may be reproduced in any form without the written permission of the copyright owner.

The contents of this document are subject to revision without notice due to continued progress in methodology, design and manufacturing.

Ericsson shall have no liability for any error or damage of any kind resulting from the use of this document.

Trademark List
Ericsson is the trademark or registered trademark of Ericsson AB. All other products or service names mentioned in this document are trademarks of their respective companies.

    ESA Installation Instruction         Ericsson SNMP Agent 16.0