EMC ITO Adapter HP Network Node Manager (NNM) · EMC® Ionix™ ITO Adapter HP Network Node Manager (NNM) ... iv VERSION 2.4 REV A01 300-011-516 ... Overview

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748-9103

1-508-435-1000www.EMC.com

EMC® Ionix™ ITO AdapterHP Network Node Manager (NNM)

Version 2.4

Installation and Configuration GuideP/N 300-011-516

REV A01

ii VERIONS 2.4 REV A01 300-011-516

Copyright © 2010 EMC Corporation. All rights reserved.Published September, 2010

EMC believes the information in this publication is accurate as of its publication date. The information issubject to change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NOREPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION INTHIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABIL-ITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicablesoftware license.

For the most up-to-date regulatory document for your product line, go to the Technical Documentationand Advisories section on EMC Powerlink.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.All other trademarks used herein are the property of their respective owners.

Table of Contents 1

Introduction 12Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Integration Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Action Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Adapter Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14ITIL Services Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Supported ITIL Object Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16System Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Persistence Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Database Acquisition Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Buffer Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Web Service Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Acquisition Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Acquisition Push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Operations Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Process Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

About the HP-NNM Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Supported Services 26Acquisition Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Polling Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Blocking Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Terminal Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27General Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Discovery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Operations Web Service Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Shared Service Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Event Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Device Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Job Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

EMC IONIX IT ORCHESTRATOR ADAPTER HP NNM INSTALLATION AND CONFIGURATION GUIDE iii

System Configuration 34Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Recommended . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Supported Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Software Installation 36Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Configuring SSL Communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Installing a License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Installing the Adapter Software - Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Start the Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Installing the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Installing the HP-NNM Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Starting the Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Setting the Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Enabling the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Running the Adapter Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Executable Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Service Manager Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Installing Adapter Software - UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Running the Adapter UNIX Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Manual Installation Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Install the Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Framework Properties 67Properties Editor Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Starting the Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Using the Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Global Framework Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Acquisition monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Automated Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

HP-NNM Framework Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71HP-NNM Agent Trap Sender Properties (nnmagent.txt) . . . . . . . . . . . . . . 71HP-NNM Agent Trap Receiver Properties (spring.properties) . . . . . . . . . 72

Custom Configuration 74Client Acquisition Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

iv VERSION 2.4 REV A01 300-011-516

Object Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74RESTful Client Acquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Calling the RESTful Client Acquisition from curl . . . . . . . . . . . . . . . . . . . . . . 75SOAP Client Acquisition Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Running on another port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Adapter High Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Operations Services Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Acquisition Services Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Use the External Database for Multiple Adapters . . . . . . . . . . . . . . . . . . . . 79Adapter Failover Infrastructure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Agent Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Java to Adapter Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Persistence Database Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Removing Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Reclaiming Unused Disk Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Connecting to the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Changing the Database Port Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Offloading the Acquisition Queue to an External Database . . . . . . . . . . 83

Ionix IT Orchestrator Configuration 84Using the ITIL Adapter Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Associated Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Installation and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Using the Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Adapter API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90API Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Package Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Key Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Service Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91SSL Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Java Code Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Managing the Adapter 96Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Connecting to the Adapter Java Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Starting the Java Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Management Beans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

com.iwave:name=Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98com.iwave:name=AcquisitionQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99com.iwave:name=FrameworkAdmin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Maintenance and Troubleshooting 102Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

EMC IONIX IT ORCHESTRATOR ADAPTER HP NNM INSTALLATION AND CONFIGURATION GUIDE v

Log Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Turning on Adapter Logging (Windows) . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Error Types and Meanings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Recoverable Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Permanent Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Global Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Re-Installing or Uninstalling the Windows Service . . . . . . . . . . . . . . . . . . . . . . 107Re-installing the Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Uninstalling the Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Starting and Stopping the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Uninstalling the Adapter Software - Windows . . . . . . . . . . . . . . . . . . . . . . . . . . 108

IT Object Model (ITOM) 112

Index 122

vi VERSION 2.4 REV A01 300-011-516

Preface 2This manual includes instructions on installing, configuring, and troubleshooting the EMC HP Network Node Manager (NNM) Adapter software.

Audience 2

This publication is written for the System Administrator or Engineer responsible for installing and configuring the EMC HP Network Node Manager (NNM) Adapter software.

Organization 2

This publication consists of the following chapters:• Introduction• System Configuration• Software Installation• Framework Properties• Custom Configuration• Orchestrator Configuration• Managing the Adapter• Maintenance and Troubleshooting• IT Object Model List (ITOM)• Index

Font conventions 2

• Bold format is used to identify dialog boxes and menu choices. For example: Start > Programs > IonixITO> adapters-2.4

• Courier fixed-width font is used for code elements (Java, HTML) as well as filenames and directories. For example:install_root refers to the directory where the Adapter software is installed, for example

EMC IONIX IT ORCHESTRATOR ADAPTER HP NNM INSTALLATION AND CONFIGURATION GUIDE vii

l

c:/Program files/install_root/Adapters

• Web addresses are displayed as hyperlinks. For example: http://www.EMC.com

Related documents 2

For more information on EMC software products, refer to the following manuals:• EMC Ionix IT Orchestrator Introduction and Planning Guide - This manua

provides an overview of the Orchestrator architecture and associated applications. It introduces the main components of the IT Orchestrator, Design Studio, Platform and applications.

• EMC Ionix IT Orchestrator Installation and Configuration Guide - This manual provides information on installing the EMC Ionix IT Orchestrator, Design Studio, Platform and associated plugins. Provides an overview on how to install the Orchestrator Studio on Windows and Linux platforms and describes the mechanism for installing the Orchestrator Platform in your managed environment.

• EMC Ionix IT Orchestrator Administration and Operations Guide - This manual identifies the administration tasks required to configure the Ionix IT Orchestrator Platform and describes the log files available for detailed analysis of running solutions.

• EMC Ionix IT Orchestrator Developer Guide -This manual provides an introduction to the Designer Studio and Lifecycle tools that enable you to design Services and Tasks in Orchestrator Studio. The manual identifies the procedures for building Services and Tasks and describes the configuration of the associated properties.

viii VERSION 2.4 REV A01 300-011-516

1Chapter
Introduction 1
Topics covered in this chapter:• Introduction• Adapter Framework• ITIL Services Support• Supported ITIL Object Types• System Architecture• Persistence Database• Web Service Methods

Introduction 1

EMC provides two different types of ITIL Adapters:• Integration Adapters• Action Adapters

Integration Adapters

EMC provides a comprehensive library of IT Service Management (ITSM) integration Adapters. Integration Adapters enable the bi-directional exchange of Incident, Problem, Configuration, Change and Asset information between ITSM applications.

The ITSM applications include:• Service Desk Applications• Enterprise Management Systems• CMDB and Asset Management Systems• Database Management Systems

Figure 1-1 illustrates a high-level view of the end-to-end, bi-directional process. In this process, the new/modified Incident Record goes from the endpoint application to the remote vendor application.

EMC IONIX IT ORCHESTRATOR ADAPTER HP NNM INSTALLATION AND CONFIGURATION GUIDE 12

INTRODUCTION

EMC provides for two-way integrations allowing this process flow to move in either direction. An Adapter is required on each endpoint as each application has a customized API. Integrations can be performed for multiple applications; integrations are not limited to two.

Figure 1-1 High-Level Integration Overview

Action Adapters

Action Adapters allow you to quickly create integration Adapters for ITSM applications without resorting to programming. EMC provides the following Action Adapters, which can be installed with other Integration Adapters:• Command Line Adapter• Reverse Proxy Adapter• SQL Proxy Adapter

Command Line Adapter

The Command Line Adapter allows remote execution of command line processes on the machine where the Adapter is installed. Commands can be executed using the Command Line Web Service.

Reverse Proxy Adapter

The Reverse Proxy Adapter can be used by customers who may need to put their service desk application on the public internet. The Reverse Proxy Adapter can be used to provide a layer of indirection between the Ionix IT Orchestrator and the service desk. The proxy can provide security (HTTPS) and authentication (HTTP Basic Authentication) without needing to set up these configurations on the service desk.

SQL Proxy Adapter

The SQL Adapter allows remote execution of SQL queries on the Adapter system. This allows the Ionix IT Orchestrator to effectively query a database that is only accessible through the public internet. The Adapter can secure the

13 VERSION 2.4 REV A01 300-011-516

ADAPTER FRAMEWORK

communication and provide the actual access to the database. To utilize the SQL Proxy Adapter, you must configure the Adapter to point to the database you wish to use.

Adapter Framework 1

The EMC Adapter Framework is a Java 6 application. The Adapter Framework manages communication between the EMC Adapter and consumers (including EMC Ionix IT Orchestrator). The EMC Adapter interfaces with the ITSM application’s API and is therefore restricted by the limitations of that API. • For some ITSM applications, the EMC Adapter must run on the same machine

as the ITSM application itself. • For other ITSM applications that support remote APIs, the Adapter may run on

a separate machine.


ITIL SERVICES SUPPORT

ITIL Services Support 1

EMC Adapters support the Information Technology Infrastructure Library (ITIL) service silos as illustrated in Figure 1-2. The ITIL is a set of best practice standards for Information Technology Service Management (ITSM) and has become the worldwide standard in service management.• Incident Management - needs configuration (CI) dependency information

and determines a correlation of incidents and creates a problem report.• Problem Management - needs all Incident reports related to a problem.

Determines the root cause and determines if an RFC needs to be created from specific CIs.

• Asset Management (Financial) - determines the following:— If a new CI needs to be added to the Configuration Management

system.— If an RFC is needed for the Change Management system.— If a Service Desk task needs to be created to provision and model the

new asset in the Configuration Management system.• Event Management - generates events and alerts.

Figure 1-2 EMC ITIL Service Silos and Objects

15 VERSION 2.4 REV A01 300-011-516

SUPPORTED ITIL OBJECT TYPES

Supported ITIL Object Types 1

Each transaction record has an associated object type. This may either be a built in object type (i.e., Incident) or it may be a custom type. When an item is added into the Acquisition Queue, a specified object type or an object class is used:• If the object type is specified, then that type is used. • If no object type is specified, the type of the object class is used.

Note: Not all Adapters support all objects.

The EMC Adapter may include the following built in object types:• Incident Object - includes the Incident object in the Incident Management

Service silo. The primary difference between an Incident object and an ITObject object lies in the schema. The Incident has a predetermined schema allowing all adapters to map information into common predetermined data elements, whereas the ‘ITObject’ is completely generic and all data is stored as native data.

• Problem Object - includes the Problem object type for Problem Management.

• Change Object - includes the Change object type for Change Management. This object is also known as a Request for Change (RFC).

• CI Object - includes the CI (Configuration Item) object type for Configuration Management. This provides configuration information from a CMDB.

• Event Object – includes the Event object type for Event Management.• IT Object – includes the generic objects correlating back to the endpoint

application forms that may not have any relationship to the ITIL processes. ITObject Services are used in cases where customers have created their own representation of the Incident via custom forms or have developed custom forms representing data needed to integrate between applications.


SYSTEM ARCHITECTURE

System Architecture 1

The EMC Adapter translates information from an Endpoint Application for input into a remote vendor application (and vice versa). The translation process includes the following Adapter software components identified in Figure 1-3: • Persistence Database• Web Service Methods:

— Operations Service— Acquisition Service

Figure 1-3 EMC Adapter System Architecture

EMC Ionix ITO

EMC Ionix ITOAdapter

17 VERSION 2.4 REV A01 300-011-516

PERSISTENCE DATABASE

Persistence Database 1

The Persistence Database is an open source, relational Apache Derby database that holds transactions in the order that they are received. Once data is received, it is assigned a transaction number and stored in the Acquisition Queue. This is necessary to ensure that each application in the integration has proper data synchronization.

The Acquisition Queue consists of two areas: • Database Acquisition Queue• Buffer Queue

Database Acquisition Queue

Each time an incident is created, modified, or closed in the Endpoint Application, the change is captured as a transaction. This transaction data is stored in the Database Acquisition Queue, which is periodically polled by the EMC Ionix IT Orchestrator. When polled, the transaction data is packaged into an XML document and sent to the Ionix IT Orchestrator via HTTP/HTTPS. The Ionix IT Orchestrator processes the transaction via its workflows and provides the data to the Operations Service of one or more remote Adapters to facilitate platform integration.

After the transaction is successfully processed, the Ionix IT Orchestrator acknowledges the transaction in the queue, so it can be removed. The Ionix IT Orchestrator can optionally acknowledge the transaction as errors based on workflow thresholds. Transactions acknowledged as “complete” or “errors” are no longer available when polled.

Buffer Queue

The Buffer Queue stores records on disk until there is room in the database for them. This allows the Adapter to perform more effectively with larger loads. Instead of records going into the database directly, they are stored to the file system when the number of database records exceeds the configuration option acquisition.bufferqueue.limit (default 200).

The Buffer Queue stores records waiting to be put in the database in the data/queue/buffer directory. When the buffer is active, it starts a background thread to push data into the database. Order of the records is maintained. The files in the directory should not be modified while the adapter is running.

This also provides a store-forward like capability for the Adapters similar to the agents. If the database is down, the Buffer Queue is also engaged


WEB SERVICE METHODS

Web Service Methods 1

EMC Adapters handle communication with the actual ITSM Endpoint Application. EMC Adapters provide a common set of Web Services methods:• Acquisition Service - acquire transaction information from the ITSM

applications.• Operational Service - create, update, or search and retrieve information

within the ITSM applications.

EMC Adapter Acquisition and Operational Services are consumed by processes running in the EMC Ionix IT Orchestrator.

The HP NNM adapter uses a specialized application Agent to send notifications.

19 VERSION 2.4 REV A01 300-011-516

ACQUISITION SERVICE

Acquisition Service 1

The Acquisition Service provides access to objects that have changed in endpoint applications. All of the data is stored in a Persistence Queue. Acquisition is the process that allows the Adapter to react to the creation, modification, or closure of an incident and place that information into the Persistence Database queue. The EMC Ionix IT Orchestrator polls the transactions from the Persistence Database queue. Then the Ionix IT Orchestrator processes and sends the transactions to the target application(s).

The same Acquisition Service is used for all object types and polling can be restricted to certain object types.

Process Flow

Figure 1-4 displays a detailed architectural view and Acquisition process flow for the EMC Adapter. This process allows the EMC Ionix IT Orchestrator to receive and manage transaction data stored in the Persistence Database queue.

The process consists of the following steps:1. The Ionix IT Orchestrator sends a Transaction Management request to the

Acquisition Service.2. The Acquisition Service queries the Persistence Database queue for

transaction data.3. The Persistence Database sends the transaction back upstream to the Ionix IT

Orchestrator.Figure 1-4 Acquisitions Process Flow

EMC Ionix ITO



ACQUISITION SERVICE

Acquisition Push

The Acquisition Push mechanism provides lifecycle management of adapter queue transactions. It allows the workflow developer to write workflows to handle transactions only. The Acquisition Push mechanism handles the following functions: • Performs the polling operations. It polls in groups of 50 at a time, which it can

execute in parallel. Only one thread performs polling. • Allows a configurable number of threads to be used to process transactions. • Performs a complete operation when a workflow successfully executes. • Performs a retry if it cannot connect to Ionix IT Orchestrator or if there is an

error. Has a configurable number of retries (defaults to 60). If the retries count is exceeded, the transaction is put into a resolvable error state.

• Automatically notifies the Monitoring Server of errors that occur and logs the errors.

• Allows the workflow creator to optionally use blocking or error functionality manually. This allows for using this mechanism for simple processes but gives the full acquisition service capability where required.

• If Ionix IT Orchestrator is detected to be down (planned or otherwise), the mechanism will wait for Ionix IT Orchestrator service to return rather than continually generating errors.

Terminology

• Buckets - The acquisition push mechanism uses the concept of 'buckets' to parallelize processing. A blocking key is the unique combination of 'serviceId', 'objectType' and 'objectId'. This is used as the criteria for blocking on the acquisition queue. The push mechanism takes results of a poll and breaks it up into separate groups known as buckets. One bucket is created for each blocking key in the poll. If all records are for unique IDs in the endpoint application, then each bucket will have only one record in it. All buckets can be processed independent of other buckets.

• Side Effects - The acquisition push mechanism analyzes the 'side effects' of processing. The Acquisition Push will look at a transaction status and blocking to determine if it is safe to process other transactions in the same bucket. If it determines that is not safe, then it will not do further processing on the same bucket. Side effects are determined as follows: Safe to process in same bucket:— Complete: Will not be present on the queue. Get will fail. — Error: Will not show as 'Blocked'. Not Safe to process in same bucket: — Retry: Will show with transaction status of 'Poll'. — Resolvable Error: Will show as 'Blocked' — Blocked: Will show as 'Blocked'

21 VERSION 2.4 REV A01 300-011-516

ACQUISITION SERVICE

Performance

This mechanism has been optimized to perform handling of adapter queue data the best. • It only uses a single thread for polling. This reduces the idle time load on the

adapters. One problem with Ionix IT Orchestrator polling is having so many jobs continuously hitting the adapters with poll calls.

• Worker threads are used to perform simultaneous processing. Separate jobs do not need to fire on a repeat interval. When there is work in the queue to be done, it can keep all worker threads active.

• All adapter calls are handled internally and do not need to go over the wire (web services). Transactions are only pushed when they are to be run.


OPERATIONS WEB SERVICE

Operations Web Service 1

An operation constitutes the process of pushing, getting, and finding data from a remote application. For example, when an incident is created, modified or closed in an application that is integrated with an endpoint application, the modified information is placed into the endpoint application. This operation effectively synchronizes an application’s data with its remote counterpart.

Process Flow

The process consists of the following steps:1. The Ionix IT Orchestrator calls the Operations Service methods to interact with

the Endpoint application’s API.2. Operations Service translates the record information from the IT Object Model

to the Endpoint application’s native record format. The native record information is sent to the Endpoint application through the API.

3. The API Interface inserts the data into the Endpoint application.4. The results from the API are translated back into the IT Object Model and

returned from the web service call.Figure 1-5 Operations Process Flow

EMC Ionix ITO Adapter


23 VERSION 2.4 REV A01 300-011-516

ABOUT THE HP-NNM ADAPTER

About the HPNNM Adapter 1

The EMC HP Network Node Manager (HP-NNM) Adapter requires a special HP-NNM Agent to perform operations against the HP-NNM API. The HP-NNM Agent is a C implementation that uses the HP-NNM API, which does not support Java, to insert information into HP-NNM and retrieve information from HP-NNM. • Operation calls are performed using a trap sender. • Acquisition is performed using a trap receiver that makes calls to the

framework acquisition event service.


ABOUT THE HP-NNM ADAPTER

25 VERSION 2.4 REV A01 300-011-516

2Chapter
Supported Services 2
This section identifies the supported Adapter Services:• Acquisition Service Methods• Discovery Service• Operations Service Methods

Acquisition Service 2

The following services are made available to the EMC Ionix IT Orchestrator through the EMC Adapter’s Acquisition Service:• Polling Methods• Blocking Methods• Terminal Methods• General Methods

WSDL

The Acquisition Services are used to access the Adapter acquired messages on a queue. The following is the WSDL URL for the Acquisition Service:https://localhost:9443/services/AcquisitionService?wsdl

Polling Methods

While in the Acquisition Queue, transactions are assigned a polling status:• Poll - indicates the transaction has no related transactions that are Blocking

and it is available for polling. Related transactions are defined as those with the same objectType, serviceId and objectId (see the getRelated operation).

• Pending - indicates records that have been polled and are currently being processed.

• Error - indicates records that have been polled, processed and contain errors.


ACQUISITION SERVICE

The following are the supported polling methods:• poll(objectType, maxResults) - Polls the acquisition service for

transactions with the given object type. The maximum number of records returned is specified. This method puts the records into the blocking state and sets their status as pending. If maxResults is not specified, one record will be returned.

• pollAny(maxResults) - Polls the acquisition service for transactions. The maximum number of records returned is specified. This method puts the records into the blocking state and sets their status as pending. If maxResults is not specified, one record will be returned.

• pollByService(serviceId, objectType, maxResults) - Polls the acquisition service for transactions with the given service ID and object type. The maximum number of records returned is specified. This method puts the records into the blocking state and sets their status as pending. If maxResults is not specified, one record will be returned.

Blocking Methods

A blocking transaction is a transaction that is currently being processed by an instance. A blocking transaction record prevents other related records from being polled. Blocking Methods are used to identify if the transaction is blocking (TRUE) or non -blocking (FALSE). If the transaction is blocking, the blockType is identified as either Pending or Asynchronous.• block(id, message, blockType) - Sets the transaction as Blocking

and sets the blockType. Since polling automatically sets the blocking flag as TRUE, most of the time this method will just set the blocking type.

• unblock(id, message) - Sets the transaction as non-blocking. (Blocking = false)

Terminal Methods

Terminal Methods are called to signal the end of Ionix IT Orchestrator processing on a record.

• complete(id) - Acknowledges a transaction and deletes it. This used to be called acknowledgeComplete. acknowledgeList will be removed as transactions are generally handled sequentially.

• retry(id, message) - Sets the status to Poll and unblocks the transaction. This can be used to resolve and retry errors or to retry something that was polled.

• resolvableError(id, message) - Sets the status to Error and ensures that the transaction is Blocking. This is used instead of acknowledgeError. The blocking is preserved to prevent data corruption. This block type is set to Error.

27 VERSION 2.4 REV A01 300-011-516

ACQUISITION SERVICE

• error(id, message) - Sets the status to error and unblocks. This is used for final errors that were never retried. By using this method, the user allows other related transactions to be processed. Use this method with caution.

General Methods

General Methods are called to get and return transaction and blocking results.• getBlocking(maxResults) - Gets all transactions in the Blocked state.• getBlockingFor(maxResults, blockType, seconds) - Gets all

transactions in the blocked state for a number of seconds. This can be used for auditing asynchronous transactions.

• getTransaction(id) - Gets the specified transaction.• count(id) - Returns the total count of available transactions and error

transactions in the Persistence Queue.• countErrors(id) - Gets the total number of records that are in the Error

state in the Acquisition Queue. Similar to count() but for errors.• getErrors(maxResults) - Gets all transactions with the Error Status.• getRelated(id) - Gets a list of all transactions that are related to this

transaction. Related transactions are defined as ones that have the same objectType, serviceId and objectId. This is useful to get any transactions that are related to a transaction that is blocking.


DISCOVERY SERVICE

Table 2-1 identifies the formats and descriptions of the method input variables.

Discovery Service 2

The discovery service allows you to see what web services are deployed on the adapters framework. This will list all adapter web services, Monitoring Server services and any RESTful HTTP services. The Discovery Service information can be accessed in two different ways:• through a SOAP Web Service• through a standard HTTP GET

WSDL

The following are the WSDL locations for the Discovery Service:• For SOAP:

https://localhost:9443/services/DiscoveryService?wsdl

• For HTTP GET:https://localhost:9443/services/discovery

Table 2-1 Acquisition Service Method Input Descriptions

Inputs Format Description

blocktype string This field defines the type, category, tag or state associated with the block.

id Integer Identifies the transaction ID.

maxResults Integer Identifies the maximum number of items to poll. (Default =1)

message String Text string identifying the method message.

objectType String Case sensitive ITIL Object Type (Change, CI, Problem, and Event, Incident or ITObject).

seconds Integer Identifies the number of seconds.

serviceId String Case sensitive Service ID.

29 VERSION 2.4 REV A01 300-011-516

OPERATIONS WEB SERVICE METHODS

Operations Web Service Methods 2

The HP NNM Adapter utilizes the following Operations Web Services:• Shared Service Operations• Event Service• Device Service• Job Service

Shared Service Operations

Core Methods

These are the core methods available on most of the services.

Relationship Methods

These methods manage relationships between the object defined and other objects in the endpoint application.

Log Methods

These methods provided access to modifying logs. Logs are returned as references and should be retrieved and modified by these operations. Log

Table 2-2 Shared Services - Core Methods

Event Description/Notes

get(identifier) Gets the object with the identifier provided.

find(query (IncidentID)) Finds the object with the endpoint application query specified.

create(Object) Creates the object in the endpoint application.

update(Object) Updates the object in the endpoint application.

Table 2-3 Relationship Methods


relate(identifier, reference) Relates the object reference specified to the identifier of the object to refer to it.

unrelate(identifier, reference) Removes the relationship between the object represented by the identifier and the reference.



identifiers are retrieved through the object models for the various object types as object references.

Attachment Methods

These methods provide access to get or create attachments. On some systems, creating an attachment with an existing ID may update an existing attachment. This functionallity is not covered by the Adapter framework.

Event Service

The following is the WSDL location for the Operations Event Service:

https://localhost:9443/services/Hpnnmionix-scm/EventService?wsdl

This adapter consolidates four VCM IDs into a string in the format of <alert_id>-<alert_rule_id>-<machine_group_id>-<machine_id> as VCM event identifier.

All the event methods are implemented based on the assumption that if multiple event entries with the same identifier components exist on VCM

Table 2-4 Log Methods


createLog(identifier, log) Creates a new log object associated with the identifier of the object specified.

getLogs(ids<List>) Retrieves a list of log objects given a list of their IDs.

Table 2-5 Attachment Methods


createAttachment(identifier, attachment)

Creates a new attachment associated with the identifier specified. The attachment object contains all of the data that corresponds to the attachment to create.

getAttachments(ids<List>) Retrieves a list of Attachment objects given a list of their IDs.

31 VERSION 2.4 REV A01 300-011-516


table ecm_dat_alerts_found, only the latest event entry represents the current state of the event, and so the operations only apply to that entry

.

Device Service

The following is the WSDL location for the Operations Device Service:

https://localhost:9443/services/ionix-scm/DeviceService?wsdl

Table 2-6 Event Service Details


get(identifier) Gets the Event with the identifier provided.

find(query) Finds the Event with the endpoint application query specified.

Finds Event(s) against VCM table ecm_dat_alerts_found. The query string is an SQL query statement without leading "select * from ecm_dat_alerts_found". A blank query will return all the events.

acknowledge(event) Acknowledges the Event in the endpoint application.

Acknowledge the event with either alert_found_id or identifier provided. If an alert_found_id is provided as a NumberField extended field, and that entry is not a latest entry for its identifier, then it's considered as target not found.

clear(event) Clears the Event in the endpoint application.

Table 2-7 Device Service Methods

Change Description/Notes

get(identifier) Gets the device with the identifier provided.

find(query) Finds a device using a query statement. An empty query will return all available devices.

Finds the device from the VCM table ecm_dat_machines. It should be a query stament without leading “select * from ecm_dat_machines”.



Job Service

The following is the WSDL location for the Operations Job Service:

https://localhost:9443/services/ionix-scm/EventService?wsdl

Table 2-8 Job Service Details


get(identifier) Gets the Change with the identifier provided. Any VCM job event GUID is acceptable as input parameter as well.

find(query) Finds Event(s) against VCM table ecm_dat_alerts_found. The query string is an SQL query statement without leading "select * from ecm_dat_alerts_found". A blank query will return all the events. .

approve(object) Approves the change job with the information provided.

reject(object)) Reject the change job with the information provided.

33 VERSION 2.4 REV A01 300-011-516

3Chapter
System Configuration 1
This chapter identifies the requirements for configuring the EMC Adapter solution and discusses the following topics:• Supported Operating Systems• System Requirements• Supported Databases

Supported Operating Systems 1

The Adapter software can be installed on the following operating systems:• Windows - NT4, 2000, XP, 2003 Server, 2008 Server• UNIX- Solaris 10 (Sparc), HP-UX 11 (Itanium), AIX• Linux - x86, x64, Kernel 2.6 (or higher)

System Requirements 1

Before you install the Adapter software, your Adapter server must meet the following system requirements.

Recommended

The following are the recommended system requirements for installing the EMC Adapter software:• CPU: Dual Core Processor running 2GHz or higher • RAM: 2 GB • Disk Space: 5 GB free disk space • Java Runtime Environment: JRE 6.0 Update 16 (or above) is recommended.

This is bundled with the Windows installer.


SUPPORTED DATABASES

Minimum

The following are the minimum system requirements for installing the EMC Adapter software:• CPU: Pentium Class or Equivalent Processor or higher • RAM: 512 MB Free • Disk Space: 2 GB free disk space • Java Runtime Environment: JRE 6.0 Update 16 (or above) is recommended.

This is bundled with the Windows installer.

Supported Databases 1

The EMC Adapter uses a relational Apache Derby database for the Persistence Queue. In addition to the Apache Derby database, the EMC Adapter supports the following external databases:• Oracle• DB2• Microsoft SQL Server

35 VERSION 2.4 REV A01 300-011-516

4Chapter
Software Installation 4
Topics covered in this section:• Overview• Configuring SSL Communications• Installing a License File• Installing the Adapter Software - Windows• Running the Adapter Windows Service• Installing Adapter Software - UNIX• Running the Adapter UNIX Service• Manual Installation Procedures


OVERVIEW

Overview 4

Based on your EMC configuration, the following components may be installed (see Figure 4-1):• EMC ITIL Adapters – includes the Adapter software and license file.• EMC ITIL Adapter Agent (Optional) – includes the Adapter URL Agent

software or custom Agent.The Agent may be installed with the Adapter on the same server or on a separate server.

• License files – are provided by EMC Customer Support and must be installed in the appropriate directory.

• EMC Ionix IT Orchestrator (Optional) – includes the Ionix IT Orchestrator software and license file.

Figure 4-1 Installation Components

EMCIonix ITO

37 VERSION 2.4 REV A01 300-011-516

CONFIGURING SSL COMMUNICATIONS

Configuring SSL Communications 4

To configure SSL communications between the Ionix IT Orchestrator and Adapter, complete the following steps.1. From the Adapter server, obtain a copy of the Adapter SSL Certificate. 2. Verify that there is not an existing or incorrect certificate already installed in

the Ionix IT Orchestrator keystore.3. Copy the hostname.cer file to the Ionix IT Orchestrator server.4. Confirm that the JAVA_HOME is set to Java 6. Once the JAVA_HOME is verified,

execute the following command to delete the existing certificate:"%JAVA_HOME%\bin\keytool" -delete -alias iwave -storepass changeit -keystore "%JAVA_HOME%\lib\security\cacerts"

5. Install the certificate into the Ionix IT Orchestrator keystore.6. Confirm that the JAVA_HOME is set to Java 6. Once the JAVA_HOME is verified,

execute the following command to store the certificate:"%JAVA_HOME%\bin\keytool" -import -alias iwave -v -file iwave.cer -keypass iwave -storepass changeit -keystore "%JAVA_HOME%\lib\security\cacerts"

Figure 4-2 SSL Configuration

EMCIonix IT Orchestrator



INSTALLING A LICENSE FILE

Installing a License File 4

When the Adapter software is purchased, a software license file (in XML format) is provided by EMC Customer Support. The license file identifies the following information for each Adapter server included in the EMC software configuration:• the types of Adapters that can be installed on the server• the Adapter software version• the expiry date for the Adapter software• the license key

During Adapter software installation, the user identifies the location of the license file. The installer then copies the license file from the original location to the following EMC Adapter installation directory:

install_root/adapters-2.4/conf

39 VERSION 2.4 REV A01 300-011-516

INSTALLING THE ADAPTER SOFTWARE - WINDOWS

Installing the Adapter Software Windows 4

This section identifies the steps required for installing the EMC Adapter software.

Before You Begin

Before you install the EMC Adapter software, complete the following tasks:• Identify the location of the Adapter license file.• Close all Windows applications.• Determine the type of Agent you are installing (if any).• Determine which Adapter will be installed.• Determine on which server the Adapter and Agent software will be installed.

Start the Installer

To install the EMC URL Agent and/or Adapter software, complete the following the steps:1. Access the location of the Adapter installer executable. Double-click the

setup-Adapter-winxx_2.4.exe file. 2. The Open File - Security Warning window displays. Click Run.3. The InstallAnywhere progress screen displays.Figure 4-3 Installer Progress Screen



4. The progress screen displays.Figure 4-4 Progress Screen

5. After the InstallAnywhere Wizard finishes loading, the EMC Adapters Installer Introduction screen displays. From this screen, select the Next button to continue.

Figure 4-5 Introduction Screen

41 VERSION 2.4 REV A01 300-011-516


6. The Choose Install Set screen displays. From this screen, select the appropriate installation option. — For instructions on installing your Adapter, refer to “Installing the

Adapter”.— For instructions on installing the HP-NNM Agent, refer to “Installing

the HP-NNM Agent”Figure 4-6 Choose Install Set


Installing the Adapter

1. From the Choose Install Set screen, select the HP Network Node Manager Adapter option. Click Next.

Figure 4-7 Choose Install Set Screen

43 VERSION 2.4 REV A01 300-011-516

2. The Choose Install Folder screen displays with the default installation folder. To change the install folder, click the Choose button and navigate to the appropriate installation directory. Click Next.

Figure 4-8 Choose Install Folder Screen


3. The Choose Shortcut Folder screen displays. From this screen, specify the areas where the software shortcut icons will be created. Click the Next button to continue.— In a new Program Group – creates a new program group with the

specified name and includes a shortcut in the Windows All Programs list.

— In an existing Program Group – includes a shortcut in an existing program group.

— In the Start Menu – includes the Adapter shortcut in the Start menu.— On the Desktop – creates an Adapter shortcut on the desktop.— In the Quick Launch Bar – includes the Adapter shortcut in the Quick

Launch menu bar.— Other – specify a custom directory location by selecting the Choose

button.— Don’t create icons – Select this option if you do not want to create an

Adapter shortcut.— Create Icons for All Users – Select this option to create shortcuts for

all users configured on the server. The shortcuts are only added to the Start Menu and Desktop.

Figure 4-9 Choose Shortcut Folder Screen

45 VERSION 2.4 REV A01 300-011-516

Note: If you choose not to create a menu shortcut, you can start the Adapterframework using the startAdapters.bat file. This file is located in theinstall_root\bin directory.

4. The Choose License File screen displays. From this screen, verify that the license file location identified in the Please Choose License File field, is correct. To change the license file location, select the Choose button and select the appropriate directory. Click Next.

Figure 4-10 Choose License File Screen


5. The Enable Security screen displays. On this screen, the Use HTTPS (port 9443) check box is selected by default. This option uses SSL for secure Web-based communications. To use standard unsecured HTTP Web-based communications, un-check this box. Click Next.

Figure 4-11 Enable Security screen

47 VERSION 2.4 REV A01 300-011-516

6. The Web Service Authentication screen displays. From this screen, enter the Username and Password you want to use for authentication. You must enter the password twice for confirmation purposes. Click Next.

Figure 4-12 Web Services Authentication


7. The Monitoring Server Configuration screen displays. Based on your Adapter configuration, determine the appropriate step to complete:— If you are monitoring the Adapter with the Monitoring Server and the

Monitoring Server is on a different host from the Adapter, select the Specify host for Monitoring Server checkbox. Identify the following information and click Next:– URL - identifies the URL location of the Monitoring Server.– Username - identifies the username for the Monitoring Server.– Password - identifies the password associated with the username.

— If you are not using a Monitoring Server or your Monitoring Server is running on the same server as the Adapter, leave the checkbox unchecked. Click Next.

Figure 4-13 Monitoring Server Configuration

49 VERSION 2.4 REV A01 300-011-516

8. The Pre-Installation Summary screen displays. Using the scroll bar, review the information before continuing the installation process.— If the information is correct, click Next.— If the information is incorrect, click Previous and change the

configurations on the previous screen. Click Next when done.Figure 4-14 Pre-Installation Summary


9. The Adapters Configuration screen displays. Click Next.Figure 4-15 Adapters Configuration

51 VERSION 2.4 REV A01 300-011-516

10. The XML Agent Location screen displays. In the URL field, enter the URL and port where the HP Network Node Manager XML Agent service is located. Click Next.

Figure 4-16 XML Agent Location


11. The Preparing to Install screen displays. Click Install.Figure 4-17 Preparing to Install

53 VERSION 2.4 REV A01 300-011-516

12. The Installing Adapters screen displays. This screen displays the progress of the installation process. During this step, the Windows Service is installed and a keystore file is generated for SSL.

Figure 4-18 Installing the Adapter


13. The Start Service screen displays. From this screen, select the Start the Adapter Service checkbox if you want to start the Adapter service during the installation process.

If you do not start the Adapter Service during installation, the Adapter service can be started manually. For more information on starting and stopping the Windows Service, refer to "Running the Adapter Windows Service" on page 62. Click Next.

Figure 4-19 Start Service

55 VERSION 2.4 REV A01 300-011-516

14. If you selected the Start the Adapter Service option, the following screen displays.

Figure 4-20 Starting the Adapters Service


15. The Install Complete screen displays. Click Done to exit the installer.Figure 4-21 Install Complete

57 VERSION 2.4 REV A01 300-011-516

INSTALLING THE HP-NNM AGENT

Installing the HPNNM Agent 4

The NNM Agent is installed using the gzipped tar file named nnm.tar.gz. To install the HP-NNM Agent, complete the following steps:

1. Retrieve the nnm.tar.gz file from the EMC FTP site.2. Create the directory where the software will be installed. For example:

/usr/IonixITO/NNM.3. Move the nnm.tar.gz file to this directory.4. From the nnm.tar.gz file, extract the directories and files to create the Agent

directory and file structure.

tar -xvf nnm.tar

5. The following files and directories are created.

6. Refer to the OpenView NNM configuration for the MIB(s) for which the agent is to receive traps. Using this information, update the value of the Filter keyword in the nnmagent.txt file (see Figure 4-22).

Table 4-1 Agent Directories and Files

Directory File Description

Log Log files are stored here

Bin traprecv

trapsend

HP-NNM Agent trap receiver

HP-NNM Agent trap sender

Conf nnmagent.txt Configuration file for traprecv and trapsend.

data/nnm- store Guaranteed delivery directory used by traprecv.

scripts nnmagent.ksh Starts traprecv and trapsend.

traprecv.ksh Starts traprecv.

trapsend.ksh Starts trapsend.

setenv Sets environment variables for other scripts.



Figure 4-22 nnmagent.txt file

7. If the OpenView pmd process is running on a system other than that where the agent is installed, un-comment the PmdAddress keyword in the nnmagent.txt file and supply the host name of the pmd process system.

8. Start the agent with the following commands:> cd /usr/IonixITO/nnm/scripts> nnmagent.ksh

Starting the Agent

To start both the trapsend and trap receive agents at the same time, use the nnmagent.ksh script.

Figure 4-23 nnmagent.ksh Script

If for some reason only one agent must be started (i.e., it ended unexpectedly) then use either the traprecv.ksh or trapsend.ksh scripts.

Figure 4-24 traprecv.ksh Script

Figure 4-25 trapsend.ksh Script

#LogOptions=NORMAL#LogPath=../log#PmdAddress=#MaxLogFiles=5#MaxLogSize=1000000#SendEntityName=OperationServices#ListenPort=9008#ListenHost=localhost#RecvEntityName=AcquisitionServices#URL=http://localhost:8080/services/acquisition-event/hpnnm/event#StoreLocale=../data/nnm-storeFilter=.*

#!/bin/ksh./trapsend.ksh./traprecv.ksh

#!/bin/ksh. ./setenv../bin/traprecv ../conf/nnmagent.txt &

#!/bin/ksh. ./setenv../bin/trapsend ../conf/nnmagent.txt &

59 VERSION 2.4 REV A01 300-011-516


Setting the Environment Variables

The setenv script sets environment variables used by the other scripts and by the Agents. It may be necessary to modify IW_LIBPATH depending on the local OS.

Figure 4-26 setenv Script

!/bin/ksh# Force the environment to treat "unset" environment variables as empty# not as errors#set +uCUR=`pwd`cd ..export IWHOME=`pwd`export IWAVEBIN=$IWHOME/binexport IWAVECONF=$IWHOME/confcd $CURexport IW_LIBPATH=/opt/OV/lib/hpux32:/usr/lib/hpux32# Used by HP/UX to locate shared library files#if [ -z "$SHLIB_PATH" ]thenexport SHLIB_PATH=$IW_LIBPATHelseexport SHLIB_PATH=$SHLIB_PATH:$IW_LIBPATHfi



61 VERSION 2.4 REV A01 300-011-516

ENABLING THE ADAPTER

Enabling the Adapter 4

The endpoints directory contains the spring configuration for the default HP-NNM Adapter. To enable the adapter, copy the hpnnm-spring.xml configuration file to the conf directory.

In the hpnnm-spring.xml file, the following is required to import the HP- NNM Adapter for the Event IT objects.<import resource="classpath:com/iwave/adapters/hpnnm/event-adapter.xml"/>

Running the Adapter Windows Service 4

The Adapters Windows Service is automatically installed during the installation process and if selected, is automatically started, as well.

Shortcuts

Based on which option was selected during installation, shortcuts may be provided from the Windows Start menu for starting and stopping the Windows Service.• To start the Adapters Service, select Start>All

Programs>install_root>adapters-2.4>Start Adapters Service.• To stop the Adapters Service, select Start>All

Programs>install_root>adapters-2.4>Stop Adapters Service.

Executable Location

Two executable files are provided for interacting with the Windows Service:• adapters.exe: The main executable that launches the service.• adaptersw.exe: The executable for starting the Service Manager application.

These files are located in the installation bin directory:install_root/bin

Service Manager Application

The Service Manager application is an application that allows you to configure options of the service such as turning on debugging. The service can also be started and stopped from this console.

To start the Manager application, double-click on the adaptersw.exe file. The Adapters Properties screen displays (see Figure 4-27).


RUNNING THE ADAPTER WINDOWS SERVICE

Figure 4-27 Adapters Properties - Services Manager Console

63 VERSION 2.4 REV A01 300-011-516

INSTALLING ADAPTER SOFTWARE - UNIX

Installing Adapter Software UNIX 4

Before You Begin

Before installing the Adapters on the UNIX platform, you must complete the following tasks:• For UNIX platform:

— Install the Java Runtime Environment (JRE) 6 Update 11. — Java 6 must be installed and run on the local computer. If multiple Java

platforms are present on the local computer, make sure that %JAVA_HOME% points to Java 6 when running the Adapter.

• For both UNIX and Linux (optional):— Create an “admin” user for running the framework.

Installing the Software

To install the Adapter software on a UNIX platform, run the appropriate setup application from the Linux or UNIX prompt.• Linux Installer: setup-Adapter-linux_2.4.bin• Other UNIX Platforms: setup-Adapter-unix_2.4.bin

Running the Adapter UNIX Service 4

The bin/service.sh script starts and stops the framework as a service. A special file service.PID is created when the service is started. This is used to find the PID of the running service. Do not delete this file manually.

• Starting the service: ./service.sh start• Stopping the service: ./service.sh stop• Restarting the service: ./service.sh restart• Service Status:./service.sh status

If you wish the service to start automatically at boot time, the following is a sample init.d script you can use to call the service.sh script:

#!/bin/shIWAVE_USER=adminIWAVE_SERVICE=/usr/IonixITO/adapters-2.4/bin/service.shsu - ${IWAVE_USER} -c "$IWAVE_SERVICE" $1


MANUAL INSTALLATION PROCEDURES

Manual Installation Procedures 4

If an installation is being performed on an unsupported operating system, the EMC Adapter can be installed manually without the installer.

Before You Begin

Before manually installing the Adapter software, you must complete the following tasks:• Ensure that you are installing on either a Windows or UNIX platform.• Java 6 must be installed and run on the local computer. If multiple Java

platforms are present on the local computer, make sure that %JAVA_HOME% points to Java 6 when running the EMC Adapter.

• An Adapter license file (license.xml) must be copied to the install_root\conf directory. If you do not have a license file for your Adapter, contact your EMC Sales Representative.

Install the Files

To install the files manually on a Windows or UNIX platform, complete the appropriate steps.

For Windows:

1. Contact EMC Customer Support and request a zipped copy of the Adapter installer to be placed on the EMC FTP site.

2. From the Adapter server, download the zipped file.3. Unzip the file and place the extracted file(s) in any directory on any machine

with network access to the computer running the endpoint application.

Note: For Windows installations, there are no registry keys to edit. Thelocation of these files is referred to as %IonixITO_HOME%.

For UNIX and Linux:

1. Contact EMC Customer Support and request a tarred/zipped copy of the Adapter installer to be placed on the EMC FTP site.

2. From the Adapter server, download the tarred/zipped file in binary format. Place the .zip file in the directory where you want the software installed. For example: /opt/EMC

3. Extract the files included in the zip file. This will create an adapters directory with several sub directories.jar xfv adapter-2.4.zip

65 VERSION 2.4 REV A01 300-011-516

MANUAL INSTALLATION PROCEDURES

4. Change to the adapters/conf directory. 5. Copy your license file to the conf directory. Ensure that the license file is

named license.xml.6. Change to the adapters/endpoints directory. Access the directory for

your endpoint adapter.7. Copy the endpoint-spring.xml file to the adapters/conf directory.8. Using the propertiesEditor.bat utility, modify the following

parameters in the framework.properties file.— framework.username

— framework.password - use the -h option when setting the password.

— endpoint.datasource.jdbc.url

— endpoint.datasource.jdbc.username

— endpoint.datasource.jdbc.password

—

9. Change to the adapters/bin directory10. Run the setup.bat script.

./setup.bat

11. Install the Adapter as a service. ./service.bat install

12. Start the adapters service.13. After a few seconds, change to the adapters/log directory and view the

framework.log file. At the bottom of the file, the log should indicate that the adapter framework has started.


5Chapter
Framework Properties 1
During installation, the framework.properties file is installed in the conf directory. The framework.properties file includes configuration parameters for the Adapter Framework. Any parameters specified in this file are automatically recognized by the external (framework.xml) and internal (inside the framework jars) spring configurations. These parameters allow the base configuration to be used and only a few parameters should be changed.

The framework.properties file is in the standard Java Properties format. The file can be edited using a text editor or the properties in the file can be edited using the PropertiesEditor command.

The properties in the framework.properties file that are encrypted are shown in the format: "ENC;XXXXX" where XXXXX is the encrypted data.

Note: The Properties Editor tool is only capable of creating these propertiesand not reading them.

Properties Editor Tool 1

The Properties Editor is a tool used to edit configuration properties in the framework.properties file. This command allows encrypted parameters to be specified.

Starting the Tool

To start the Properties Editor tool, execute the following batch file or shell script from the command line:• For Windows: bin/propertiesEditor.bat

• For Unix: bin/propertiesEditor.sh


PARAMETERS

Using the Command

When entering the PropertiesEditor command, multiple options can be specified in a single invocation of the command.

Usage

PropertiesEditor [options] <target-file>

Options

-p <key>=<value> Sets a property with the key and value specified in plain text.

-e <key>=<value> Sets a property with the key and value specified in encrypted data.

-h <key>=<value> Sets a property with the key and value specified in SHA-1 Hashed format. This is used for framework passwords.

-m <file> Merges multiple properties from the file specified to the target file.

Examples

The following are examples of using the Properties Editor tool: • To set the framework username and password for authentication, enter the

following command:bin/propertiesEditor.bat -p framework.username=admin -h framework.password="Hashed String" conf/framework.properties

• To set the Adapter hostname, username and password, enter the following command:bin/propertiesEditor.bat -p adapter.host=hostname -p adapter.username=Demo -e adapter.password=password conf/framework.properties

Parameters 1

The framework.properties file includes two types of properties:• global framework properties• Adapter-specific properties

Global Framework Properties

These global framework properties are automatically configured for all Adapters.


PARAMETERS

Framework Authentication

The following properties are used for the Web Services HTTP authentication:• framework.username - Username to log into the provided web services.• framework.password - Password to log into the provided web services.• framework.admin.password - Administrator password to restart the

adapters over JMX.• framework.auth.enabled - If this is set to true, authentication will be

required. (Default: true)

Default base URLs to Exposed Services

The following properties configure the base URLs for the Adapter services:• services.url - Base URL for all adapter operations services (https://

${hostname}:9443/services).• client.url - Base URL for client acquisition service (https://

${hostname}:9443/services).• notification.url - Base URL for notifications (http://

${hostname}:9080/services/notification).• acquisitionevent.url - Base URL for acquisition events (http://

${hostname}:9080/services/acquisition-event).

DataSource Properties

The following properties can be modified to enable support for another database instead of the default (Derby) Persistence database:• datasource.jdbc.driver – identifies the database driver (i.e.,

com.microsoft.sqlserver.jdbc.SQLServerDriver). • datasource.jdbc.url – identifies URL to the database (i.e.,

jdbc:sqlserver://hostname:1433;DatabaseName=testdb). • datasource.jdbc.username - identifies the username to log into the

database.• datasource.jdbc.password – identifies the password associated with

the database username. If required, the password can be encrypted.

Database Monitoring

The following properties can be modified to enable monitoring tasks on the database. Only one Adapter per database can have this enabled.• datasource.monitor.enabled - identifies if database monitoring is

enabled. (Default: true)

69 VERSION 2.4 REV A01 300-011-516

PARAMETERS

Acquisition monitoring

The Adapters automatically send the adapter.acquisition.queuesize and adapter.acquisition.queuewait events to the Monitoring Server based on the health of the Adapter queue. The following parameters are used to configure Acquisition monitoring. • acquisition.monitor.enabled - identifies if Acquisition monitoring is

enabled. (Default: true)• acquisition.monitor.queue-threshold - identifies the number of

items allowed in the queue before the queuesize event is sent. (Default: 500)

• acquisition.monitor.queue-wait-hours- identifies the number of hours an item must be on the queue before the queuewait event is sent (Default: 24)

• acquisition.bufferqueue.limit - identifies the maximum number of items that are allowed in the buffer queue. (Default: 500)

Automated Alerts

If the Monitoring Server is on a different host from the Adapter, the following configuration are updated to include the connection settings for the Monitoring Server. These parameters identify the location to send automated alerts. If you are using a Monitoring Server and it is installed on the same server as your Adapter, leave these parameters blank.• framework.events.url - identifies the Monitoring Server URL location

to send events.• framework.events.username - identifies the Monitoring Server

username for basic authentication.• framework.events.password - identifies the password associated with

the Monitoring Server username. The password can be encrypted.


HP-NNM FRAMEWORK PROPERTIES

HPNNM Framework Properties 1

The framework.properties file includes the following parameters for the HP-NNM Adapter:• hpnnm.xmlagent - the XML agent URL (Default: http://localhost:9008)• hpnnm.serviceId = the service identifier for the adapter.(Default: hpnnm)

Figure 5-1 Framework Properties for HP-NNM

HPNNM Agent Trap Sender Properties (nnmagent.txt)

The HP-NNM Agent trap sender requires the following properties to be set in the nnmagent.txt configuration file (case-insensitive):

Table 5-1 HP-NNM Agent Trap Sender Properties

Property Description

hpnnm.LogPath The pathname of the directory for Agent log files. Optional, default is ./log. The Agent log files are generational. The current log file is generation 0, the next oldest is generation 1, etc. The log file name for generation 0 is trapsend.log.0.

hpnnm.MaxLogFiles The maximum number of log file generations. Optional, default is 5.

hpnnm.MaxLogSize The maximum size for a log file. Optional, default is 1000000.

hpnnm.LogOptions A plus- delimited list of 0 or more log options. Optional. Specify ADET+EXIT for details.

hpnnm.PmdAddress The IP address or hostname of the HP-NNM pmd process. Optional, default is the local host.

hpnnm.SendEntityName The entity name of the HP-NNM Agent. Optional, default is OperationServices.

hpnnm.ListenPort The IP port at which the trap sender is to listen for Operation requests. Optional, default is 9008.

hpnnm.ListenHost The host name at which the trap sender is to listen for Operation requests. Optional, default is localhost

## HP-NNM Adapterhpnnm.xmlagent = http://localhost:9008hpnnm.serviceId = hpnnm

71 VERSION 2.4 REV A01 300-011-516


HPNNM Agent Trap Receiver Properties (spring.properties)

The HP-NNM Agent trap receiver requires the following properties to be set in the spring.properties configuration file (case-insensitive).

Table 5-2 Agent Trap Receiver Parameters

Property Description

hpnnm.LogPath he pathname of the directory for Agent log files. Optional, default is ../log. The Agent log files are generational. The current log file is generation 0, the next oldest is generation 1, etc. The log file name for generation 0 is traprecv.log.0.

hpnnm.MaxLogFiles The maximum number of log file generations. Optional, default is 5.

hpnnm.MaxLogSize The maximum size for a log file. Optional, default is 1000000.

hpnnm.LogOptions A plus-delimited list of 0 or more log options. Optional. Specify ADET for details.

hpnnm.PmdAddress The IP address or hostname of the HP-NNM pmd process. Optional, default is the local host.

hpnnm.RecvEntityName The entity name of the HP-NNM Agent. Optional, default is AcquisitionServices.

hpnnm.URL The URL of the Acquistion Event Service. Optional, default is as described above.

hpnnm.StoreLocale The store directory for guaranteed deliver to the Acquisition Event Service. Optional, default is ../data/hpnnm-store.

hpnnm.Filter The filter defining which events the Agent is to receive from the HP-NNM pmd process. The format is described in the man page for OVsnmpEventOpen (3) and repeated below. Optional, default is ".*", which specifies that all events are to be forwarded to the Agent, excluding those generated from within the ECS engine. A customer is very unlikely to use the default. A knowledge of the specific MIB or MIBs used by the customer is needed to install the correct filter.



73 VERSION 2.4 REV A01 300-011-516

6Chapter
Custom Configuration 1
Topics covered in this section:• Client Acquisition Service• Adapter High Availability• Java to Adapter Integration• Persistence Database Management

Client Acquisition Service 1

The Client Acquisition service allows customers to leverage the EMC Acquisition Services with their data. Customer data can be added to the existing EMC Acquisition system. Processes in Ionix IT Orchestrator can be configured to feed off of their data similar to the existing Adapter workflows. Two services are provided for getting data into the Acquisition Queue. Both provide the exact same features, but allow customers to choose the easiest integration point.

Data Format

The data must be provided in the following XML format:

<?xml version="1.0“ encoding=”UTF-8”?><client-object> </client-object>

Object Format

Schema for the client object (client-object.xsd):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="client-object" type="clientDefinedObject"/>


CLIENT ACQUISITION SERVICE

<xs:complexType name="clientDefinedObject" mixed="true"> <xs:sequence> <xs:any processContents="skip" namespace="##other" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType></xs:schema>

To provide data to the acquisition queue, customers must always specify the serviceId and objectType along with the object data.• serviceId - Unique identifier of the service that placed this data here.

This is used to differentiate between different applications that push data into the queue.

• objectType - Unique type of the object. This should not be one of the built in types (Incident, Event, CI, Change, Problem, ITObject). It can be any unique name to identify the customer's data.

The return for the service provides the ID of the transaction back to the client. This can be used to correlate the call with the transaction that appears in the queue.

RESTful Client Acquisition

For the Client Acquisition endpoint, HTTP POST to the following address:

https://localhost:9443/services/client-acquisition/{serviceId}/{objectType}:

Replace {serviceId} and {objectType} with the desired values.

• HTTP Basic Authentication is expected to authenticate the user.• If a problem occurs, and HTTP 500 (Internal Error) response code is returned,

the content of the response contains the error message. A HTTP 200 code indicates the request was processed normally. Any HTTP 4xx codes indicate some sort of client error.

Note: If you have a form with a ":" colon in it, use the ASCII Hex decimal with a"%" sign prefix to escape it in the Restful service URL.

Calling the RESTful Client Acquisition from curl

In order to call the RESTful Client Acquisition from curl, the URL Agent must be installed. Once the URL Agent is installed, complete the following tasks: 1. Create an XML file with the root node of the client-object.

<?xml version="1.0" encoding="UTF-8"?><client-object> </client-object>

2. From the command line, call the following command:

75 VERSION 2.4 REV A01 300-011-516


python agent.py -l -v -x {filename} https://iwave:password@localhost:9443/services/client-acquisition/{serviceId}/{objectType}

3. An HTTP/1.1 200 OK response is sent and the data should be in the Acquisition Queue.

SOAP Client Acquisition Web Service

The following is the location of the SOAP Client Acquisition Service WSDL:https://localhost:9443/services/ClientAcquisitionService?wsdl

If an error occurs, a web service fault is thrown matching the framework exception com.iwave.acquisition.client.AcquisitionException.This exception contains a message with the details of the problem. HTTP Basic Authentication is expected to authenticate the user.

Running on another port

To run the Client Acquisition service from another port, you must modify the client-acquisition-spring.xml file. Figure 6-1 identifies the spring configuration file for the client acquisition service. In this file, perform the following modifications:1. Replace the ${services.url} with the required URL and port number

(i.e., 9080).

Note: If you specify port 9443, you must use HTTPS in the URL.

2. If you need to disable authentication, delete the following three lines in the two places they occur.<jaxws:inInterceptors> <ref bean="securityInterceptor"/></jaxws:inInterceptors>

3. To start a second copy of the Acquisition Service, copy the modified file to the conf directory.



Figure 6-1 Spring Configuration

<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:jaxws="http://cxf.apache.org/jaxws" xmlns:jaxrs="http://cxf.apache.org/jaxrs" xmlns:lang="http://www.springframework.org/schema/lang" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd http://www.springframework.org/schema/lang http://www.springframework.org/schema/lang/spring-lang-2.0.xsd">

<bean id="clientAcquisitionService2" class="com.iwave.acquisition.client.ClientAcquisitionService"> <property name="queue" ref="acquisitionQueue"/></bean>

 <bean id="acquisitionExceptionProvider2" class="com.iwave.acquisition.client.AcquisitionExceptionMapper"/>

 <jaxws:endpoint id="clientAcquisitionServiceEndpoint2" implementor="#clientAcquisitionService2" implementorClass="com.iwave.acquisition.client.ClientAcquisitionService" address="${services.url}/ClientAcquisitionService2"> <jaxws:inInterceptors> <ref bean="securityInterceptor"/> </jaxws:inInterceptors> </jaxws:endpoint>

<jaxrs:server id="clientAcquisitionServiceRest2" address="${services.url}/client-acquisition2"> <jaxrs:inInterceptors> <ref bean="securityInterceptor"/> </jaxrs:inInterceptors> <jaxrs:serviceBeans> <ref bean="clientAcquisitionService2"/> </jaxrs:serviceBeans> <jaxrs:providers> <ref bean="acquisitionExceptionProvider2" /> </jaxrs:providers> </jaxrs:server></beans>

77 VERSION 2.4 REV A01 300-011-516

ADAPTER HIGH AVAILABILITY

Adapter High Availability 6

The EMC Ionix IT Orchestrator Adapter solution may be scaled to allow more Adapters in the network configuration. Adapter scaling may be performed for the following reasons:• to increase the number of transactions being processed• to provide high-availability (i.e., redundancy)• to handle additional simultaneous requests

Figure 6-2 provides an illustration of a network configuration with multiple Adapters utilizing an external Acquisition database.

Figure 6-2 Adapter Scaled Network Configuration

Operations Services Scaling

The Operations Web Services can be scaled easily. The operations are essentially stateless, allowing a second adapter to be installed on another system that can handle the operations. If the primary Adapter fails, workflows can be updated to switch to use a secondary Adapter’s operations services.

Acquisition Services Scaling

The Acquisition Services component of the Adapter architecture can be scaled by completing the following steps:1. Offload the Acquisition Queue to an external database.2. Use the external database with multiple Adapters.


ADAPTER HIGH AVAILABILITY

Use the External Database for Multiple Adapters

Each Acquisition Service is pulling from the same shared queue. A second adapter install can be used to handle additional acquisitions. Workflows can be updated to switch to the second adapter if the acquisition queue operations fail on the primary server.

Adapter Failover Infrastructure

Since it is difficult to add logic for Adapter failover within workflows, specific infrastructure must be implemented to handle Adapter failover. The following are options for implementing high-availability for the EMC Adapters:• Round-Robin DNS Server - A Round-Robin DNS can be used to allow a single

hostname to provide access to multiple IP addresses representing the multiple Adapter environments installed. With this configuration, if the primary Adapter server goes out-of-service, the DNS server can point users to the secondary Adapter server that is in-service.

• Highly Available HTTP Proxy Server - A highly available HTTP Proxy server can be used to forward requests between Adapters. When the primary Adapter server goes out-of-service, the HTTP proxy server should be able to forward requests to a secondary Adapter server that is in-service.

Agent Scaling

It is assumed that if the endpoint application is up and running, it should be able to invoke the Agent script running within that environment. The agent needs to only notify one acquisition adapter that is running. The reason is that the message only needs to be added to the queue once.

There are two options for this:• If the customer has a Round-Robin DNS or proxy set up that allows access to

any of the installed adapters that are running, this can be used from the agent. The agent would point to the single hostname. One of the adapters receives the request and add it only once to the queue.

• If multiple URLs are present on the agent command line, it makes the request to only one of them, the first available one. Store-forwarding is still provided but is only used if none of the services can be reached.

79 VERSION 2.4 REV A01 300-011-516

JAVA TO ADAPTER INTEGRATION

Java to Adapter Integration 6

If a Java application must be used to push information into any of the Adapter RESTful web services, specific Java code must be used. Figure 6-3 includes a Java code sample used to perform an HTTP POST or GET with the EMC Adapter.

Prerequisites

In order to use this code, you need to download the Apache Commons HTTP Client version 3.1. The Commons HTTP Client can be downloaded from the following location:

http://hc.apache.org/downloads.cgi

From the Apache Http Components Downloads page, scroll down and select to download the Commons HttpClient 3.1. To use this client, you also need the following jar files:• commons-httpclient-3.1.jar • commons-codec-1.3.jar • commons-logging-1.1.1.jar


JAVA TO ADAPTER INTEGRATION

Figure 6-3 Sample Java code

package com.iwave.net;import java.io.IOException;import org.apache.commons.httpclient.HttpClient;import org.apache.commons.httpclient.HttpException;import org.apache.commons.httpclient.HttpStatus;import org.apache.commons.httpclient.methods.GetMethod;import org.apache.commons.httpclient.methods.PostMethod;import org.apache.commons.httpclient.methods.StringRequestEntity;/** * Example of making an HTTP GET or POST in Java. * * */public class SimpleHTTPClient { public String post(String url, String xml) throws HttpException, IOException { HttpClient client = new HttpClient(); PostMethod method = new PostMethod(url); try { if (xml != null) { method.setRequestEntity(new StringRequestEntity(xml, "text/xml" , "UTF-8")); } // Execute the method. int statusCode = client.executeMethod(method); if (statusCode != HttpStatus.SC_OK) { throw new IOException("HTTP POST method failed: " + method.getStatusLine()); } return method.getResponseBodyAsString(); } finally { method.releaseConnection(); } } public String get(String url) throws HttpException, IOException { HttpClient client = new HttpClient(); GetMethod method = new GetMethod(url); try { // Execute the method. int statusCode = client.executeMethod(method); if (statusCode != HttpStatus.SC_OK) { throw new IOException("HTTP GET method failed: " + method.getStatusLine()); } return method.getResponseBodyAsString(); }

81 VERSION 2.4 REV A01 300-011-516

PERSISTENCE DATABASE MANAGEMENT

Persistence Database Management 6

This section discusses the following maintenance tasks that can be performed on the Persistence database.• Removing Transactions• Reclaiming Unused Disk Space• Connecting to the Database• Changing the Database Port Number• Offloading the Acquisition Queue to an External Database

Removing Transactions

The pruning service removes all transactions that are older than 7 days and are in the “Error” state from the Persistence database. The service runs every night at 3:00 a.m.

Reclaiming Unused Disk Space

After large amounts of data have been deleted or updated on the Derby database, a Derby table or index can contain unused space. By default, Derby does not return unused space to the operating system. However, Derby does provide a way to reclaim unused space in tables and associated indexes.

If you determine that a table and its indexes have a significant amount of unused space, use one of the following procedures to reclaim the space: • SYSCS_UTIL.SYSCS_COMPRESS_TABLE - is guaranteed to recover the

maximum amount of free space, at the cost of temporarily creating new tables and indexes before the statement in committed.

• SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE - attempts to reclaim space within the same table, but cannot guarantee it will recover all available space. This procedure uses no temporary files and moves rows around within the same table or index.

For more information, refer to the Apache Derby Administration Guide.

To reclaim space in the table and recreate the indexes, execute the following script from adapters/bin directory:

runScript.bat derbyMaint


PERSISTENCE DATABASE MANAGEMENT

Connecting to the Database

To connect to the Adapter Derby database over the network, use the Java driver derbyclient-10.4.2.0.jar. The following URL will connect to the Derby database running in the Adapter.

jdbc:derby://HOST:1528/persistence-db

Changing the Database Port Number

To change the port number of the database, modify the derby.drpa.portNumber in the system.properties file located in the conf directory.

Offloading the Acquisition Queue to an External Database

In addition to the Apache Derby database, the Acquisition Queue can be offloaded to an external database. To enable support for another database, complete the following steps:1. Download the JDBC driver for the required platform and place the file in the

lib/adapters directory in the adapter install directory.2. Modify the following properties in the Adapter framework.properties

file:— datasource.jdbc.driver: identifies the database driver name

(i.e., com.microsoft.sqlserver.jdbc.SQLServerDriver).— datasource.jdbc.url: identifies the URL to the database

(i.e., jdbc:sqlserver://hostname:1433;DatabaseName=testdb).— datasource.jdbc.username: Username— datasource.jdbc.password: Password. This can be encrypted if

desired.3. Restart the Adapter.

For the database to be highly available, database clustering technologies should be used. Refer to the appropriate database documentation for more information.

83 VERSION 2.4 REV A01 300-011-516

7Chapter
Ionix IT Orchestrator Configuration 1
Topics covered in this chapter:• Using the ITIL Adapter Plugin• Adapter API

Using the ITIL Adapter Plugin 1

The ITIL Adapters plugin for Orchestrator enables the ITIL Adapters to be easily used from EMC Ionix IT Orchestrator and leverages the Adapter API.

Associated Files

The following files are utilized by the Adapters plugin:• com.iwave.ext.adapters_x.x.zip – This is the core of the Adapters plugin for

Orchestrator. This plugin provides the ‘TransactionProcessor’ for acquisition and the Tasks for operation services. It also contains the full Adapter API jar files so that they can be used within workflows.

• com.iwave.ext.adapters.httpdispatcher_x.x.zip - This archive contains the AdaptersDispatcher.war. This needs to be loaded with the container and provides an endpoint that communicates with the adapters push mechanism. Extract this zip to the root of the container and it should be unpacked in the correct directory.

• com.iwave.ext.adapters.examples_x.x.zip – (Optional) This is an Orchestrator project that should be imported into Studio. It contains some tests and examples on how to use the push mechanism. This project is not required to use this plugin but is helpful as a starting point and example.

Installation and Configuration

HTTP Dispatcher (com.iwave.ext.adapters.httpdispatcher_2.3.1)

This component is a web application that provides a Web API used by the Adapter to push to the Ionix IT Orchestrator. This is required for the


https://integratorng.trac.cvsdude.com/integratorng/wiki/AdaptersAPI

https://internal-sbs.iwavesoftware.com:8084/servlet/JiveServlet/showImage/102-1011-5-1004/client-workflow.jpg





https://prime:8444/TransactionDispatcher/ClientA

https://prime:8444/TransactionDispatcher/ClientB

USING THE ITIL ADAPTER PLUGIN

Acquisition Push feature. The web application is packaged as a single file called AdaptersDispatcher.war.

To install this component: 1. Copy the AdaptersDispatcher.war file to the conf/webapps/

directory of the container. 2. Extract the zip file to the root container directory and it will be placed in the

correct location.3. If you do not wish to use a standalone container install, there is a container

install bundled with studio. This container install is located in directory plugins/com.enigmatec.ems.platform_4.0.0.

4. Ensure that a JAAS login module is set up for the container. The default container install sets up JAAS to use conf/JaasAuth-windows.conf. This enables Windows based authentication, which will always succeed if the user is logged in.

Adapters Plugin (com.iwave.ext.adapters_2.3.1)

The com.iwave.ext.adapters plugin needs to be installed in both Studio and the container. This is installed like any other Ionix IT Orchestrator plugin. A new version of this plugin will be required for a new release of the adapters as it contains the API for a specific adapters version.

To install this plugin:1. Extract the com.iwave.ext.adapters_2.3.1.zip to the base studio

directory. This will install the plugin into the plugins directory of studio. If a previous version of the plugin exists, remove it by removing the plugins\com.iwave.ext.adapters* from the studio installation.

2. A sample container startup script called adapters-container.bat is provided with the examples project. After extracting the examples project, you can find this file in the resources directory. The following jar files from the plugin need to be on the classpath for the container. The adapters-container.bat script takes care of this for you. — plugins\com.iwave.ext.adapters_2.3.1\adapters.jar

— plugins\com.iwave.ext.adapters_2.3.1\lib\api-2.3.jar

— plugins\com.iwave.ext.adapters_2.3.1\lib\ejb3-persistence-1.0.2.GA.jar

adapters-container.bat:

set ORCH_HOME=c:\iWaveSoftware\orchestrator-studio\plugins\com.enigmatec.ems.platform_4.0.0

set CONTAINER_CLASSPATH=%ORCH_HOME%\..\com.iwave.ext.adapters_2.3.1\adapters.jar;%CONTAINER_CLASSPATH%

85 VERSION 2.4 REV A01 300-011-516

https://internal-sbs.iwavesoftware.com:8084/servlet/JiveServlet/showImage/102-1011-5-1001/newservice.jpg





set CONTAINER_CLASSPATH=%ORCH_HOME%\..\com.iwave.ext.adapters_2.3.1\lib\api-2.3.jar;%CONTAINER_CLASSPATH%

set CONTAINER_CLASSPATH=%ORCH_HOME%\..\com.iwave.ext.adapters_2.3.1\lib\ejb3-persistence-1.0.2.GA.jar;%CONTAINER_CLASSPATH%

%ORCH_HOME%\bin\container -r c:\iWaveSoftware\orchestrator-repository-adapters

Adapters Push Configuration

The com.iwave.ext.adapters.examples project contains samples of implementing a push handler. The sample sets up two push clients that can be accessed via the URLs https://localhost:8444/TransactionDispatcher/ClientA and https://localhost:8444/TransactionDispatcher/ClientB. These need to be specified in the adapters configuration.• Adapters - To enable the push mechanism on the adapters, the

acquisition-push-spring.xml file needs to be placed in the conf directory of the adapters. This should contain the content below. Note that multiple QueueProcessors can be included to perform pushes from multiple different objectType/serviceIds.

acquisition-push-spring.xml

<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"><bean>

<property name="threads" value="3"/><property name="objectType" value="*"/><property name="serviceId" value="*"/><property name="pusher"><bean>

<property name="url" value="https://prime:8444/AdaptersDispatcher/ClientA"/>

<property name="username" value="admin"/><property name="password" value="admin"/></bean>

</property> </bean>

</beans>



Using the Plugin

This section describes how to use the adapters plugin.

Acquisition

The adapters plugin provides a special ME type to handle TransactionRecords pushed from the adapters. A service can be created to implement this ME type by creating a new Service and adding the super type TransactionProcessor.

Figure 7-1 Creating a New Service

The TransactionProcessor type requires an effector to be implemented named processTransaction. This effector provides a TransactionRecord as a parameter that has to be processed by the workflow. When the workflow successfully completes, the record will be marked as complete in the adapters.

The effector has two return fields:• transactionResponse - This field indicates if the processing of the record was

successful or not. There are three possible values for this return:

87 VERSION 2.4 REV A01 300-011-516


— com.iwave.ext.adapters.acquisition.TransactionResponse.OK - Indicates that the processing was successful. This responds to the adapters with a success code and the transaction will be completed (unless it was manually changed through the workflow.

— com.iwave.ext.adapters.acquisition.TransactionResponse.ERROR_RETRY - Indicates that there was an error processing the record. The adapters will retry this again after the usual interval. This is the default handling for errors.

— com.iwave.ext.adapters.acquisition.TransactionResponse.ERROR_NO_RETRY - Indicates that there was an error processing the record that will always fail and it should not be retried again.

• errorMessage - If an error occurred, this contains the text that is passed to the Adapters. This is useful for logging the error back into the adapters logs and to Monitoring Server.

Operations

The adapters plugin provides Services for each of the common services available in the adapters API. Theses services are available from the palette under the com.iwave.ext.adapters heading. They can be dropped onto any workflow.

Figure 7-2 Workflow



Configuration of the adapter services is done from the service organization. You need to specify the following configuration parameters to connect to the adapters web services. • wsdl - URL to the WSDL for the web service. This may be a URL to a resource or

the local file system and does not necessarily need to be the remote endpoint.• endpointUrl - The URL to the endpoint to use for the web service. If this is null

then the endpoint URL contained in the WSDL file is used. • username - The HTTP Basic Authentication username to use for

authentication to the adapters. • password - The HTTP Basic Authentication password to use for authentication

to the adapters.Figure 7-3 Client Service Organization

89 VERSION 2.4 REV A01 300-011-516

ADAPTER API

Adapter API 7

The Adapter API is a subset of the Adapter Framework that contains the common object model and services that are used for all of the ITIL adapters. All Adapter services are exposed as Web Services. This API provides a mechanism for integrating Java-based tools with the adapters. The functionality of this API is exactly the same as what can be used from the Web Services.

Note: This API cannot be used if you need to integrate a non Java-basedsystem with the adapters.

The Adapter API uses JAX-WS to connect to the API using the standard Web Services.

Software Requirements

When using this ITIL Adapter API with Ionix IT Orchestrator, the following software is required:• Java version 6 • Adapters version 2.3 (or later)

API Distribution

The API distribution zip file (i.e., api-2.4.zip) contains the following files and directories:• javadocs - JavaDoc documentation for the API. This should be used as a full

reference for the API operations. • lib/api-2.3.jar - This is the main API archive. • lib/ejb3-persistence-1.0.2.GA.jar - The API depends on the JPA

('javax.persistence') APIs. This is part of JEE but is provided as a standalone jar file.

• lib/log4j-1.2.14.jar - The API does limited logging in certain situations. The log4j logger jar file is required for this.

Package Descriptions

The following are the descriptions of the packages included in the API:• com.iwave.acquisition - Object model and services for the adapter

acquisition services. • com.iwave.adapters - Adapters Client API entry point. • com.iwave.batch - Object model and services for the adapter batch services.


ADAPTER API

• com.iwave.ims - Object model and services for the Monitoring Server services.

• com.iwave.itom - The IT Object Model and supporting helper classes. • com.iwave.operations - The Adapters operational services (IT endpoint

operations). • com.iwave.util - Various internal utilities required by the API.

Key Classes

This following are the descriptions of the key classes in the API. For complete information on the API and methods available, consult the Javadocs.• com.iwave.adapters.AdapterClient - This is a utility class for getting client

proxies to the acquisition, Monitoring Server, batch and operation services. • com.iwave.itom.support.XmlSerialization - This is a utility for serializing

and deserializing adapter object models to/from XML. • com.iwave.itom.extended.ExtendedFieldFactory - This is a utility class for

creating extended fields from k-v Map constructs or getting Maps from extended fields. This is the easiest way of working with extended fields from Java.

Service Classes

The following are the Service Classes included in the API:• Acquisition Services:

— IAcquisitionService - Acquisition Services for interacting with the adapters queue.

— IAcquisitionManagementService - Management information about the adapter queue.

• Batch Services:— IBatchService - Batch services.

• iWave Monitoring Server Services:— IIWaveEventService - Monitoring Server Service for publishing events.

• IT Operational Services:— IITObjectService - ITObject Operations service. — IITObjectAttachmentService - ITObject Operations service. This also

supports attachments and must be used for operations for adapters that support attachments.

— IIncidentService - Incident Operations service. — IIncidentAttachmentService - Incident Operations service. This also


— IChangeService - Change Operations service.

91 VERSION 2.4 REV A01 300-011-516

ADAPTER API

— IChangeAttachmentService - Change Operations service. This also supports attachments and must be used for operations for adapters that support attachments.

— IProblemService - Problem Operations service. — IProblemAttachmentService - Problem Operations service. This also


— IConfigurationService - Configuration Item Operations service.— IDeviceService - Device Operations service. — IDomainDeviceService - Device Operations service that accepts the

domain/network as an extra parameter to each call. This is required for adapters such as ITOI that has this capability.

— IEventService - Event Operations service. — IEventServiceDestination - Event Operations Service that requires the

destination/domain to be specified on each call. This is required for adapters such as SCOM that has this capability.

SSL Certificates

If the Adapter service is using a self signed certificate, JAX-WS may fail to establish an SSL connection. There are two options for dealing with this potential failure:• Install the SSL Certificate from the adapters into the trust keystore for the Java

application using the API. • Disable trust verification for SSL. This can be dangerous on the public internet

allowing for man-in-the-middle attacks but is generally not a problem where customers have a secure pipe to begin with. This is almost always the case for our customers. The 'com.iwave.ext.adapters.examples' orchestrator project contains an example of installing a trust-all security manager.


ADAPTER API

Java Code Examples

This section includes Java code examples of the Acquisition Services and Incident Services. For complete examples on how to use this API from Ionix IT Orchestrator, see the 'com.iwave.ext.adapters.examples' orchestrator project that is available with the API.

Figure 7-4 Acquisition Example

// Example using the acquisition services IAcquisitionService acquisition = AdapterClient.get(IAcquisitionService.class, "https://hostname:9443/services/AcquisitionService?wsdl", "iwave", "password"); // Example creating a service with no authentication: //IAcquisitionService acquisition = AdapterClient.newClient(IAcquisitionService.class,

// "https://hostname:9443/services/AcquisitionService?wsdl"); // Example creating a service with an alternate endpoint URL: //IAcquisitionService acquisition = AdapterClient.newClient(IAcquisitionService.class,

// "https://hostname:9443/services/AcquisitionService?wsdl", // "https://alternatehost:9443/services/AcquisitionService", // "iwave", "password"); // Calling count System.out.println("Adapter queue count: " + acquisition.count());

93 VERSION 2.4 REV A01 300-011-516

ADAPTER API

Figure 7-5 Incident Operations Example

// Example using the incident service. After this service is created, // this proxy should be cached. Creating this every time is expensive. IIncidentAttachmentService inc = AdapterClient.get(IIncidentAttachmentService.class, "https://hostname:9443/services/ionix-sm/IncidentService?wsdl", "iwave", "password"); // Retrieving an incident Incident incident = inc.get("2"); System.out.println("Incident Found: " + incident.getIdentifier()); System.out.println(" Desc: " + incident.getDescription()); // Print the entire incident content as XML System.out.println(incident); // Example accessing extended fields. // This can be used to access a single field but it is not efficient System.out.println("Field 'MODE': " + incident.getExtendedField("MODE", StringField.class).getValue()); // This should be used for easiest access to bulk fields. // This creates a map for accessing fields by key/value pairs Map<String,Object> fields = ExtendedFieldFactory.fieldsToMap(incident.getExtendedFields()); System.out.println("Field 'MODE': " + fields.get("MODE"));

// Updating an Incident Incident updateIncident = new Incident(); // ID is required for updates updateIncident.setIdentifier("2"); updateIncident.setDescription("Updated the description"); // Creating extended fields on update (Single mode)

//updateIncident.addExtendedField("MODE", "REVIEW"); // Creating many extended fields. (This will probably change to Map<String,Object>) Map<Object,Object> updateFields = new HashMap<Object,Object>(); updateFields.put("MODE", "REVIEW"); updateIncident.addExtendedFields(updateFields); // or

//updateIncident.setExtendedFields(ExtendedFieldFactory.newExtendedFields(updateFields)); // Perform the update System.out.println(updateIncident);

System.out.println(inc.update(updateIncident));


ADAPTER API

95 VERSION 2.4 REV A01 300-011-516

8Chapter
Managing the Adapter 8
In order to manage the EMC Adapters, the Java Console application may be installed on your workstation. The Java Console graphical user interface is a management tool that complies to the Java Management Extensions (JMX) specification. Java Console uses the Java Virtual Machine (Java VM) to provide information about the performance and resource consumption of the Adapters installed in your network.

This application allows you to perform the following functions:• list the names of the Adapters that are licensed and loaded• provide the status of the endpoint applications• restart all Adapters• provide a status of items in the Acquisition Queue

Note: For information on monitoring Events that are generated on the EMCAdapter and Ionix IT Orchestrator, refer to the “EMC Monitoring ServerInstallation and Configuration Guide”.


PREREQUISITES

Figure 8-1 Jconsole – List Adapters

Prerequisites 8

In order to use the Java console to manage the Adapter services, the following tasks must be completed:• The Adapter software must be installed on your computer.• The following Java Development Kit (JDK) package must be installed on your

computer:Java JDK1.6.0

Connecting to the Adapter Java Process 8

There are two ways you can connect to the Adapter Java process: • Connect to the local JMX instance. By default, JMX is not available for remote

connection. Java allows you to connect to a Java process running as the same user using the jconsole.

• JMX can be enabled in the process itself for remote access. Remote access can make use of SSL and authentication. setEnv – Enable JMX monitoring in

97 VERSION 2.4 REV A01 300-011-516

STARTING THE JAVA CONSOLE

setEnv20 identifies the Java properties that can be set to enable JMX without any security or authentication. These properties are included in the setEnv.bat/.sh file, which is located in the install_root\adapters-2.4\bin directory. The JMX monitoring properties are disabled by default. To enable JMX monitoring, delete the rem comment from the setEnv file. PORT can be replaced with any port name that is desired. — -Dcom.sun.management.jmxremote.port=PORT

-Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false

Figure 8-2 setEnv – Enable JMX monitoring in setEnv

Starting the Java Console 8

The Java Console is started by the jconsole executable. This executable can be found in the JDK_HOME/bin directory, where JDK_HOME is the directory in which the JDK software is installed. If this directory is in your system path, you can start the Java Console by typing jconsole in a command (shell) prompt. Otherwise, you have to type the full path to the executable file.

Management Beans 8

The following Adapter management beans can be used through JMX to manage the Adapter:• com.iwave:name=Adapters • com.iwave:name=AcquisitionQueue • com.iwave:name=FrameworkAdmin

com.iwave:name=Adapters

The Adapters Management bean allows the user to see which Adapters are loaded and the status of the endpoint applications.

Methods

The following Methods are supported for the Adapter Management bean:• listAdapterNames() - Gives a list of the names of the adapters that are

licensed and loaded.


MANAGEMENT BEANS

• getEndpointStatus(endpointName) - Gives the status of an adapter. The supplied parameter endpointName should be one of the values returned from listAdapterNames(). Possible values for endpoint status are: — Unknown - Indicates that this adapter does not support the status

check. Currently the only adapters that support this operation are BMC Remedy and CA-USD.

— Available - Indicates that the endpoint application is running and responds to a simple command.

• NotAvailable - Indicates that the endpoint application cannot be reached or fails to respond to a simple command.

com.iwave:name=AcquisitionQueue

The Acquisition Management bean allows the user to see the status of the Acquisition Queue without directly querying the database.

Methods

The following Methods are supported for the Acquisition Queue bean:• countErrors(serviceId, objectType) - Gives a count of the items

on the queue in the Error state. This is the same as the acquisition service countErrors() method.

• countPoll(serviceId, objectType) - Gives a count of the items on the queue in the Poll state. This is the same as the acquisition service count() method.

• countBlocked(serviceId, objectType) - Gives a count of the items on the queue in the Blocked state.

• countTotal(serviceId, objectType) - Gives a count of all of the items on the queue regardless of state.

• queueWaitingTime() - Gets the queue waiting time for the top item on the persistence queue. The date of the first transaction is returned. This can give an idea of when the last transaction was processed and if the queue processor is stalled.

Each of the count methods take parameters of the serviceId and objectType. These must be valid serviceId and objectType or part of a word. % is a valid wildcard. If no objectType and serviceId are specified, the default will be to query all.

Note: The Acquisition Management Service is also exposed as a web service.The following is the WSDL for the Acquisition Management Service:

https://localhost:9443/services/AcquisitionManagementService?wsdl

99 VERSION 2.4 REV A01 300-011-516

MANAGEMENT BEANS

com.iwave:name=FrameworkAdmin

The Framework Administration bean allows administration tasks to be performed on the Adapters.

Methods

The following Methods are supported for the Adapter Management bean:• restart(password) - Restarts the adapters. All services are shutdown,

configuration files reloaded and the services restarted. A parameter of the admin password is required.

• framework.admin.password - This is the new setting in framework.properties that contains the admin password hash. The default value for this password is adminpw. If the JMX service will be enabled, this password should be changed from the default.


MANAGEMENT BEANS

101 VERSION 2.4 REV A01 300-011-516

9Chapter
Maintenance and Troubleshooting 9
This chapter covers the following topics pertaining to the maintenance and troubleshooting of the EMC Adapter software.• Logging• Error Types and Meanings• Re-Installing or Uninstalling the Windows Service• Starting and Stopping the Adapter• Uninstalling the Adapter Software - Windows

Logging 9

Logging is provided for both the Adapter Framework and the URL Agent. Before logs can be generated, logging must be turned on and the amount of details specified.

Log Location

Based on the operating system, the EMC Adapter stores logs in following directories:• For Windows: C:\install_root\adapters\log

• For UNIX: /opt/install_root/adapters/log

Turning on Adapter Logging (Windows)

To turn on Adapter Windows logging, you must edit the log4j.properties file.1. From Windows Explorer, navigate to the conf directory:

C:\install_root\Adapters\conf2. Right-click log4j.properties file and click Open on the pop-up menu. If

this is the first time you have opened the properties file, Windows displays the following dialog:


LOGGING

Figure 9-1 Windows Unknown File Type

3. Click Select the program from a list option and click OK.4. From the Open With List, select Notepad. Select Always use the selected

program to open this kind of file and click OK to open Notepad.5. In the log4jproperties file, find the Production Environment

Configuration section and the line: log4j.rootLogger=INFO,File,ErrorAppender

6. Replace the word INFO with DEBUG.7. Find the line: log4j.logger.com.iwave=INFO8. Replace the word INFO with DEBUG. The log4j.properties file should look

like the file identified in Figure 9-2.9. From the menu, select File > Save to save the changes.10. From the menu, select File > Exit to close the file.

103 VERSION 2.4 REV A01 300-011-516

LOGGING

Figure 9-2 log4j.properties File

•


ERROR TYPES AND MEANINGS

Error Types and Meanings 9

The URL Agent and EMC Adapter generate their own errors. Several types of errors can occur when several complex software applications interact. This complexity is expanded when considering that the applications may be communicating over vast distances (via the Internet) and that they are typically asynchronous.

The following types of errors that may occur when using the EMC Adapter:• Recoverable• Permanent• Global Errors

Recoverable Errors

Recoverable errors go away in time without involving any particular change to the EMC configuration or the endpoint application. For instance, if the EMC URL Agent attempts to send an event notification to the EMC Adapter and the connection is down, the Agent continues sending the notification until the connection is restored. In this case, there is an error message in the log, but no action needs to be performed to return the Adapter to service. The Adapter is returned to service automatically.

Permanent Errors

Permanent errors cannot be recovered automatically and require some form or corrective interaction. For example, if the EMC user for the endpoint application does not have a high enough privilege to open a new incident, the attempt fails. No matter how many times the EMC user attempts to open a new Incident, the action continues to fail until the user account is modified to allow the action.

Global Errors

An error can thrown from either the Adapter, Ionix IT Orchestrator or Integration workflow. Some of these errors are results of errant configurations such as an incorrect workflow assumption, incorrect URL, or a bad SSL configuration. Other errors could result from an error in the software itself.

105 VERSION 2.4 REV A01 300-011-516

ERROR TYPES AND MEANINGS

Adapter Errors

The table below indicates errors that can occur in the EMC Adapter. These errors can be generated by either the Acquisition or Operations Services.

Table 9-1 Adapter errors

Error Cause

AcquisitionException A problem occurred while trying to retrieve a transaction from the adapter.

ObjectNotFoundException Occurs when the object requested on a get, update, or remove operation is not found

UnsupportedOperationException The method used on the adapter is not supported by the adapter.

OperationsException Typically a recoverable error such as connectivity issues

NonRecoverableOperationsException

Permanent error condition.


https://integratorng-trac.cvsdude.com/integratorng/wiki/AcquisitionException

RE-INSTALLING OR UNINSTALLING THE WINDOWS SERVICE

ReInstalling or Uninstalling the Windows Service 9

If the Windows Service needs to be re-installed or un-installed, complete the following steps:

Reinstalling the Windows Service

To re-install the Windows Service:

1. Access the bin directory:install_root/adapters-2.4/bin

2. Run the installation script.service.bat install

Uninstalling the Windows Service

To uninstall the Windows Service:

1. Access the bin directory:install_root/adapters-2.4/bin

2. Run the un-install script.service.bat uninstall

Starting and Stopping the Adapter 9

If the Windows Service has been uninstalled and the Adapter needs to be started, the startAdapters.bat file is included in the following directory:

install_root/adapters-2.4/bin/startAdapters.bat

This command starts the Adapter framework with a command window. To stop the Adapter framework, close the command window.

107 VERSION 2.4 REV A01 300-011-516

UNINSTALLING THE ADAPTER SOFTWARE - WINDOWS

Uninstalling the Adapter Software Windows 9

To uninstall the EMC Adapter software, complete the following tasks:1. From the Start menu, select the Uninstall Adapters option.2. The Uninstall EMC Adapters Introduction screen displays. From this screen,

click Uninstall.Figure 9-3 Uninstall Introduction



3. The Uninstaller begins to remove features associated with the installed Adapter. It then uninstalls the EMC Adapter files, shortcut, LaunchAnywhere features, folders, and registry.

Figure 9-4 Uninstall In Progress

109 VERSION 2.4 REV A01 300-011-516


4. The Uninstallation Complete screen displays. The files that were not installed may be displayed on the screen. These files must be removed manually. Click Done.

Figure 9-5 Uninstallation complete



111 VERSION 2.4 REV A01 300-011-516

10Chapter
IT Object Model (ITOM) 1
Table 10-1 identifies the Event mappings for the HP-NNM Adapter.


VERSION 2.4 REV A01 300-011-516

Notes

The uuid of the NNM event related to a trap.

Traps do not have anything in their fixed fields that is equivalent to this; everything other than uuid is in variable bindings, which are specific to a particular MIB and therefore cannot be mapped in advance in a universally applicable model

113

Table 10-1 ITOM Event Mapping for HP-NNM

Name Description Type Name (Label)

Type

Base.Identifier The unique identifier for an Event xs:string uuid

Base.Summary Summary of the Event xs:string

Base.Description Detailed description of the Event xs:string

Type Event type xs:string

Status The status of the event xs:string

Severity The severity of the event

Impact The impact that this event has on the system

xs:string

Urgency The urgency of the event xs:string

Priority The priority of the event xs:string

RepeatCount A count of the number of duplicate events

xs:integer

LastRepeatDate Date of the last duplicated event xs:datetime

—sheet 1 of 8—

114

Notes

EMC IONIX IT ORCHESTRATOR ADAPTER HP NNM INSTALLATION AND CONFIGURATION GUIDE

Owner Owner that is responsible for resolving this event

xs:string

CreateDate Date that this event was created xs:datetime

ResolvedDate Date that this event was resolved xs:datetime

ResolvedBy User that resolved the event xs:string

LastModifiedBy User that made the last modification

xs:string

LastModified Date of the last modification to this event

xs:datetime

StatusLastModified Date that the status of this event was last modified

xs:datetime

LastModifiedByNonConnector Date that this event was last modified by a non-connector

xs:datetime

MaintenanceModeLastModified Date of the last modification to this event while in maintenance mode

xs:datetime

MonitorEvent Flag to indicate whether this is an event generated by a monitor

xs:boolean

ExternalEventIdentifier The unique identifier for this event in the external system

xs:string

Table 10-1 ITOM Event Mapping for HP-NNM (continued)


Type

—sheet 2 of 8—

VERSION 2.4 REV A01 300-011-516

vent

Notes

115

ExternalIncidentIdentifier The unique identifier for an incident associated with this event

xs:string

Escalation Indicates information about the escalation of this event

Escalation.Escalated Unique identifier of the group associated with this event

xs:boolean

Escalation.Server Server that escalated this event xs:string

Escalation.EscalatedBy User who escalated this event xs:string

Group Group that encompasses the components associated with this e

Group.Identifier Unique identifier of the group associated with this event

xs:string

Group.Name Name of the group associated with this event

xs:string

Group.Version Version number of the group associated with this event

xs:string

Class Class of object targeted by this event

Class.Identifier Unique identifier of the class xs:string

Class.Name Formal name of the class xs:string

Class.DisplayName Console display name of the class

xs:string



Type

—sheet 3 of 8—

116

Notes


Class.Description Description of the class xs:string

Class.Container.Identifier Unique identifier of the container where the class is defined

xs:string

Class.Container.Name Formal name of the container where the class is defined

xs:string

Class.Container.DisplayName Console display name of the container where the class is defined

xs:string

Class.Container.Description Description of the container where the class is defined

xs:string

Object Object targeted by this event

Object.Identifier Unique identifier of the target object

xs:string

Object.ComputerName Name of the computer where this object is located

xs:string

Object.DisplayName Display name of the target object xs:string

Object.Name Formal name of the target object xs:string

Object.State State of the target object xs:string

Object.InMaintenanceMode Flag that indicates whether the object is in maintenance mode

xs:boolean

Metric Metric that was violated to trigger the event



Type

—sheet 4 of 8—

VERSION 2.4 REV A01 300-011-516

Notes

117

Metric.Category Name of the metric category that was violated

xs:string

Metric.Subcategory Name of the metric subcategory that was violated

xs:string

Metric.KeyValues Array of key values associated with the metric

xs:string

Source Notification source that generated the event

Source.Identifier Unique identifier of the source that generated this event

xs:string

Source.Type Type of source that generated this event

xs:string

Source.DisplayName Console display name of the source that generated this event

xs:string

Source.Name Formal name of the source that generated this event

xs:string

Source.Description Description of the source that generated this event

xs:string

Source.Domain Domain of the computer that generated this event

xs:string

Source.ComputerName Fully qualified name of the computer that originated this event

xs:string



Type

—sheet 5 of 8—

118

Notes


Source.Container.Identifier Unique identifier of the container that defines the source that originated this event

xs:string

Source.Container.DisplayName Console display name of the container that defines the source that generated this event

xs:string

Source.Container.Name Formal name of the container that defines the source that generated this event

xs:string

Source.Container.Description Description of the container that defines the source that generated this event

xs:string

Knowledge Knowledge entry associated with this event

Knowledge.Type Type of knowledge entry xs:string

Knowledge.Summary Brief description of the knowledge entry

xs:string

Knowledge.Description Description of the knowledge entry

xs:string

Knowledge.DisplayName Console display name of the knowledge entry

xs:string

Knowledge.Name Formal name of the knowledge entry

xs:string



Type

—sheet 6 of 8—

VERSION 2.4 REV A01 300-011-516

Notes

119

Knowledge.Content Knowledge entry information in a common format. Format to be used is TBD

xs:string

Knowledge.Identifier Unique identifier of the knowledge entry

xs:string

Knowledge.LanguageCode Language used in the knowledge information

xs:string

Knowledge.LastModified Date the knowledge entry was last updated

xs:datetime

Knowledge.Status Status of the knowledge entry xs:string

Knowledge.dateCreated Date the knowledge entry was created

xs:datetime

Log Logging Activity

Log.Identifier Log unique identifier for each instance

xs:string

Log.Type Type of Log activity xs:string

Log.Summary Log Summary xs:string

Log.Source Log Source xs:string

Log.Description Log Description xs:string

Log.Submitter User who submtted the log entry xs:string



Type

—sheet 7 of 8—

120

Notes


Log.SubmitDate The date and time the log entry was submitted

xs:datetime



Type

—sheet 8 of 8—

VERSION 2.4 REV A01 300-011-516
121

Index 1

Aacquisition

monitoring 70WSDL URL location 26

acquisition service 20polling methods 26process flow 20scaling 78

adapterfailover infrastructure 79management 96

Adapter Framework 14running as a Windows service 62starting 107stopping 107

AgentProperties 71

agentscaling 79

agent propertiesHP-NNM 71

alertsautomated 70

Apache Derby 35

Bbase URLs 69blocking methods 27

Cclient acquisition service

running on another port 76core methods 30

Ddatabase

monitoring 69

databasesenabling support for another database 69external

user for multiple adapters 79supported 35

datasource properties 69device service 32discovery service 29

Eerror messages

types 105error types

permanent 105recoverable 105

errors 105Adapter 106

event service 31, 33

Fframework HTTP authentication 69framework properties 67

for the global framework 68

Gglobal framework properties 68

Hhigh availability 78

IInformation Technology Service Management 15install folder 44install set 42, 43installer

Linux 64starting 40


Unix 64ITIL services 15

supported object types 16ITSM 15

applications 12

JJava console

starting 98Java Management Extensions 96Java to Adapter integration 80JMX 96

management beans 98

Llicense file 46

directory location 39installing 39

loglocation

for UNIX 102for Windows 102

methods 30, 31log4j.properties file 102logging 102

turning onfor Windows 102

Ooperating systems

supported 34operations service 23

event service 31, 33process flow 23scaling 78

Ppassword

iMS 49web service authentication 48

permanent errors 105persistence database 82

changing the port number 83connecting to 83removing transactions 82

polling methods 26properties editor 67

command 68starting 67

Rrecoverable errors 105relationship methods 30RESTful Client Acquisition 75

Ssecurity 47shared service operations 30shortcut folder 45SOAP client acquisition service 76software

uninstallWindows 108

software installation 36for Windows 40manual 65

UNIX 65Windows 65

system configuration 34system requirements 34

Tterminal methods 27troubleshooting 102

error types and meanings 105

UURL

iMS 49username

iMS 49web service authentication 48

Wweb service authentication 48Windows service

exectuable location 62manager application 62manual install or uninstall 107re-installing 107running 62uninstalling 107

123 VERSION 2.4 REV A01 300-011-516

B

EMC Corporation

Corporate Headquarters, Hopkinton, MA 01748-9103U.S.A.

Tel.:1-508-435-1000

http://www.EMC.com

EMC Ionix IT Orchestrator AdapterHP NNMInstallation and Configuration Guide

Document number: 300-011-516Product release: 2.4Document version: A01Date: September 2010

Printed in the United States of America.Copyright © 2010, EMC Corporation All Rights Reserved

B

Documents

EMC ITO Adapter HP Network Node Manager (NNM) · EMC® Ionix™ ITO Adapter HP Network Node Manager (NNM) ... iv VERSION 2.4 REV A01 300-011-516 ... Overview