38
IBM ® Tivoli ® Netcool/OMNIbus Gateway for Remedy ARS Version 12.0 Reference Guide November 8, 2013 SC23-6037-11

IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS ... · vi IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: ... various required BMC shared ... 8.0 and 8.1 Remedy 7.5 and 7.6 Remedy

  • Upload
    buitruc

  • View
    267

  • Download
    3

Embed Size (px)

Citation preview

IBM® Tivoli® Netcool/OMNIbus Gateway for Remedy ARSVersion 12.0

Reference GuideNovember 8, 2013

SC23-6037-11

���

IBM® Tivoli® Netcool/OMNIbus Gateway for Remedy ARSVersion 12.0

Reference GuideNovember 8, 2013

SC23-6037-11

���

NoticeBefore using this information and the product it supports, read the information in “Notices and Trademarks,” on page 23.

Edition notice

This edition (SC23-6037-11) applies to version 12.0 of IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS andto all subsequent releases and modifications until otherwise indicated in new editions.

This edition replaces SC23-6037-10.

© Copyright IBM Corporation 2006, 2013.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

About this guide . . . . . . . . . . . vDocument Control Page . . . . . . . . . . vConventions used in this guide . . . . . . . . vi

IBM Tivoli Netcool/OMNIbus Gateway forRemedy ARS . . . . . . . . . . . . 1Summary . . . . . . . . . . . . . . . 1Overview . . . . . . . . . . . . . . . 2Supported Remedy versions and platforms . . . . 3

Running the gateway different versions ofRemedy . . . . . . . . . . . . . . . 3

Installing the gateway . . . . . . . . . . . 4Installing probes and gateways on TivoliNetcool/OMNIbus V8.1 . . . . . . . . . 4Installing the gateway on TivoliNetcool/OMNIbus V7.3.0, V7.3.1, and V7.4.0 . . 6

Configuration . . . . . . . . . . . . . . 7Initial setup. . . . . . . . . . . . . . 7

Connecting the gateway to Remedy without a portmapper . . . . . . . . . . . . . . . 7Gateway for Remedy configuration . . . . . . 8

Action SQL files . . . . . . . . . . . . . 11Example update Action SQL file . . . . . . 11Example close Action SQL file . . . . . . . 11

Mapping . . . . . . . . . . . . . . . 12Example mapping . . . . . . . . . . . 12

Writer attributes . . . . . . . . . . . . . 13Example configuration file . . . . . . . . . 17AES encryption . . . . . . . . . . . . . 19Running the gateway . . . . . . . . . . . 22

Running the gateway on UNIX . . . . . . . 22

Appendix. Notices and Trademarks . . 23Notices . . . . . . . . . . . . . . . . 23Trademarks . . . . . . . . . . . . . . 25

© Copyright IBM Corp. 2006, 2013 iii

iv IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

About this guide

The following sections contain important information about using this guide.

Document Control PageUse this information to track changes between versions of this guide.

The IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS documentation isprovided in softcopy format only. To obtain the most recent version, please visitthe IBM® Tivoli® Netcool® knowledge center:

http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/common/kc_welcome-444.html?lang=en

Table 1. Document modification history

Documentversion

Publicationdate Comments

SC23-6037-01 June 30, 2007 First IBM publication.

SC23-6037-02 December 19,2007

“Summary” on page 1 updated.

Supported Remedy versions and platforms sectionupdated.

Mapping section updated. Writer attributes sectionupdated.

HOPEFUL_PMC_CLOSE attribute description modified.

ENABLE_SECONDARY_CACHE attribute added.

SC23-6037-03 March 28,2008

“Summary” on page 1 updated.

Support added for the AES encryption of string values thatcan be assigned to attributes within the WRITER section ofthe gateway configuration file.

Running the ObjectServer in a secure mode section added.

SC23-6037-04 December 31,2008

“Summary” on page 1 updated.

Supported Remedy versions and platforms sectionupdated.

SC23-6037-05 June 4, 2010 “Summary” on page 1 updated.

“Supported Remedy versions and platforms” on page 3updated.

SC23-6037-06 February 25,2011

“Summary” on page 1 updated.

“Supported Remedy versions and platforms” on page 3updated.

“Connecting the gateway to Remedy without a portmapper” on page 7 updated.

“Event format” on page 11 added.

© Copyright IBM Corp. 2006, 2013 v

Table 1. Document modification history (continued)

Documentversion

Publicationdate Comments

SC23-6037-07 November 4,2011

The following topics were added to this guide:

“Conventions used in this guide”

The password writer attribute description was updated toinclude encryption instructions in the following section:

“Writer attributes” on page 13

SC23-6037-08 April 6, 2012 Support platform information for Linux Suse 10.0 wasadded to “Supported Remedy versions and platforms” onpage 3

SC23-6037-09 November 30,2012

Guide updated for Netcool/OMNIbus V7.4 release.

SC23-6037-10 July 5, 2013 Support extended to Remedy ARS 8.1

“Summary” on page 1 updated.

“Supported Remedy versions and platforms” on page 3updated.

“Configuration” on page 7 updated.

“Adding conversions to the Gateway for Remedy ARS” onpage 8 added.

The following environment variables were added to the“Setting environment variables” on page 8

v NCO_ARWMODULE_READ_USES_LT_X

v NOTIFICATION_SCHEMA

v REMEDY_VIEW

SC23-6037-11 November 8,2013

“Summary” on page 1 updated.

Conventions used in this guideAll gateway guides use standard conventions for operating system-dependentenvironment variables and directory paths.

Operating system-dependent variables and paths

All gateway guides use standard conventions for specifying environment variablesand describing directory paths, depending on what operating systems the gatewayis supported on.

For gateways supported on UNIX and Linux operating systems, gateway guidesuse the standard UNIX conventions such as $variable for environment variables andforward slashes (/) in directory paths. For example:

$OMNIHOME/gates

For gateways supported only on Windows operating systems, gateway guides usethe standard Windows conventions such as %variable% for environment variablesand backward slashes (\) in directory paths. For example:

vi IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

%OMNIHOME%\gates

For gateways supported on UNIX, Linux, and Windows operating systems,gateway guides use the standard UNIX conventions for specifying environmentvariables and describing directory paths. When using the Windows command linewith these gateways, replace the UNIX conventions used in the guide withWindows conventions. If you are using the bash shell on a Windows system, youcan use the UNIX conventions.

Note: The names of environment variables are not always the same in Windowsand UNIX environments. For example, %TEMP% in Windows environments isequivalent to $TMPDIR in UNIX and Linux environments.

Operating system-specific directory names

Where Tivoli Netcool/OMNIbus files are identified as located within an archdirectory under NCHOME or OMNIHOME, arch is a variable that represents youroperating system directory. For example:

$OMNIHOME/gates/arch/

The following table lists the directory names used for each supported operatingsystem.

Table 2. Directory names for the arch variable

Operating system Directory name represented by arch

AIX® systems aix5

HP-UX PA-RISC-based systems hpux11

HP-UX Integrity-based systems hpux11hpia

Red Hat Linux and SUSE systems linux2x86

Linux for System z® linux2s390

Solaris systems solaris2

Windows systems win32

About this guide vii

viii IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS

The IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS is a help desksystem operating on UNIX platforms using a system of trouble tickets.

The Gateway for Remedy ARS converts alerts into Remedy help desk troubletickets. Trouble tickets are updated, according to a predefined mapping throughoutthe lifetime of the alert.

This guide contains the following sections:v “Summary”v “Overview” on page 2v “Supported Remedy versions and platforms” on page 3v “Configuration” on page 7v “Action SQL files” on page 11v “Mapping” on page 12v “Writer attributes” on page 13v “Example configuration file” on page 17

SummaryThe following table provides a summary of the Gateway for Remedy ARS.

Table 3. Summary

Gateway target All Remedy versions from version 7.0 to 8.1.Note: For details of the supported operating systemsfor Remedy, see Table 4 on page 3.

Gateway executable name nco_g_remedy

Additional binaries Additional binaries are installed in the followingdirectory:

$OMNIHOME/gates/remedyNote: For details of these binaries, see “SupportedRemedy versions and platforms” on page 3.

Package Version 12.0

Gateway supported on For details of supported operating systems, see thefollowing Release Notice on the IBM Software Supportwebsite:http://www-01.ibm.com/support/docview.wss?uid=swg21640594Note: For details of which version of these operatingsystems the gateway is supported, see Table 4 on page3.

Configuration files $OMNIHOME/gates/remedy/close_action.remedy.sql

$OMNIHOME/gates/remedy/G_REMEDY.conf

$OMNIHOME/gates/remedy/omnibus.def

$OMNIHOME/gates/remedy/update_action.remedy.sql

Requirements A currently support version of IBM TivoliNetcool/OMNIbus

© Copyright IBM Corp. 2006, 2013 1

Table 3. Summary (continued)

Requirements for Remedy V7.0 toV8.1.

In order for the gateway reader-writer module(nco_arwmodule) to locate various required BMC sharedlibraries, the following directories from an ARS RemedyServer installation need to be included in the librarysearch path.

v The BMC API library (libar) found in the followingdefault location: $ARSERVER/api/lib.Note: This is not required for AIX.

v The BMC ICU libraries (libicu*) are required by theBMC library (libar) whether statically ordynamically linked to the gateway reader-writermodule. These are found in the following defaultlocation: $ARSERVER/bin

Where $ARSERVER is the file path to that location onthe main Remedy ARS server.

Where the library search path is the following on eachoperating system:

v LIBPATH on the AIX operating system.

v SHLIB_PATH on the HPUX operating system.

v LD_LIBRARY_PATH on the Linux and Solaris operatingsystems.

Note: The library path environment variables can beset in the following file:

v $OMNIHOME/platform/arch/bin/nco_g_remedy.env

Note: The default nco_arwmodule is a copy ofnco_arwmodule76 and requires BMC files from an ARSv7.6 arserver installation, while nco_arwmodule81requires files from an ARS v8.1 arserver installation.

The BMC ICU and API libraries can be installed byselecting the api option during the AR System Serverinstallation. The API may be installed separately afterserver installation. For further details, refer to the ARSAPI Reference Guide and server installation instructions.

Remote connectivity Yes

Failover/Failback functionality Available

OverviewThe Gateway for Remedy ARS Action Request System (ARS) is a bidirectionalgateway that converts alerts into Remedy ARS help desk trouble tickets. Troubletickets are updated, according to a predefined mapping, throughout the life-spanof the alert.

The gateway supports the following functions:v Flexible port mapping to Remedy.v Failover and failback between Netcool/OMNIbus and Remedy.v Flexible event filtering that allows you to specify which event details are sent

from Netcool/OMNIbus to Remedy.v Reporting within Netcool/OMNIbus of Remedy operation failures.

2 IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

v Forwarding tickets in Remedy when the associated events in Netcool/OMNIbusare updated or deleted.

v Updating tickets in Remedy when the associated event in Netcool/OMNIbus isupdated.

v Closing tickets in Remedy when the associated event in Netcool/OMNIbus isdeleted, and visa versa.

v Creation of journal entries in Netcool/OMNIbus for Remedy.v TCP functionality.v Conversion of data types.

Supported Remedy versions and platformsThe following table shows the binaries used with each supported version ofRemedy and the platforms on which they run.

The nco_arwmodule file is the reader-writer module default binary, this is located inthe $OMNIHOME/bin/arch/ directory. Where arch represents the operating system.

This file is a copy of the nco_arwmodule76 binary. If you require one of the otherreader-writer binaries, copy the required binary from the $OMNIHOME/gates/remedy/directory to the $OMNIHOME/bin/arch/ directory and rename it to nco_arwmodule.

Note: If one of the reader-writer binaries is compiled against a particular versionof the Remedy gateway API, the required Remedy API libraries must be set in thelibrary search path. See the “Summary” on page 1 for a full list of binaries for eachoperating system.

Table 4. Binaries supplied with Remedy version

Platform Remedy 8.0 and 8.1 Remedy 7.5 and 7.6 Remedy 7.0 and 7.1

Solaris 8, 9, and 10

HP-UX 11.0 and11.11

AIX 5.0, 5.1, 5.2, 5.3and 6.1

Redhat Linux 3.0(ES, AS, and WS),4.0 and 5.0

Linux Suse 10.0

nco_g_remedy

nco_arwmodule81

Note: Remedy 8.1 isnot available onHP-UX.

nco_g_remedy

nco_arwmodule76

nco_g_remedy

nco_arwmodule7

Running the gateway different versions of RemedyPerform the following steps to run the gateway against various versions ofRemedy. By default the gateway runs against Remedy V7.6.

By default, nco_g_remedy and the latest version of nco_arwmodule are installed inthe following directory:$OMNIHOME/bin/arch/

If you are using other versions of Remedy, the gateway is also supplied with therequired binaries for different nco_arwmodule reader-writer modules in thefollowing directory:

IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS 3

$OMNIHOME/gates/remedy/

If you want to run the gateway against other versions of Remedy, you must copythe appropriate nco_arwmodule binary from the $OMNIHOME/gates/remedy/ directoryto the $OMNIHOME/bin/arch/ directory and rename it .

Installing the gatewayThere are separate procedures for installing the gateway on each version of TivoliNetcool/OMNIbus.

Follow the procedure for the version of Tivoli Netcool/OMNIbus that your siteuses.

Installing probes and gateways on Tivoli Netcool/OMNIbusV8.1

From Netcool/OMNIbus V8.1 onwards, Netcool/OMNIbus probes and gatewayscan be installed using the IBM Installation Manager (IM). One of the key featuresof Installation Manager is that all platforms are shipped in a single ZIP file, whichmeans that you do not have to select the platform that you require; InstallationManager does it for you.

Before you can install a probe or gateway, you must have installed and configuredInstallation Manager and Netcool/OMNIbus. To install probes and gateways, youmust make sure that the Core Netcool/OMNIbus features Probe Support andGateway Support respectively are installed.

Installing probes and gateways using the Command Line Tool

To install the probe or gateway using the Command Line Tool, run the followingcommand:

installation_manager_location/eclipse/tools/imcl -c installcom.ibm.tivoli.omnibus.integrations.integration_name -repositoriesrepository_containing_required_integration -installationDirectorylocation_of_netcool_omnibus_install_you_are_installing_into

You will be prompted to agree to the terms and conditions of the license as aprerequisite for installing the integration. If you have no concerns about the licenseand want to skip the manual acceptance, add the -acceptLicense option to theinstall command to silently agree to the license.

The following is an example command used to install the SNMP Probe:

imcl -c install com.ibm.tivoli.omnibus.integrations.nco-p-mttrapd-repositories /home/my_home_dir/nco-p-mttrapd_im_package-installationDirecory /opt/IBM/tivoli/netcool

Where /home/my_home_dir/nco-p-mttrapd_im_package contains the unzippedcontents of the SNMP Probe Installation Manager package.

Note: The command line tool does not add the repository permanently to theInstallation Manager instance. If you subsequently start the Installation ManagerGUI, the repositories will not be present in the Repositories dialog box.

4 IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

Uninstalling probes and gateways using the Command Line Tool

To uninstall the probe or gateway using the Command Line Tool, run thefollowing command:

installation_manager_location/eclipse/tools/imcl uninstallcom.ibm.tivoli.omnibus.integrations.integration_name -installationDirectorylocation_of_netcool_omnibus_install_you_are_uninstalling_from

The following is an example command used to uninstall the SNMP Probe:

imcl uninstall com.ibm.tivoli.omnibus.integrations.nco-p-mttrapd-installationDirecory /opt/IBM/tivoli/netcool

Installing probes and gateways using the GUI

To install the probe or gateway using the GUI, use the following steps:1. Start Installation Manager using the following command:

installer_path/IBMIM

Where installer_path is the path to the Installation Manager directory.2. Ensure that you point to the repository that contains the probe or gateway by

adding the repository using the dialog box got from the following menuactions:Files > Preferences > Repositories.

Use the button Add Repository in the dialog box to carry out this task.

Note: as a prerequisite, the contents of the IM package need to be unzippedinto a directory of your choosing. A file called repository.config will appearafter unzipping the IM package. The repository location in IM should point tothat repository.config file and NOT its containing directory.

3. Click the Install software packages icon.4. Select the name of the probe or gateway that you want to install.5. Click Next.6. Click I accept when the Licensing panel appears.7. Highlight IBM Tivoli Netcool OMNIbus in the Package Group Name field.8. Click Next.9. Click Next.

10. Click Install.11. When the Install Packages panel appears indicating that you have

successfully installed the probe, click Finish.

Uninstalling probes and gateways using the GUI

To uninstall the probe or gateway, use the following steps:1. Start Installation Manager using the following command:

installer_path/IBMIM

Where installer_path is the path to the Installation Manager directory.2. Click the Uninstall software packages icon.3. Select the name of the probe or gateway that you want to uninstall.4. Click Next.

IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS 5

5. Click Unisntall .6. When the Install Packages panel appears indicating that you have successfully

uninstalled the probe, click Finish.

Installing the gateway on Tivoli Netcool/OMNIbus V7.3.0,V7.3.1, and V7.4.0

For Tivoli Netcool/OMNIbus V7.3.0, V7.3.1, and V7.4.0, all gateways are installedusing the Tivoli Netcool/OMNIbus installer.

You can install the gateway using any of the following:v “The installation wizard”v A text-based installer (“Console mode”)v Settings predefined in a text file (“Silent mode” on page 7)

The installation package and patches for the gateway are supplied as archives. Thearchive management application that you use to extract the files must be able topreserve the directory structure contained in the archive on extraction.

Note: If you are installing a 32-bit gateway on a system that runs a 64-bit UNIX orLinux operating system, you will need to install additional, 32-bit operating systemlibraries. See the IBM Tivoli Netcool/OMNIbus Installation and Deployment Guide formore information.

Obtaining the installation packageTo obtain the installation package and prepare it for installation use the followingsteps:1. Download the installation package for the gateway from the Passport

Advantage Online Web site:http://www-306.ibm.com/software/howtobuy/passportadvantage/pao_customers.htm

2. Make a backup of any existing configuration files that you want to retain.3. Extract the contents of the installation package to a temporary directory.

Now use one of the installation methods to install your gateway. In each case, thegateway is installed in the following directory:

$NCHOME/omnibus/gates

The installation wizardTo install the gateway using the installation wizard:1. Run the installer for your operating system:

$NCHOME/omnibus/install/nco_install_integration

2. When the installation wizard starts, specify the extracted directory that containsthe README.txt file as the location of the gateway installation files.

3. Accept the license conditions.

Console modeTo install the gateway in console mode:1. Run the installer for your operating system:

$NCHOME/omnibus/install/nco_install_integration -i console

2. When the text-based installer starts, specify the extracted directory that containsthe README.txt file as the location of the gateway installation files.

6 IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

3. Accept the license conditions.

Silent modeTo install the gateway in silent mode:1. Create a text file named reponse.txt and add the following entries:

PROBE_OR_GATE_LOCATION=README_directorypathLICENSE_ACCEPTED=true

where README_directorypath is the path to the directory containing theREADME.txt file in the extracted package.

2. Run the installer for your operating system:$NCHOME/omnibus/install/nco_install_integration -i silent -fresponse_path/response.txt

where response_path is the full path to the response.txt file.

ConfigurationThe Gateway for Remedy ARS package contains the executable nco_g_remedy andall other components of the gateway. The gateway no longer requires theinstallation of separate gateway and module patches. All of the componentsrequired are now contained in the single nco_g_remedy package.

The default server name for the nco_g_remedy binary is G_REMEDY, this requires theconfiguration of a server entry with the name G_REMEDY within nco_xigen. You canoverride the default server name using the -name command line option.

The nco_g_remedy executable runs the reader-writer module executables.

When nco_g_remedy is started, by default it obtains the configuration file from$OMNIHOME/etc (on UNIX platforms). However, this can be overridden using the-config command line option.

This section describes how to configure the Gateway for Remedy ARS, for moreinformation about installing gateways, refer to the IBM Tivoli Netcool/OMNIbusProbe and Gateway Guide.

Initial setupFor the bidirectional Gateway for Remedy ARS to work correctly, the gatewaymust log in using its own unique username and password. These must not be usedby any other user of the Remedy system. It is therefore recommended that youcreate an OMNIbus user within your Remedy system, which is used by thegateway for logging into the Remedy server.

Having a separate user enables the gateway to track changes made to troubletickets that it created. Using its own login the gateway can determine whether achange made to a ticket that it created was made by the gateway itself or by athird party. This enables the gateway to determine what changes need to be passedback from the Remedy system to the original alert.

Connecting the gateway to Remedy without a port mapperPerform the following steps to connect the gateway to Remedy without a portmapper.

To connect the gateway to Remedy without using a port mapper, use the followingsteps:

IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS 7

1. Start the Remedy Administrator.

Note: The Remedy Administrator is not supported on version 7.62. Select Open File > Server Information > Server Ports and Queues.3. Set the Server TCP/IP field to a valid port number, for example, 4444.4. Leave the AlertOutbound Port field set to 0.5. Uncheck the Register with Portmapper field.6. Exit from the Remedy Administrator.

Gateway for Remedy configurationTo simplify the configuration of the Gateway for Remedy, the gateway is suppliedwith an example schema and associated filters.

This section contains information about:v Setting connection propertiesv Setting environment variablesv Configuring failover and failbackv Importing the example schemav Modifying the filters

Setting connection attributesSet the following connection attributes in the gateway configuration file:TCP_FLAG = TRUE #AR_TCP_PORT = 4444 # The server TCP/IP port for the writer to connect

Setting environment variablesIf the TCP_FLAG attribute is set to FALSE, you must set the ARTCPPORT environmentvariable using the following command:setenv ARTCPPORT 4444

If the following environment variables are required for your gatewayconfiguration, set them in this file:

$OMNIHOME/platform/arch/bin/nco_g_remedy.env

Note: This file is executed when the gateway starts and can also be used to set thelibrary search path.v Set the REMEDY_VIEW and NOTIFICATION_SCHEMA environment variables if the view

tag or notification schema name is different from the default one.v Set the NCO_ARWMODULE_READ_USES_LT_X environment variable to allow the

notification query to use an index on the Read field of the AlertEventsform.

Adding conversions to the Gateway for Remedy ARSTo add conversions to the gateway, use the following commands.

Note: You must add conversions to the gateway, and uncomment theCONVERSIONS_TABLE attribute setting for it to run successfully. For more informationsee the “Example configuration file” on page 17create database conversions;use database conversions;create table conversions.remedy persistent (KeyField varchar(255) primary key,Colname varchar(255),

8 IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

OSValue varchar(255),Conversion varchar(255));

insert into conversions.remedy values (’Severity0’,’Severity’,’0’,’Clear’);insert into conversions.remedy values (’Severity1’,’Severity’,’1’,’Indeterminate’);insert into conversions.remedy values (’Severity2’,’Severity’,’2’,’Warning’);insert into conversions.remedy values (’Severity3’,’Severity’,’3’,’Minor’);insert into conversions.remedy values (’Severity4’,’Severity’,’4’,’Major’);insert into conversions.remedy values (’Severity5’,’Severity’,’5’,’Critical’);

Configuring failover and failbackThe Gateway for Remedy ARS can be configured to use failover and failbackfunctionality.

The following figure shows an example ObjectServer setup for failover andfailback:

PrimaryObjectServer

BackupObjectServer

Virtual ObjectServer

RemedyGateway

Configuring the gateway for failover and failback functionality

To configure the gateway for failover and failback functionality:1. Configure the virtual ObjectServer as shown in the figure Figure 1.2. Make sure the ObjectServer details in the gateway configuration file indicate

the virtual ObjectServer and not the primary or the backup ObjectServer.3. Start the gateway from Process Control.

Note: For detailed information about setting up failover and failback functionality,see the IBM Tivoli Netcool/OMNIbus Installation Guide (GI11-8064).

Importing the schemaTo begin Gateway for Remedy ARS configuration, import the example schema andfilters into the Remedy server.

The schema is stored in:v $OMNIHOME/gates/remedy/omnibus.def

Figure 1. Sample Failover ObjectServer Setup

IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS 9

The filters provide part of the Remedy-to-Netcool/OMNIbus feedback, whichpasses through the notification server. These filters which are attached to theimported schema, reference the user Omnibus, and generate update and closenotifications for changes to trouble tickets created by the gateway itself.

Note: The gateway assumes that the notification server is running on the samemachine as the Remedy server.

Modifying the gateway filtersOnce you have imported your schema, you can modify the filters through theModify Filter window of the Remedy administration tool.

You may also need to modify the action SQL files, as described in “Action SQLfiles” on page 11.

An example of the notification message format is:[<TYPE>][’$Last-modified-by$’] <attr_1>=<value_1> ... <attr_n>=<value_n>

Where TYPE is either M for Modification (Update) or C for Close event.

The attribute value pairs are named values that can be referenced in the actionSQL files as specific values you want to be updated in the alert within theObjectServer. For example:Node = $Node

Where Node contains the value of the $Node field within the Remedy schema. Thismeans that when you refer to $(Node) in the action SQL files you get the correctvalue.

You could use Name = $Node and reference the Node value in the action SQL files as$(Name). As shown in the examples below, either the name or the value can bestring quoted to ensure that the complete value is extracted for either the name orthe value. This is because a space is a delimiter character. If a space appears in thevalue, you need use string quotes. For example:First="$FirstOccurrence$"

This ensures that the complete date is the value of the name First.

Note: When using a filter with a gateway, existing alerts that are excluded by thegateway do not have a trouble ticket. If the alert changes and is no longerexcluded by the filter, the gateway creates a new trouble ticket.

Example update filter

The example update filter is:[M][’$Last_modifed-by$’] "Node" = "$Node$" Serial =$Serial$First="$FirstOccurrence$" Tally= $Tally$ Static="hello \"\\\\"Last=$Last-modified-by$ User=$OwnerUID$ Agent="$Agent$" User=$USER$

Example close filter

The example close filter is:[C][’$Last-modified-by$’] Node ="$Node$" Serial= $Serial$First="$FirstOccurrence$" Last=$Last-modified-by$

10 IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

Event formatThe Gateway for Remedy ARS sends and receives information in a particularformat.

Remedy makes updates available to the gateway in the form of name : value pairs,the field names available are defined within the schema imported to OMNIbusfrom , by default, $OMNIHOME/gates/remedy/omnibus.schema.

The gateway sends and expects events in the following format:name : Omnibus-Modifytimestamp : 1156434617owner : Demolast-changed : Demofilter-op : 2enable : 1filter-order : 500wk-conn-type : 1schema-name : Alerts __VERSION__export-version : 9filter-query : 4\1\99\2\2\4\4\Demo\action {

notify-user : Demonotify-mech : 1notify-pri : 1notify-behvr: 0notify-perm : 0notify-text : [M][’$5$’] Node = "$536870944$" Serial=$536870913$

}object-prop : 4\60006\4\0\\60008\40\0\60009\4\0\\60010\4\0\\

end

The notify-text field is used to make fields available to the gateway. To enablethe gateway to use a specific field, add the specified field under the notify-textfield in the action field , for example:

notify-text : [M][’$5$’] Node = "$536870944$" Serial=$536870913$Severity=$7$ Summary="$536870916$" NodeAlias="$536870915$"

Action SQL filesThere are two action SQL files. They define how the gateway should handle aclosed or updated Remedy alert. Any changes you make to the default filters mayneed to be reflected in these files.

Example update Action SQL fileAn example update action SQL file is shown below:## Example Remedy Action SQL for the Netcool/OMNIbus Gateway Server 3.4.1## Remedy Problem Update Action SQL.#update alerts.status set Node=’$(Node)’ where Serial = $(Serial);

Example close Action SQL fileAn example close action SQL file is shown below:## Example Remedy Action SQL for the Netcool/OMNIbus Gateway Server 3.4.1#

IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS 11

# Remedy Problem Close (Deletion) Action SQL.#delete from alerts.status where Serial = $(Serial);

MappingThis section describes mappings of the Gateway for Remedy ARS with RemedyARS writer.

Mappings for use with the Remedy ARS writer must use this syntax:CREATE MAPPING mappingname(ARSFieldId = '@fieldname' [ ON INSERT ONLY ] [ CONVERT TO type ][ , ARSFieldId = '@fieldname' [ ON INSERT ONLY ] [ CONVERT TO type ] ]...) ;

where:v mappingname is the name of the mapping to be created.v ARSFieldId is the integer value for the field to be written to in the ARS system.v fieldname must be the name of a field in the ObjectServer alerts.status table.

The optional ON INSERT ONLY controls the updating of the field during the life ofthe alert; when omitted, the field is updated for any change in the state of thealert. When included, the field is only set when the alert is created.

You cannot use ON INSERT ONLY with the following fields:v Severity

v InternalLast

v StateChange

v Tally

v Acknowledged

If you use ON INSERT ONLY with these fields, the gateway does not work.

The optional CONVERT TO type allows the mapping to define a forced conversionfor situations where a source field may not match the type of the destination field.type can be INTEGER, STRING, or DATE to force the source field to be converted to aninteger, string, or date type. The writer must pass across serial and severityfields to ARS to function correctly.

Example mappingThe following is an example of the mapping of the gateway with Remedy ARSwriter.

The default mapping as supplied in the $OMNIHOME/etc/G_REMEDY.conf file isdesigned for the supplied schema in $OMNIHOME/gates/remedy/omnibus.schema.CREATE MAPPING ARS_MAP(536870914 = ’@Identifier’ ON INSERT ONLY,536870913 = ’@Serial’ ON INSERT ONLY,536870944 = ’@Node’ ON INSERT ONLY,536870915 = ’@NodeAlias’ ON INSERT ONLY,536870932 = ’@Manager’ ON INSERT ONLY,536870939 = ’@Agent’ ON INSERT ONLY,536870918 = ’@AlertGroup’ ON INSERT ONLY,536870931 = ’@AlertKey’ ON INSERT ONLY,

12 IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

7 = ’@Severity’,536870916 = ’@Summary’ ON INSERT ONLY,536870946 = ’@StateChange’,536870912 = ’@FirstOccurrence’ ON INSERT ONLY,536870917 = ’@LastOccurrence’,536870935 = ’@InternalLast’,536870938 = ’@Poll’ ON INSERT ONLY,536870941 = ’@Type’ ON INSERT ONLY,536870940 = ’@Tally’,536870945 = ’@Class’ ON INSERT ONLY,536870942 = ’@Grade’ ON INSERT ONLY,536870934 = ’@Location’ ON INSERT ONLY,536870933 = ’@Acknowledged’);

The integer value is the Remedy ARS field identifier. Most fields are written tospecially defined records within the schema, with the exception of Severity(written to the ARS core field Status) and Summary (written to the ARS core fieldShort Description). Severity, InternalLast, StateChange, Tally, and Acknowledgedfields are updated in the trouble ticket as the alert is updated.

The string values must currently be set to @fieldname values that refer to fields inthe alerts.status table.

Writer attributesThe following table describes the attributes used to create a Remedy ARS writer.

Note: For details of the data type definitions for the alerts tables forwarded to theObjectServer, see the IBM Tivoli Netcool/OMNIbus Administration Guide (SC23-6371).

Table 5. Writer attributes

Attribute name Type Description

ALERT_EVENTS_POLL_PERIOD

integer This writer attribute specifies the time period (inseconds) to wait before checking for new Remedynotifications (alert events).

The default is 3.

AR_TCP_PORT integer This writer attribute specifies the port that the writermodule uses to connect to the Remedy server. IfAR_TCP_PORT is not set, the client connects to serversthrough a port mapper.

The default is 0 (no port is specified).Note: If you set this attribute to a value greater than0, you must also set the TCP_FLAG attribute to TRUE.

ARS_PORT integer This writer attribute enables the gateway to beconfigured to use a non-default RPC port forcommunication with the Remedy server.

The default is -1 (no port specified).Note: ARS_PORT property id set when the TCP_FLAG isset to FALSE.

CLOSE_ACTION_SQL string This writer attribute specifies the this writer attributespecifies the name of the file containing the closeaction SQL to be performed at the ObjectServer. Noaction is taken if no attribute is supplied. Used inbidirectional implementations of this gateway.

IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS 13

Table 5. Writer attributes (continued)

Attribute name Type Description

CONVERSIONS_TABLE string This writer attribute specifies the conversion tablewithin the ObjectServer that the gateway uses.Note: The table specified must be created and thecorrect conversion values inserted before this attributecan function correctly.

CONVERT_INSERT_TO_UPDATE

boolean This writer attribute specifies whether the gatewayforwards inserts that contain trouble ticket numbersin their Feedback fields to Remedy as updates.

The default is FALSE.Note: If you set this attribute to TRUE, you must alsoset the VERIFY_INSERT attribute to TRUE.

COUNTER_PART string This writer attribute specifies the name of thecounterpart reader in a bidirectional gatewayconfiguration. This defines a link between the readerand the writer of one half of the bidirectionalgateway and prevents the gateway from sending analert straight back to the ObjectServer from which itwas received.Note: The reader must be running for the attributevalue to be applied.

DETAILS string This writer attribute specifies the identifier of theDetails field in the ARS schema.

ENABLE_SECONDARY_CACHE

string This writer attribute enables the Remedy server toretrieve alert details for the cache entry. It is usedwhen the corresponding alert is not available in theObjectServer, or the ObjectServer is unavailable.

TRUE : This enables the alert retrieval.

FALSE : This disables the alert retrieval.

The default is TRUE.

FEEDBACK_FAILURE string If the gateway fails to create a problem ticket number,the gateway can feedback a failed creation message tothe feedback field instead of a trouble ticket. Thisgives clear feedback to the user that the gateway hasfailed to create a trouble ticket. This attribute controlswhether this functionality is enabled.

TRUE : This activates the feedback failure

FALSE : This disables the feedback failure

The default is TRUE.

FEEDBACK_FIELD string This writer attribute specifies the name of field inFEEDBACK_SERVER where the feedback mechanismshould write the trouble ticket number.

FEEDBACK_SERVER string This writer attribute specifies the name ofObjectServer where the feedback mechanism shouldwrite the trouble ticket number.

FILTER_CONDITION string This writer attribute enables you to qualify whichrecords are retrieved when the cache is being rebuilton startup. The gateway ignores this attribute if theREBUILD_CACHE attribute is set to FALSE.

14 IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

Table 5. Writer attributes (continued)

Attribute name Type Description

FORWARD_DELETES boolean This writer attribute specifies whether the gatewayforwards delete events to Remedy.

The default is TRUE.Note: If this attribute is set to FALSE, the gatewaydrops delete events.

FORWARD_HISTORIC_DETAILS

boolean This writer attribute specifies whether or not thegateway forwards all historic details relating to analert on opening the event in Remedy.

The default is TRUE.

FORWARD_HISTORIC_JOURNALS

boolean This writer attribute specifies whether or not thegateway forwards all historic journals relating to analert on opening the event in Remedy.

The default is TRUE.

FORWARD_UPDATES boolean This writer attribute specifies whether the gatewayforwards update events to Remedy.

The default is TRUE.Note: If this attribute is set to FALSE, the gatewaydrops update events.

HOPEFUL_PMC_CLOSE boolean This writer attribute specifies whether the gatewaydrops a delete event if it does not find a cache entryfor the corresponding record. If you set this attributeto FALSE, the gateway tries to reclaim the cache entryto enable it to be forwarded to Remedy.

The default is TRUE.

JOURNAL string This writer attribute specifies the identifier of theJournal field in the ARS schema.

MAP string This writer attribute specifies the map file that thewriter uses.

MODULE_REVISION integer This writer attribute specifies the version ofnco_arwmodule that the gateway uses.

The default is 8.Note: Set this property to 8 for all versions ofnco_arwmodule supplied with the patch.

PASSWORD string This writer attribute specifies the password of theuser specified in USER attribute. The password thatyou specify for this writer attribute must be inencrypted format. To set this writer attribute correctly,use the following steps:

1. Encrypt the password using nco_g_crypt.

2. Set this writer attribute to the encrypted output ofthe password.

3. Prefix the encrypted output with ^

For example, if the encrypted output isECEDBJAGBJFHGD set this writer attribute to^ECEDBJAGBJFHGD.

IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS 15

Table 5. Writer attributes (continued)

Attribute name Type Description

REBUILD_CACHE string This writer attribute specifies whether the gatewayqueries the ObjectServer and rebuilds the cache onstartup.

The default is FALSE.

RECLAIM_ARS boolean This writer attribute specifies the gateway's primarycache reclamation is from the ObjectServer. If thegateway fails to reclaim the trouble ticket number ofa given alert, it falls back to its secondary cachereclamation system, which is to attempt a lookup ofthe trouble ticket number in the Remedy server. Thesecondary cache lookup system requires theServerName and ServerSerial fields to be stored inthe schema.

The default is FALSE.

REPOPULATE_TTNUM boolean This writer attribute specifies the controls whether thefeedback field is updated if the trouble ticket numberhas been lost. When an update notification isprocessed for an alert that has a trouble ticketcreated, and the feedback field is found to be blank,this attribute control whether the gateway attempts tore-populate the field with the trouble ticket number.

The default is FALSE.

REVISION integer This writer attribute specifies the revision of writer.

You must set this attribute to 1.

SCHEMA string This writer attribute specifies the name of the schemain Remedy ARS where the writer should generatetrouble tickets using the specified map file.

SERVER string This writer attribute specifies the name of serverwhere the Remedy ARS is running.

SET_TO_NULL boolean This writer attribute specifies whether the gatewaysets empty character fields to $NULL$.

The default is FALSE.

TCP_FLAG boolean This writer attribute specifies whether the gatewayuses TCP functionality.

The default is FALSE.Note: If you set this attribute to TRUE, you mustspecify appropriate ports for the AR_TCP_PORTattributes.

TIME_FORMAT string This writer attribute specifies the date format used towrite dates in journal entries created by the gatewayfor associated trouble tickets.

The default is '%d/%m/%Y %H:%M:%S'.

TYPE string This writer attribute specifies the type of writer.

This attribute must be set to ARS.

16 IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

Table 5. Writer attributes (continued)

Attribute name Type Description

UPDATE_ACTION_SQL string This writer attribute specifies the name of the filecontaining the update action SQL to be performed atthe ObjectServer. No action is taken if no attribute issupplied. Used in bidirectional implementations ofthis gateway.

USER string This writer attribute specifies the name of theRemedy ARS user to be used to submit and updatealerts to the ARS system.

VERIFY_INSERT boolean This attribute is only used in a system that uses aresynchronizing bidirectional ObjectServer gatewaybetween two ObjectServers to which the ARSgateway can failover. Due to the resynchronization,the Gateway for Remedy may receive insertnotifications to alerts that already have troubletickets. The default action for an insert notification isto create a trouble ticket. This can lead to duplicatetickets being created. If this attribute is enabled, theGateway for Remedy starts to verify each insertnotification and determines whether the alert markedfor insertion has a trouble ticket number already. If itdoes then no trouble ticket is created.

The default is FALSE.

VERIFY_WITH_AR_SERVER

boolean This attribute extends the VERIFY_INSERT attribute.The default operation of VERIFY_INSERT is to checkthe current contents of the feedback field for a valuethat can be regarded as a trouble ticket number. If thefield is blank, a trouble ticket is created. If thisattribute is enabled and the field is blank, thegateway also queries the Remedy server for anappropriate trouble ticket for the alert usingServerName and ServerSerial. A trouble ticket iscreated only if this query returns no results. Thisprevents the possibility of the trouble ticket numberbecoming lost.

The default is FALSE.

Example configuration fileThis section provides an example of a configuration file.

Note: To ensure that gateway updates work correctly you must uncomment theCONVERSION_TABLE line in this file and you must also add a comma at the end ofthe preceding line to ensure the gateway reads the settings correctly.## Example configuration file for Netcool/OMNIbus Gateway for Remedy ARS## Create a mapping from the Object Server’s fields into ARS field Id’s## Fields marked ON INSERT ONLY will only be set when the entry is created# for the first time (i.e. they will not be updated)#CREATE MAPPING ARS_MAP(536870914 = ’@Identifier’ ON INSERT ONLY,

IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS 17

536870913 = ’@Serial’ON INSERT ONLY,536870944 = ’@Node’ON INSERT ONLY,536870915 = ’@NodeAlias’ON INSERT ONLY,536870932 = ’@Manager’ON INSERT ONLY,536870939 = ’@Agent’ON INSERT ONLY,536870918 = ’@AlertGroup’ ON INSERT ONLY,536870931 = ’@AlertKey’ON INSERT ONLY,7 = ’@Severity’,536870916 = ’@Summary’ON INSERT ONLY,536870946 = ’@StateChange’,536870912 = ’@FirstOccurrence’ON INSERT ONLY,536870917 = ’@LastOccurrence’,536870935 = ’@InternalLast’,536870938 = ’@Poll’ON INSERT ONLY,536870941 = ’@Type’ON INSERT ONLY,536870940 = ’@Tally’,536870945 = ’@Class’ON INSERT ONLY,536870942 = ’@Grade’ON INSERT ONLY,536870934 = ’@Location’ON INSERT ONLY,536870933 = ’@Acknowledged’,536870922 = ’@ServerSerial’ON INSERT ONLY,536870923 = ’@ServerName’ON INSERT ONLY);## Start up the reader - connect to the ObjectServer NCOMS## This example uses no filtering.#START READER SERVER_READER CONNECT TO ObjectServer NCOMS;## Start up the writer#START WRITER ARS_WRITER(TYPE = ARS,# Action Request SystemREVISION = 1,# Revision One (not really needed)MODULE_REVISION = 8,# reader-writer module version numberMAP = ARS_MAP,# Name of map to useSERVER = ’example’,# ARS server to connect toSCHEMA = ’Alerts __VERSION__’, # ARS schema nameUSER = ’Demo’,# ARS user namePASSWORD = ’’,# ARS passwordFEEDBACK_SERVER = NCOMS,# Which server for feedbackFEEDBACK_FIELD = ’Location’,# Which field in feedback serverJOURNAL = 536870921,# Journal field Id in schemaDETAILS = 536870921,# Details field Id in schemaCOUNTER_PART = SERVER_READER,# Bi-directional counter-part.REPOPULATE_TTNUM = TRUE,# If TTnum is lost repopulate feedbackUPDATE_ACTION_SQL =’/opt/Omnibus/gates/remedy/update_action.remedy.sql’,CLOSE_ACTION_SQL = ’/opt/Omnibus/gates/remedy/close_action.remedy.sql’## Additional Remedy gateway attributes that can be set.## ARS_PORT = <port number> # RPC Port to use# AR_TCP_PORT = <port number> # Port for writer connection to ARS Server# ALERT_EVENTS_POLL_PERIOD = 3# Check for new alert events# (notifications) every x seconds# CONVERSIONS_TABLE = ’conversions.remedy’# conversion table to use# ENABLE_SECONDARY_CACHE = TRUE ## FEEDBACK_FAILURE = FALSE# When true, if gateway fails to# update event with trouble# ticket, update feedback field# with error message# FILTER_CONDITION = ""# filter events when re-building cache# FORWARD_UPDATES = TRUE # Forward updates to Remedy?# FORWARD_DELETES = TRUE# Forward deletes to Remedy?

18 IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

# FORWARD_HISTORIC_DETAILS = TRUE# Forward historic details to Remedy?# FORWARD_HISTORIC_JOURNALS = TRUE# Forward historic details to Remedy?# HOPEFUL_PMC_CLOSE = TRUE# If FALSE, avoid attempting to# reclaim cache for an event if it# is not found in the cache when# you want to delete it# RECLAIM_ARS = FALSE # Reclaim TTnum from ARS, not OS# SET_TO_NULL = FALSE # If true set empty char fields to NULL# TCP_FLAG = TRUE # Use TCP functionality# TIME_FORMAT = ’%d/%m/%Y %H:%M:%S’ # Date/time format in Journal entries# VERIFY_INSERT = TRUE# Verify inserts when bi-OS# gateway is used for# re-synchronization between two# object servers# VERIFY_WITH_AR_SERVER = FALSE # Extends VERIFY_INSERT by# querying the REMEDY Server);## Add a route from the reader to the writer so the info gets passed#ADD ROUTE FROM SERVER_READER TO ARS_WRITER;## End of file#

AES encryptionAES encryption can be used to encrypt any string within the gateway writersection of the configuration file. It is used by the gateway to prevent sensitive datafrom being available in readable format in the gateway configuration file.

Note: AES encryption is supported on Tivoli Netcool/OMNIbus V7.2.0 (andabove) on all UNIX and Linux operating systems.

nco_aes_crypt

You can encrypt strings in the gateway configuration file using the nco_aes_crypttool (supplied with Tivoli Netcool/OMNIbus). The syntax of encrypted data is asfollows:@datalength:encrypted_data@

Where datalength is the length of the data in bytes (expressed as a decimal) andthe data itself is base64 encoded. The at sign (@) indicates the start and end of theencrypted data definition. The colon (:) acts as a field separator.

The encrypted values appear in single quotes on the right side of expressions inthe writer section of the configuration file. The following is an example line from aconfiguration file showing the host name given in encrypted format:HOST =’@64:lHBLuIPLNye8zCWhykFVFY7y90V9kCjGK5GSWu5VBdSlgQOqarq6T4UK4xk5Vqix@’

Note: You can obtain the nco_aes_crypt tool from the IBM Passport Advantagewebsite: http://www-306.ibm.com/software/howtobuy/passportadvantage/pao_customers.htm. Access the Software Downloads section and search forNetcool/OMNIbus Gateway configuration encryption library.

IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS 19

Using the nco_aes_crypt tool

Data in the configuration file must be encrypted using the nco_aes_crypt tool.

This is a command line tool which takes the following format:nco_aes_crypt [-d | -e] [-o outfile] -k keyfile -f filenamenco_aes_crypt [-d | -e] [-o outfile] -k keyfile data

The output of this command will be the encrypted string to be used in theconfiguration file.

The following table describes the options available with nco_aes_crypt:

Table 6. nco_aes_crypt command line options

Command line option Description

-d or-e Use this option to specify the mode in whichthe nco_aes_crypt tool runs:

d - decrypt mode

e - encrypt mode

The default is e.

-o string Use this option to specify the output file towhich the encrypted data will be written.

-k string Use this option to specify the path of the filecontaining the key data.

-f string Use this option to specify the path of the filecontaining data requiring encryption.

data Use this option to specify the data to beencrypted or decrypted.

Encryption key file

The encryption key is stored in a flat file alongside the encrypted data. The keystorage file has an ASCII numeric key length indicator followed by a colon and thekey in binary form.

The format of the key file is as follows:key_length:key_data

Where key_length is the length of the key in bits and the key_data is the key inbinary form. Valid length values are 128, 192 and 256.

For example:128:1234567812345678

In this case, key_length is 128 since the ASCII string 1234567812345678 has 16bytes (128 bits).

You can generate random or pre-defined keys of varying lengths using nco_keygen.To generate a key file, use the following command:nco_keygen -o outfile[-l length|-k]key][-h |-?]

20 IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

The following table gives the descriptions of the above command line options.

Table 7. Encrytion key file command line options

Command line option Description

-o outfile Use this option to specify the output filename.

-l length Use this option to specify the length (in bits)of the key to write out.

The default is 128.Note: The value that you specify must bedivisible by 8.

-k key Use this option to specify the key to bewritten out, expressed as hex digits.Note: This option bypasses automatic keygeneration.

-h |-? Use this option to print the help informationand exit

Note: AES encryption is used as the initial encryption method for sensitive data.However, this does not mean that the data can be considered to be secure purelydue to AES encryption; the security of the data depends on the restriction of accessto the key file used for AES encryption. Access to this file is controlled using UNIXfile permissions.

Using encrypted data

To use encrypted data, you must add the following line to the WRITER section ofthe configuration file:LOAD ENCRYPTION KEY FROM ’key_file_path’ USING ’AES’

Where key_file_path is the path to the file containing the encryption key.

Running the ObjectServer in a secure mode

When the gateway connects to the ObjectServer running in secure mode, it needsto authenticate with a user name and password. This user name and password canbe encrypted using the nco_aes_crypt tool.

To enable the encryption, the location of the key file must be specified at thebeginning of the configuration file. This is followed by the AUTH_USER andAUTH_PASSWORD fields which contain the encrypted user name and passwordrequired for authentication.

The following example shows the three fields that need to be added at thebeginning of the configuration file when the ObjectServer runs in a secure mode:LOAD ENCRYPTION KEY FROM ’/HOME/72/solaris/omnibus/keyflie_name’ USING’AES’;AUTH_USER ’@44:2yXgd6fp9q1Ey4sSAb2RibzA3+PpCZmhAZXo6nNdkvQ=@’; #encrypted_user_nameAUTH_PASSWORD ’@44:mdyEb8VTh+2wALnNlR7dnGnxRZ3BkMOQbR5IgxLlHuc=@’; #encrypted_password

IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS 21

Running the gatewayThe following section describes how to run the Gateway for Remedy ARS onUNIX.

Before running the gateway, you must complete the configuration; for details, see“Configuration” on page 7.

Running the gateway on UNIXPerform the following steps to run the Gateway for Remedy ARS on UNIX.

About this task

To run the gateway with a default configuration, enter the following at thecommand line:$OMNIHOME/bin/nco_g_remedy

This runs a gateway with the default server named G_REMEDY and the defaultconfiguration file $OMNIHOME/etc/G_REMEDY.conf.

To run the gateway with your own configuration, use command line options; forexample:$OMNIHOME/bin/nco_g_remedy -name MY_REMEDY -config $OMNIHOME/etc/REMEDY.conf

This runs a gateway server named MY_REMEDY using a configuration file namedREMEDY.conf.

The gateway should be configured to run under process control. Process control isdescribed in the IBM Tivoli Netcool/OMNIbus Installation Guide (GI11-8064).

22 IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

Appendix. Notices and Trademarks

This appendix contains the following sections:v Noticesv Trademarks

NoticesThis information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia CorporationLicensing 2-31 Roppongi 3-chome, Minato-kuTokyo 106-0032, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

© Copyright IBM Corp. 2006, 2013 23

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who want to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM CorporationSoftware Interoperability Coordinator, Department 49XA3605 Highway 52 NRochester, MN 55901U.S.A.

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this information and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement, or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subjectto change without notice. Dealer prices may vary.

This information is for planning purposes only. The information herein is subject tochange before the products described become available.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

24 IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

COPYRIGHT LICENSE:

This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have notbeen thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs.

Each copy or any portion of these sample programs or any derivative work, mustinclude a copyright notice as follows:

© (your company name) (year). Portions of this code are derived from IBM Corp.Sample Programs. © Copyright IBM Corp. _enter the year or years_. All rightsreserved.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.

TrademarksIBM, the IBM logo, ibm.com, AIX, Tivoli, zSeries, and Netcool are trademarks ofInternational Business Machines Corporation in the United States, other countries,or both.

Adobe, Acrobat, Portable Document Format (PDF), PostScript, and all Adobe-basedtrademarks are either registered trademarks or trademarks of Adobe SystemsIncorporated in the United States, other countries, or both.

Intel, Intel Inside (logos), MMX, and Pentium are trademarks of Intel Corporationin the United States, other countries, or both.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks ofMicrosoft Corporation in the United States, other countries, or both.

Java™ and all Java-based trademarks are trademarks of Sun Microsystems, Inc. inthe United States, other countries, or both.

Linux is a trademark of Linus Torvalds in the United States, other countries, orboth.

UNIX is a registered trademark of The Open Group in the United States and othercountries.

Appendix. Notices and Trademarks 25

26 IBM Tivoli Netcool/OMNIbus Gateway for Remedy ARS: Reference Guide

����

Printed in USA

SC23-6037-11