Netcool/OMNIbus Probe for IEC CIMAdvanced Metering ... · Netcool/OMNIbus Probe for IEC CIMAdvanced Metering Infrastructure Version ... for IEC CIMAdvanced Metering Infrastructure

Netcool/OMNIbus Probe for IEC CIM Advanced MeteringInfrastructureVersion 2.0

Reference GuideNovember 7, 2014

SC27-6262-01

��

Netcool/OMNIbus Probe for IEC CIM Advanced MeteringInfrastructureVersion 2.0

Reference GuideNovember 7, 2014

SC27-6262-01

��

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

Edition notice

This edition (SC27-6262-01) applies to version 2.0 of IBM Tivoli Netcool/OMNIbus Probe for IEC CIM AdvancedMetering Infrastructure and to all subsequent releases and modifications until otherwise indicated in new editions.

This edition replaces SC27-6262-00.

© Copyright IBM Corporation 2014.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 . . . . . . . . v

IBM Tivoli Netcool/OMNIbus Probe forIEC CIM Advanced MeteringInfrastructure . . . . . . . . . . . . 1Summary . . . . . . . . . . . . . . . 1Getting started. . . . . . . . . . . . . . 2Installing probes . . . . . . . . . . . . . 3Configuring the probe . . . . . . . . . . . 4Data acquisition . . . . . . . . . . . . . 5

ObjectServer information . . . . . . . . . 6Setting the Web Service URI . . . . . . . . 6Inactivity . . . . . . . . . . . . . . 7

Data stream capture . . . . . . . . . . . 7Support for Unicode and non-Unicode characters 8Peer-to-peer failover functionality . . . . . . 9Setting the component logging properties . . . 10

Running the probe . . . . . . . . . . . . 10Running multiple probes . . . . . . . . . 10Running the probe as a Windows service . . . 11

Properties and command line options . . . . . 12Elements . . . . . . . . . . . . . . . 14Error messages . . . . . . . . . . . . . 14ProbeWatch messages . . . . . . . . . . . 15

Appendix. Notices and Trademarks . . 17Notices . . . . . . . . . . . . . . . . 17Trademarks . . . . . . . . . . . . . . 19

© Copyright IBM Corp. 2014 iii

iv IBM Tivoli Netcool/OMNIbus Probe for IEC CIM Advanced Metering Infrastructure: 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 Probe for IEC CIM Advanced MeteringInfrastructure documentation is provided in softcopy format only. To obtain themost recent version, visit the IBM® Tivoli® Knowledge Center.

http://www-01.ibm.com/support/knowledgecenter/?lang=en#!/SSSHTQ/omnibus/probes/common/Probes.html

Table 1. Document modification history

Documentversion

Publicationdate

Comments

SC27-6262-00 March 7, 2014 First IBM publication.

SC27-6262-01 November 7,2014

“Summary” on page 1 updated..

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

Operating system-dependent variables and paths

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

For probes supported on UNIX and Linux operating systems, probe guides use thestandard UNIX conventions such as $variable for environment variables andforward slashes (/) in directory paths. For example:

$OMNIHOME/probes

For probes supported only on Windows operating systems, probe guides use thestandard Windows conventions such as %variable% for environment variables andbackward slashes (\) in directory paths. For example:

%OMNIHOME%\probes

For probes supported on UNIX, Linux, and Windows operating systems, probeguides use the standard UNIX conventions for specifying environment variablesand describing directory paths. When using the Windows command line withthese probes, replace the UNIX conventions used in the guide with Windowsconventions. If you are using the bash shell on a Windows system, you can use theUNIX conventions.

© Copyright IBM Corp. 2014 v



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. Where such variables aredescribed in the guide, both the UNIX and Windows conventions will be used.

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/probes/arch

The following table lists the directory names used for each operating system.

Note: This probe may not support all of the operating systems specified in thetable.

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

OMNIHOME location

Probes and older versions of Tivoli Netcool/OMNIbus use the OMNIHOMEenvironment variable in many configuration files. Set the value of OMNIHOME asfollows:v On UNIX and Linux, set $OMNIHOME to $NCHOME/omnibus.v On Windows, set %OMNIHOME% to %NCHOME%\omnibus.

vi IBM Tivoli Netcool/OMNIbus Probe for IEC CIM Advanced Metering Infrastructure: Reference Guide

IBM Tivoli Netcool/OMNIbus Probe for IEC CIM AdvancedMetering Infrastructure

The Advanced Metering Infrastructure (AMI) is a system of smart meters forenergy and water utilities that connects to data management systems throughcomputer networks. AMI enables the 2-way exchange of data between theconsumer and the utility company. Some examples of the uses of AMI are:v Automated, remote meter readingv Remote control of thermostats and other controlsv In-house energy monitors for the consumerv Equipment monitoring, fault detection, and outage alerts

The Probe for IEC CIM Advanced Metering Infrastructure publishes a web serviceusing the SOAP and WSDL technologies, to collect AMI events generated bydevices and element management systems (EMS) that are compliant with the IEC61968-9 and IEC 61968-100 standards.

This guide contains the following sections:v “Summary”v “Getting started” on page 2v “Installing probes” on page 3v “Configuring the probe” on page 4v “Data acquisition” on page 5v “Running the probe” on page 10v “Properties and command line options” on page 12v “Elements” on page 14v “Error messages” on page 14v “ProbeWatch messages” on page 15

SummaryEach probe works in a different way to acquire event data from its source, andtherefore has specific features, default values, and changeable properties. Use thissummary information to learn about this probe.

The following table provides a summary of the Probe for IEC CIM AdvancedMetering Infrastructure.

Table 3. Summary

Probe target Network devices and EMS that implement the IEC CIMAdvanced Metering Infrastructure.

Probe executable name nco_p_iec_cim_ami

Package version 2.0

© Copyright IBM Corp. 2014 1

Table 3. Summary (continued)

Probe 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=swg21663915

Properties file $OMNIHOME/probes/arch/iec_cim_ami.props

Rules file $OMNIHOME/probes/arch/iec_cim_ami.rules

Requirements For details of any additional software that this proberequires, refer to the description.txt file that issupplied in its download package.

Connection method The probe connects to the endpoint using aSOAP/HTTP(S) interface.

Multicultural support Available

For information about configuring multiculturalsupport, including language options, see the IBM TivoliNetcool/OMNIbus Installation and Deployment Guide.

Peer-to-peer failover functionality Available

IP environment IPv4 and IPv6

Federal Information ProcessingStandards (FIPS)

IBM Tivoli Netcool/OMNIbus V7.3.0, 7.3.1, 7.4.0, and8.1 use the FIPS 140-2 approved cryptographicprovider: IBM Crypto for C (ICC) certificate 384 forcryptography. This certificate is listed on the NISTwebsite at http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/1401val2004.htm For details aboutconfiguring Netcool/OMNIbus for FIPS 140-2 mode,see IBM Tivoli Netcool/OMNIbus Installation andDeployment Guide.

Getting startedThis section shows how to start the probe with the minimum requiredconfiguration. The procedure assumes that you have a version ofNetcool/OMNIbus installed and running.

Use the following procedure to start the probe with a minimal configuration:

Note: The commands shown in this example are for a Linux system. Adapt thesecommands as necessary for the operating system that your probe server runs.1. Download the probe's installation package following the instructions in

http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/probes/all_probes/wip/reference/install_download_intro.html.

2. Edit the probe's properties file and set values for the following:v Server: Set this property to the name of the ObjectServer that the probe

sends events to. The default value of this property is NCOMS.v MessageLevel: Set this property to debug. This setting provides the maximum

amount of information when the probe is running.

2 IBM Tivoli Netcool/OMNIbus Probe for IEC CIM Advanced Metering Infrastructure: Reference Guide



http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/1401val2004.htm

http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/1401val2004.htm

http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/probes/all_probes/wip/reference/install_download_intro.html


Note: Using this level of message logging significantly increases the amountof information sent to the log file. Once you have verified that the proberuns correctly, change the value of the MessageLog property. For example, setthe property to info.

v LocalHttpHost: Set this property to the name of the local host that runs theweb service. The default value of this property is localhost.

v LocalHttpPort: Set this property to the port that the probe listens on for AMIevents. The default value of this property is 8080.

3. Ensure that $NCHOME/etc/omni.dat includes information on the ObjectServer.4. Obtain a listing of the probe's command line options to check the probe is

installed correctly:$NCHOME/omnibus/probes/linux2x86/nco_p_iec_cim_ami -help

Check that the output from this command begins as follows:Using IBM JavaVersion 1.6.7Usage: "nco_p_iec_cim_ami" [options]

where options can be:

-autosaf Enable automatic Store and Forward on startup-beatinterval Probe failover heartbeat interval-beatthreshold Probe failover heartbeat threshold time-buffer Turn on alert buffering

5. Start the probe as follows:$NCHOME/omnibus/probes/linux2x86/nco_p_iec_cim_ami \-propsfile $NCHOME/omnibus/probes/linux2x86/iec_cim_ami.props \-messagelevel debug

6. Check the probe's log file to ensure the probe started correctly and is ready toreceive, process, and dispatch events.The probe's MessageLog property provides the name and location of the probe'slog file.

7. Where possible, use a test tool to send events to the probe and so check theyare processed correctly.

The probe is now successfully installed and operational. You can now configure theprobe to suit your operating environment.

Installing probesAll probes are installed in a similar way. The process involves downloading theappropriate installation package for your operating system, installing theappropriate files for the version of Netcool/OMNIbus that you are running, andconfiguring the probe to suit your environment.

The installation process consists of the following steps:1. Downloading the installation package for the probe from the Passport

Advantage Online website.Each probe has a single installation package for each operating systemsupported. For details about how to locate and download the installationpackage for your operating system, visit the following page on the IBM TivoliKnowledge Center:http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/probes/all_probes/wip/reference/install_download_intro.html

2. Installing the probe using the installation package.

IBM Tivoli Netcool/OMNIbus Probe for IEC CIM Advanced Metering Infrastructure 3



The installation package contains the appropriate files for all supportedversions of Netcool/OMNIbus. For details about how to install the probe torun with your version of Netcool/OMNIbus, visit the following page on theIBM Tivoli Knowledge Center:http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/probes/all_probes/wip/reference/install_install_intro.html

3. Configuring the probe.This guide contains details of the essential configuration required to run thisprobe. It combines topics that are common to all probes and topics that arepeculiar to this probe. For details about additional configuration that iscommon to all probes, see the IBM Tivoli Netcool/OMNIbus Probe and GatewayGuide.

Configuring the probeAfter installing the probe you need to make various configuration settings to suityour environment.

The following table outlines how to use the probe's properties to configure theproduct's features. Configuration of some features is mandatory for allinstallations. For those features set the properties to the correct values or verifythat their default values are suitable for your environment. Further configuration isoptional depending on how many features of the probe you want to use.

Table 4. Configuring the probe

Feature Properties See

Mandatory features:

ObjectServer host name Server “ObjectServer information”on page 6

Web service URI

The information needed todefine the web serviceSOAP interface.

LocalHttpHostLocalHttpPort

“Setting the Web ServiceURI” on page 6

IEC CIM AMI version inuse

EndpointRelease “Properties and commandline options” on page 12

Optional features:

Inactivity policy

Specifies whether the probedisconnects from the EMSendpoint following a periodof inactivity.

Inactivity“Inactivity” on page 7

Data stream capture

Allows you to capture thestream of raw binary datafrom the target device andstore it in a file.

StreamCaptureStreamCaptureFilePath

“Data stream capture” onpage 7


http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/probes/all_probes/wip/reference/install_install_intro.html

http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/probes/all_probes/wip/reference/install_install_intro.html

Table 4. Configuring the probe (continued)

Feature Properties See

Support for Unicode andnon-Unicode characters

Enables the probe to processcharacters encoded inUTF-8, such as Asianlanguages.

EncodingStandardUTF8Enabled

“Support for Unicode andnon-Unicode characters” onpage 8

Peer-to-peer failover pair

Allows you to set up twoprobes to act as a failoverpair to improve availability.If the master probe shouldstop working, the slaveprobes takes over until themaster is available oncemore.

MessageLogModePeerHostPeerPortPidFilePropsFileRulesFile

“Peer-to-peer failoverfunctionality” on page 9

Probe component loggingproperties

None “Setting the componentlogging properties” on page10

Running multiple instancesof the probe

Allows you to run two ormore instances of the probeon a single host machine.

LocalHttpPortNamePropsFileRulesFile

“Running multiple probes”on page 10

Running the probe as aWindows service

None “Running the probe as aWindows service” on page11

Data acquisitionEach probe uses a different method to acquire data. Which method the probe usesdepends on the target system from which it receives data.

The Probe for IEC CIM Advanced Metering Infrastructure acquires data from theAdvanced Metering Infrastructure by publishing a web service, using the SOAPand WSDL technologies. The service can receive AMI events from devices that arecompliant with the IEC Common Information Model (CIM) standards IEC 61968-9and 61968-100.

Data acquisition is described in the following topics:v “ObjectServer information” on page 6v “Setting the Web Service URI” on page 6v “Inactivity” on page 7v “Data stream capture” on page 7v “Support for Unicode and non-Unicode characters” on page 8v “Peer-to-peer failover functionality” on page 9v “Setting the component logging properties” on page 10


ObjectServer informationDefine the ObjectServer, or pair of ObjectServers, that the probe communicateswith.

The probe sends processed events to an ObjectServer resource. This can be a singleserver or a failover pair of ObjectServers.

Single ObjectServer

Configure the probe to communicate with an ObjectServer by setting the Serverproperty to the name of the ObjectServer.

Failover pair

Optionally, you can define a failover pair of ObjectServers. One of them acts as theprimary ObjectServer that the probe communicates with initially. Should thatObjectServer become unreachable, the probe communicates with the other, backupObjectServer. To define a failover pair set the following probe properties:

Table 5. Properties that define a failover pair of ObjectServers

Property Value

Server Set this property to the name of the primary ObjectServer.

ServerBackup Set this property to the name of the backup ObjectServer.

NetworkTimeout Set this property to the timeout period, in seconds, for the primaryObjectServer. If the probe does not receive a response from the primaryObjectServer within that time, it connects to the backup ObjectServer.

PollServer Set this property to the time period, in seconds, when the probe tries toreconnect to the primary ObjectServer.

Note: Ensure that the value of NetworkTimeout is less than the value of PollServer.

Setting the Web Service URIThe probe publishes a web service so that it can listen for alarms from the EMS.

A unique URI that identifies the web service, and that URI is built from the valuesof the following properties:

LocalEventServiceName

LocalHttpHost

LocalHttpPort

In this release of the probe, the value of LocalEventServiceName is fixed and youcannot change it. Set the values of the other properties appropriately for your site.The resultant URI has the following format:

http://host:port/servicename

Where:host is the value of the LocalHttpHost property.port is the value of the LocalHttpPort property.


servicename is the value of the LocalEventServiceName property.

For example, using the default values of these properties, the URI for the serviceis:

http://localhost:8080/Operation

Ensure that the full URI is configured on the EMS so that it can publish events tothe probe. Batch control of events and event filtering, if required, also need to beconfigured on the EMS.

InactivityThe probe can disconnect from the target system and shut down if there is noevent activity for a predefined amount of time.

You can use the Inactivity property to specify how long, in seconds, the probewaits before disconnecting from the target system and shutting down. If the probereceives no events during that time, it disconnects from the target system andshuts down. To ensure that the probe never disconnects from the target system, setthe value of the property to 0, which is the default value.

Data stream captureThe probe can capture the stream of binary data from the target device and store itin a file. The data can be used for problem solving, debugging purposes, todevelop new features for the probe, or to pass onto other management systemsthat require the same data.

To capture the data stream in a file, use the following procedure:1. Set the value of the StreamCapture property to 1.2. Set the value of the StreamCaptureFilePath property to the full path of a

directory to hold the files of data.

Notes:

v Specify the full path of the directory. For example:/opt/tivoli/netcool/omnibus/var

v You cannot include variables such as $OMNIHOME in the directory path.v If the directory does not exist, or StreamCaptureFilePath does not have a

value, the probe stores the file in the directory that the probe was run from.That is, $NCHOME/omnibus/probes on a Linux or Unix system, or%NCHOME%\omnibus\probes\win32 on a Windows system.

3. If the probe is running, restart the probe.

The probe now writes stream data to a file in the specified directory. The name ofthe file has the following format:

probename_soapws-timestamp.data

Where:probename is the name of the probe defined in the Name property.timestamp is the UTC time (expressed in miliseconds) when the file was created.

Example:


iec_cim_ami_soapws-1392014991642.data

Note: Capturing the data stream to a log file generates a lot of data, consumingdisk space and other system resources. So use this feature with caution. As soon asyou no longer require the capture of data, set the value of the StreamCaptureproperty to 0 and restart the probe.

Support for Unicode and non-Unicode charactersThe probe can process multibyte characters such as Unicode UTF-8, GB, Big5, orShift-JIS.

Use the following procedure to set up the probe to process multibyte characters:1. Ensure that the device or EMS is configured to send data in the required format

(for example, UTF-8).2. Set the required locale on the system that runs the probe:

Table 6. Setting the locale for multibyte characters

Operatingsystem Procedure to set the locale

Linux and Unix Set the locale by changing the values of the LANG and LC_ALLenvironment variables. For example, to set the locale to simplifiedChinese in UTF-8, use the following commands:

export LANG=zh_CN.UTF-8export LC_ALL=zh_CN.UTF-8

Windows 1. Open the Control Panel and double click on Regional andLanguage.

2. On the Formats tab, select the language from the list in Format.

3. On the Administrative tab, click Change system locale.

4. Select the language from the list in Current System Locale.

5. Click OK.

6. Click OK.

3. Configure the ObjectServer to enable the insertion of data that uses the requiredcharacter set. The IBM Tivoli Netcool/OMNIbus Administration Guide shows howto create, configure, and run an ObjectServer in UTF-8 mode or using anothercharacter set.

4. Run the probe or, if it is already running, restart the probe.When running the probe on a Windows system using a UTF-8 character set,always specify the -utf8enabled command line option. For all other charactersets, do not use the -utf8enabled command line option.


Peer-to-peer failover functionalityThe probe supports failover configurations where two probes run simultaneously.One probe acts as the master probe, sending events to the ObjectServer; the otheracts as the slave probe on standby. If the master probe fails, the slave probeactivates.

While the slave probe receives heartbeats from the master probe, it does notforward events to the ObjectServer. If the master shuts down, the slave probe stopsreceiving heartbeats from the master and any events it receives thereafter areforwarded to the ObjectServer on behalf of the master probe. When the master isrunning again, the slave continues to receive events, but no longer sends them tothe ObjectServer.

Example property file settings for peer-to-peer failover

You set the peer-to-peer failover mode in the properties files of the master andslave probes. The settings differ for a master probe and slave probe.

Note: In the examples, make sure to use the full path for the property value. Inother words replace $OMNIHOME with the full path. For example:/opt/IBM/tivoli/netcool.

The following example shows the peer-to-peer settings from the properties file of amaster probe:Server : "NCOMS"RulesFile : "master_rules_file"MessageLog : "master_log_file"PeerHost : "slave_hostname"PeerPort : 5555 # [communication port between master and slave probe]Mode : "master"PidFile : "$OMNIHOME/var/opc_ua"

The following example shows the peer-to-peer settings from the properties file ofthe corresponding slave probe:Server : "NCOMS"RulesFile : "slave_rules_file"MessageLog : "slave_log_file"PeerHost : "master_hostname"PeerPort : 5555 # [communication port between master and slave probe]Mode : "slave"PidFile : "$OMNIHOME/var/opc_ua2"


Setting the component logging propertiesSet the location of the log file for the probe components.

The probe can create a log file that contains details of the behavior of the probe'scomponents. This feature is primarily used when problem solving and is definedin $NCHOME/omnibus/probes/java/iec_cim_ami_dsl_log.properties. If you need touse the feature, enable the destination of this log file that is appropriate for theoperating system that the probe runs on.1. Navigate to $NCHOME/omnibus/probes/java and edit the file

iec_cim_ami_dsl_log.properties.2. Locate the following lines in the file:

# Uncomment to enable for Windows#log4j.appender.LFA.File=C:/IBM/Tivoli/Netcool/omnibus/log/iec_cim_ami_dsl.log# Uncomment to enable for Unix#log4j.appender.LFA.File=$OMNIHOME/log/iec_cim_ami_dsl.log

3. Remove the comment marker from the beginning of the line that is appropriatefor the operating system that the probe runs on.

4. Save the file and exit from the text editor.

Running the probeThe way in which you run the probe depends on whether the operating system ofthe host machine is UNIX or Windows.

To start the probe on UNIX, use the following command:$NCHOME/omnibus/probes/nco_p_iec_cim_ami

To start the probe from a Microsoft Windows command prompt, use the followingcommand:%NCHOME%\omnibus\probes\nco_p_iec_cim_ami.bat

Running multiple probesYou can run multiple, concurrent instances on a single host machine.

Preparation

For each instance of the probe that you want to run, do the following:1. Create a uniquely-named copy of the probe's properties file, for example:

$NCHOME/omnibus/probes/arch/nco_p_iec_cim_ami_n.props

For each copy of the properties file, replace n with a unique number.2. Create a uniquely-named copy of the probe's rules file. Customize the copy as

required.3. In the properties file for each instance, define a unique value for each of the

following properties:LocalHttpPort

Name

4. In the properties file for each instance, set the values of the PropsFile andRulesFile properties to the names of the files you created in steps 1 and 2.


Running the probes

To run each instance of the probe, specify the -propsfile command line option torefer to the appropriate properties file, for example on UNIX:$NCHOME/omnibus/probes/nco_p_iec_cim_ami-propsfile $NCHOME/omnibus/props/aix5/nco_p_iec_cim_ami_1.props

$NCHOME/omnibus/probes/nco_p_iec_cim_ami-propsfile $NCHOME/omnibus/props/aix5/nco_p_iec_cim_ami_2.props

Running the probe as a Windows serviceThe Windows version of the probe can run as a Windows service.

Registering and running the Windows service

To run a single instance of the probe as a Windows service:1. Open a Command Prompt.2. Register the probe as a Windows service:

%OMNIHOME%\probes\win32\nco_p_iec_cim_ami.bat /INSTALL /INSTANCE instanceName/CMDLINE "command-line-options"

Replace instanceName with a unique name for the service andcommand-line-options with any command line options that you want to usewhen running the probe. Always enclose the command line options in quotes.If you do not want to use any command line options, exclude the /CMDLINEswitch.

Note: If you omit the /INSTANCE switch, the name of the service isNCONcoPIecCimAmiProbe.Example:%OMNIHOME%\probes\win32\nco_p_iec_cim_ami.bat /INSTALL /INSTANCE IecCimAmiProbe/CMDLINE "-utf8enabled"

Note: Ensure that the environment variables that the probe uses are defined assystem variables. Typically, the relevant variables are %OMNIHOME% and%IEC_CIM_EP_RLS_JAR_PATH%. Refer to the file nco_p_iec_cim_ami.bat forthe value of the %IEC_CIM_EP_RLS_JAR_PATH% variable.

3. Run the service:a. Open the Windows Control Panel and double click Administrative Tools.b. Double click Services.c. Click on the entry for the probe service and click Start.

Removing the service

To remove the service, if required:1. Stop the service if it is running:

a. Open the Windows Control Panel and double click Administrative Tools.b. Double click Services.c. Click on the entry for the probe service and click Stop.

2. Open a Command Prompt and enter the following command to remove theprobe service from the system:%OMNIHOME%\probes\win32\nco_p_iec_cim_ami.bat /REMOVE /INSTANCEinstanceName


Replace instanceName with the instance name you supplied when registeringthe probe as a service.

Properties and command line optionsYou use properties to specify how the probe interacts with the device. You canoverride the default values by using the properties file or the command lineoptions.

The following table describes the properties and command line options specific tothis probe. For information about default properties and command line options, seethe IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

Table 7. Properties and command line options

Property name Command line option Description

DSLLogConfig string -dsllogconfig string Use this property to specify theconfiguration file for the detailedlogging of the probe's components.The location of the file is$NCHOME/omnibus/probes/java.

The default is:iec_cim_ami_dsl_log.properties

EndpointRelease string -endpointrelease string Use this property to specify theversion of the IEC CIM AMIstandard that the target systemimplements.

In this release of the probe, thisproperty has the following value:

IEC_CIM: The target system iscompliant with the IEC CIM AMIspecification.

The default is: IEC_CIM

Inactivity integer -inactivity integer Use this property to specify thelength of time (in seconds) that canpass without the probe receivingevents. If this time expires, theprobe disconnects from the targetsystem and shuts down. A value of0 means that the probe never shutsdown.

The default is: 0

LocalEventServiceNamestring

-localeventservicenamestring

Use this property to specify thename of the web service endpointto receive AMI events from theEMS. In the current release, theonly supported value of thisproperty is Operation.

The default is: Operation


Table 7. Properties and command line options (continued)

Property name Command line option Description

LocalHttpHost string -localhttphost string Use this property to specify thename or IP address of the local hostthat runs the web service (that isthe system where the probe isrunning).

The default value is: localhost

LocalHttpPort integer -localhttpport integer Use this property to specify thenumber of the port that the probelistens on for AMI events.

The default value is: 8080

PidFile string -pidfile string Use this property to define the filethat contains the process ID for thedevice.

The default value is:$OMNIHOME/var/iec_cim_ami

StreamCapture integer -streamcapture integer Use this property to specifywhether the stream capture featureis enabled.

This property takes the followingvalues:

1: The probe uses the streamcapture feature.

0: The probe does not use thestream capture feature.

The default is: 0Note: If you set the value of thisproperty to 1, define a value for theStreamCaptureFilePath property aswell.

StreamCaptureFilePathstring

-streamcapturefilepathstring

Use this property to specify thedirectory where the probe stores theinput data stream.

The default is: ""

See “Data stream capture” on page7 for more information on how touse this property.


ElementsThe probe breaks event data down into tokens and parses them into elements.Elements are used to assign values to ObjectServer fields; the field values containthe event details in a form that the ObjectServer understands.

The following table describes the elements that the Probe for IEC CIM AdvancedMetering Infrastructure generates. Not all the elements described are generated foreach event; the elements that the probe generates depends upon the event type.

Table 8. Elements

Element name Element description

$Event_category This element contains the category of the event asdefined in the IEC CIM AMI standard. Thecategory consists of four integers separated byperiods. The first integer identifies the type ofdevice that generated the event, the remainingthree integers identify the type of event.

In this release, the probe implements only a smallnumber of the events and types of device that theIEC CIM AMI standards define.

The probe uses two look up tables to convert theIEC CIM AMI event data into fields for anObjectServer event. These tables appear in the file$NCHOME/omnibus/probes/includes/iec_cim_ami_lookup.rules.

$Event_createdDateTime This element contains date and time when thiscategory of event first occurred.

$Event_description This element contains a description of the event.

$Event_mRID This element contains name of the entity that theevent relates to and is held in the <mRID> tag inthe XML message that contains the event.

Error messagesError messages provide information about problems that occur while running theprobe. You can use the information that they contain to resolve such problems.

The following table describes the error messages specific to this probe. Forinformation about generic error messages, see the IBM Tivoli Netcool/OMNIbusProbe and Gateway Guide.

Table 9. Error messages

Error Description Action

Invalid StreamCaptureproperty value: value

The StreamCapture propertyhas a value that is not one ofthose defined in “Propertiesand command line options”on page 12.

Edit the properties file and setthe value of the property toone of the defined values.


Table 9. Error messages (continued)

Error Description Action

Probe failed: reasonCause: cause

An error occurred while theprobe was starting. The reasoncontains the error messagerelating to the problem.Where a cause can beidentified, the related messageappears as the cause.

Correct the cause of the errorand restart the probe.

Probe failed to addevent: reason

An error occurred while theprobe was trying to add anevent to the queue waiting tobe sent to the ObjectServer.The reason contains a detailedmessage relating to theproblem.

Correct the cause of the errorand restart the probe.

Unsupported endpointrelease: releaseversion

The value of theEndpointRelease property isnot one of the supportedvalues.

Correct the value of theproperty and restart theprobe.

ProbeWatch messagesDuring normal operations, the probe generates ProbeWatch messages and sendsthem to the ObjectServer. These messages tell the ObjectServer how the probe isrunning.

The following table describes the raw ProbeWatch error messages that the probegenerates. For information about generic ProbeWatch messages, see the IBM TivoliNetcool/OMNIbus Probe and Gateway Guide.

Table 10. ProbeWatch messages

ProbeWatch message Description Triggers/causes

Running... The has started. This message indicates thatthe probe is running normally.

Going down... The probe is stopping. This message indicates thatthe probe is shutting down.



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. 2014 17

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.


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. in theUnited 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 19


��

Printed in USA

SC27-6262-01

Documents

Netcool/OMNIbus Probe for IEC CIMAdvanced Metering ... · Netcool/OMNIbus Probe for IEC CIMAdvanced Metering Infrastructure Version ... for IEC CIMAdvanced Metering Infrastructure