JP1 Version 12 JP1/Integrated Management 2 - Manager Command and Definition File Reference

3021-3-D55-10(E)

Notices

Relevant program products

For details about the supported OS versions, and about the OS service packs and patches required by JP1/Integrated Management 2 - Manager and JP1/Integrated Management 2 - View, see the release notes for the relevant product.

JP1/Integrated Management 2 - Manager (for Windows):

P-2A2C-8ECL JP1/Integrated Management 2 - Manager 12-10

The above product includes the following:

P-CC2A2C-9MCL JP1/Integrated Management 2 - Manager 12-10 (for Windows Server 2019, Windows Server 2016, Windows Server 2012)

P-CC2A2C-6HCL JP1/Integrated Management 2 - View 12-00 (for Windows Server 2019, Windows Server 2016, Windows 10, Windows 8.1, Windows 8, Windows Server 2012, Windows 7)

JP1/Integrated Management 2 - Manager (for Linux):

P-812C-8ECL JP1/Integrated Management 2 - Manager 12-10

The above product includes the following:

P-CC812C-9MCL JP1/Integrated Management 2 - Manager 12-10 (for Linux 7, Linux 6 (x64), Oracle Linux 7, Oracle Linux 6 (x64), CentOS 7, CentOS 6 (x64))

P-CC9W2C-9MCL JP1/Integrated Management 2 - Manager 12-10 (for SUSE Linux 15, SUSE Linux 12)

P-CC2A2C-6HCL JP1/Integrated Management 2 - View 12-00 (for Windows Server 2019, Windows Server 2016, Windows 10, Windows 8.1, Windows 8, Windows Server 2012, Windows 7)

Trademarks

HITACHI, HiRDB, JP1 are either trademarks or registered trademarks of Hitachi, Ltd. in Japan and other countries.

Active Directory is either a registered trademark or a trademark of Microsoft Corporation in the United States and/or other countries.

IBM, AIX are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide.

AMD, AMD Opteron, and combinations thereof, are trademarks of Advanced Micro Devices, Inc.

Internet Explorer is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.

Microsoft and Hyper-V are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

Netscape is a trademark of AOL Inc.in the U.S. and other countries.

Oracle and Java are registered trademarks of Oracle and/or its affiliates.

Red Hat, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the United States and other countries. Linux(R) is the registered trademark of Linus Torvalds in the U.S. and other countries.

RSA and BSAFE are either registered trademarks or trademarks of EMC Corporation in the United States and/or other countries.

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

Windows is either a registered trademark or a trademark of Microsoft Corporation in the United States and/or other countries.

Windows Server is either a registered trademark or a trademark of Microsoft Corporation in the United States and/or other countries.

Other company and product names mentioned in this document may be the trademarks of their respective owners.

This product includes RSA BSAFE Cryptographic software of EMC Corporation.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

This product includes software developed by Ben Laurie for use in the Apache-SSL HTTP server project.

Portions of this software were developed at the National Center for Supercomputing Applications (NCSA) at the University of Illinois at Urbana-Champaign.

This product includes software developed by the University of California, Berkeley and its contributors.

This software contains code derived from the RSA Data Security Inc. MD5 Message-Digest Algorithm, including various modifications by Spyglass Inc., Carnegie Mellon University, and Bell Communications Research, Inc (Bellcore).

Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England. The original software is available from ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/

This product includes software developed by Ralf S.Engelschall <rse@engelschall.com> for use in the mod_ssl project (http://www.modssl.org/).

This product includes software developed by Andy Clark.

This product includes software developed by Daisuke Okajima and Kohsuke Kawaguchi (http://relaxngcc.sf.net/).

This product includes software developed by IAIK of Graz University of Technology.

This product includes software developed by the Java Apache Project for use in the Apache JServ servlet engine project (http://java.apache.org/)

Java is a registered trademark of Oracle and/or its affiliates.

Microsoft product name abbreviations

This manual uses the following abbreviations for Microsoft product names.

Abbreviation

Full name or meaning

Hyper-V

Microsoft(R) Windows Server(R) 2008 R2 Hyper-V(R)

Microsoft(R) Windows Server(R) 2012 Hyper-V(R)

IE

Windows Internet Explorer

Windows(R) Internet Explorer(R)

SCVMM

Microsoft(R) System Center Virtual Machine Manager 2008

Microsoft(R) System Center Virtual Machine Manager 2012

Windows 7

Microsoft(R) Windows(R) 7 Enterprise

Microsoft(R) Windows(R) 7 Professional

Microsoft(R) Windows(R) 7 Ultimate

Windows 8

Windows(R) 8 Enterprise

Windows(R) 8 Pro

Windows 8.1

Windows(R) 8.1 Enterprise

Windows(R) 8.1 Pro

Windows 10

Windows(R) 10 Enterprise 32-bit

Windows(R) 10 Enterprise 64-bit

Windows(R) 10 Home 32-bit

Windows(R) 10 Home 64-bit

Windows(R) 10 Pro 32-bit

Windows(R) 10 Pro 64-bit

Windows Server 2012

Windows Server 2012

Microsoft(R) Windows Server(R) 2012 Datacenter

Microsoft(R) Windows Server(R) 2012 Standard

Windows Server 2012 R2

Microsoft(R) Windows Server(R) 2012 R2 Datacenter

Microsoft(R) Windows Server(R) 2012 R2 Standard

Windows Server 2016

Microsoft(R) Windows Server(R) 2016 Datacenter

Microsoft(R) Windows Server(R) 2016 Standard

Windows Server 2019

Microsoft(R) Windows Server(R) 2019 Datacenter

Microsoft(R) Windows Server(R) 2019 Standard

Windows is often used generically to refer to Windows Server 2019, Windows Server 2016, Windows 10, Windows 8.1, Windows 8, Windows Server 2012, or Windows 7.

Restrictions

Information in this document is subject to change without notice and does not represent a commitment on the part of Hitachi. The software described in this manual is furnished according to a license agreement with Hitachi. The license agreement contains all of the terms and conditions governing your use of the software and documentation, including all warranty rights, limitations of liability, and disclaimers of warranty.

Material contained in this document may describe Hitachi products not available or features not available in your country.

No part of this material may be reproduced in any form or by any means without permission in writing from the publisher.

Issued

Jan. 2020: 3021-3-D55-10(E)

Copyright

Copyright (C) 2019, 2020, Hitachi, Ltd.

Copyright (C) 2019, 2020, Hitachi Solutions, Ltd.

Colophon

Publisher

Hitachi, Ltd.

6-6, Marunouchi 1-chome, Chiyoda-ku, Tokyo, 100‒8280 Japan

Summary of amendments

The following table lists changes in this manual (3021-3-D55-10(E)) and product changes related to this manual.

Changes

Location

The following commands were added:

jddsetproxyuser

1.Commands, 1.jddsetproxyuser

A functional description was modified.

1.jddsetaccessuser

The data folder for 64-bit integrated trace logs was added.

1.jcoview_log.bat(Windows only)

The data folder of plug-ins for the Intelligent Integrated Management Base was added.

The -b option was added.

1.jim_log.bat(Windows only), 1.jim_log.sh(UNIX only)

The following functions are now available in the Intelligent Integrated Management Base:

Proxy server authentication

Configuring User-defined window display area

Configuring whether to use the linked unit display function

Configuring whether to display an icon indicating that the impact on following root jobnets is unknown

Compatible setting of the repeated event viewing suppression function(compatible with version 12-00)

2. Intelligent Integrated Management Base definition file (imdd.properties)

The configuration of an object root node that belongs to a system or subsystem can now be obtained.

2. System node definition file (imdd_systemnode.conf)

A relationship between jobnets can now be defined.

2. IM management node link definition file (imdd_nodeLink_def.conf)

Specifiable substitute keywords of the Definition file for opening monitor windows, In the Intelligent Integrated Management Base, the string is not substituted was supplemented.

2. Definition file for opening monitor windows

Limitations applicable to dummy events were added.

3.2.1

In addition to the above changes, minor editorial corrections were made.

Preface

This manual describes the commands and definition files of JP1/Integrated Management 2 - Manager and JP1/Integrated Management 2 - View systems. In this manual, JP1/Integrated Management is abbreviated to JP1, and JP1/Integrated Management 2 - Manager and JP1/Integrated Management 2 - View are generically referred to as JP1/Integrated Management or JP1/IM. In addition, in this manual, read JP1/Integrated Management - Manager and JP1/Integrated Management - View as JP1/Integrated Management 2 - Manager and JP1/Integrated Management 2 - View, respectively.

Intended readers

This manual is intended for users who want to manage, use, and operate an infrastructure that manages an open-platform system form JP1/IM. More specifically, it is intended for:

System administrators who manage, use, and operate JP1/IM to centrally monitor the events that arise in the system.

System administrators who manage, use, and operate JP1/IM to centrally monitor the status of the system management infrastructure based on correlation with events that arise in the system

Those who have knowledge of operating systems and applications

Organization of this manual

This manual consists of the following chapters:

1. Commands

Chapter 1 describes the syntax for the commands that can be used in JP1/Integrated Management.

2. Definition Files

Chapter 2 describes the formats and syntax of the definition files for JP1/Integrated Management.

3. JP1 Events

Chapter 3 describes the types and attributes of the JP1 events that are issued by JP1/Integrated Management.

4. Lists of System-Monitoring Objects (for Central Scope)

Chapter 4 describes the system-monitoring objects that are provided by JP1/Integrated Management.

5. Monitoring Tree Models (for Central Scope)

Chapter 5 describes the structures of monitoring trees that are created automatically.

Manual suite

JP1/IM manuals provide necessary information according to the phase in the system life cycle (the phases include planning/design, configuration, and operation). Read the manual appropriate for the purpose.

The following figure explains which phases the JP1/IM manuals provide information for.

Conventions: Diagrams

This manual uses the following conventions in diagrams:

Conventions: Fonts and symbols

The following table explains the text formatting conventions used in this manual:

Text formatting

Convention

Bold

Bold characters indicate text in a window, other than the window title. Such text includes menus, menu options, buttons, radio box options, or explanatory labels. For example:

From the File menu, choose Open.

Click the Cancel button.

In the Enter name entry box, type your name.

Italic

Italic characters indicate a placeholder for some actual text to be provided by the user or system. For example:

Write the command as follows:

copy source-file target-file

The following message appears:

A file was not found. (file = file-name)

Italic characters are also used for emphasis. For example:

Do not delete the configuration file.

Monospace

Monospace characters indicate text that the user enters without change, or text (such as messages) output by the system. For example:

At the prompt, enter dir.

Use the send command to send mail.

The following message is displayed:

The password is incorrect.

The following table explains the symbols used in this manual:

Symbol

Convention

|

In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR. For example:

A|B|C means A, or B, or C.

{ }

In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. For example:

{A|B|C} means only one of A, or B, or C.

[ ]

In syntax explanations, square brackets indicate that the enclosed item or items are optional. For example:

[A] means that you can specify A or nothing.

[B|C] means that you can specify B, or C, or nothing.

...

In coding, an ellipsis (...) indicates that one or more lines of coding have been omitted.

In syntax explanations, an ellipsis indicates that the immediately preceding item can be repeated as many times as necessary. For example:

A, B, B, ... means that, after you specify A, B, you can specify B as many times as necessary.

Δ

Indicates a space.

Δ₀: Zero or more spaces (space can be omitted).

Δ₁: One or more spaces (space cannot be omitted).

Indicates a tab.

Example:

A means that a tab character precedes A.

Conventions: Installation folders for the Windows version of JP1/IM and JP1/Base

In this manual, the installation folders for the Windows versions of JP1/IM and JP1/Base are indicated as follows:

Product name

Installation folder

Default installation folder#

JP1/IM - View

View-path

system-drive:\Program Files\Hitachi\JP1CoView

JP1/IM - Manager

Manager-path

system-drive:\Program Files\Hitachi\JP1IMM

Console-path

system-drive:\Program Files\Hitachi\JP1Cons

Scope-path

system-drive:\Program Files\Hitachi\JP1Scope

JP1/Base

Base-path

system-drive:\Program Files\Hitachi\JP1Base

#: Represents the installation folder when the product is installed in the default location. The location represented by system-drive:\Program Files is determined at the time of installation by an OS environment variable, and might differ depending on the environment.

Conventions: Meaning of "Administrator permissions" in this manual

In this manual, Administrator permissions refers to the Administrator permissions for the local PC. Provided that the user has Administrator permissions for the local PC, operations are the same whether they are performed with a local user account, a domain user account, or in an Active Directory environment.

Conventions: Version numbers

The version numbers of Hitachi program products are usually written as two sets of two digits each, separated by a hyphen. For example:

Version 1.00 (or 1.0) is written as 01-00.

Version 2.05 is written as 02-05.

Version 2.50 (or 2.5) is written as 02-50.

Version 12.25 is written as 12-25.

The version number might be shown on the spine of a manual as Ver. 2.00, but the same version number would be written in the program as 02-00.

Conventions: Paths specified in definition files

A definition cannot include any file name that is specified with a network path.

For example, the event guide information file must have EV_FILE specified with a folder path that is not a network path.

Online manuals

JP1/IM comes with an HTML manual that you can read in a web browser.

The HTML manual has the same contents as this manual.

To view the HTML manual:

In JP1/IM - View, choose Help and then Help Contents.

In Integrated Operation Viewer Window, choose Help and then Online manual.

Note:

If you use the Start menu, the HTML manual may be displayed in an existing browser window, depending on the related setting in the OS.

Output destinations of Integrated trace log file

Starting with JP1/IM 12-10, all 32-bit Java processes for JP1/IM have been changed to 64-bit Java processes. Therefore, the integrated trace log output destination output by the Java process function of each function of JP1 / IM is changed.

The following is the destination of the integrated trace log for each JP1/IM function from version 12-10. If you are using the log file trap function, you must change the settings as you change the destination.

Output destinations of Integrated trace log file (32 bit): system-drive\Program Files(x86)\Hitachi\HNTRLib2\spool

IM database

Central Scope Service

Process management

Command execution

Automatic action

Installation and Setup

Output destinations of Integrated trace log file (64 bit): system-drive\Program Files\Hitachi\HNTRLib2\spool

Event base service

Central Console viewer

Central Scope viewer

Event Genaration Service

IM Configuration Management

IM Configuration Management viewer

Intelligent Integrated Management Base

1 Commands

This chapter describes the syntax of the commands that are used in JP1/IM.

Format of command explanations

This section describes the format of the command explanations. Note that some of the items shown below might be omitted in some command explanations.

Function

Describes the function of the command.

Format

Describes the command's format.

Execution permission

Describes the user permissions required in order to execute the command.

Storage directory

Describes the command's storage location.

Arguments

Describes the arguments of the command.

Note that arguments are case sensitive (except for the ON and OFF arguments, which are not case sensitive).

Notes

Provides additional important information about the command.

Return values

Describes the command's return values.

For details about the messages that may be displayed during command execution, see the manual JP1/Integrated Management 2 - Manager Messages.

Example

Provides an example of using the command.

Example output

Provides an example of the output from execution of the command.

Lists of commands

This section lists the names of the commands that can be used in JP1/IM and the permissions required to execute these commands. Note that the commands are described in alphabetical order from the next section.

Legend and notes for tables

Whether a command is supported in the Windows and UNIX environments is indicated in the tables by the following notations and notes:

Legend:

Y: Supported

--: Not supported

#1

In Windows, a superuser means a user with Administrator permissions.

#2

This is a JP1/Base command (related to configuration definition and command execution) for the manager. For details about the command, see the chapter that describes commands in the JP1/Base User's Guide.

#3

In Windows, Administrator permissions are required. (If the Windows UAC feature is enabled, the command must be executed from the administrator console.)

Commands related to startup, termination, and setup

Overview of function

Command name

Windows

UNIX

Required execution permission

Sets up JP1/IM - Manager (Central Console)

jp1cc_setup (UNIX only)

--

Y

Superuser

Sets up JP1/IM - Manager (Central Scope)

jp1cs_setup (UNIX only)

--

Y

Superuser

Starts JP1/IM - Manager automatically

jco_start (UNIX only)

--

Y

Superuser

Terminates JP1/IM - Manager automatically

jco_stop (UNIX only)

--

Y

Superuser

Displays the status of JP1/IM - Manager processes

jco_spmd_status

Y

Y

Superuser#1

Updates the status of JP1/IM - Manager processes

jco_spmd_reload

Y

Y

Superuser#1

Specifies settings required for operation in a cluster system

jp1cohasetup (Windows only)

Y

--

Superuser#1

jp1cshasetup (Windows only)

Y

--

Superuser#1

jp1cc_setup_cluster (UNIX only)

--

Y

Superuser

jp1cs_setup_cluster (UNIX only)

--

Y

Superuser

Starts JP1/IM - Manager in a cluster system

jco_start.cluster (UNIX only)

--

Y

Superuser

Terminates JP1/IM - Manager in a cluster system

jco_stop.cluster (UNIX only)

--

Y

Superuser

Forcibly terminates JP1/IM - Manager in a cluster system

jco_killall.cluster (UNIX only)

--

Y

Superuser

Specifies dependencies between JP1/IM-Manager Service and the JP1/Base Event service

SpmSetSvcCon (Windows only)

Y

--

Superuser#1

Commands related to IM databases

Overview of function

Command name

Windows

UNIX

Required execution permission

Sets up the IM Configuration Management database for storing configuration information

jcfdbsetup

Y

Y

Superuser#1

Cancels setup of the IM Configuration Management database that stores configuration information

jcfdbunsetup

Y

Y

Superuser#1

Sets up an integrated monitoring database for storing JP1 events

jcodbsetup

Y

Y

Superuser#1

Cancels setup of the integrated monitoring database that stores JP1 events

jcodbunsetup

Y

Y

Superuser#1

Outputs to a CSV file JP1 event information registered in the integrated monitoring database

jcoevtreport

Y

Y

Superuser#1

Backs up the IM database

jimdbbackup

Y

Y

Superuser#1

Releases free area (free page area) in the IM Configuration Management database

jimdbreclaim

Y

Y

Superuser#1

Restores (recovers) a database from a backup that has been stored

jimdbrecovery

Y

Y

Superuser#1

Reorganizes fragmented free space in a database

jimdbrorg

Y

Y

Superuser#1

Checks the operating status of the IM database (such as running or stopped)

jimdbstatus

Y

Y

Superuser#1

Terminates the IM database

jimdbstop

Y

Y

Superuser#1

Updates the IM database

jimdbupdate

Y

Y

Superuser#1

Commands related to IM Configuration Management

Overview of function

Command name

Windows

UNIX

Required execution permission

Collects virtualization configuration information from HCSM, and outputs it to the virtualization configuration information file

jcfcolvmhcsm

Y

Y

Superuser#1

Collects virtualization configuration information from KVM, and outputs it to the virtualization configuration information file

jcfcolvmkvm

Y

Y

Superuser#1

Collects virtualization configuration information from SCVMM, and outputs it to the virtualization configuration information file

jcfcolvmscvmm (Windows only)

Y

--

Superuser#1

Collects virtualization configuration information from vCenter, and outputs it to the virtualization configuration information file

jcfcolvmvc

Y

Y

Superuser#1

Collects virtualization configuration information from Hitachi Compute Blade logical partitioning feature, and outputs it to the virtualization configuration information file

jcfcolvmvirtage

Y

Y

Superuser#1

Acquires virtualization configuration information from VMware ESX and outputs it to a virtualization configuration information file

jcfcolvmesx

Y

Y

Superuser#1

Outputs the hierarchical configuration (IM configuration) of a system managed by IM Configuration Management, host information, and definition information

jcfexport

Y

Y

Superuser#1

Imports IM Configuration Management information

jcfimport

Y

Y

Superuser#1

Creates from the host input information file and Central Scope export file a Central Scope import file that contains monitoring tree information for a virtualization configuration. Alternatively, creates from the business group information file, monitoring group information file, and Central Scope export file a Central Scope import file to which the monitoring tree information of a business group has been added

jcfmkcsdata

Y

Y

Superuser#1

Uses a virtualization configuration information file to update a host input information file

jcfmkhostsdata

Y

Y

Superuser#1

Updates the virtualization configuration of the specified host

jcfvirtualchstat

Y

Y

Superuser#1

Sets up an operating environment for the IM Configuration Management processes of JP1/IM - Manager

jp1cf_setup (UNIX only)

--

Y

Superuser

Sets up an environment for IM Configuration Management for cluster system operation

jp1cf_setup_cluster (UNIX only)

--

Y

Superuser

Sets up an environment for IM Configuration Management for cluster system operation

jp1cfhasetup (Windows only)

Y

--

Superuser#1

Commands related to IM Configuration Management (remote monitoring configuration)

Overview of function

Command name

Windows

UNIX

Required execution permission

Defines the profile of a remote monitoring event log trap on the specified monitored host

jcfaleltdef (Windows only)

Y

--

Superuser#1

Reloads a remote monitoring event log trap action definition file

jcfaleltreload (Windows only)

Y

--

Superuser#1

Starts a remote monitoring event log trap

jcfaleltstart (Windows only)

Y

--

Superuser#1

Displays the operating status of a remote monitoring event log trap

jcfaleltstat (Windows only)

Y

--

Superuser#1

Stops a remote monitoring event log trap

jcfaleltstop (Windows only)

Y

--

Superuser#1

Adds or deletes the profile of a remote monitoring log file trap on the specified monitored host

jcfallogdef

Y

Y

Superuser#1

Reloads the action definition file of a remote monitoring log file trap

jcfallogreload

Y

Y

Superuser#1

Starts a remote monitoring log file trap

jcfallogstart

Y

Y

Superuser#1

Displays the operating status of a remote monitoring log file trap

jcfallogstat

Y

Y

Superuser#1

Stops a remote monitoring log file trap

jcfallogstop

Y

Y

Superuser#1

Commands related to upgrading

Overview of function

Command name

Windows

UNIX

Required execution permission

Converts an action definition file from version earlier than 11-50 to version 11-50 or later

jcadefconv

Y

Y

Superuser#1

Changes the location of the event acquisition filter from Event Console Service to Event Base Service (when the event acquisition filter is being used for compatibility)

jcochafmode (UNIX only)

Y

Y

Superuser#1

Migrates JP1/Base command execution logs for version 7 or earlier to a command execution log file for version 8

jcocmdconv#2

Y

Y

Superuser#1

Upgrades a logical host environment that was set up using a previous version of JP1/IM - Manager or JP1/IM - Manager (Central Console)

jp1cohaverup

Y

Y

Superuser#1

Upgrades a physical host environment from a previous version of JP1/IM - Manager (Central Scope)

jp1csverup.bat (Windows only)

Y

--

Superuser#1

Upgrades a logical host environment that was set up using a previous version of JP1/IM - Manager (Central Scope)

jp1cshaverup.bat (Windows only)

Y

--

Superuser#1

Upgrades a physical host environment from a previous version of JP1/IM - Manager (Central Scope)

jp1csverup (UNIX only)

--

Y

Superuser

Upgrades a logical host environment that was set up using a previous version of JP1/IM - Manager (Central Scope)

jp1cshaverup (UNIX only)

--

Y

Superuser

Commands related to the Intelligent Integrated Management Base

Overview of function

Command name

Windows

UNIX

Required execution permission

Collects the configuration information of the system managed by JP1/IM - Manager (Intelligent Integrated Management Base) and creates the IM management node-related files

jddcreatetree

Y

Y

Superuser#1

Collects system configuration information from the products managed by the Intelligent Integrated Management server, and creates IM management node-related files that are used as input data for the jddupdatetree command

jddupdatetree

Y

Y

Superuser#1

Sets a user ID and password that are used for JP1/IM - Manager (Intelligent Integrated Management Base) to be authenticated by linked products

jddsetaccessuser

Y

Y

Superuser#1

Sets authentication information for the proxy server when REST APIs are executed from plug-ins that are provided by JP1/IM - Manager (Intelligent Integrated Management Base)

jddsetproxyuser

Y

Y

Superuser#1

Commands related to views

Overview of function

Command name

Windows

UNIX

Required execution permission

Starts IM Configuration Management - View

jcfview (Windows only)

Y

--

None

Registers into or deletes from the Windows Start menu the menu item for starting IM Configuration Management - View

jcovcfsetup (Windows only)

Y

--

Superuser#1

Opens JP1/IM - View's Login window or Monitoring Tree (Editing) window, or logs in to JP1/IM - Manager from the command line

jcoview (Windows only)

Y

--

None

Commands related to configuration definition

Overview of function

Command name

Windows

UNIX

Required execution permission

Distributes configuration definition information to the lower hosts and enables the definition information

jbsrt_distrib#2

Y

Y

Superuser#1

Collects configuration definition information from the lower hosts and updates the configuration definition

jbsrt_sync#2

Y

Y

Superuser#1

Deletes the configuration definition information for the host that executed the command

jbsrt_del#2

Y

Y

Superuser#1

Displays the existing configuration definition information

jbsrt_get#2

Y

Y

Superuser#1

Commands related to events

Overview of function

Command name

Windows

UNIX

Required execution permission

Changes the response status for severe events

jcochstat

Y

Y

None#3

Sets up a JP1/IM - Manager system environment

jcoimdef

Y

Y

Superuser#1

Commands related to automated actions and command execution

Overview of function

Command name

Windows

UNIX

Required execution permission

Checks the definitions of automated actions and merges multiple automated action definition files

jcamakea

Y

Y

Superuser#1

Displays the result of automated action execution

jcashowa

Y

Y

None#3

Displays to standard output the status of the Automatic Action Service that is running and the contents of the automated action definition file that is loaded.

jcastatus

Y

Y

None#3

Reloads the automated action definitions, places the automated action function on standby, or enables or disables the automated action definition.

jcachange

Y

Y

Superuser#1

Cancels automated actions

jcacancel

Y

Y

Superuser#1

Sets up a command execution environment

jcocmddef#2

Y

Y

Superuser#1

Outputs logs of executed commands

jcocmdlog#2

Y

Y

None

Deletes commands that were executed from JP1/IM - View or executed by automated actions

jcocmddel#2

Y

Y

Superuser#1

Checks the status of commands that were executed from JP1/IM - View or executed by automated actions

jcocmdshow#2

Y

Y

Superuser#1

Commands related to the email notification function

Overview of function

Command name

Windows

UNIX

Required execution permission

Sends email to the specified email address

jimmail (Windows only)

Y

--

Superuser#1

Sets the password for POP before SMTP authentication or SMTP-AUTH authentication in the email environment definition file

jimmailpasswd (Windows only)

Y

--

Superuser#1

Commands related to correlation event generation

Overview of function

Command name

Windows

UNIX

Required execution permission

Changes correlation event generation definitions

jcoegschange

Y

Y

Superuser#1

Checks the contents of a correlation event generation definition file

jcoegscheck

Y

Y

Superuser#1

Places the correlation event generation function in correlation running status

jcoegsstart

Y

Y

Superuser#1

Displays the status of the correlation event generation function and the correlation event generation definitions that are being used currently

jcoegsstatus

Y

Y

None#3

Places the correlation event generation function in standby status

jcoegsstop

Y

Y

Superuser#1

Commands used in the Central Scope environment setup

Overview of function

Command name

Windows

UNIX

Required execution permission

Registers host information into the host information database

jcshostsimport

Y

Y

Superuser#1

Acquires host information from the host information database

jcshostsexport

Y

Y

Superuser#1

Creates or re-creates the monitoring object database

jcsdbsetup

Y

Y

Superuser#1

Commands related to filters

Overview of function

Command name

Windows

UNIX

Required execution permission

Switches the event acquisition filter

jcochfilter

Y

Y

Superuser#1

Changes the operating mode of the common exclusion-conditions

jcochcefmode

Y

Y

Superuser#1

Commands related to changing the monitoring node status in Central Scope

Overview of function

Command name

Windows

UNIX

Required execution permission

Changes the status of monitoring nodes (monitoring objects or monitoring groups)

jcschstat

Y

Y

Superuser#1

Commands for migrating monitoring object database information in Central Scope

Overview of function

Command name

Windows

UNIX

Required execution permission

Acquires monitoring object database storage information from JP1/IM - Manager and outputs it locally to a file

jcsdbexport

Y

Y

Superuser#1

Applies the information output to a file by the jcsdbexport command to the monitoring object database of JP1/IM - Manager

jcsdbimport

Y

Y

Superuser#1

Commands used for troubleshooting

Overview of function

Command name

Windows

UNIX

Required execution permission

Creates a Java thread dump of IM Configuration Management - View

jcfthreaddmp (Windows only)

Y

--

None

Collects data in the event of a failure in JP1/IM - Manager or JP1/IM - View

jim_log.bat (Windows only)

Y

--

None#3

Collects data in the event of a failure in JP1/IM - Manager

jim_log.sh (UNIX only)

--

Y

Superuser

Collects data in the event of a failure in JP1/IM - View

jcoview_log.bat (Windows only)

Y

--

None#3

Outputs a thread dump in the event of a failure in JP1/IM - View

jcothreaddmp (Windows only)

Y

--

None

Outputs a thread dump and a core dump (UNIX only) in the event of a failure in JP1/IM - Manager

jcogencore

Y

Y

Superuser#1

Tests the notification command that is defined in the health check definition file in JP1/IM - Manager

jcohctest

Y

Y

Superuser#1

Commands for checking the contents of the JP1/IM - Manager definition file

Overview of function

Command name

Windows

UNIX

Required execution permission

Checks the definition file for extended event attributes

jcoattrfcheck

Y

Y

None#3

Checks the definition file for opening monitor windows

jcomonitorfcheck

Y

Y

None#3

Commands for checking the contents of the JP1/IM - View definition file

Overview of function

Command name

Windows

UNIX

Required execution permission

Checks the definition file for executing applications

jcoappexecfcheck (Windows only)

Y

N

None

Checks the definition file for the Tool Launcher window

jcofuncfcheck (Windows only)

Y

N

None

Command that counts the number of nodes managed by JP1/IM - Manager

Overview of function

Command name

Windows

UNIX

Required execution permission

Counts the number of nodes managed by JP1/IM - Manager

jimnodecount

Y

Y

Superuser#1

jcacancel

Function

This command cancels automated actions. It is used to delete from JP1/IM - Manager the following actions that are no longer needed for system operation:

Actions that remain in the queuing state without being executed because many automated actions have been performed during system operation

Actions that remain in the running state because a command that needs time to be processed or processing of which does not end has been executed

The command executed for an action can be deleted by the jcocmddel command, but the status of the action does not change to canceled. Use the jcocmddel command to delete an action that cannot be canceled by using the jcacancel command.

For details about the jcocmddel command, see the chapters related to commands in the JP1/Base User's Guide.

The action status after cancellation depends on the action status before cancellation. The following table lists and describes the action statuses that can be canceled and the action statuses after cancellation.

Table 1‒1: Statuses of actions that can be canceled and the action statuses after cancellation

Status of action that can be canceled

Action status after cancellation#1

Wait or Wait (Miss)

Cancel

Send (Miss)#2

Queue or Queue (Miss)

Running or Running (Miss)

Kill

#1: If an error occurs in JP1/Base command control during cancellation processing, the action status is set to Error (Miss).

#2: An action whose status is Send cannot be canceled. If an attempt is made to cancel such an action, the action status is set to Send (Miss).

Format

jcacancel [-h logical-host-name]
          {[-i action-serial-number,...] | [-a] | [-s action-executing-host-name]}
          [-f]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. The command cancels automated actions that correspond to the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-i action-serial-number

Specifies an automated action that is to be canceled.

You can determine the action serial numbers by using the jcashowa command or by displaying the List of Action Results window and the Action Log Details window in JP1/IM - View. You can specify a maximum of 20 action serial numbers. If you specify multiple action serial numbers, separate them with the comma (,). No other options can be specified between action serial numbers.

If you specify multiple action serial numbers and an error occurs on one action serial number during execution, processing continues. As many error messages are displayed as there are errors.

If you specify multiple action serial numbers in the -i option (in order to cancel multiple actions) and then multiple errors occur, the return value of the jcacancel command is for the last error that occurred.

-a

Specifies that all automated actions that are to be executed from the JP1/IM where jcacancel is executed and that exist on all monitored hosts are to be canceled.

If you specify the -a option to cancel multiple actions and multiple errors occur, the return value of the jcacancel command is for the last error that occurred.

-s action-executing-host-name

Specifies a host name when the automated actions that are to be canceled are the automatic actions executed from the JP1/IM where jcacancel is executed and that exist on the specified action executing host.

You can specify only a host that has been set as a managed host in the system configuration definition. Neither an IP address nor a host group can be specified.

If you specify the -s option to cancel multiple actions and multiple errors occur, the return value of the jcacancel command is for the last error that occurred.

-f

Specifies that the automated actions are to be canceled without displaying a configuration message during cancellation processing.

Notes

Processing if the target host is restarted during cancellation processing

If the target host where automated actions are to be executed is restarted during automated action cancellation processing, the cancellation status of actions cannot be acquired. Therefore, the action status remains as Wait (Canceling), Send (Canceling), Queue (Canceling), or Running (Canceling), making it impossible to determine whether cancellation processing was successful. Use the jcocmdshow command to check the results. If there are any remaining actions, delete them with the jcocmddel command.

Return values

0

Normal termination

1

Invalid argument error

2

Invalid common definition error

3

Invalid action status error

4

Cancellation processing error

5

Input/output error

6

There was no response from the automated action function (Automatic Action Service)

7

Execution permission error (Windows only)

255

System error

Example 1

Cancel multiple automated actions (action serial numbers 23, 35, and 42):

jcacancel -i 23,35,42

Example 2

Cancel all automated actions that are executed from the hostA logical host and that exist on all hosts that are monitored by the hostA logical host:

jcacancel -h hostA -a

Example 3

Cancel the automated actions that are executed from the JP1/IM that executes jcacancel and that exist on the host01 host:

jcacancel -s host01

Example 4

Cancel the automated actions that are executed from the hostB logical host and that exist on host02, which is monitored by the hostB logical host:

jcacancel -h hostB -s host02

Example 5

Cancel the automated actions that are monitored by the hostC logical host and that have specified action serial numbers (23, 35, and 42):

jcacancel -h hostC -i 23,35,42

jcachange

Function

This command reloads the automated action definition file, places the automated action function on standby, or, enables or disables the automated action definition.

If both options are omitted, the command reloads the automated action definition file. After you have changed the contents of the automated action definition file, you use this command to activate the modified action definitions by reloading the file.

This command skips invalid action definitions in the automated action definition file, and continues processing.

If the automated action definition file contains an invalid action definition, the command displays the KAVB5104-W message. If you want to reload the automated action definition file you edited, before executing the jcachange command, execute the jcamakea command to make sure that there are no errors in the automated action definition file.

If the KAVB5104-W message is displayed, review the contents of the automated action definition file.

If the loaded automated action definition file contains no valid action definitions, the command displays the KAVB4053-I message and places the automated action function on standby.

When this command is executed with no option specified, the suppression time and the status of satisfied AND-joined conditions are initialized for all action execution conditions. When this command is executed with the -e, -on, -off, or -st option specified, the suppression time and the status of satisfied AND-joined conditions are not initialized unless the definition of the action execution condition is changed.

A reloaded automated action definition parameter that exceeds the maximum size is ignored by the command. For details about the size of an automated action definition parameter, see Automated action definition file (actdef.conf) in Chapter 2. Definition Files.

Format

jcachange [-n] [-h logical-host-name]
          [-e [action-ID[,action-ID...] | ALL]]
          [-on action-ID[,action-ID...]]
          [-off action-ID[,action-ID...]]
          [-st]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-n

Specifies that the automated action function is to be placed on standby. No actions are executed even if an event that matches an action definition is received.

To restart the automated action function, either execute the jcachange command with no options specified or restart JP1/IM - Manager.

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. The command reloads or places on standby the action definitions for the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-e [action-ID[,action-ID...] | ALL]

Specifies the action ID of an action definition to enable. Other action definitions whose IDs are not specified in this option are disabled. To specify multiple IDs, separate them with a comma (,). To enable all actions, specify ALL.

Executing the command with this option changes every valid parameter in the action definition file. When the action ID is specified, the corresponding valid parameter is changed to true. When the action ID is not specified, it is changed to false. When ALL is specified, all valid parameters are changed to true.

This option is available only when DESC_VERSION of the action definition file is 4.

When the action definition of a specified action ID is not found in the action definition file, the KAVB4028-E message is sent to the standard error output and integrated trace log, and the command ends with a return code of 10. When no action execution condition is defined in the action definition file and ALL is specified for this option, the KAVB4029-E message is sent to the standard error output and integrated trace log, and the command ends with a return code of 10. When no action execution condition is defined in the action definition file and no action ID is specified for this option, the KAVB4029-E message is sent to the standard error output and integrated trace log, and the command ends with a return code of 11.

-on action-ID[,action-ID...]

Specifies the action ID of an action definition to enable. To specify multiple IDs, separate them with a comma (,). The status of other action definitions whose IDs are not specified remains the same. This option cannot be combined with the -e option.

Executing the command with this option changes the valid parameters of the specified action IDs in the action definition file to true.

This option is available only when DESC_VERSION of the action definition file is 4.

When the action definition of a specified action ID is not found in the action definition file, the KAVB4028-E message is sent to the standard error output and integrated trace log, and the command ends with a return code of 10.

-off action-ID[,action-ID...]

Specifies the action ID of an action definition to disable. To specify multiple IDs, separate them with a comma (,). The status of other action definitions whose IDs are not specified remains the same. This option cannot be combined with the -e option.

Executing the command with this option changes the valid parameters of the specified action IDs in the action definition file to false.

This option is available only when DESC_VERSION of the action definition file is 4.

When the action definition of a specified action ID is not found in the action definition file, the KAVB4028-E message is sent to the standard error output and integrated trace log, and the command ends with a return code of 11.

-st

Specifies that executing the command will not initialize the suppression status and the status of satisfied conditions of the AND-joined conditions when the following is true for the action execution condition:

There is no difference between the definition of the action execution condition that works in the Event Base Service and the definition that is specified in the action definition file.

This option is available only when DESC_VERSION of the action definition file is 4. Only the -h option can be combined with this option.

Notes

Executing the jcachange command concurrently many timesmight cause timeouts or a degraded performance of managers.

Return values

0

Normal termination

4

There was no response from the automated action function

5

Command failed to reload the automated action definition file or place the automated action function on standby

10

There is no action definition that is to be enabled

11

There is no action definition that is to be disabled

12

Failed to update due to failure to acquire exclusive rights for the automated action definition file

13

Failed to read due to failure to acquire exclusive rights for the automated action definition file

111

Failed to connect to the Event Base Service or the Event Console Service (in UNIX)

154

File input/output error (in UNIX)

243

A specified argument value was invalid (in UNIX)

-13

A specified argument value was invalid (in Windows)

-102

File input/output error (in Windows)

-401

Failed to connect to the Event Base Service or the Event Console Service (in Windows)

Other value

System error

jcadefconv

Function

This command converts an action definition file from version earlier than 11-50 (DESC_VERSION value is less than 4) to version 11-50 or later (DESC_VERSION value is 4).

If the action definition file for version 8 or earlier uses any of the characters listed below in its messages or in basic event information, detailed event information, or extended event information, the file is converted and defined.

Table 1‒2: Character conversion

Character before conversion

Characters after conversion

\/

/

Space

%20

%

%25

Before it executes this conversion, this command automatically checks the format of the action definition file. If it detects any errors, the action definition file is not converted and the command outputs error messages to standard error.

You can specify any output destination for the converted action definition file.

An action definition file is converted from version 8 or earlier to version 11-50 or later as shown below.

Table 1‒3: Conversion of action definition files

Format of version 8 or earlier

Format of version 11-50 or later

Remarks

No DESC_VERSION

DESC_VERSION=4

--

DESC_VERSION=1

DESC_VERSION=4

--

DESC_VERSION=2

DESC_VERSION=4

--

DESC_VERSION=3

DESC_VERSION=4

--

:state_watch=true

cmn

staΔtrue

end-cmn

--

:state_watch=false

cmn

staΔfalse

end-cmn

--

:state_watch not specified

cmn

staΔfalse

end-cmn

--

#comment-1

+0Δ*Δ:action.exe

actΔaction-1

prmΔ0

cmtΔcomment-1

. . .

end-act

--

#Δcomment-1

+0Δ*Δ:action.exe

actΔaction-1

prmΔ0

cmtcomment-1

. . .

end-act

--

#comment-1

#comment-2

+0Δ*Δ:action.exe

actΔaction-1

prmΔ0

cmtΔcomment-2

. . .

end-act

--

Action specifying a parameter group

actΔaction-serial-number

When the command is executed in an Japanese language environment

actΔaction-serial-number

When the command is executed in an English language environment

AND action

act

--

+parameter-group-number

prmΔparameter-group-number

--

&

prmΔ&

--

$basic-part-of-event-ID

eidΔbasic-part-of-event-ID

--

$basic-part-of-event-ID:extended-part-of-event-ID

eidΔbasic-part-of-event-ID:extended-part-of-event-ID

--

*

eidΔ*

--

/message/

B.MESSAGEΔREGEXΔmessage

--

/basic-event-information/

B.BASICΔREGEXΔbasic-event-information

--

/detailed-event-information/

B.DETAILΔREGEXΔdetailed-event-information

--

//

No condition is set

--

/-------E/

E.SEVERITYΔINΔEmergency

--

/------A-/

E.SEVERITYΔINΔAlert

--

/-----C--/

E.SEVERITYΔINΔCritical

--

/----E---/

E.SEVERITYΔINΔError

--

/---W----/

E.SEVERITYΔINΔWarning

--

/--N-----/

E.SEVERITYΔINΔNotice

--

/-I------/

E.SEVERITYΔINΔInformation

--

/D-------/

E.SEVERITYΔINΔDebug

--

/DINWECAE/

E.SEVERITYΔINΔEmergencyΔAlertΔCriticalΔErrorΔWarningΔNoticeΔInformationΔDebug

When a condition with multiple event levels is specified

extended-event-information-attribute-name=/attribute-value/

E.extended-event-information-attribute-nameΔREGEXΔattribute-value

--

u=user-name

usrΔuser-name

--

e=environment-variable-file-name

varΔenvironment-variable-file-name

--

d=execution-host-name

hstΔexecution-host-name

--

d=group-name

hstΔgroup-name

--

dt=suppression-time

detΔsuppression-time

--

rt=delay-monitoring-period

retΔdelay-monitoring-period

--

+0Δ*Δ:action

cmdΔaction

--

+0Δ*Δ:<RULE>

rule

When JP1/IM - RL is executed

+0Δ*Δ:action.exe

actΔaction-1

prmΔ0

eidΔ*

cnd

end-cnd

cmdΔaction.exe

end-act

When there is no event condition

+0Δ*Δ/message/ : action.exe

actΔaction-1

prmΔ0

eidΔ*

cnd

B.MESSAGEΔREGEXΔmessage

end-cnd

cmdΔaction.exe

end-act

When there is an event condition

--

aidΔ action-ID

An action ID is assigned to an action execution condition from the top of the action definition in the order at which the action execution conditions are listed. The ID increments from 0 to 2,147,483,647. Note that no action ID is assigned to the action execution condition whose parameter group is set to &.

--

validΔtrue

The valid parameter is set to true (enabled). However, this parameter is not changed for the action execution condition whose parameter group is set to &.

Legend:

: Indicates a tab

Δ: Indicates a space

--: None

Format

jcadefconv -i action-definition-file-name-before-conversion
           -o action-definition-file-name-after-conversion
          [-h logical-host-name]

Execution permission

In Windows: Administrator permissions

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-i action-definition-file-name-before-conversion

Specifies the relative or absolute path name of the action definition file that is to be converted. If the path name of the action definition file contains a space, enclose the entire path name in double quotation marks ("). The file name can consist of a maximum of 255 bytes.

-o action-definition-file-name-after-conversion

Specifies the relative or absolute path name of the action definition file that is obtained after conversion. If the path name of the action definition file contains a space, enclose the entire path name in double quotation marks ("). The file name can consist of a maximum of 255 bytes.

Note that the following characters and character strings cannot be specified in a file name in Windows:

Characters: : ? " < > |

A character string that completely matches any of the following strings (not case sensitive): CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9

The user can select any name for action-definition-file-name-after-conversion, except that it cannot be the file name specified in the -i option. Furthermore, if a file that has the same name as the name of the file specified in the -o option, the KAVB5504-E message is displayed and the program terminates.

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. The command checks the contents of the definition file to be converted by using regular expressions used by the specified logical host.

If this option is omitted, the command assumes the logical host name specified in the JP1_HOSTNAME environment variable. If the JP1_HOSTNAME environment variable is not specified, the command assumes the physical host name.

Notes

If you use the -i or -o option to specify the automated action definition used in JP1/IM - Manager, do so after stopping JP1/IM - Manager.

When a file is converted to the format of version 11-50 or later, some items become undefined. If such an undefined item is present, the KAVB5505-W message is displayed. Follow the directions in the message to correct the action definition file, and then use the jcamakea command to check that the definition file has been corrected successfully.

Return values

0

Normal termination

1

Abnormal termination

2

Termination with warning

Example

The following is an example of converting an action definition file that was created in the format of version 8 or earlier to the format of version 11-50 or later:

jcadefconv  -i actdef.conf  -o actdef_new.conf

The example assumes the following contents for the action definition file created in the format of version 8 or earlier:

DESC_VERSION=2
:state_watch=true
#comment
+0 $0000000A /message/,/basic-event-information/,/detailed-event-information/,/-------E/ ATTR1=/attribute-value-1/ : u=user-name e=environment-variable-file-name d=execution-host-name dt=20 rt=30 action

When the jcadefconv command is executed, the file is converted as follows:

DESC_VERSION=4
cmn
  sta true
end-cmn
act action-1
  aid action-ID
  valid true
  prm 0
  cmt comment
  eid A
  cnd
    B.MESSAGE REGEX message
    B.BASIC REGEX basic-event-information
    B.DETAIL REGEX detailed-event-information
    E.SEVERITY IN Emergency
    E.ATTR1 REGEX attribute-value-1
  end-cnd

  usr user-name
  hst execution-host-name
  cmd action
  var environment-variable-file-name
  det 20
  ret 30
end-act

jcamakea

Function

This command checks the definitions of automated actions. If the definitions span multiple automated action definition files, the command merges the files into one file. When multiple automated action definition files are to be merged, the command uses the version of the action definition file and the automated action status monitoring parameter that apply to the first file that is loaded.

The checking and merging results are output to standard output. The command checks the output results and creates the automated action definition file.

If the command detects errors during checking, it outputs error messages to standard error.

An automated action definition parameter in a specified automated action definition file that exceeds the maximum size is not output to standard output. For details about the size of an automated action definition parameter, see Automated action definition file (actdef.conf) in Chapter 2. Definition Files.

If a file contains no definition parameters or contains only comments, an error results.

Format

jcamakea [-h logical-host-name]automated-action-definition-file-name-1 [...automated-action-definition-file-name-100]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host that contains the regular expressions to be used to check the contents of the definition files that are to be converted. The command checks the contents of the definition files to be converted using the regular expressions used by the specified logical host. The command also checks whether any automated action definition file exceeds the maximum file size according to the file size settings in the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

automated-action-definition-file-name-1 [...automated-action-definition-file-name-100]

Specifies the relative or absolute path names of the files containing automated action definitions. You can specify a maximum of 100 files. Separate multiple file names with the space character. If the path name of an automated action definition file contains a space, enclose the entire path name in double quotation marks (").

A file name can consist of a maximum of 255 bytes.

Return values

0

Normal termination

3

Invalid argument

7

Format error or no permission

152

System error (in UNIX)

153

Insufficient memory (in UNIX)

154

File open error (in UNIX)

156

Logical error (in UNIX)

255

File open error (in UNIX)

-1

File open error (in Windows)

-100

Logical error (in Windows)

-102

File input/output error (in Windows)

-103

Insufficient memory (in Windows)

-104

System error (in Windows)

When the command reads an action definition file in the format of version 08-50 or earlier, it sets one of the following return values:

0: Normal termination

Other than 0: Abnormal termination

If multiple errors occur, the return value is for the last error that occurred.

Example

Merge automated action definition files /usr/console/action1 and /usr/console/action2 to create the automated action definition file /usr/console/actionx1:

jcamakea /usr/console/action1 /usr/console/action2 > /usr/console/actionx1

jcashowa

Function

This command displays the results of executing automated actions stored in an action information file. Automated action execution results can be displayed for an event that was registered at a specified date and time, or for all events that were registered during a specified period of time, or for all actions.

Format

jcashowa [-d {[MM/dd/hh:mm][, [MM/dd/hh:mm]]}]
         [-h logical-host-name]
         [action-information-file-name]

Execution permission

In Windows: Administrator permissions (If the Windows UAC feature is enabled, the command must be executed from the administrator console.)

In UNIX: None

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-d {[MM/dd/hh:mm][, [MM/dd/hh:mm]]}

Specifies the time that the events subject to the actions stored in the action information file were registered. Use a comma (,) to separate the beginning date and time from the ending date and time. The command displays information about the actions for events that were registered during the specified period of time. When this option is omitted, the command displays information about all the actions stored in the action information file.

About the date/time specification (MM/dd/hh:mm):

You can use the formats shown in the table below for the date/time specification. Use the format appropriate to your operation.

Table 1‒4: Date/time specification formats

Date/time specification pattern

Description

MM/dd/hh:mm

Specify month in MM, date in dd, hour in hh, and minute in mm.

MM/dd/hh

Specify month in MM, date in dd, and hour in hh.

For the omitted mm, the command assumes 00.

MM/dd

Specify month in MM and date in dd.

For the omitted hh and mm, the command assumes 00 for both.

dd

Specify date in dd.

For the omitted MM, the command assumes the month the jcashowa command was executed. For hh and mm, the command assumes 00 for both.

dd/hh:mm

Specify date in dd, hour in hh, and minute in mm.

For the omitted MM, the command assumes the month the jcashowa command was executed.

hh:mm

Specify hour in hh and minute in mm.

For the omitted MM, the command assumes the month the jcashowa command was executed. For dd, the command assumes the date the jcashowa command was executed.

About the date/time range specification ([MM/dd/hh:mm][, [MM/dd/hh:mm]]):

You can use the formats shown in the table below for the date/time range specification. Use the format appropriate to your operation.

Table 1‒5: Date/time range specification formats

Range specification pattern

Description

-d datetime

By specifying datetime, you can display the result of an action that was executed for an event registered at a specific date and time.

For example, to display the result of an action that was executed for an event registered at 22:00 on October 24, specify as follows:

jcashowa -d 10/24/22:00

-d datetime,datetime

By specifying datetime,datetime, you can display the results of all actions that were executed for the events registered during a specified period (range) of time.

For example, to display the results of the actions that were executed for all events registered from 22:00 on October 24 through 10:00 on November 24, specify as follows:

jcashowa -d 10/24/22:00,11/24/10:00

-d datetime,

By specifying datetime,, you can display the results of all actions that were executed for the events registered on and subsequent to the specified date and time.

For example, to display the results of the actions that were executed for the events registered at 22:00 on October 24 and thereafter, specify as follows:

jcashowa -d 10/24/22:00,

-d ,datetime

By specifying ,datetime, you can display the results of all actions that were executed for the events registered at and before the specified date and time.

For example, to display the results of the actions that were executed for the events registered up to (and including) 10:00 on November 24, specify as follows:

jcashowa -d ,11/24/10:00

About the default year:

If the specified beginning month value is greater than the value for the month during which the jcashowa command is executed, the command assumes the specified date and time belong to the previous year and treats the specification as being from the beginning date and time in the previous year to the ending date and time in the current year.

When the specified beginning month value is greater than the value for the month during which the jcashowa command is executed:

12 (December) ≥ value specified as the beginning month > value for the month during which the jcashowa command is executed

The command assumes that the year for the specified beginning date and time is the year preceding the year during which the jcashowa command is executed.

When the specified beginning month value is less than the value for the month during which the jcashowa command is executed:

Value for the month during which the jcashowa command is executed ≥ value specified as the beginning month ≥ 01 (January)

The command assumes that the year for the specified beginning date and time is the same as the year during which the jcashowa command is executed.

Example 1 (if the jcashowa command is executed on 2003/10/31):

# jcashowa -d 11/01/0:00,10/01/23:59

The command assumes the specified time range is from 2002/11/01 0:00 to 2003/10/01 23:59 and performs processing normally.

Example 2 (if the jcashowa command is executed on 2003/11/01):

# jcashowa -d 11/01/0:00,10/01/23:59

The command assumes the specified time range is from 2003/11/01 0:00 to 2003/10/01 23:59 and displays the message KAVB4009-W because the specified date and time are not in chronological order.

The specification of the -d option determines the chronicity of the specified dates/times. If the specified beginning and ending dates/times are not in chronological order, an error results.

About the seconds specification

For the seconds specification, 00 is assumed as the beginning time and 59 is assumed as the ending time.

Example 1 (if the jcashowa command is executed as follows):

# jcashowa -d 10/24/22:00

The results of actions executed from October 24, 22:00:00 to October 24, 22:00:59 are displayed.

Example 2 (if the jcashowa command is executed as follows):

# jcashowa -d 10/24/22:00,11/24/10:00

The results of actions executed from October 24, 22:00:00 to November 24, 10:00:59 are displayed.

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. The command displays action execution results for the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

action-information-file-name

Specifies the full path of the file to be used for the action information file.

If you specify an action information file at the physical host, do not specify the -h option or the JP1_HOSTNAME environment variable.

If you specify an action information file at the logical host, specify the logical host name in the -h option or the JP1_HOSTNAME environment variable.

The action information file name can consists of a maximum of 255 bytes.

The specified action information file will be used to store information about the executed actions.

This option must be the final option specified in the command. It must be specified after you have specified all other options that need to be specified.

Return values

0

Normal termination

3

Argument error

6

System error

7

No permission to execute the command (Windows)

Output format

When you execute the jcashowa command, automated action information is output in the following format:

Event information#1 event-IDΔserial-numberΔregistered-timeΔevent-arrival-time

Action information#2 action-serial-numberΔaction-typeΔstatusΔdelay-statusΔPIDΔexecution-host-name

Action information action-inserted-timeΔaction-starting-timeΔaction-ending-timeΔreturn-code

Command command

Message message

#1

If an AND condition is specified in the automated action settings, the command outputs only information about the last event received among all the events set in the execution condition.

#2

If no delay monitoring setting is specified for the action or the action is not delayed, the command outputs the following information:

Action information action-serial-numberΔaction-typeΔstatusΔPIDΔexecution-host-name

The following table lists and described each item that is output.

Table 1‒6: Automated action information output items

Item

Description

event-ID

Event ID, in the format basic-code:extended-code.

serial-number

Serial number of the event.

registered-time

Event registration time, in the format month/date hour:minute:second.

event-arrival-time

Event arrival time, in the format month/date hour:minute:second.

action-serial-number

Action serial number of the action that is to be executed.

action-type

One of the following action types:

Command (command)

Rule (rule startup request to JP1/IM - Rule Operation)

status

One of the following character strings indicating the action's execution status:

running (running)

ended (terminated)

none (none)

fail (not executable; error occurred before the execution request was passed to JP1/Base)

error (execution failed; error occurred within JP1/Base command control)

unknown (status unknown; command's execution result could not be determined)

wait (waiting for termination of the preceding command)

send (command is being transmitted)

queue (waiting for command execution in JP1/Base)

cancel (canceled)

kill (forced termination)

deterrent (suppressed)

If the action is canceled from JP1/IM - View or by the jcacancel command, the cancellation status is displayed following the applicable status shown above.

The action cancellation statuses are as follows:

canceling (being canceled). Example: queue (canceling)

miss (cancellation failed). Example: ended (miss)

If the command is re-executed during a restart of the Automatic Action Service or the action is output to the action re-execution file, -R is appended to the above status (example: ended-R).

If the action is re-executed from JP1/IM - View, -RU is appended to the above status (example: ended-RU).

If a suppressed action is re-executed from JP1/IM - View, -RUD is appended to the above status (example: ended-RUD).

If a suppressed action is re-executed from JP1/IM - View and then re-executed again or output to the action re-execution file because the Automatic Action Service was restarted (including node switching) during the re-execution, -RD is appended to the status (example: ended-RD).

If a suppressed action's status is fail (not executable), -D is appended to fail (example: fail-D).

delay-status

Action's delay status.

If the action is delayed, delay is displayed.

If the action is not delayed, nothing is displayed.

PID

Process ID of the execution action.

When action information is entered into the action re-execution file because of node switching, OUTPUT is displayed.

execution-host-name

Name of the host that executed the action.

action-inserted-time

Insertion time of the action to be executed, in the format month/date hour:minute:second.

If the action has not been inserted, **/** **:**:** is displayed.

action-starting-time

Action start time, in the format month/date hour:minute:second.

If the action has not started, **/** **:**:** is displayed.

action-ending-time

Action end time, in the format month/date hour:minute:second.

If the action has not ended, **/** **:**:** is displayed.

return-code

Return code from the executed action.

If the action has not ended, *** is displayed.

command

Command executed as the action.

message

Message displayed by the command.

Example output

Example 1:

The command terminated abnormally and a message has been output:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 23000 Command ended 27934 raysol
Action information: 12/03 12:09:15 12/03 12:09:16
                    12/03 12:09:17 1
Command:            /usr/local/action
Message:            abc was not found.

Example 2:

Execution of the command is underway and no message has been output:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 23000 Command running 27934 raysol
Action information: 12/03 12:09:15 12/03 12:09:16
                    **/** **:**:** ***
Command:           /usr/local/executing

Example 3:

The command status is running, the cancellation status is canceling, and no message has been output:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 10 Command running(canceling) 15236 raysol
Action information: 12/03 12:09:15 12/03 12:09:16
                    **/** **:**:** ***
Command:           /usr/local/action

Example 4:

There are results for multiple actions:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 380 Command ended 233 raysol
Action information: 12/03 12:09:13 12/03 12:09:14
                    12/03 12:09:14 20
Command:            /usr/local/action
Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 381 Command ended 279 raysol
Action information: 12/05 10:39:20 12/05 10:39:21
                    12/05 10:39:23 128
Command:            /usr/local/action2
Message:            No permission
Execute as a superuser
Processing is canceled

Example 5:

There are multiple actions for a single event because a parameter group was specified:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 987 Command running 2904 raysol
Action information: 12/05 10:39:20 12/05 10:39:21
                    12/03 12:09:13 0
Command:            /usr/local/first
Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 988 Command ended 2906 raysol
Action information: 12/05 10:39:20 12/05 10:39:21
                    12/06 21:02:54 0
Command:            /usr/local/second

Example 6:

Action information was entered in the action re-execution file due to node switching:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 45687 Command ended-R OUTPUT
Action information: **/** **:**:** *** **/** **:**:** ***
                    /****:**:** ***

Example 7:

The action being executed is delayed:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 987 Command running delay 2904 raysol
Action information: 12/05 10:39:20 12/05 10:39:21
                    **/** **:**:** ***
Command:            /usr/local/executing

Example 8:

The command was executed with no arguments specified (the JP1/IM - Rule Operation linkage function is enabled):

Event information:  00000111:00000000 628 03/13 16:18:24
                    03/13 16:18:24
Action information: 523 Rule ended 3016 raysol
Action information: 03/13 16:18:24 03/13 16:18:24
                    03/13 16:18:28 0
Command:      jrmexecrule -c raysol -s 628 -t 1142234304
Message:      KAJX4101-I The rule started successfully.
List of start rules:
RuleOperation/rule005
Event information:  00000111:00000000 628 03/13 16:18:24
                    03/13 16:18:24
Action information: 524 Command ended 3156 raysol
Action information: 03/13 16:18:24 03/13 16:18:28  03/13 16:18:28 0
Command:            hostname
Message:            raysol

jcastatus

Function

Using standard output, this command displays the status (stopped, running, standby) of the automated action function that is running, and the contents of the automated action definition file that is loaded by the active automated action function.

Note that you can execute multiple instances of this command concurrently.

Format

jcastatus [-h logical-host-name]
          [-d]

Execution permission

In Windows: Administrator permissions (If the Windows UAC feature is enabled, the command must be executed from the administrator console.)

In UNIX: None

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. The command displays the status of the automated action function (Event Base Service) that corresponds to the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-d (at Event Base Service)

Specifies that the contents of the automated action definition file that is loaded by the automated action function is displayed to standard output. The command displays the information in the same format as in the automated action definition file.

Even when all automated action definitions are disabled, the contents of the automated action definition file that is loaded by the active automated action function are displayed to standard output.

Return values

0

Normal termination

4

No response from the automated action function (Event Base Service)

5

Command cannot display the contents of the automated action definition file because the automated action function (Event Base Service) is stopped or on standby

6

System error (at the command)

152

System error (at Event Base Service) (in UNIX)

154

Input/output error (in UNIX)

243

A specified argument value was invalid (in UNIX)

-13

A specified argument value was invalid (in Windows)

-102

Input/output error (in Windows)

-104

System error (at Event Base Service) (in Windows)

Output format

When you execute the jcastatus command, the status of the automated action function is output in the following format:

Status : status

The following table describes the character strings that can be displayed as status.

Table 1‒7: Statuses of the automated action function

Character string displayed in status

Status

Description

STOP

Stopped

The automated action function (Event Base Service) is stopped.

RUNNING

Running

The automated action function (Event Base Service) is running and available for use.

STANDBY

Standby

The Event Base Service is running, but the automated action function is in the standby mode.

In this status, events are still received, but no action is taken on the received events.

If the status changes from standby to running, action is not taken on the events that were received while in the standby mode.

Example output

The automated action function is in the standby mode:

Status : STANDBY

jcfaleltdef (Windows only)

Function

Defines the profile of a remote monitoring event log trap on the specified monitored host. The definition is overwritten whether the profile on the specified monitored host is running or has stopped.

To perform a batch reload, use the jcfaleltdef command to overwrite multiple running remote monitoring event log traps, and then use the jcfaleltreload command to batch-reload the profiles.

Note that a maximum of five commands can be executed concurrently.

The following conditions must be satisfied to execute this command:

The IM Configuration Management service is running.

There is a remotely monitored host in the remote monitoring configuration.

A remotely monitored host has already collected host information.

Format

jcfaleltdef -f remote-monitoring-event-log-trap-action-definition-file-name
            -o monitored-host-name
            [-filter filter]
            [-h logical-host-name]

Execution permission

Administrator permissions

Storage directory

Manager-path\bin\imcf\

Arguments

-f remote-monitoring-event-log-trap-action-definition-file-name

Specifies the name of an action definition file.

Specify the action definition file name as the full path or a relative path from the current directory with a maximum of 256 bytes. When specifying a relative path, do so in such a way that the full-path name with the directory name will not be more than 256 bytes.

The action definition file can be placed in any directory, and any file name can be specified.

-o monitored-host-name

Specifies the name of the monitored host for a remote monitoring event log trap whose profile you want to define. Note that the OS on the monitored host must be Windows.

-filter filter

Specifies the log type to filter on when the system has been set up to collect only event logs from a remotely monitored host.

When this option is specified, only event logs that match the specified log type are transferred to the manager. Specify this option to control the amount of log file data that is transferred from a remotely monitored host to the manager.

Use a character string in the following table to specify the log type. Note that the character strings are not case sensitive.

Specifiable log type

Log type of event logs to be filtered

Error

Error, Critical

Warning

Warning

Information

Information, Verbose

Audit_success

Security Audit Success

Audit_failure

Security Audit Failure

To specify multiple log types, use a comma (,) as a separator. Do not insert a space before or after the comma.

-h logical-host-name

Specifies the name of the logical host on which you want to execute the command. If this option is omitted, the logical host name specified for the JP1_HOSTNAME environment variable is set. If no logical host name is set for JP1_HOSTNAME, the physical host name is set.

Return values

0

Addition successful

4

Invalid argument

6

Unable to connect to the server

7

Invalid host information

10

Error in obtaining exclusive edit rights

14

Invalid DB

17

Invalid permission

18

Input/output error

21

Upper limit for number of concurrent executions reached

255

Internal error

Other value

Other error

Example 1

Add a profile on host1:

jcfaleltdef -f actionDefinition.conf -o host1

Example 2

Filter to obtain only the error, warning, and failed-audit event logs when a profile has been added on host1:

jcfaleltdef -f actionDefinition.conf -o host1 -filter Error,Warning,Audit_failure

jcfaleltreload (Windows only)

Function

Reloads remote monitoring event log traps. If trap processing is being performed when the command is executed, the traps are reloaded after the trap processing has finished. When a start option has been changed by using the jcfaleltdef command or the Display/Edit Profiles window, the change is not applied by the reload operation. Restart the system to apply the change.

Note that a maximum of five commands can be executed concurrently.

The following conditions must be satisfied to execute this command:

The IM Configuration Management service is running.

There is a remotely monitored host in the remote monitoring configuration.

A remotely monitored host has already collected host information.

DCOM is set.

A remote monitoring event log trap is running.

Format

jcfaleltreload {-o monitored-host-name | ALL}
               [-h logical-host-name]

Execution permission

Administrator permissions

Storage directory

Manager-path\bin\imcf\

Arguments

-o monitored-host-name

Specifies the name of the monitored host for the remote monitoring event log traps you want to reload. The OS on the monitored host must be Windows.

ALL

All remote monitoring event log traps are reloaded.

-h logical-host-name

Specifies the name of the logical host on which you want to execute the command. If this option is omitted, the logical host name specified for the JP1_HOSTNAME environment variable is set. If no logical host name is set for JP1_HOSTNAME, the physical host name is set.

Return values

0

Reloading successful

2

Partial or total failure

4

Invalid argument

6

Unable to connect to the server

7

Invalid host information

10

Error in obtaining exclusive edit rights

11

Invalid action definition file

12

Invalid authentication definition file

13

Communication error

14

Invalid DB

15

The specified remote monitoring event log trap has already stopped

17

Invalid permission

18

Input/output error

21

Upper limit for number of concurrent executions reached

255

Internal error

Other values

Other error

Example

Reload the remote monitoring event log trap on host1:

jcfaleltreload -o host1

jcfaleltstart (Windows only)

Function

Starts a remote monitoring event log trap.

Executing this command collects the event log files on the monitored host specified in the option, converts a line in a log file that satisfies the conditions specified in the action definition file of a remote monitoring event log trap to a JP1 event, and registers the event on an event server.

In order to specify the -f option, the action definition file of a remote monitoring event log trap must be created before the command is executed. Also, if the command is executed with the -f option specified and the profile has stopped, the existing action definition file of the remote monitoring event log trap is overwritten and the process for the trap profile is started. If the profile is running, the existing action definition file of the remote monitoring event log trap is overwritten and saved on the server, and an error message is displayed. At this point, the profile is running with the operation definition that existed before the action definition was overwritten.

Note that a maximum of five commands can be executed concurrently.

The following conditions must be satisfied to execute this command:

The IM Configuration Management service is running

There is a remotely monitored host in the remote monitoring configuration.

A remotely monitored host has already collected host information.

DCOM is set.

Format

jcfaleltstart
        -o monitored-host-name
        [-h logical-host-name]
        [-f remote-monitoring-event-log-trap-action-definition-file-name
        [-filter filter]]

Execution permission

Administrator permissions

Storage directory

Manager-path\bin\imcf\

Arguments

-o monitored-host-name

Specifies the name of the monitored host for the remote monitoring event log traps you want to start. The OS on the monitored host must be Windows.

-h logical-host-name

Specifies the name of the logical host on which you want to execute the command. If this option is omitted, the logical host name specified for the JP1_HOSTNAME environment variable is set. If no logical host name is set for JP1_HOSTNAME, the physical host name is set.

-f remote-monitoring-event-log-trap-action-definition-file-name

Specifies the name of an action definition file. If the -f option is specified, the existing action definition file of a remote monitoring event log trap is overwritten and started. If the -f option is not specified, the existing remote monitoring event log trap is started.

Specify the action definition file name as a full path or a relative path from the current directory with a maximum of 256 bytes. When specifying a relative path, do so in such a way that the full-path name with the directory name will be no more than 256 bytes.

The action definition file can be placed in any directory, and any file name can be specified.

-filter filter

Specifies a filter, when filters have already been set, according to log type to filter event logs acquired on a remotely monitored host. This option can be specified only when the -f option is specified.

When this option is specified, only event logs that match the specified log type are transferred to the manager. Specify this option to control the amount of log file data that is transferred from a remotely monitored host to the manager.

Use a character string in the following table to specify the log type. Note that the character strings are not case sensitive.

Specifiable log type

Log type of event logs to be filtered

Error

Error, Critical

Warning

Warning

Information

Information, Verbose

Audit_success

Security Audit Success

Audit_failure

Security Audit Failure

To specify multiple log types, use a colon (,) as a separator. Do not insert a space before or after the colon.

Return values

0

Trap started successfully

4

Invalid argument

6

Unable to connect to the server

7

Invalid host information

8

Already running

9

Profile threshold value exceeded

10

Error in obtaining exclusive edit rights

11

Invalid action definition file

12

Invalid authentication definition file

13

Communication error

14

Invalid DB

17

Invalid permission

18

Input/output error

21

Upper limit for number of concurrent executions reached

255

Internal error

Other values

Other error

Example 1

Start a remote monitoring event log trap on host1:

jcfaleltstart -o host1 -f actionDefinition.conf

Example 2

Filter to obtain only the error, warning, and failed-audit event logs when a remote monitoring event log trap on host1 is started:

jcfaleltstart -o host1 -f actionDefinition.conf -filter Error,Warning,Audit_failure

jcfaleltstat (Windows only)

Function

Displays the operating status of a remote monitoring event log trap.

When this command is executed, the operating status of a remote monitoring event log trap that monitors the monitored host specified as the argument is returned.

If ALL is specified in the -o option and there is no host in the remote monitoring configuration, or if the OS is not Windows, a message indicating this status appears.

Note that a maximum of five commands can be executed concurrently.

The following conditions must be satisfied to execute this command:

The IM Configuration Management service is running

There is a remotely monitored host in the remote monitoring configuration.

A remotely monitored host has already collected host information.

Format

jcfaleltstat {-o monitored-host-name | ALL}
             [-h logical-host-name]

Execution permission

Administrator permissions

Storage directory

Manager-path\bin\imcf\

Display format

When the jcfaleltstat command is executed, the output result is displayed in the format shown below.

#

In this example, the line number is added at the beginning of each line for descriptive purposes:

1 message-IDΔmessage

2 message-IDΔmessage

3 host-nameΔstatus

4 host-nameΔstatus

5 host-nameΔstatus

6 :

Line 1

A message indicating that command execution has started is displayed.

Line 2

A message indicating the following display scope is displayed:

All

Specified hosts

Specified event log traps on the specified host

Lines 3 to 6

The statuses related the event log traps on the remotely monitored hosts (Windows) for the specified scope are displayed. The following statuses are displayed:

START: The event log trap is running.

STOP: The event log trap has stopped.

EDIT: The action definition file for the event log trap is being edited, but the changes have not been applied.

FAIL: The event log trap status could not be obtained:

- The host is invalid (host information was not collected, or collection failed))

- An error occurred during WMI communication.

- An authentication error occurred

- An input/output error occurred.

- An error occurred during an attempt to obtain exclusive rights.

- An internal error occurred.

Arguments

-o monitored-host-name

Specifies the name of the monitored host for a remote monitoring event log trap whose operating status you want to check. The OS on the monitored host must be Windows.

ALL

Checks the operating status of all remote monitoring event log traps.

-h logical-host-name

Specifies the name of the logical host on which you want to execute the command. If this option is omitted, the logical host name specified for the JP1_HOSTNAME environment variable is set. If no logical host name is set for JP1_HOSTNAME, the physical host name is set.

Return values

0

All remote monitoring event log traps are running

1

Some remote monitoring event log traps are running (when the ALL option is specified)

2

Partial or total failure

4

Invalid argument

6

Unable to connect to the server

7

Invalid host information

14

Invalid DB

17

Invalid permission

18

Input/output error

19

All remote monitoring event log traps have stopped.

21

Upper limit for number of concurrent executions reached

255

Internal error

Other values

Other error

Example

Display the operating status of a remote monitoring event log trap on host1:

jcfaleltstat -o host1

jcfaleltstop (Windows only)

Function

Stops remote monitoring event log traps.

Note that a maximum of five commands can be executed concurrently.

The following conditions must be satisfied to execute this command:

The IM Configuration Management service is running

There is a remotely monitored host in the remote monitoring configuration.

A remotely monitored host has already collected host information.

DCOM is set.

A remote monitoring log file trap is running.

Format

jcfaleltstop {-o monitored-host-name | ALL}
             [-h logical-host-name]

Execution permission

Administrator permissions

Storage directory

Manager-path\bin\imcf\

Arguments

-o monitored-host-name

Specifies the name of the monitored host for the remote monitoring event log traps you want to stop. The OS on the monitored host must be Windows.

ALL

Stops all remote monitoring event log traps.

-h logical-host-name

Specifies the name of the logical host on which you want to execute the command. If this option is omitted, the logical host name specified for the JP1_HOSTNAME environment variable is set. If no logical host name is set for JP1_HOSTNAME, the physical host name is set.

Return values

0

Stopped successfully

2

Partial or total failure

4

Invalid argument

6

Unable to connect to the server

7

Invalid host information

10

Error in obtaining exclusive edit rights

12

Invalid authentication definition file

13

Communication error

14

Invalid DB

15

The specified remote monitoring event log trap has already stopped

17

Invalid permission

18

Input/output error

21

Upper limit for number of concurrent executions reached

255

Internal error

Other values

Other error

Example

Stop all remote monitoring event log traps:

jcfaleltstop ALL

jcfallogdef

Function

Adds or deletes the profile of a remote monitoring log file trap on the specified monitored host. Specifying the -f option adds the profile, and specifying the -d option deletes the profile.

If an added profile has the same monitoring name as an existing profile on the specified monitored host, the action definition file is overwritten whether the profile is running or has stopped.

This command can be executed only when the profile specified for deletion has stopped.

To perform a batch reload, use the jcfallogdef command to overwrite multiple running remote monitoring log file traps, and then use the jcfallogreload command to batch-reload the profiles.

Note that a maximum of five commands can be executed concurrently.

The following conditions must be satisfied to execute this command:

The IM Configuration Management service is running

There is a remotely monitored host in the remote monitoring configuration.

A remotely monitored host has already collected host information.

Format

jcfallogdef
        -a monitoring-name
        -o monitored-host-name
        [-h logical-host-name]
        {-f remote-monitoring-log-file-trap-action-definition-file-name
            -c character-encoding
            [-filter filter]
            [-m maximum-length-of-data-treated-as-event (bytes)]
            [-p log-data-output-source-program-name]
            [-r]
            [-t file-monitoring-interval (seconds)]
            log-file-name1 [...log-file-name32] |
         -d}
        [-q]

Execution permission

In Windows: Administrator permissions

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-a monitoring-name

Specifies the monitoring name used to identify a remote monitoring log file trap.

Specify a character string with a maximum of 30 bytes for the monitoring name. Alphanumeric characters, hyphens (-), and underlines can be used. The first character must be an alphanumeric character. The monitoring name is not case sensitive.

A paired monitoring name and monitored host must be unique, and cannot be the same as another pair specified by jcfallogstart. Note, however, that the same monitoring name as the one specified by jevlogstart of JP1/Base can be used.

-o monitored-host-name

Specifies the name of the monitored host for a remote monitoring log file trap to which you want to add or from which you want to delete a profile.

-h logical-host-name

Specifies the name of the logical host on which you want to execute the command. If this option is omitted, the logical host name specified for the JP1_HOSTNAME environment variable is set. If no logical host name is set for JP1_HOSTNAME, the physical host name is set.

-f remote-monitoring-log-file-trap-action-definition-file-name

Specifies the name of an action definition file.

Specify the action definition file name as a full path or a relative path from the current directory with a maximum of 256 bytes. When specifying a relative path, do so in such a way that the full-path name with the directory name will be no more than 256 bytes.

The action definition file can be placed in any directory, and any file name can be specified.

-c character-encoding

Specifies the character encoding of a log file. This option can be specified only when the -f option is specified.

You can specify the following character encodings.

Table 1‒8: Character codes

OS

Japanese

English

Chinese

AIX

SJIS

When SJIS is specified, SJIS/Ja_JP is set.

SJIS/Ja_JP

SJIS/Ja_JP.IBM-932

EUC

When EUC is specified, EUC/ja_JP is set.

EUC/ja_JP

EUC/ja_JP.IBM-eucJP

UTF-8

When UTF-8 is specified, UTF-8/JA_JP is set.

UTF-8/JA_JP

UTF-8/JA_JP.UTF-8

C

C

GB18030

When GB18030 is specified, GB18030/Zh_CN.GB18030 is set.

GB18030/Zh_CN.GB18030

GB18030/Zh_CN

UTF-8

When UTF-8 is specified, UTF-8/ZH_CN is set.

UTF-8/ZH_CN

UTF-8/ZH_CN.UTF-8

C

HP-UX

SJIS

When SJIS is specified, SJIS/ja_JP.SJIS is set.

SJIS/ja_JP.SJIS

SJIS/japanese

EUC

When EUC is specified, EUC/ja_JP.eucJP is set.

EUC/ja_JP.eucJP

EUC/japanese.euc

UTF-8

When UTF-8 is specified, UTF-8/ja_JP.utf8 is set.

UTF-8/ja_JP.utf8

C

C

GB18030

When GB18030 is specified, GB18030/zh_CN.gb18030 is set.

GB18030/zh_CN.gb18030

UTF-8

When UTF-8 is specified, UTF-8/zh_CN.utf8 is set.

UTF-8/zh_CN.utf8

C

Linux

UTF-8

When UTF-8 is specified, UTF-8/ja_JP.UTF-8 is set.

UTF-8/ja_JP.UTF-8

UTF-8/ja_JP.utf8

SJIS#1

If SJIS is specified, SJIS/ja_JP.sjis is set.

SJIS/ja_JP.sjis#1

SJIS/ja_JP.SJIS#1

C

C

GB18030

When GB18030 is specified, GB18030/zh_CN.gb18030 is set.

GB18030/zh_CN.gb18030

UTF-8

When UTF-8 is specified, UTF-8/zh_CN.utf8 is set.

UTF-8/zh_CN.utf8

C

Solaris

EUC

When EUC is specified, EUC/ja is set.

EUC/ja

EUC/japanese

EUC/ja_JP.eucJP

SJIS

When SJIS is specified, SJIS/ja_JP.PCK is set.

SJIS/ja_JP.PCK

UTF-8

When UTF-8 is specified, UTF-8/ja_JP.UTF-8 is set.

UTF-8/ja_JP.UTF-8

C

C

GB18030

When GB18030 is specified, GB18030/zh_CN.GB18030 is set.

GB18030/zh_CN.GB18030

GB18030/zh_CN.GB18030@pinyin

GB18030/zh_CN.GB18030@radical

GB18030/zh_CN.GB18030@stroke

UTF-8

When UTF-8 is specified, UTF-8/zh.UTF-8 is set.

UTF-8/zh.UTF-8

UTF-8/zh_CN.UTF-8

UTF-8/zh_CN.UTF-8@pinyin

UTF-8/zh_CN.UTF-8@radical

UTF-8/zh_CN.UTF-8@stroke

C

Windows

SJIS

SJIS#2

C

GB18030

#1

Valid only when the monitored OS is SUSE Linux.

#2

If the product runs on an English OS, the character encoding is C even if you specify SJIS for the character encoding.

-filter filter

Specifies a filter, when filters have already been set, that uses regular expressions to filter log files obtained on a remotely monitored host.

When this option is specified, only log data that matches the specified regular expressions is transferred to the manager. Specify this option to control the amount of log file data that is transferred from a remotely monitored host to the manager.

This option can be specified only when the -f option is specified.

This option is valid only when the OS on the remotely monitored host is UNIX. As a prerequisite condition, the grep command must be able to be executed over a SSH connection. When the OS on the remotely monitored host is Windows and this option is specified, it is ignored.

The regular expression formats that can be specified are the same as the formats of the extended regular expressions that can be specified in the -E option for the grep command on the remotely monitored host. No environment variables can be used.

Specify a character string with a maximum of 128 bytes for regular expressions. Characters that can be specified in the string are ', ", <, >, alphanumeric characters (excluding control characters), spaces, and symbols. If the character string contains a space, the entire string must be enclosed in double quotation marks (").

Path examples for the grep command are given below. For details, see the documentation about the grep command in the applicable OS.

For Linux: /bin/grep

For Solaris: /usr/xpg4/bin/grep

For an OS other than Linux and Solaris: /usr/bin/grep

-m maximum-length-of-data-treated-as-event (bytes)

Specifies the number of bytes to be read from the beginning of a line in a log file. From 1 to 1,024 bytes can be specified. If this option is omitted, 512 is set.

The last character in the line is converted to the \0 symbol and indicates the end of the line. If a line in a log file exceeds the number of bytes specified for this option, the last byte is converted to \0.

The value specified for this option indicates the valid length of a line in the entered log file. Therefore, ensure that the regular expressions in the MARKSTR parameter in the action definition file of a remote monitoring log file trap and the regular expressions in the ACTDEF parameter are within the length specified here. In short, if there are any regular expressions corresponding to a column that exceed the valid length, they are not checked.

-p log-data-output-source-program-name

Specifies the name of the program to which log data is output. The specified name is displayed in the Event Console window of JP1/IM - View.

The following names are displayed.

In Windows:

/HITACHI/JP1/NT_LOGTRAP/log-data-output-source-program-name

In UNIX:

/HITACHI/JP1/UX_LOGTRAP/log-data-output-source-program-name

If this option is omitted, /HITACHI/JP1/NT_LOGTRAP is displayed for Windows and /HITACHI/JP1/UX_LOGTRAP is displayed for UNIX.

-r

If this option is omitted and any of the following cases apply, the system tries to collect data at the interval specified in the -t option until the log data can be collected.

The remotely monitored host cannot be accessed when the remote monitoring log file trap starts.

The remotely monitored host cannot be accessed while the remote monitoring log file trap is running

The log file that is to be monitored cannot be accessed when the remote monitoring log file trap starts

The log file that is to be monitored cannot be accessed while the remote monitoring log file trap is running

Specify the -r option for the following cases:

The remotely monitored host can be accessed after the remote monitoring log file trap starts.

The log file that is to be monitored is created after a remote monitoring log file trap starts.

You want to continue monitoring the remotely monitored host even if it cannot be accessed.

If this option is omitted, one or the other of the following occurs:

If the log file that is to be monitored cannot be obtained when the remote monitoring log file trap starts, the startup process stops and processing terminates.

If the log file that is to be monitored cannot be collected while it is running, retry is attempted for the number of times specified in the action definition file for the log file trap at the interval specified in the file.

-t file-monitoring-interval (seconds)

Specifies the file monitoring interval. A value from 60 to 86,400 (seconds) can be specified. If this option is omitted, 300 is set.

When a log file in WRAP2 format is monitored

If wrap-around is performed frequently or a long monitoring interval is specified, the remote monitoring log file trap is overwritten before it reads data, causing some data to be lost. To prevent unread data, use the following formula for the monitoring interval:

log-file-size (bytes) × number-of-log-files > output-size-per-second (bytes) × monitoring-interval (seconds)

log-file-name1 [...log-file-name32]

Specifies the names of the log files to be monitored. Specify a character string with a maximum of 256 bytes for a log file name. If the monitored host OS is Windows, use the network path name without the host name for specification. If the OS is UNIX, use the full-path name. Note that wildcard characters cannot be specified for a log file to be monitored.

For a monitored host running UNIX, only log files with file paths consisting of alphanumeric characters, hyphens (-), underscores (_), periods (.), and slashes (/) can be monitored. File paths that include any other characters might not be monitored correctly.

A maximum of 32 files, and the following file formats, can be specified:

Sequential file (SEQ)

Sequential file (SEQ2)

Wrap around file (WRAP2)

-d

Deletes the profile of a remote monitoring log file trap.

Because specifying this option deletes the remote monitoring log file trap from the profile tree, a message is displayed to confirm that there is no problem.

-q

If this option is specified, no confirmation message is displayed when the -d option is specified. If -d option is not specified, this option is ignored.

Return values

0

Addition or deletion successful

4

Invalid argument

6

Unable to connect to the server

7

Invalid host information

8

The specified monitoring name is already running (when the -d option is specified)

9

Profile threshold value exceeded

10

Error in obtaining exclusive edit rights

14

Invalid DB

17

Invalid permission

18

Input/output error

21

Upper limit for number of concurrent executions reached

255

Internal error

Other values

Other error

Example 1

Add a profile on host1:

jcfallogdef -a name1 -o host1 -f actionDefinition.conf -c SJIS -filter ".*-E" /log/sample.log

Example 2

Delete a profile on host1:

jcfallogdef -a name1 -o host1 -d -q

jcfallogreload

Function

Reloads the action definition file of a remote monitoring log file trap.

The only definition information you can reload is that specified by the MARKSTR and ACTDEF parameter values of the action definition file. If a value other than the MARKST and ACTDEF parameter values is changed by using the jcfallogdef command or the Display/Edit Profiles window, the change is not applied by reloading the definition file. Restart the system to apply the change. Also, if the reload command is executed at the same time trap processing is executed, the information to be reloaded is applied to the trap processing.

Note that a maximum of five commands can be executed concurrently.

The following conditions must be satisfied to execute this command:

The IM Configuration Management service is running

There is a remotely monitored host in the remote monitoring configuration.

A remotely monitored host has already collected host information.

For SSH communication, SSH authentication can be performed by using the applicable remotely monitored host and public key encryption.

For NetBIOS (NetBIOS over TCP/IP) communication, the log file to be monitored is shared.

A remote monitoring log file trap is being started.

Format

jcfallogreload {-o monitored-host-name [-a monitoring-name] | ALL}
               [-h logical-host-name]

Execution permission

In Windows: Administrator permissions

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-o monitored-host-name

Specifies the name of the monitored host for a remote monitoring log file trap you want to reload.

-a monitoring-name

Specifies the monitoring name of a remote monitoring log file trap you want to reload.

Specify a character string with a maximum of 30 bytes for the monitoring name. Alphanumeric characters, hyphens (-), and underlines can be used. The first character must be an alphanumeric character. The monitoring name is not case sensitive.

ALL

Reloads the action definition file of each remote monitoring log file trap.

-h logical-host-name

Specifies the name of the logical host on which you want to execute the command. If this option is omitted, the logical host name specified for the JP1_HOSTNAME environment variable is set. If no logical host name is set for JP1_HOSTNAME, the physical host name is set.

Return values

0

Reloading successful

2

Partial or total failure

4

Invalid argument

6

Unable to connect to the server

7

Invalid host information

10

Error in obtaining exclusive edit rights

11

Invalid action definition file

12

Invalid authentication definition file

13

Communication error

14

Invalid DB

15

The specified remote monitoring log file trap is already ended

17

Invalid permission

18

Input/output error

21

Upper limit for number of concurrent executions reached

255

Internal error

Other values

Other error

Example

Reload the remote monitoring log file trap name1 on host1:

jcfallogreload -o host1 -a name1

jcfallogstart

Function

Starts a remote monitoring log file trap.

Executing this command collects log files on a monitored host, and sets a line in a log file that matches the conditions in the action definition file of the remote monitoring log file trap as a JP1 event. The event is then registered on an event server.

Specifying the -f option adds a new profile for a remote monitoring log file trap, and then starts a process. If a profile with the same monitoring name already exists on the specified monitored host when the profile has stopped, the trap's action definition file is overwritten, and a remote monitoring log file trap process is started. If the profile is running, the action definition file is overwritten and saved on the server, and an error message is displayed before the process stops. At this point, the profile is running with the operation definition that existed before the action definition was overwritten. If the -f option is not specified, the profile process for an existing remote monitoring log file trap is started.

Log files in different data formats cannot be processed together. For such cases, start a separate remote monitoring log file trap for each format.

Note that a maximum of five commands can be executed concurrently.

The following conditions must be satisfied to execute this command:

The IM Configuration Management service is running

There is a remotely monitored host in the remote monitoring configuration.

A remotely monitored host has already collected host information.

For SSH communication, SSH authentication can be performed by using the applicable remotely monitored host and public key encryption.

For NetBIOS (NetBIOS over TCP/IP) communication, the log file to be monitored is shared.

Format

jcfallogstart
        -a monitoring-name
        -o monitored-host-name
        [-h logical-host-name]
        [-f remote-monitoring-log-file-trap-action-definition-file-name
          -c character-encoding
          [-filter filter]
          [-m maximum-length-of-data-treated-as-event (bytes)]
          [-p log-data-output-source-program-name]
          [-r]
          [-t file-monitoring-interval (seconds)]
          log-file-name1[ ...log-file-name32]]

Execution permission

In Windows: Administrator permissions

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-a monitoring-name

Specifies the monitoring name used to identify the remote monitoring log file trap.

Specify a character string with a maximum of 30 bytes for the monitoring name. Alphanumeric characters, hyphens (-), and underlines can be used. The first character must be an alphanumeric character. The monitoring name is not case sensitive.

A paired monitoring name and a monitored host must be unique, and cannot be the same as another pair specified by jcfallogstart. Note, however, that the same monitoring name as the one specified by jevlogstart of JP1/Base can be used.

-o monitored-host-name

Specifies the name of the monitored host for a remote monitoring log file trap you want to start.

-h logical-host-name

Specifies the name of the logical host on which you want to execute the command. If this option is omitted, the logical host name specified for the JP1_HOSTNAME environment variable is set. If no logical host name is set for JP1_HOSTNAME, the physical host name is set.

-f remote-monitoring-log-file-trap-action-definition-file-name

Specifies the name of the action definition file as a full path or a relative path from the current directory with a maximum of 256 bytes. When specifying a relative path, do so in such a way that the full-path name with the directory name will be no more than 256 bytes.

The action definition file can be placed in any directory, and any file name can be specified.

Specifying this option creates a new remote monitoring log file trap and starts it. If this option is omitted, an existing remote monitoring log file trap is started.

-c character-encoding

Specifies the character encoding of a log file. This option can be specified only when the -f option is specified.

The following character encodings can be specified.

Table 1‒9: Character codes

OS

Japanese

English

Chinese

AIX

SJIS

When SJIS is specified, SJIS/Ja_JP is set.

SJIS/Ja_JP

SJIS/Ja_JP.IBM-932

EUC

When EUC is specified, EUC/ja_JP is set.

EUC/ja_JP

EUC/ja_JP.IBM-eucJP

UTF-8

When UTF-8 is specified, UTF-8/JA_JP is set.

UTF-8/JA_JP

UTF-8/JA_JP.UTF-8

C

C

GB18030

When GB18030 is specified, GB18030/Zh_CN.GB18030 is set.

GB18030/Zh_CN.GB18030

GB18030/Zh_CN

UTF-8

When UTF-8 is specified, UTF-8/ZH_CN is set.

UTF-8/ZH_CN

UTF-8/ZH_CN.UTF-8

C

HP-UX

SJIS

When SJIS is specified, SJIS/ja_JP.SJIS is set.

SJIS/ja_JP.SJIS

SJIS/japanese

EUC

When EUC is specified, EUC/ja_JP.eucJP is set.

EUC/ja_JP.eucJP

EUC/japanese.euc

UTF-8

When UTF-8 is specified, UTF-8/ja_JP.utf8 is set.

UTF-8/ja_JP.utf8

C

C

GB18030

When GB18030 is specified, GB18030/zh_CN.gb18030 is set.

GB18030/zh_CN.gb18030

UTF-8

When UTF-8 is specified, UTF-8/zh_CN.utf8 is set.

UTF-8/zh_CN.utf8

C

Linux

SJIS/ja_JP.sjis#1

SJIS/ja_JP.SJIS#1

UTF-8

When UTF-8 is specified, UTF-8/ja_JP.UTF-8 is set.

UTF-8/ja_JP.UTF-8

UTF-8/ja_JP.utf8

C

C

GB18030

When GB18030 is specified, GB18030/zh_CN.gb18030 is set.

GB18030/zh_CN.gb18030

UTF-8

When UTF-8 is specified, UTF-8/zh_CN.utf8 is set.

UTF-8/zh_CN.utf8

C

Solaris

EUC

When EUC is specified, EUC/ja is set.

EUC/ja

EUC/japanese

EUC/ja_JP.eucJP

SJIS

When SJIS is specified, SJIS/ja_JP.PCK is set.

SJIS/ja_JP.PCK

UTF-8

When UTF-8 is specified, UTF-8/ja_JP.UTF-8 is set.

UTF-8/ja_JP.UTF-8

C

C

GB18030

When GB18030 is specified, GB18030/zh_CN.GB18030 is set.

GB18030/zh_CN.GB18030

GB18030/zh_CN.GB18030@pinyin

GB18030/zh_CN.GB18030@radical

GB18030/zh_CN.GB18030@stroke

UTF-8

When UTF-8 is specified, UTF-8/zh.UTF-8 is set.

UTF-8/zh.UTF-8

UTF-8/zh_CN.UTF-8

UTF-8/zh_CN.UTF-8@pinyin

UTF-8/zh_CN.UTF-8@radical

UTF-8/zh_CN.UTF-8@stroke

C

Windows

SJIS

SJIS#2

C

GB18030

#1

Valid only when the monitored OS is SUSE Linux.

#2

If the product runs on an English OS, the character encoding is C even if you specify SJIS for the character encoding.

-filter filter

Specifies a filter, when filters have already been set, that uses regular expressions to filter log files obtained on a remotely monitored host.

When this option is specified, only log data that matches the specified regular expressions is transferred to the manager. Specify this option to control the amount of log file data that is transferred from a remotely monitored host to the manager.

This option can be specified only when the -f option is specified.

This option is valid only when the OS on the remotely monitored host is UNIX. As a prerequisite condition, the grep command must be able to be executed over an SSH connection. When the OS on the remotely monitored host is Windows and this option is specified, it is ignored.

The regular expression formats that can be specified are the same as the formats of the extended regular expressions that can be specified in the -E option for the grep command on the remotely monitored host. No environment variables can be used.

Specify a character string with a maximum of 128 bytes for regular expressions. Characters that can be specified in the string are ', ", <, >, alphanumeric characters (excluding control characters), spaces, and symbols. If the character string contains a space, the entire string must be enclosed in double-quotation marks (").

Path examples for the grep command are given below. For details, see the documentation about the grep command in the applicable OS.

For Linux: /bin/grep

For Solaris: /usr/xpg4/bin/grep

For an OS other than Linux and Solaris: /usr/bin/grep

-m maximum-length-of-data-treated-as-event (bytes)

Specifies the number of bytes to be read from the beginning of a line in a log file. From 1 to 1,024 bytes can be specified. If this option is omitted, 512 is set.

The last character in the line is converted to the \0 symbol and indicates the end of the line. If a line in a log file exceeds the number of bytes specified for this option, the last byte is converted to \0.

The value specified for this option indicates the valid length of a line in the entered log file. Therefore, ensure that the regular expressions in the MARKSTR parameter in the action definition file of a remote monitoring log file trap and the regular expressions in the ACTDEF parameter are within the length specified here. In short, if there are any regular expressions corresponding to a column that exceed the valid length, they are not checked.

-p log-data-output-source-program-name

Specifies the name of the program to which log data is output. The specified name is displayed in the Event Console window of JP1/IM - View.

The following names are displayed.

In Windows:

/HITACHI/JP1/NT_LOGTRAP/log-data-output-source-program-name

In UNIX:

/HITACHI/JP1/UX_LOGTRAP/log-data-output-source-program-name

If this option is omitted, /HITACHI/JP1/NT_LOGTRAP is displayed for Windows and /HITACHI/JP1/UX_LOGTRAP is displayed for UNIX.

-r

If this option is omitted and any of the following cases apply, the system tries to collect data at the interval specified in the -t option until the log data can be collected.

The remotely monitored host cannot be accessed when the remote monitoring log file trap is started

The remotely monitored host cannot be accessed while the remote monitoring log file trap is running

The log file that is to be monitored cannot be accessed when the remote monitoring log file trap is started

The log file that is to be monitored cannot be accessed while the remote monitoring log file trap is running

Specify the -r option for the following cases:

The remotely monitored host can be accessed after the remote monitoring log file trap starts.

The log file that is to be monitored is created after a remote monitoring log file trap starts.

You want to continue monitoring a remotely monitored host even if you cannot access it.

If this option is omitted, one or the other of the following occurs:

If the log file that is to be monitored cannot be obtained when the remote monitoring log file trap starts, the startup process stops and processing terminates.

If the log file that is to be monitored cannot be collected while it is running, retry is attempted for the number of times specified in the action definition file for the log file trap at the interval specified in the file.

-t file-monitoring-interval (seconds)

Specifies the file monitoring interval. A value from 60 to 86,400 (seconds) can be specified. If you omit this option, 300 is set.

When a log file in WRAP2 format is monitored

If wrap-around is performed frequently or a long monitoring interval is specified, the remote monitoring log file trap is overwritten before it reads data, causing some data to be lost. To prevent unread data, use the following formula for the monitoring interval:

log-file-size (bytes) × number-of-log-files > output-size-per-second (bytes) × monitoring-interval (seconds)

log-file-name1 [...log-file-name32]

Specifies the names of the log files to be monitored. Specify a character string with a maximum of 256 bytes for the log file name. If the monitored host OS is Windows, use the network path name without the host name for specification. If the OS is UNIX, use the full-path name. Note that wildcard characters cannot be specified for the log file to be monitored.

For a monitored host running UNIX, only log files with file paths consisting of alphanumeric characters, hyphens (-), underscores (_), periods (.), and slashes (/) can be monitored. File paths that include any other characters might not be monitored correctly.

A maximum of 32 files, and the following file formats, can be specified:

Sequential file (SEQ)

Sequential file (SEQ2)

Wrap around file (WRAP2)

Return values

0

Trap started successfully

4

Invalid argument

6

Unable to connect to the server

7

Invalid host information

8

The specified monitoring name is already running

9

Profile threshold value exceeded

10

Error in obtaining exclusive edit rights

11

Invalid action definition file

12

Invalid authentication definition file

13

Communication error

14

Invalid DB

17

Invalid permissions

18

Input/output error

21

Upper limit for number of concurrent executions reached

255

Internal error

Other values

Other error

Example 1

Start the remote monitoring log file trap monitoringName on host1:

jcfallogstart -a monitoringName -o host1

Example 2

Create a new action definition file for a remote monitoring log file trap and start it:

jcfallogstart -a monitoringName -o host2 -f actionDefinition.conf -c SJIS -filter ".*-E" /log/sample.log

jcfallogstat

Function

Displays the operating status of a remote monitoring log file trap.

Executing this command returns the operating status of a remote monitoring log file trap that has the monitoring name specified as the argument or that monitors the monitored host specified as the argument.

Note that a maximum of five commands can be executed concurrently.

The following conditions must be satisfied to execute this command:

The IM Configuration Management service is running

There is a remotely monitored host in the remote monitoring configuration.

A remotely monitored host has already collected host information.

Format

jcfallogstat {-o monitored-host-name [-a monitoring-name] | ALL}
             [-h logical-host-name]

Execution permission

In Windows: Administrator permissions

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Display format

Executing the jcfallogstat command displays the output result in the format described below. Note that when ALL is specified and there are no hosts in the remote monitoring configuration, or when the specified host does not exist in the remote monitoring configuration, a message to that effect is displayed.

Note:

In this example, a line number is added at the beginning of each line for descriptive purposes:

1 message-IDΔmessage

2 message-IDΔmessage

3 [host-name]

4 monitoring-nameΔstatus

5 monitoring-nameΔstatus

6 monitoring-nameΔstatus

7 [host-name]

8 [host-name]

9 Δstatus

10 :

Line 1

A message indicating that command execution has started is displayed.

Line 2

A message indicating the following display scope is displayed:

All

Specified host

Specified log file traps on the specified host

Lines 3 to 6

The statuses of the log file traps on the remotely monitored host for the specified scope are displayed. The following statuses are displayed:

START: The log file trap is running.

STOP: The log file trap has stopped.

EDIT: The action definition file for the log file trap is being edited, but the changes have not been applied.

FAIL: The log file trap status could not be obtained for one of the following reasons:

- The host is invalid (host information was not collected, or collection failed).

- An error occurred in SSH or WMI/NetBIOS (NetBIOS over TCP/IP) communication.

- An authentication error occurred.

- An input/output error occurred.

- An error occurred during an attempt to obtain exclusive rights.

- An internal error occurred.

Line 7

If no log file traps are defined, only the host name is displayed.

Lines 8 and 9

If an error has occurred on a host but the status could not be obtained, only FAIL is displayed.

Line 10

The statuses of log file traps on all remotely monitored hosts for the specified scope are displayed.

Arguments

-o monitored-host-name

Specifies the name of the monitored host for a remote monitoring log file trap whose operating status you want to check.

-a monitoring-name

Specifies the monitoring name of a remote monitoring log file trap whose operating status you want to check.

Specify a character string with a maximum of 30 bytes for the monitoring name. Alphanumeric characters, hyphens (-), and underlines can be used. The first character must be an alphanumeric character. The monitoring name is not case sensitive.

ALL

Specifies the monitoring names of all log file traps.

-h logical-host-name

Specifies the name of the logical host on which you want to execute the command. If this option is omitted, the logical host name is set. If this option is omitted, the logical host name specified for the JP1_HOSTNAME environment variable is set. If no logical host name is set for JP1_HOSTNAME, the physical host name is set.

Return values

0

All remote monitoring log file traps are running

1

Some remote monitoring log file traps are running (When the ALL option is specified, or only the -o option is specified)

2

Partial or total failure

4

Invalid argument

6

Unable to connect to the server

7

Invalid host information

14

Invalid DB

17

Invalid permission

18

Input/output error

19

All remote monitoring log file traps have stopped

21

Upper limit for number of concurrent executions reached

255

Internal error

Other values

Other error

Example

Display the operating status of the remote monitoring log file trap name1 on host1:

jcfallogstat -o host1 -a name1

jcfallogstop

Function

Stops remote monitoring log file traps.

The following options are provided:

Period of time that traps stop (individually or batched)

Whether stopped remote monitoring log file traps should be deleted

Note that a maximum of five commands can be executed concurrently.

The following conditions must be satisfied to execute this command:

The IM Configuration Management service is running

There is a remotely monitored host in the remote monitoring configuration.

A remotely monitored host has already collected host information.

For SSH communication, SSH authentication can be performed by using the applicable remotely monitored host and public key encryption.

For NetBIOS (NetBIOS over TCP/IP) communication, the log file to be monitored is shared.

A remote monitoring log file trap is running.

Format

jcfallogstop {-o monitored-host-name [-a monitoring-name] | ALL}
             [-d]
             [-h logical-host-name]
             [-q]

Execution permission

In Windows: Administrator permissions

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-o monitored-host-name

Specifies the name of the monitored host for a remote monitoring log file trap you want to stop.

-a monitoring-name

Specifies the monitoring name of a remote monitoring log file trap you want to stop.

Specify a character string with a maximum of 30 bytes for the monitoring name. Alphanumeric characters, hyphens (-), and underlines can be used. The first character must be an alphanumeric character. The monitoring name is not case sensitive.

ALL

Stops all remote monitoring log file traps.

-d

Specifying this option deletes the entry for the remote monitoring log file trap you want to stop from the profile tree.

If this option is used together with the -a, -o, or ALL option, multiple remote monitoring log file traps are removed from the profile tree. In this case, a message is output to confirm that there is no problem. If this option is used together with any other option, it is ignored.

-h logical-host-name

Specifies the name of the logical host on which you want to execute the command. If this option is omitted, the logical host name specified for the JP1_HOSTNAME environment variable is set. If no logical host name is set for JP1_HOSTNAME, the physical host name is set.

-q

If this option is specified, a confirmation message is not displayed when the -d option is specified. If -d option has not been specified, this option is ignored.

Return values

0

Stopping or deletion successful

2

Partial or total failure

4

Invalid argument

6

Unable to connect to the server

7

Invalid host information

10

Error in obtaining exclusive edit rights

12

Invalid authentication definition file

13

Communication error

14

Invalid DB

15

The specified remote monitoring log file trap has already stopped (when the -d option is not specified)

17

Invalid permission

18

Input/output error

21

Upper limit for number of concurrent executions reached

255

Internal error

Other values

Other error

Example 1

Stop the remote monitoring log file trap name1 on host1:

jcfallogstop -o host1 -a name1

Example 2

Stop and then delete all remote monitoring log file traps:

jcfallogstop ALL -d

jcfcolvmesx

Function

This command acquires virtualization configuration information from VMware ESX and outputs it to a virtualization configuration information file.

In order to collect the virtual host name of a guest OS from VMware ESX, VMware Tools must be running on the guest OS. The virtual host name cannot be collected if VMware Tools is not installed or if it is installed but not running.

The virtual host name also cannot be collected if the guest OS itself is not running.

This command uses the interface of VMware Infrastructure SDK for communication.

Format

jcfcolvmesx
          [-m communication-type]
          -u user-ID
          [-p password]
          -c host-name [host-name]
          -o output-file-name

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-m communication-type

Specifies the method used to communicate with VMware ESX.

If https is specified, HTTPS is used for communication with VMware ESX. If http is specified, HTTP is used for communication with VMware ESX.

If this option is omitted, the command uses HTTPS for communication.

-u user-ID

Specifies the user ID associated with the connection-target VMware ESX account.

The user ID must be a maximum of 256 characters. Neither the space nor the tab character can be specified.

-p password

Specifies the password for the user ID that was specified in the -u option.

The password must be a maximum of 256 characters. Neither the space nor the tab character can be specified.

If this option is omitted, the command assumes that there is no password.

-c host-name [host-name]

Specifies the names of hosts where VMware ESX is running. For a host name, specify a maximum of 255 characters. You can specify multiple host names by separating them with the space character or the tab delimiter.

-o output-file-name

Specifies the relative or absolute path name of the virtualization configuration information file that is to store the configuration information collected from VMware ESX. This option is mandatory. If the path contains a space, enclose the entire path in double-quotation marks (").

Return values

0

Normal termination#1

1

Argument error

2

Insufficient memory

3

JavaVM start error occurred

4

Execution permission error (Windows only)

5

Command was not executed from the administrator console (Windows only)

6

Output file already exists

7

Acquisition of virtualization configuration information failed#2

8

An input/output error occurred

99

Other error

#1

The command terminates normally even when some of the virtualization configuration information has not been acquired.

#2

The command outputs a return value if it is unable to acquire virtualization configuration information from any host.

Format of the virtualization configuration information file

Table 1‒10: Header information (line 1)

Item

Output value

Identification character string for a virtualization configuration information file

#VM

File format version

090100

Character encoding

UTF-8 fixed

Table 1‒11: Output items (lines beginning with line 2)

Item

Output value

Host_name

Host_name

VMM_host_name

VMM_host_name

Virtual_manager_type

Virtual_manager_type

Manager_version

Manager_version

Virtual_host_manager

Virtual_host_manager

Table 1‒12: Output items (From line 3)

Item

Description

Host name

Host name

VMM host name

Name of the host where virtualization environment software is run.

In the case of a VMM host with no guest OS, the virtual host name field is blank and only the VMM host name is set.

Virtual_manager_type

Type of product that manages the virtualization configuration:

For VMware ESX: ESX

Manager_version

Version of the product that manages a virtualization configuration

Virtual_host_manager

Name of the host that manages the VMM host

For jcfcolvmesx: a space

Example output

#VM,090100,UTF-8
Host_name,VMM_host_name,Virtual_manager_type,Manager_version,Virtual_host_manager
Vm1,ESX1,,,
Vm2,ESX1,,,
ESX1,,ESX,4.0,

jcfcolvmhcsm

Function

This command acquires virtualization configuration information from HCSM, and outputs it to a virtualization configuration information file.

For details about the prerequisite conditions for executing this command, see 3.3.1(1) Prerequisites for managing a virtualization configuration in the JP1/Integrated Management 2 - Manager Configuration Guide.

Format

jcfcolvmhcsm
          -u user-ID
          -p password
          [-port port-number]
          -c host-name [host-name]
          -o output-file-name

Execution permission

In Windows: Administrators permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-u user-ID

Specifies the user ID of a connection-destination HCSM account. Specify a character string with a maximum of 255 bytes, excluding control characters, for the user ID.

-p password

Specifies the password for the user ID that is specified in the -u option. Specify a character string with a maximum of 255 bytes, excluding control characters, for the password.

-port port-number

Specifies the port number for communicating with the connection destination HCSM. Specify a numeric value with one-byte characters from 1 to 65535. If you omit this option, 23015 is assumed.

-c host-name [host-name]

Specifies the names of hosts where HCSM is running. For a host name, specify a maximum of 255 characters. You can specify multiple host names by separating them with the space character or the tab delimiter.

-o output-file-name

Specifies the relative or absolute path name of the virtualization configuration information file that is to store the configuration information acquired from HCSM. This option is mandatory. If the path contains a space, enclose the entire path in double-quotation marks (").

Return values

0

Normal termination#1

1

Argument error

2

Insufficient memory

3

JavaVM start error occurred

4

Execution permission error

5

Command was not executed from the administrator console

6

Output file already exists

7

Acquisition of virtualization configuration information failed#2

8

An input/output error occurred

99

Other error

#1

The command terminates normally even when some of the virtualization configuration information has not been acquired.

#2

The command outputs a return value if it is unable to acquire virtualization configuration information from any host.

Format of the virtualization configuration information file

Table 1‒13: Header information (line 1)

Item

Output value

Identification character string for a virtualization configuration information file

#VM

File format version

101000

Character encoding

UTF-8 fixed

Table 1‒14: Header information (line 2)

Item

Output value

Host name

Host_name

VMM host name

VMM_host_name

Virtualization management type

Virtual_manager_type

Virtualization management product version

Manager_version

Virtualization configuration management host

Virtual_host_manager

Table 1‒15: Output items (From line 3)

Item

Description

Host name

Host name

VMM host name

Name of the host where virtualization environment software is running.

In the case of a VMM host with no guest OS, the virtual host name field is blank and only the VMM host name is set.

Virtualization management type

Type of the product that manages the virtualization configuration:

For HCSM: HCSM

For Hitachi Compute Blade logical partitioning feature: Virtage

Virtualization management product version

Version of the product that manages a virtualization configuration.

When the virtualization management type is HCSM, the version of the external connection interface for HCSM is set.

Note that if virtualization configuration information is acquired from HCSM, no versions can be acquired on a host whose virtualization management type is Virtage.

Virtualization configuration management host

Name of the host that manages a VMM host

Example output

#VM,101000,UTF-8
Host_name,VMM_host_name,Virtual_manager_type,Manager_version,Virtual_host_manager
WIN-T0NFDNMQ29E,,HCSM,7.2,
10.197.62.41,,Virtage,,WIN-T0NFDNMQ29E
bs20071-1,10.197.62.41,,,
WIN-77MGIUCU8P0,,,,WIN-T0NFDNMQ29E
guest01,,,,WIN-T0NFDNMQ29E

jcfcolvmkvm

Function

This command acquires virtualization configuration information from KVM, and outputs it to a virtualization configuration information file.

For details about the prerequisite conditions for executing this command, see 3.3.1(1) Prerequisites for managing a virtualization configuration in the JP1/Integrated Management 2 - Manager Configuration Guide.

Format

jcfcolvmkvm
          -u user-ID
          -i private-key-file-path
          [-port port-number]
          -c host-name [host-name]
          -o output-file-name

Execution permission

In Windows: Administrators permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-u user-ID

Specifies the user ID of the host where the connection destination KVM is running. Specify a character string with a maximum of 255 bytes, excluding control characters, for the user ID.

-i private-key-file-path

Specifies the name of the private key file that is used to communicate with the connection destination KVM in absolute path format. Specify a character string with a maximum of 256 bytes, excluding control characters, for the private key file. The private key file path is case sensitive. If the path contains a space, enclose the entire path in double-quotation marks (").

-port port-number

Specifies the port number for an SSH connection with the connection destination KVM. Specify a numeric value with one-byte characters from 1 to 65535. If you omit this option, 22 is assumed.

-c host-name [host-name]

Specifies the names of hosts where KVM is running. For a host name, specify a maximum of 255 characters. You can specify multiple host names by separating them with the space character or the tab delimiter.

-o output-file-name

Specifies the relative or absolute path name of the virtualization configuration information file that is to store the configuration information acquired from KVM. This option is mandatory. If the path contains a space, enclose the entire path in double-quotation marks (").

Return values

0

Normal termination#1

1

Argument error

2

Insufficient memory

3

JavaVM start error occurred

4

Execution permission error

5

Command was not executed from the administrator console

6

Output file already exists

7

Acquisition of virtualization configuration information failed#2

8

An input/output error occurred

99

Other error

#1

The command terminates normally even when some of the virtualization configuration information has not been acquired.

#2

The command outputs a return value if it is unable to acquire virtualization configuration information from any host.

Format of the virtualization configuration information file

Table 1‒16: Header information (line 1)

Item

Output value

Identification character string for a virtualization configuration information file

#VM

File format version

101000

Character encoding

UTF-8 fixed

Table 1‒17: Header information (line 2)

Item

Output value

Host name

Host_name

VMM host name

VMM_host_name

Virtualization management type

Virtual_manager_type

Virtualization management product version

Manager_version

Virtualization configuration management host

Virtual_host_manager

Table 1‒18: Output items (From line 3)

Item

Description

Host name

Host name

VMM host name

Name of the host where virtualization environment software is running.

In the case of a VMM host with no guest OS, the virtual host name field is blank and only the VMM host name is set.

Virtualization management type

Type of the product that manages the virtualization configuration:

For KVM, KVM is output.

Virtualization management product version

Version of the product that manages a virtualization configuration.

Virtualization configuration management host

Name of the host that manages a VMM host.

For the jcfcolvmkvm command, this field is always blank.

Example output

#VM,101000,UTF-8
Host_name,VMM_host_name,Virtual_manager_type,Manager_version,Virtual_host_manager
jp1-sf7800b,,KVM,0.12.1,
kv7801,jp1-sf7800b,,,
kv7802,jp1-sf7800b,,,
kv7803,jp1-sf7800b,,,
kv7804,jp1-sf7800b,,,

jcfcolvmscvmm (Windows only)

Function

This command acquires virtualization configuration information from SCVMM and outputs it to a virtualization configuration information file.

For details about the prerequisite conditions for executing this command, see 3.3.1(1) Prerequisites for managing a virtualization configuration in the JP1/Integrated Management 2 - Manager Configuration Guide.

Format

jcfcolvmscvmm
          -c host-name [host-name]
                   [-d domain name -u user-ID[-p password]]
          -o output-file-name

Execution permission

Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

Storage directory

Manager-path\bin\imcf\

Arguments

-c host-name [host-name]

Specifies the names of hosts where SCVMM is running. For a host name, specify a maximum of 255 characters. You can specify multiple host names by separating them with the space character or the tab delimiter.

-d domain name

Specifies the name of the domain to which the connection-target SCVMM host belongs. This option can be omitted if JP1/IM - Manager belongs to the same domain as that of the connection-target SCVMM host. For a domain name, specify a maximum of 255 characters.

-u user-ID

Specifies the user ID of the administrator permission account for the domain to which the connection-target SCVMM host belongs. This option is optional, but if you specify the -d option, you must also specify this option. Specify a character string with a maximum of 255 bytes, excluding control characters, for the user ID.

-p password

Specifies the password for the user ID that is specified in the -u option. If this option is omitted, the command assumes that there is no password. Specify a character string with a maximum of 255 bytes, excluding control characters, for the password.

-o output-file-name

Specifies the name of the virtualization configuration information file that stores the configuration information obtained from vCenter in relative path or absolute path format. If the path contains a space, enclose the entire path in double-quotation marks (").

Return values

0

Normal termination#1

1

Argument error

2

Insufficient memory

3

JavaVM start error occurred

4

Execution permission error

5

Command was not executed from the administrator console

6

Output file already exists

7

Acquisition of virtualization configuration information failed#2

8

An input/output error occurred

99

Other error

#1

The command terminates normally even when some of the virtual configuration information has not been acquired.

#2

The command outputs a return value if it is unable to acquire virtualization configuration information from any host.

Format of the virtualization configuration information file

Table 1‒19: Header information (line 1)

Item

Description of output value

Identification character string for a virtualization configuration information file

#VM

File format version

090100

Character encoding

UTF-8 fixed

Table 1‒20: Header information (line 2)

Item

Description of output value

Host_name

Host_name

VMM_host_name

VMM_host_name

Virtual_manager_type

Virtual_manager_type

Manager_version

Manager_version

Virtual_host_manager

Virtual_host_manager

Table 1‒21: Output items (lines beginning with line 3)

Item

Description

Host_name

Host name

VMM_host_name

Name of the host where virtualization environment software is run.

In the case of a VMM host with no guest OS, the virtual host name field is blank and only the VMM host name is set.

Virtual_manager_type

Type of product that manages the virtualization configuration:

For Hyper-V: Hyper-V

For SCVMM: SCVMM

For vCenter: vCenter

For VMware ESX: ESX

Manager_version

Version of the product that manages a virtualization configuration

Virtual_host_manager

Name of the host that manages a VMM host

Example output

#VM,090100,UTF-8
Host_name,VMM_host_name,Virtual_manager_type,Manager_version,Virtual_host_manager
Vm1,ESX1,,,
Vm2,ESX1,,,
ESX1,,ESX,4.0,vCenter1
vCenter1,, vCenter,2.0,SCVMM1
SCVMM1,,SCVMM,2008,

jcfcolvmvc

Function

Obtains virtualization configuration information from vCenter, and outputs it to a virtualization configuration information file.

For details about the prerequisite conditions for executing this command, see 3.3.1(1) Prerequisites for managing a virtualization configuration in the JP1/Integrated Management 2 - Manager Configuration Guide.

Format

jcfcolvmvc
          [-m communication-type]
          -u user-ID
          [-p password]
          -c host-name [host-name]
          -o output-file-name

Execution permission

In Windows: Administrator permissions (If the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-m communication-type

Specifies the method of communication with vCenter.

When https is specified, https communication is used for communication with vCenter. When http is specified, http communication is used for communication with vCenter.

If this option is omitted, https communication is used.

-u user-ID

Specifies the user ID of a connection-target vCenter account.

Specify a character string with a maximum of 255 bytes, excluding control characters, for the user ID.

-p password

Specifies the password for the user ID that is specified in the -u option.

Specify a character string with a maximum of 255 bytes, excluding control characters, for the password.

If this option is omitted, the command assumes that there is no password.

-c host-name [host-name]

Specifies the names of the hosts where vCenter is running. For a host name, specify a maximum of 255 characters. You can specify multiple host names by separating them with the space character or the tab delimiter.

-o output-file-name

Specifies the name of the virtualization configuration information file that stores the configuration information obtained from vCenter in relative path or absolute path format. If the path contains a space, enclose the entire path in double-quotation marks (").

Return values

0

Normal termination#1

1

Argument error

2

Insufficient memory

3

JavaVM start error occurred

4

Execution permission error

5

The command was not executed from the administrator console

6

Output file already exists

7

Acquisition of virtualization configuration information failed#2

8

Input/output error

99

Other error

#1

The command terminates normally even when some of the virtual configuration information has not been acquired.

#2

The command outputs a return value if it is unable to acquire virtualization configuration information from any host.

Format of the virtualization configuration information file

Table 1‒22: Header information (line 1)

Item

Output value

Identification character string for a virtualization configuration information file

#VM

File format version

090100

Character encoding

UTF-8 fixed

Table 1‒23: Header information (line 2)

Item

Output value

Host name

Host_name

VMM host name

VMM_host_name

Virtualization management type

Virtual_manager_type

Virtualization management product version

Manager_version

Virtualization configuration management host

Virtual_host_manager

Table 1‒24: Output items (From line 3)

Item

Description

Host name

Host name

VMM host name

Name of the host where virtualization environment software runs.

In the case of a VMM host with no guest OS, the virtual host name field is blank and only the VMM host name is set.

Virtualization management type

Type of product that manages the virtualization configuration:

For vCenter: vCenter

For VMware ESX: ESX

Virtualization management product version

Version of the product that manages a virtualization configuration

Virtualization management former host name

Name of the host that manages a VMM host

Example output

#VM,090100,UTF-8
Host_name,VMM_host_name,Virtual_manager_type,Manager_version,Virtual_host_manager
Vm1,ESX1,,,
Vm2,ESX1,,,
ESX1,,ESX,4.0,vCenter1
vCenter1,, vCenter,2.0,

jcfcolvmvirtage

Function

This command acquires virtualization configuration information from Hitachi Compute Blade logical partitioning feature and outputs it to a virtualization configuration information file.

For the prerequisite conditions for executing this command, see 3.3.1(1) Prerequisites for managing a virtualization configuration in the JP1/Integrated Management 2 - Manager Configuration Guide.

Format

jcfcolvmvirtage
          -c host-name [host-name]
          -o output-file-name

Execution permission

In Windows: Administrator permissions (If the Windows UAC feature is enabled, the command is executed from the administrator console.)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-c host-name [host-name]

Specifies the name of the host where JP1/SC/CM that manages Hitachi Compute Blade logical partitioning feature is running. For a host name, specify a maximum of 255 characters. You can specify multiple host names by separating them with the space character or the tab delimiter.

-o output-file-name

Specifies the virtualization configuration information file that stores the configuration information obtained from JP1/SC that manages Hitachi Compute Blade logical partitioning feature in relative path or absolute path format. This option cannot be omitted. If the path contains a space, enclose the entire path in double-quotation marks (").

Return values

0

Normal termination#1

1

Argument error

2

Insufficient memory

3

JavaVM start error occurred

4

Execution permission error

5

The command was not executed from the administrator console

6

Output file already exists

7

Acquisition of virtualization configuration information failed#2

8

Input/output error

99

Other error

#1

The command terminates normally even when some of the virtual configuration information has not been acquired.

#2

The command outputs a return value if it is unable to acquire virtualization configuration information from any host.

Format of the virtualization configuration information file

Table 1‒25: Header information (line 1)

Item

Output value

Identification character string for a virtualization configuration information file

#VM

File format version

090100

Character encoding

UTF-8 fixed

Table 1‒26: Header information (line 2)

Item

Output value

Host name

Host_name

VMM host name

VMM_host_name

Virtualization management type

Virtual_manager_type

Virtualization management product version

Manager_version

Virtualization configuration management host

Virtual_host_manager

Table 1‒27: Output items (From line 3)

Item

Description

Host name

Host name

VMM host name

Name of the host where virtualization environment software runs.

In the case of a VMM host with no guest OS, the virtual host name field is blank and only the VMM host name is set.

Virtualization management type

Type of product that manages the virtualization configuration:

For JP1/SC/CM: JP1/SC/CM

For Hitachi Compute Blade logical partitioning feature: Virtage

Virtualization management product version

Version of the product that manages a virtualization configuration

Virtualization management former host name

Name of the host that manages a VMM host

Example output

#VM,090100,UTF-8
Host_name,VMM_host_name,Virtual_manager_type,Manager_version,Virtual_host_manager
Vm1,VIRTAGE1,,,
Vm2, VIRTAGE1,,,
VIRTAGE1,,Virtage,
SCCM1,VIRTAGE1,JP1/SC/CM,,

jcfdbsetup

Function

This command sets up the IM Configuration Management database for storing configuration information. You must have already specified in advance in the setup information file the database's size, port number, and storage location.

In Windows, if this command is executed in an environment where the integrated monitoring database is not set up, the following services are registered in the OS:

When setting up a physical host: JP1/IM2-Manager DB Server, JP1/IM2-Manager DB Cluster Service

When setting up a cluster configuration: JP1/IM2-Manager DB Server_logical-host-name, JP1/IM2-Manager DB Cluster Service_logical-host-name

In UNIX, if this command is executed in an environment where the integrated monitoring database is not set up, an entry containing the path to the IM database is added to the /etc/inittab file. The entry is added to the respective physical and logical hosts on which the command was executed. Do not delete, edit, or comment out the entry in the /etc/inittab file that is added when this command is executed.

Format

jcfdbsetup {-f setup-information-file-name|-s}
           [-h logical-host-name -c {online|standby}]
           [-q]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imdb\

In UNIX:

/opt/jp1imm/bin/imdb/

Arguments

-f setup-information-file-name

Specifies the setup information file that contains the requisite information, such as the installation folder and the size of the database area. If neither an IM Configuration Management database nor an integrated monitoring database has been set up, you must specify this option. If the integrated monitoring database has already been set up, specify in this option the setup information file that you specified when you set up the integrated monitoring database. Alternatively, if the integrated monitoring database has already been set up, you can specify the -s option instead. In such a case, the command uses the setup information that was specified when the integrated monitoring database was set up.

This option cannot be specified together with the -s option. Additionally, the -f and -s options cannot both be omitted.

If the path contains a space, enclose the entire path in double-quotation marks ("). If you configure a cluster environment, specify the cluster setup information file name.

-s

If the integrated monitoring database has already been set up, you can specify this option instead of the -f option. When this option is specified, the command sets up the IM Configuration Management database using the setup information that was specified when the integrated monitoring database was set up.

If the integrated monitoring database has not been set up but this option is specified, the command displays the KNAN11193-E message.

This option cannot be specified together with the -f option. Additionally, the -s and -f options cannot both be omitted.

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host that executes the command. The command sets up the IM Configuration Management database for the specified logical host. If you do not use a cluster system, specification of this option is not needed. Note that this logical host name cannot be JP1_DEFAULT. In addition, the logical host name is case sensitive. For the logical host name, specify a logical host name set in JP1/Base in the correct form, especially case.

-c {online|standby}

Specifies the setup type in the cluster configuration (primary node or secondary node). If you have specified the -h option, you must specify this option. In addition, if the integrated monitoring database has already been set up on the same host, for the -c option, specify the same value that you used when you created the integrated monitoring database.

online: Specifies that the primary node is to be set up.

standby: Specifies that the secondary node is to be set up.

If you specify online, mount the shared disk and establish a connection to the logical host. If you are running a logical host in a non-cluster environment, specify online in the -c option.

-q

Specifies that the command is to be executed without requesting confirmation from the user.

Return values

0

Normal termination

1

Abnormal termination

Notes

The contents of the cluster setup information files must be identical between the primary and secondary nodes. When you set up the secondary node, copy the cluster setup information file used for the primary node and then use that file. If the contents of the files specified for the primary and secondary nodes are different, cancel the setup at the secondary node, copy the cluster setup information file from the primary node, and then re-execute the command.

If you execute the command with the -c option specified, do not switch servers during execution. If you switch servers during execution, cancel the setup after the command has terminated, and then re-execute the command.

If you have canceled the command's execution by pressing Ctrl + C or Ctrl + Break, make sure that the pdistup, pdfmkfs, pddef, and pdload processes are not executing, execute the jcfdbunsetup command, and then re-execute this command.

If the integrated monitoring database has already been set up and the IM database is being used, JP1/IM - Manager Service must be stopped.

If you are using the integrated monitoring database in Windows, the IM database (JP1/IM2-Manager DB Server) must be running and the cluster service for the IM database (JP1/IM2-Manager DB Cluster Service_logical-host-name) must be stopped.

If you are using JP1/IM - MO, the JP1/IM - Message Optimizer service of JP1/IM - MO on the connection source must be stopped.

Before executing the command, verify that the logical host name specified in the argument matches the JP1/Base logical host name, and that the logical host name can be resolved.

If you cancel setup of the IM database by executing the jcodbunsetup or jcfdbunsetup command, you must restart the OS before re-executing the jcfdbsetup command.

Before executing the command in Windows , in case of existing the Application Experience service, make sure that the startup type of the Application Experience service is not set to Disabled.

jcfdbunsetup

Function

This command cancels setup of the IM Configuration Management database that stores configuration information.

Execute this command when you stop using the IM Configuration Management database, uninstall JP1/IM - Manager, re-create the IM Configuration Management database, or expand the database size.

In an environment in which an integrated monitoring database has been set up, the integrated monitoring database is still available even after execution of this command.

In Windows, if this command is executed in an environment where the integrated monitoring database is not set up, the following services are deleted:

When removing setup of a physical host: JP1/IM-Manager DB Server, JP1/IM-Manager DB Cluster Service

When removing setup of a cluster configuration: JP1/IM-Manager DB Server_logical-host-name, JP1/IM-Manager DB Cluster Service_logical-host-name

In UNIX, if this command is executed in an environment where the integrated monitoring database is not set up, entries in the /etc/inittab file registered by the jcodbsetup or jcfdbsetup command are deleted. The entries that are deleted are only those for processing related to the physical and logical hosts on which the command was executed.

Note that the following files must be deleted after the jcfdbunsetup command has been executed.

In Windows:

For a physical host:

Manager-path\data\imcf\file-under-imconfig

Manager-path\data\imcf\file-and-folder-under-profiles

For a logical host:

shared-folder\data\imcf\file-under-imconfig

shared-folder\data\imcf\file-and-folder-under-profiles

In UNIX:

For a physical host:

/var/opt/jp1imm/data/imcf/file-under-imconfig

/var/opt/jp1imm/data/imcf/file-and-folder-under-profiles

For a logical host:

shared-directory/data/imcf/file-under-imconfig

shared-directory/data/imcf/file-and-directory-under-profiles

Format

jcfdbunsetup [-h logical-host-name -c {online|standby}]
             [-q]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imdb\

In UNIX:

/opt/jp1imm/bin/imdb/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host that executes the command. The command cancels setup of the IM Configuration Management database for the specified logical host. If you do not use a cluster system, specification of this option is not needed. Note that this logical host name cannot be JP1_DEFAULT. In addition, the logical host name is case sensitive. For the logical host name, specify a logical host name set in JP1/Base in the correct form, especially case.

-c {online|standby}

Specifies the type of setup being canceled in the cluster configuration (primary node or secondary node). If you have specified the -h option, you must specify this option.

online: Specify this value if you specified online during setup of the IM Configuration Management database.

standby: Specify this value if you specified standby during setup of the IM Configuration Management database.

If you specify online, mount the shared disk and establish a connection to the logical host. If you cancel setup of the IM Configuration Management database on a logical host that was running in a non-cluster environment, specify online in the -c option.

-q

Specifies that the command is to be executed without requesting confirmation from the user.

Return values

0

Normal termination

1

Abnormal termination

Notes

If you want to expand the database size in an environment where the integrated monitoring database has been created, you must execute the command for performing unsetup of the integrated monitoring database after executing the jcfdbunsetup command.

If you execute this command with the -c option specified, do not switch servers during execution. If you switch servers during execution, re-execute the command after it has terminated.

If you have canceled the command's execution by pressing Ctrl + C or Ctrl + Break, make sure that the pdirst process is not executing, and then re-execute this command.

In Windows, services must be in the following status:

For the physical host:

The cluster service for the IM database (JP1/IM2-Manager DB Cluster Service) must have stopped, and the IM database service (JP1/IM2-Manager DB Server) must have started. In addition, when the integrated monitoring database has been set up and the IM database is being used, the JP1/IM - Manager service (JP1/IM2-Manager) must have stopped.

For the logical host:

The cluster service for the IM database (JP1/IM2-Manager DB Cluster Service_logical-host-name) on the logical host must be stopped, and the IM database service (JP1/IM2-Manager DB Server_logical-host-name) on the logical host must be started. In addition, if the integrated monitoring database has been set up and the IM database is being used, the JP1/IM - Manager service (JP1/IM2-Manager_logical-host-name) must be stopped.

In UNIX, when the IM Configuration Management database has been set up and the IM database is being used, the JP1/IM-Manager service must have stopped.

If you are using JP1/IM - MO, the JP1/IM - Message Optimizer service of JP1/IM - MO on the connection source must be stopped.

Before executing the command in Windows, in case of existing the Application Experience service, make sure that the startup type of the Application Experience service is not set to Disabled.

jcfexport

Function

This command outputs the hierarchy configuration (IM configuration) of the system managed by IM Configuration Management, host information, and definition information.

When you execute this command, the three types of information (host, system hierarchy, and profiles) that have been managed by IM Configuration Management before import processing are all deleted and then the specified information is imported.

To use this command, IM Configuration Management Service must be running. This command cannot be executed while the jcfimport command is executing. A maximum of five commands can be executed concurrently.

Format

jcfexport        [-h logical-host-name]
                 [-f]
                 -o directory-name
                 [-m | -r | -c | -g | -a]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host that executes the command. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-f

Specifies that the file is to be overwritten if the specified directory already contains a file with the same name as the export file. If this option is omitted and the export target already contains a file with the same name, the information is not exported.

-o directory-name

Specifies the name of the directory to which the export data is to be output, expressed as an absolute path or a path relative to the location where the command is executed. This option is mandatory. If the path contains a space, enclose the entire path in double-quotation marks (").

-m

Specifies that only the host information is to be exported. The exported information is output to the host input information file (host_input_data.csv).

This option cannot be specified together with the -r, -c, -g, or -a option. If all of the -m, -r, -c, -g, and -a options are omitted, the -a option is assumed.

-r

Only host information and remote authentication information are exported.

This option cannot be specified together with the -m, -c, -g, or -a option. If specified in such a case, an invalid argument error results. If all of the -m, -r, -c, -g, and -a options are omitted, the -a option is assumed.

-c

Specifies that only the host information and the system hierarchy information is to be exported. The host information is output to the host input information file (host_input_data.csv), and the system hierarchy is output to system_tree_information.txt.

This option cannot be specified together with the -m, -r, -g, or -a option. If specified in such a case, an invalid argument error results. If you omit all of the -m, -c, and -a options, the -a option is assumed. If all of the -m, -r, -c, -g, and -a options are omitted, the -a option is assumed.

-g

Only host information, business group information, and monitoring group information are exported.

This option cannot be specified together with the -m, -r, -c, or -a option. If specified in such a case, an invalid argument error results. If all of the -m, -r, -c, -g, and -a options are omitted, the -a option is assumed.

-a

Specifies that all three types of information are to be exported. The exported information is output to data_information.txt. The host information is output to the host input information file (host_input_data.csv), the system hierarchy is output to system_tree_information.txt, and the definition information is output to the following files directly under directory-specified-in--o-option\definition_files\host-name\product-name:

Forwarding settings file (forward)

The action definition file of a log file trap (an arbitrary file)

Log file trap startup definition file (jevlog_start.conf)

Event log trapping function operation definition file (ntevent.conf)

Location action definition file (jbslcact.conf)

This option cannot be specified together with the -m, -r, -c, or -g option. If specified in such a case, an invalid argument error results. If all of the -m, -r, -c, -g, and -a options are omitted, the -a option is assumed.

Notes

For hosts where no profile configuration file is collected, there is no data to be exported (and no directory is created).

Return values

0

Normal termination

4

Invalid option

8

Server cannot be connected

12

Memory shortage occurred

16

Invalid permission

20

Error, such as a file error, invalid path, or file already exists

21

Upper limit for number of concurrent executions reached

24

An input/output error occurred

120

System error occurred

124

Terminated due to other error

201 or greater

JavaVM start error occurred

Example

Export all IM Configuration Management information to the directory under c:\temp:

jcfexport -o c:\temp

jcfimport

Function

This command imports IM Configuration Management information.

You cannot use this command unless IM Configuration Management Service is running. Note that this command cannot be executed during remote monitoring. In addition, a maximum of five commands can be executed concurrently.

Executing this command deletes three types of information (host, system hierarchy (IM configuration), and profile) that have been managed by IM Configuration Management before import processing. Thereafter, the information specified by options is imported.

To perform remote monitoring after the import, open the System Common Settings window from the IM Configuration Management - View, review the settings, and then click the OK button.

Format

jcfimport  [-h logical-host-name]
            -i directory-name
           [-m | -r | -c | -g | -a]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host that executes the command. If this option is omitted, the command assumes the logical host name specified in the JP1_HOSTNAME environment variable. If the JP1_HOSTNAME environment variable is not specified, the command assumes the physical host name. If you do not use a cluster system, there is no need to specify this option.

-i directory-name

Specifies the name of the directory to which files were exported by the jcfexport command, expressed as an absolute path or a path relative to the location where the jcfimport command is executed. This option is mandatory.

-m

Specifies that only the host information is to be imported. This option cannot be specified together with the -c, -r, -g, or -a option. If specified in such a case, an invalid argument error results. If all of the -m, -r, -c, -g, and -a options are omitted, the -a option is assumed.

-r

Imports only host information and remote authentication information.

This option cannot be specified together with the -m, -c, -g, or -a option. If specified in such a case, an invalid argument error results. If all of the -m, -r, -c, -g, and -a options are omitted, the -a option is assumed.

-c

Specifies that the system hierarchy and host information are to be imported. This option cannot be specified together with the -m or -a option. If specified in such a case, an invalid argument error results. If you omit all of the -m, -c, and -a options, the -a option is assumed.

-g

Imports host information, business group information, and monitoring group information only.

This option cannot be specified together with the -m, -r, -c, or -a option. If specified in such a case, an invalid argument error results. If all of the -m, -r, -c, -g, and -a options are omitted, the -a option is assumed.

-a

Specifies that all information is to be imported. This option cannot be specified together with the -m, -r -c, or -g option. If specified in such a case, an invalid argument error results. If all of the -m, -r, -c, -g, and -a options are omitted, the -a option is assumed.

Return values

0

Normal termination

4

Invalid option

8

Server cannot be connected

12

Memory shortage occurred

16

Invalid permission

20

Error, such as a file error or invalid path

21

Upper limit for number of concurrent executions reached

24

An input/output error occurred

120

System error occurred

124

Terminated due to other error

201 or greater

JavaVM start error occurred

Example

Import all the data of an export file located under the c:\temp:

jcfimport -i c:\temp

jcfmkcsdata

Function

This command creates from the host input information file (host_input_data.csv) and the Central Scope export file a Central Scope import file that contains monitoring tree information for a virtualization configuration. Alternatively, the command creates from the business group information file (monitoring_system_data.csv), the monitoring group information file (monitoring_group_data.csv), and the Central Scope export file a Central Scope import file to which the monitoring tree information of a business group is added.

For details about the business group information file (monitoring_system_data.csv) and the monitoring group information file (monitoring_group_data.csv), see 9.7.1(5) Business group information and 9.7.1(6) Monitoring group information in the JP1/Integrated Management 2 - Manager Administration Guide.

Format

jcfmkcsdata
          { -f host-input-information-file-name Central-Scope's-export-file-name | -g business-group-information-file-name monitoring-group-information-file-name Central-Scope's-export-file-name }
          -o export-file-name
          [-r]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-f host-input-information-file-name Central-Scope's-export-file-name

Specifies the relative or absolute path of the host input information file (host_input_data.csv) exported by the jcfexport command and of the file exported by the jcsdbexport command. This option cannot be specified together with the -g option. If a path contains a space, enclose the entire path in double-quotation marks (").

For the Central Scope's export file, specify the file to which a server-oriented tree has been exported.

For details about the host input information file (host_input_data.csv), see 9.7.1(1) Host information in the JP1/Integrated Management 2 - Manager Administration Guide.

-g business-group-information-file-name monitoring-group-information-file-name Central-Scope's-export-file-name

Specifies the business group information file exported by using the jcfexport command (monitoring_system_data.csv), the monitoring group information file (monitoring_group_data.csv), and the file exported by using the jcsdbexport command, expressed as a relative path or an absolute path. This option cannot be specified together with the -f option. If the path contains a space, enclose the entire path in double-quotation marks (").

For the Central Scope's export file, specify the file to which a server-oriented tree was exported. Note that for the export file, specify a file exported from the monitoring object DB whose data version is 0810 or later.

-o export-file-name

Specifies the relative or absolute path of the Central Scope import file that is to be output by the command. This option is mandatory. If the path contains a space, enclose the entire path in double-quotation marks (").

[-r]

This option sets whether to use the virtualization system configuration tree contained in the JP1/IM - Manager (Central Scope) export file specified by the argument. When this option is specified, the command creates a new file without using the virtualization system configuration tree contained in the JP1/IM - Manager (Central Scope) export file. If this option is not specified, a new virtualization system configuration tree is added to the virtualization system configuration tree contained in the JP1/IM - Manager (Central Scope) export file.

Note

If IM Configuration Management is upgraded from version 09-00 or earlier, perform the following file operations:

Host input information file (host_input_data.csv)

If JP1/IM - Manager (IM Configuration Management) is upgraded from 09-00, the format version of the host input information file (host_input_data.csv) is 0900, and the jcfmkcsdata command cannot be executed. Perform the following procedure to change the format version.

Execute the jcfimport command to import the host input information file into IM Configuration Management.

Execute the jcfexport command to export the host input information file.

The format version of the host input information file is changed to 0901, and the jcfmkcsdata command can be executed.

Return values

0

Normal termination

1

Argument error

2

Specified file is invalid

3

Specified input file was not found

4

Export file already exists

5

No permission to access a specified file

6

Insufficient memory

7

An input/output error occurred

9

Insufficient disk space

10

Execution permission error

11

Forced termination by pressing the Ctrl and C keys

12

The data version of the specified Central Scope export file is old

20

A reserved device was specified for the file path

99

Other error

122

Command was not executed from the administrator console (Windows only)

jcfmkhostsdata

Function

This command uses a virtualization configuration information file to update a host input information file.

Format

jcfmkhostsdata
          -imcf host-input-information-file
          -vm virtualization-configuration-information-file
          -o output-file-name

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-imcf host-input-information-file

Specifies the relative or absolute path name of the host input information file. This option is mandatory. If the path contains a space, enclose the entire path in double-quotation marks (").

-vm virtualization-configuration-information-file

Specifies the relative or absolute path name of the virtualization configuration information file. This option is mandatory. If the path contains a space, enclose the entire path in double-quotation marks (").

-o output-file-name

Specifies the relative or absolute path name of the host input information file to which the result of updating the host input information file is to be output. This option is mandatory. If the path contains a space, enclose the entire path in double-quotation marks (").

Note

If IM Configuration Management is upgraded from version 09-00 or earlier, perform the following file operations:

Host input information file (host_input_data.csv)

If JP1/IM - Manager (IM Configuration Management) is upgraded from 09-00, the format version of the host input information file (host_input_data.csv) is 0900, and the jcfmkhostsdata command cannot be executed. Perform the following procedure to change the format version:.

Execute the jcfimport command to import the host input information file into IM Configuration Management.

Execute the jcfexport command to export the host input information file.

The format version of the host input information file is changed to 0901, and the jcfmkhostsdata command can be executed.

Virtualization configuration information file

Execute the jcfcolvmesx virtualization configuration collection command for IM Configuration Management to output the virtualization configuration information file again. The format version of the virtualization configuration information file becomes 0901.

Return values

0

Normal termination

1

Argument error

2

Insufficient memory

3

JavaVM start error occurred

4

Execution permission error (Windows only)

5

Command was not executed from the administrator console (Windows only)

6

Output file already exists

7

A specified file is invalid

8

A specified input file was not found

9

No permission to access a specified file

10

An input/output error occurred

99

Other error

jcfthreaddmp (Windows only)

Function

This command creates a Java thread dump of IM Configuration Management - View.

Execute this command to collect a Java thread dump under the following circumstances:

Window operation has become disabled.

There are no stopped IM Configuration Management - View processes or IM Configuration Management server processes.

The command outputs a Java thread dump of IM Configuration Management - View to a text file in the log directory:

%ALLUSERSPROFILE%\Hitachi\JP1\JP1_DEFAULT\JP1CoView\log

If you create a thread dump of IM Configuration Management - View while it is running normally, JavaVM will become unstable, in which case you will have to restart IM Configuration Management - View.

Format

jcfthreaddmp process-ID

Execution permission

None (if the Windows UAC feature is enabled, the command is executed from the administrator console)

Storage directory

View-path\bin\

Arguments

process-ID

Specifies the process ID of the java.exe process of IM Configuration Management - View that has become disabled.

The number of binds that can be specified by the process ID depends on OS limitations.

CTRL_BREAK_EVENT is not sent to a process other than IM Configuration Management - View (java.exe).

Return values

0

Normal termination

1

Open error or argument error

2

Process check error

3

Thread dump output request transmission error

4

Execution permission error

10

Other error

Example 1

The process ID of the IM Configuration Management - View that is disabled is 1234:

jcfthreaddmp 1234

Example 2

Identify the process ID of the java.exe process that corresponds to the IM Configuration Management - View:

Use the procedure below to identify the process ID of the java.exe process that corresponds to the disabled IM Configuration Management - View and then specify that process ID in the jcfthreaddmp command.

If you are running multiple instances of IM Configuration Management - View, there are also multiple java.exe processes. In such a case, you use the procedure described below to identify the process ID.

Add a PID (Process Identifier) column.

Open Task Manager's Process page, from the View menu choose Select Columns, and then select the PID (Process Identifier) check box in the Select Columns dialog box.

Check whether the relevant IM Configuration Management - View instance is disabled.

On the Task Manager's Applications page, select IM Configuration Management - View. From the right-click pop-up menu, choose Bring to Front. Check if the IM Configuration Management - View displayed in front is disabled.

Display the PID (process identifier) of the java.exe process that corresponds to the disabled IM Configuration Management - View.

On the Applications page, select the disabled IM Configuration Management - View, and then from the right-click pop-up menu, choose Go To Process.

The Processes page is displayed and the java.exe line of the disabled IM Configuration Management - View is selected. The PID column of that line is the process ID of the java.exe process that corresponds to the disabled IM Configuration Management - View.

jddcreatetree

Function

This command collects system configuration information from products managed by the Intelligent Integrated Management server to create the IM management node-related files, which in turn are input to the jddupdatetree command. Before you can execute this command, you must execute the jddsetaccessuser command to set a user ID and password that are required for authentication.

For details about the jddupdatetree and jddsetaccessuser commands, see jddupdatetree and jddsetaccessuser in Chapter 1. Commands.

This command requests the Intelligent Integrated Management Base to create the IM management node-related files and waits until the request is completed.

Before you can execute this command, you must complete definitions in the following files: system node definition file (imdd_systemnode.conf), category name definition file for IM management nodes (imdd_category_name.conf), and target host definition file for configuration collection (imdd_target_host.conf). Additionally, you must complete the host name definition file (imdd_host_name.conf) for mapping between aliases and real host names if you want IM management nodes to include products that can have aliases for host names.

For details about the IM management node-related files, see the section that describes the IM management node-related files in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

For details about the definition files, see System node definition file (imdd_systemnode.conf), Category name definition file for IM management nodes (imdd_category_name.conf), Target host definition file for configuration collection (imdd_target_host.conf), and Host name definition file (imdd_host_name.conf) in Chapter 2. Definition Files.

Format

jddcreatetree -o directory-name [-h logical-host-name]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imdd\

In UNIX:

/opt/jp1imm/bin/imdd/

Arguments

-o directory-name

Specifies the path of the directory that stores files to be created. The value can be an absolute path or a relative path from the directory where this command is executed. The value must be enclosed in double quotation marks (") if a space is included. The length of the path can be up to 200 characters.

-h logical-host-name

Specifies the logical host name of JP1/IM if JP1/IM is running in a cluster system.

If this option is omitted, the command assumes the logical host name specified in the JP1_HOSTNAME environment variable. If the JP1_HOSTNAME environment variable is not specified, the command assumes the physical host name.

The length of logical-host-name must be equal to or less than 32 bytes to successfully collect the configuration information of the logical host. Otherwise, the jddcreatetree command fails with the message KAJY02015-E and the configuration management tree will not be updated.

Notes

You cannot execute the jddcreatetree command concurrently multiple times. Doing so results in an error.

While the jddupdatetree command is running, you cannot execute the jddcreatetree command . Doing so results in an error.

Before you can execute the jddcreatetree command, JP1/IM - Manager and the IM database must be running.

Do not stop JP1/IM - Manager or the IM database while the jddcreatetree command is running.

If you have defined the base manager or the relay manager, verify if the system hierarchy has been synchronized, and then execute the jddcreatetree command on the integrated manager. When on site manager and relay manager, there is no need to execute the jddcreatetree command.

Execute the jddcreatetree command during a period when no job is running on the JP1/AJS3 - Manager host. Otherwise, each processing might be delayed as both processing loads are required simultaneously.

Execute the jddcreatetree command when the JP1/AJS3 - Manager service is running. If the jddcreatetree command is executed when the JP1/AJS3 - Manager service is stopped or in the process of starting or stopping, the information collection fails.

Do not stop the JP1/AJS3 service from which information is collected when the jddcreatetree command is collecting information. Doing so might delay the stop processing of the service.

The jddcreatetree command cannot collect the unit definition information that includes multi-byte characters other than Japanese. If such information is collected, the configuration management tree might not be displayed correctly.

The information collection might fail if control characters are included in the information that the jddcreatetree command collects, such as unit names, unit definition information, execution agent names, and JP1 resource group names. Do not include control characters in the information to be collected.

Return values

0

Normal termination

1

Normal termination (invalid property)

2

Exclusive locked

3

Invalid argument

4

Invalid logical host name

5

Authentication information used by the Intelligent Integrated Management Base is not set

6

Missing information required for the jddcreatetree command to run

7

No execution permission for the jddcreatetree command

8

The specified directory is not accessible

9

The path to the specified directory is too long

11

Failed to connect to the Intelligent Integrated Management Base

12

The Intelligent Integrated Management Base could not be authenticated

13

A required file does not exist

14

A required file could not be read

15

A required file has an invalid format

16

A required file has an invalid description

17

Information could not be received from the plug-in

18

Invalid information was received from the plug-in

20

The IM management node file could not be created

21

The IM management node link file could not be created

22

The IM management node tree data could not be created

23

The IM management node tree file could not be created

26

The user used for authentication has insufficient permissions

255

System error

Example 1

Specify that created files will be stored in C:\tmp:

$ jddcreatetree -o C:\tmp
KAJY02009-I The command (jddcreatetree) has started.
KAJY02010-I The command (jddcreatetree) terminates normally.

Example 2

Specify that created files will be stored in C:\tmp and specify a logical host named ronri:

$ jddcreatetree -o C:\tmp -h ronri
KAJY02009-I The command (jddcreatetree) has started.
KAJY02010-I The command (jddcreatetree) terminates normally.

jddupdatetree

Function

This command creates tree information and link information of the IM management nodes from the IM management node-related files, which are created by the jddcreatetree command, and the IM management node link definition file (imdd_nodeLink_def.conf), which is created manually by users. Additionally, this command retrieves all JP1 events stored in the integrated monitoring database to evaluate the status of each IM management node. Before executing this command, execute the jddsetaccessuser command to set the user ID and password information required for authentication.

This command requests the Intelligent Integrated Management Base to apply the IM management node-related files and waits until the request is completed.

For details about the jddcreatetree command, see jddcreatetree in Chapter 1. Commands.

Format

jddupdatetree -i directory-name [-h logical-host-name]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imdd\

In UNIX:

/opt/jp1imm/bin/imdd/

Arguments

-i directory-name

Specifies the path of the directory that stores files created by the jddcreatetree command. The value can be an absolute path or a relative path from the directory where this command is executed. The value must be enclosed in double quotation marks (") if a space is included.

-h logical-host-name

Specifies the logical host name of JP1/IM if JP1/IM is running in a cluster system.

If this option is omitted, the command assumes the logical host name specified in the JP1_HOSTNAME environment variable. If the JP1_HOSTNAME environment variable is not specified, the command assumes the physical host name.

Notes

You cannot execute the jddupdatetree command concurrently multiple times. Doing so results in an error.

While the jddupdatetree command is running, you cannot execute the jddcreatetree command. Doing so results in an error.

Before you can execute the jddupdatetree command, JP1/IM - Manager and the IM database must be running.

Do not stop JP1/IM - Manager or the IM database while the jddupdatetree command is running.

Return values

0

Normal termination

1

Normal termination (invalid property)

2

Exclusive locked

3

Invalid argument

4

Invalid logical host name

5

Authentication information used by the Intelligent Integrated Management Base is not set

6

Missing information required for the jddupdatetree command to run

7

No execution permission for the jddupdatetree command

8

The specified directory does not exist

10

IM database service is not running

11

Failed to connect to the Intelligent Integrated Management Base

12

The Intelligent Integrated Management Base could not be authenticated

13

A required file does not exist

14

A required file could not be read

15

A required file hasan invalid format

16

A required file has an invalid description

17

Event information could not be received

19

Information could not be received from the plug-in

21

Master file creation failed

22

Master file alternate failed

26

The user used for authentication has insufficient permissions

255

System error

Example 1

Specify that files created by the jddcreatetree command are stored in C:\tmp:

$ jddupdatetree -i C:\tmp
KAJY02009-I The command (jddupdatetree) has started.
KAJY02010-I The command (jddupdatetree) terminates normally.

Example 2

Specify that files created by the jddcreatetree command are stored in C:\tmp and specify a logical host named ronri:

$ jddupdatetree -i C:\tmp -h ronri
KAJY02009-I The command (jddupdatetree) has started.
KAJY02010-I The command (jddupdatetree) terminates normally.

jddsetaccessuser

Function

This command defines the information required for authentication through which the Intelligent Integrated Management server accesses managed JP1 products or each command of the Intelligent Integrated Management Base is used to access the Intelligent Integrated Management server when the server collects the system configuration information of managed JP1 products as IM management nodes.

You specify the user ID and password information.

Format

jddsetaccessuser -id user-ID -pw password [-h logical-host-name]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imdd\

In UNIX:

/opt/jp1imm/bin/imdd/

Arguments

-id user-ID

Specifies a user ID of user who has administrator permissions for JP1/IM, JP1/PFM, and JP1/AJS.

The user ID must be a character string of 1 to 31 bytes.

Acceptable characters are alphanumeric characters and the following symbols: exclamation mark (!), dollar sign ($), percent sign (%), ampersand (&), underscore (_), hyphen (-), hash mark (#), and at mark (@).

Specified uppercase characters are handled as lowercase.

-pw password

Specifies a password for the user who you specified with the -id option.

The password must be a character string of 6 to 32 bytes.

Acceptable characters are alphanumeric characters and the following symbols: exclamation mark (!), hash mark (#), dollar sign ($), percent sign (%), ampersand (&), underscore (_), hyphen (-), asterisk (*), forward slash (/), single quotation mark ('), caret (^), left square bracket ([), right square bracket (]), left curly bracket ({), right curly bracket (}), left parenthesis ((), right parenthesis ()), semicolon (;), vertical bar (|), equal sign (=), plus sign (+), question mark (?), left angle bracket (<), and right angle bracket (>).

A password is case sensitive. A password must be enclosed in double quotation marks (") if any of the following symbols is included: caret (^), left angle bracket (<), right angle bracket (>), vertical bar (|), and ampersand (&).

-h logical-host-name

Specifies the logical host name if you operate JP1/IM in a cluster system. If this option is omitted, the command assumes the logical host name specified in the JP1_HOSTNAME environment variable. If the JP1_HOSTNAME environment variable is not specified, the command assumes the physical host name.

Return values

0

Normal termination

1

Invalid argument

2

A specified argument value was invalid

3

The file could not be created

4

Invalid logical host name

7

No execution permission for the jddsetaccessuser command

255

System error

Example 1

Specify a password of ABCDEF for the user UserA:

$ jddsetaccessuser -id UserA -pw ABCDEF
KAJY02009-I The command (jddsetaccessuser) has started.
KAJY02010-I The command (jddsetaccessuser) terminates normally.

Example 2

Specify a password of ABCDEF for the user UserA on the logical host ronri:

$ jddsetaccessuser -id UserA -pw ABCDEF -h ronri
KAJY02009-I The command (jddsetaccessuser) has started.
KAJY02010-I The command (jddsetaccessuser) terminates normally.

jddsetproxyuser

Function

This command sets authentication information for the proxy server when REST APIs are executed from plug-ins that are provided by JP1/IM - Manager (Intelligent Integrated Management Base). This setting is not needed if you do not use proxy server authentication.

Format 1

Usage:
jddsetproxyuser {-list|-add -id user-ID -pw password |-rm -id user-ID} [-h logical-host-name]

Format 2

jddsetproxyuser -list [-h logical-host-name]

Format 3

jddsetproxyuser -add -id user-ID -pw password [-h logical-host-name]

Format 4

jddsetproxyuser -rm -id user-ID [-h logical-host-name]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imdd\

In UNIX:

/opt/jp1imm/bin/imdd/

Arguments

-list

Specify this option if you get authentication information for the proxy server configured in the Intelligent Integrated Management Base.

-add

Specify this option if you update the authentication information for the proxy server configured in the Intelligent Integrated Management Base. If this option is specified, the -id option and -pw option must be specified. If they are omitted, an error occurs.

-rm

Specify this option if you remove the authentication information for the proxy server configured in the Intelligent Integrated Management Base. If this option is specified, the -id option must be specified. If it is omitted, an error occurs.

-id user-ID

Specifies the user ID of a user for proxy server authentication.

-pw password

Specifies the password for the user you specified with the -id option.

-h logical-host-name

Specifies the logical host name of JP1/IM if JP1/IM is running in a cluster system.

If this option is omitted, the command assumes the logical host name specified in the JP1_HOSTNAME environment variable. If the JP1_HOSTNAME environment variable is not specified, the command assumes the physical host name.

Notes

You cannot execute the jddsetproxyuser command concurrently multiple times. Doing so results in an error.

Do not stop JP1/IM - Manager or the IM database while the jddsetproxyuser command is running.

You cannot execute the jddsetproxyuser command together with the API for setting proxy authentication information. For details about the API for setting proxy authentication information, see the manual provided separately.

If the jddsetproxyuser command is executed while JP1/IM - Manager is not running, the KAJY52015-W message is output and the setting will take effect next time JP1/IM - Manager is started.

Return values

0

Normal termination

1

Invalid argument

2

Exclusive locked

3

A specified argument value was invalid

4

Invalid logical host name

5

Authentication information used by the Intelligent Integrated Management Base is not set

7

No execution permission for the jddsetproxyuser command

11

Failed to connect to the Intelligent Integrated Management Base

12

The Intelligent Integrated Management Base could not be authenticated

13

Update of proxy authentication information failed

255

System error

Example 1

The following is an example of getting authentication information for the proxy server configured in the Intelligent Integrated Management Base:

jddsetproxyuser -list
KAJY02009-I The command (jddsetproxyuser) has started.
User1
User2
KAJY02010-I The command (jddsetproxyuser) terminates normally.

Example 2

The following is an example of updating authentication information for the proxy server configured in the Intelligent Integrated Management Base:

jddsetproxyuser -add -id User3 -pw PASSWORD
KAJY02009-I The command (jddsetproxyuser) has started.
KAJY02010-I The command (jddsetproxyuser) terminates normally.

jddsetproxyuser -list
KAJY02009-I The command (jddsetproxyuser) has started.
User1
User2
User3
KAJY02010-I The command (jddsetproxyuser) terminates normally.

Example 3

The following is an example of removing authentication information for the proxy server configured in the Intelligent Integrated Management Base:

jddsetproxyuser -rm -id User3
KAJY02009-I The command (jddsetproxyuser) has started.
KAJY02010-I The command (jddsetproxyuser) terminates normally.

jddsetproxyuser -list
KAJY02009-I The command (jddsetproxyuser) has started.
User1
User2
KAJY02010-I The command (jddsetproxyuser) terminates normally.

jcfview (Windows only)

Function

This command starts IM Configuration Management - View. If the -h, -u, and -p options are specified, the command logs in to IM Configuration Management - View automatically without displaying the Login window.

Format

jcfview [-h connection-target-host-name] [-u user-name] [-p password]

Execution permission

None

Storage directory

View-path\bin\

Arguments

-h connection-target-host-name

Specifies the name of the host where the IM Configuration Management to be logged into is running. For the host name, from 1 to 255 bytes of characters are permitted. You can specify only a host where JP1/IM - Manager is running.

For the connection-target host name, you can specify the following:

Host name defined on the host where the command is used

Host name whose address can be resolved on the host where the command is used

IP address

Only addresses in IPv4 address format can be specified as IP address. Addresses in IPv6 address format cannot be specified.

This option is optional. However, if you specify the -p option, you must specify this option.

If you start IM Configuration Management - View by specifying only the -h option or both the -h and the -u options, the Login window is displayed by using these arguments as the default values. If only the -h and -p options are specified to start IM Configuration Management - View, an error results.

-u user-name

Specifies a JP1 user name that has been registered in the authentication server. For the JP1 user name, from 1 to 31 alphanumeric characters are permitted (for alphabetic characters, only lowercase letters are permitted).

This option is optional. However, if you specify the -p option, you must specify this option.

If you start IM Configuration Management - View by specifying only the -u option or both the -h and the -u options, the Login window is displayed by using these arguments as the default values. If only the -u and -p options are specified to start IM Configuration Management - View, an error results.

-p password

Specifies the password for the specified user name. For the password, from 6 to 32 alphanumeric characters are permitted. Alphabetic characters are case sensitive. This option is optional.

If you specify this option, you must also specify the -h and -u options.

Return values

0

Normal termination

1

Argument error

2

Insufficient memory

3

Resource acquisition failed

4

Error message creation failed

5

Forced termination of IM Configuration Management - View

255

System error

Example 1

Start IM Configuration Management - View and display the Login window:

jcfview

Example 2

Enable automatic login without displaying the Login window:

This example specifies the connection-target host (host1), user name (user2), and password (password) to start IM Configuration Management - View:

jcfview -h host1 -u user2 -p password

jcfvirtualchstat

Function

Updates the virtualization configuration of the specified host.

If the virtualization configuration managed by the virtualization environment management software is changed, the change can be applied to IM Configuration Management by executing this command.

Note that a maximum of five commands can be executed concurrently.

Format

jcfvirtualchstat    -c host-name
                    [-h logical-host-name]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imcf\

In UNIX:

/opt/jp1imm/bin/imcf/

Arguments

-c host-name

Specifies the name of the host whose virtualization configuration information is to be collected. For the host name, specify a maximum of 255 characters.

-h logical-host-name

For operation in a cluster system, this option specifies the logical host name. Specify the name of a logical host with a maximum of 255 bytes. If this option is omitted, the logical host name specified for the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

Return values

0

Normal termination

4

Invalid option

8

Unable to connect to the server

12

Insufficient memory

16

Invalid permission

21

Upper limit for number of concurrent executions reached

24

Input/output error

120

System error occurred

124

Termination due to an error not listed here

201 or greater

JavaVM start error occurred

jco_killall.cluster (UNIX only)

Function

When you are operating in a cluster system, this command forcibly terminates the JP1/IM - Manager processes.

Executing the jco_stop.cluster command during cluster operation may not stop all processes, resulting in a cluster operation failure. The jco_killall.cluster command forcibly terminates processes. Use this command only when processes cannot be terminated by the normal method of stopping JP1/IM - Manager Service.

The command can terminate the following processes:

Process management (jco_spmd)

Automatic Action Service (jcamain)

Event Console Service (evtcon)

Event Base Service (evflow)

Event Generation Service (evgen)

Central Scope Service (jcsmain)

IM Configuration Management Service (jcfmain)

IM database service

Format

jco_killall.cluster [logical-host-name]

Execution permission

Superuser permissions

Storage directory

/etc/opt/jp1cons/

Arguments

logical-host-name

Specifies a logical host name set in JP1/Base. You can specify 1 to 32 bytes of characters. If this option is omitted, the command assumes the logical host name specified in the JP1_HOSTNAME environment variable. If the JP1_HOSTNAME environment variable is not specified, the command assumes the physical host name.

Notes

This command checks the first 32 bytes of the logical host name, and then forcibly terminates the corresponding process. The command cannot forcibly terminate a process on a logical host whose name consists of 33 bytes or more.

Return values

0

Normal termination

1

Logical host name is not specified

2

There is no log directory

jco_spmd_reload

Function

This command updates the status of JP1/IM - Manager processes. When you have changed the definition information for JP1/IM - Manager, you must reload the new information to enable it.

The jco_spmd_reload command enables the information in the definition files listed below. For details, see When the definitions are applied for each definition file in Chapter 2. Definition Files.

The following information is located in the automated action environment definition file (action.conf.update):

AND event storage period (EVENTALIVEPERIOD)

Default action executing user (ACTIONEXECUSER)

Automatic action issuance event (SENDABLE_EVENT)

Event-issuing host name acquisition method (HOSTINEVENT)

Automatic action notification definition file (actnotice.conf)

Extended startup process definition file (jp1co_service.conf)

Health check definition file (jcohc.conf)

Event guide information file (jco_guide.txt)

Host information file (jcs_hosts)

Guide information file (jcs_guide_xxx.txt)

Correlation event generation system profile (egs_system.conf)

Correlation event generation environment definition file

Definition file for manually registering incidents (incident.conf)

Configuration file for incident inheritance information (incident_info.conf)

File that defines the event source host mapping (user_hostmap.conf)

Severity changing definition file (jcochsev.conf)

File that defines which items are displayed for severity changing definitions (chsev_attr_list.conf)

File that defines automatic input of severity changing definitions (chsev_auto_list.conf)

File that defines which items are displayed for event conditions (attr_list.conf)

File that defines which items are displayed for repeated event conditions (event_storm_attr_list.conf)

File that defines automatic input of repeated event conditions (event_storm_auto_list.conf)

File that defines which items are displayed for common exclusion-conditions (common_exclude_filter_attr_list.conf)

File that defines automatic input of common exclusion-conditions (common_exclude_filter_auto_list.conf)

Definition file for extended event attributes

Definition file for extended event attributes (extended file)

Definition file for changed display messages (jcochmsg.conf)

File that defines automatic input of display message change definitions (chmsg_auto_list.conf)

File that defines which items are displayed for display message change definitions (chmsg_attr_list.conf)

Definition file for opening monitor windows

Apply-IM-configuration-method definition file (jp1cf_applyconfig.conf)

Format

jco_spmd_reload [-h logical-host-name]
                [-t monitoring-period]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. The permitted length is from 1 to 255 bytes characters. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-t monitoring-period

Specifies in seconds the amount of time to wait for the jco_spmd_reload command to terminate. The permitted value is from 0 to 32,767 (seconds). If the jco_spmd_reload command does not terminate within the specified amount of time, the system assumes that execution of the jco_spmd_reload command has failed. The default is 60 seconds.

Notes

The jco_spmd_reload command cannot be executed together with the jco_spmd_status command.

Return values

0

Normal termination

Other than 0

Abnormal termination

jco_spmd_status

Function

This command displays the startup status of the JP1/IM - Manager processes.

Format

jco_spmd_status [-h logical-host-name]
                [-t monitoring-period]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. The permitted length is from 1 to 255 bytes characters. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-t monitoring-period

Specifies in seconds the amount of time to wait for the jco_spmd_status command to terminate. The permitted value is from 0 to 32,767 (seconds). If the jco_spmd_status command does not terminate within the specified amount time, the system assumes that execution of the jco_spmd_status command has failed. The default is 60 seconds.

Return values

0

All child processes are running

1

Error occurred during communication, such as in process management.

When you are operating in a cluster system, the shared folder (shared directory) is not mounted.

Execution permission error (Windows only).

4

Some child processes are running

8

All stopped

12

Request processing is underway (can be retried)

jco_start (UNIX only)

Function

This command is a script for starting JP1/IM - Manager automatically.

To execute this command, you must have performed the following procedure after you completed installation and setup of JP1/IM - Manager:

# cd /etc/opt/jp1cons

# cp -p jco_start.model jco_start

With these operations, JP1/IM - Manager starts automatically when the system starts. If you do not want JP1/IM - Manager to start automatically at the system startup, do not perform these operations.

You must perform these operations if you set JP1/IM - Manager version 10 or earlier to start automatically.

For details about configuring the automatic startup settings, see 2.17.2 Setting automatic startup and automatic stop (for UNIX) in the JP1/Integrated Management 2 - Manager Configuration Guide.

To start JP1/IM - Manager manually, execute the /etc/opt/jp1cons/jco_start.model script, or a file to which this script has been copied.

If you use a script to which jco_start.model has been copied in JP1/IM - Manager version 10 or earlier, overwrite it with jco_start.model.

Before you execute this command, make sure that JP1/Base is running. JP1/IM - Manager uses the functions of JP1/Base (prerequisite product).If this command is executed when the following conditions are satisfied, the command starts the IM database service and then starts JP1/IM - Manager:

The IM database service has been set up.

The integrated monitoring database is used or IM Configuration Management Service is set to be started.

The command terminates with a return value of 0 after issuing a startup request to the group of JP1/IM - Manager processes. To check whether the group of processes has started successfully, use the jco_spmd_status command after the jco_start command has terminated to display the process IDs of the services that have started. Note that the process ID of the IM database service is not displayed.

Format

jco_start

Execution permission

Superuser permissions

Storage directory

/etc/opt/jp1cons/

Note

If you want to execute this command as a remote shell command, disconnect standard input, standard output, and standard error output (assign /dev/null to standard input, standard output, and standard error output). Note that the remote shell command might not terminate even when processing for starting JP1/IM - Manager has finished.

Execute this command in an environment in which the environment variable JP1_HOSTNAME has not been set. If you execute this command in an environment in which the environment variable JP1_HOSTNAME has been set, the command will attempt to start JP1/IM - Manager on the logical host set in the environment variable JP1_HOSTNAME rather than on the physical host. Because this command does not support logical hosts, you must delete the environment variable JP1_HOSTNAME if you want to start JP1/IM - Manager on the physical host.

The jco_start command cannot be executed together with the jco_spmd_status command.

Return values

0

Normal termination

1

More than one argument is specified, the event service is not running, or the IM database service cannot be started

2

There is no log directory

Example 1

When the integrated monitoring database is used:

Input value:

jco_start

Result:

Please wait a minutes, now starting the IM database service...
KNAN11188-I The status of the IM database service will now be confirmed.
KNAN11183-I The IM database service is stopped.
KNAN11189-I The status of the IM database service was successfully confirmed.
Please wait a minutes, now starting JP1/IM - Manager...
KAVB3690-I Processing to report the status of JP1_CONS has started.
Display the running processes
process name  process ID
      evflow      18990
     jcamain      19036
      evtcon      19037
KAVB3691-I All the processes have started.

Example 2

When the integrated monitoring database is not used and IM Configuration Management Service has not started:

Input value:

jco_start

Result:

Please wait a minutes, now starting JP1/IM - Manager...
KAVB3690-I Processing to report the status of JP1_CONS has started.
Display the running processes
process name  process ID
       evflow      19237
      jcamain      19277
       evtcon      19278
KAVB3691-I All the processes have started.

Example 3

When the IM database is not used:

Input value:

jco_start

Result:

Please wait a minutes, now starting the IM database service...
KNAN11188-I The status of the IM database service will now be confirmed.
KNAN11109-E The IM database service is not set up.
Unable start JP1/IM - Manager.

jco_start.cluster (UNIX only)

Function

When you are operating in a cluster system, this command starts JP1/IM - Manager on the logical host.

If you register this command into the cluster software, JP1/IM - Manager starts.

Before you execute this command, start JP1/Base on the same logical host. An error results if this command is executed while the event service of JP1/Base is not running.

The command terminates with a return value of 0 after issuing a startup request to the group of JP1/IM - Manager processes. To check whether the group of processes has started successfully, use the jco_spmd_status command after the jco_start.cluster command has terminated.

If this command is executed when the following condition is satisfied, the command starts the IM database service and then starts JP1/IM - Manager:

The integrated monitoring database on the logical host is used or IM Configuration Management Service is set to be started.

To execute this command, you must have executed jp1cc_setup_cluster and jp1cs_setup_cluster after installing and setting up JP1/IM - Manager. For the IM database service, you must set up the cluster system for the IM database service. For details about setting up a cluster system, see Chapter 8. Operation and Environment Configuration in a Cluster System (for UNIX) in the JP1/Integrated Management 2 - Manager Configuration Guide.

Format

jco_start.cluster [logical-host-name]

Execution permission

Superuser permissions

Storage directory

/etc/opt/jp1cons/

Arguments

logical-host-name

When you are operating in a cluster system, this option specifies the name of the logical host where this command is to be executed. The permitted length is from 1 to 63 bytes characters. If this option is omitted, the command assumes the logical host name specified in the JP1_HOSTNAME environment variable. If the JP1_HOSTNAME environment variable is not specified, the command assumes the physical host name.

Note

If you want to execute this command as a remote shell command, disconnect standard input, standard output, and standard error output (assign /dev/null to standard input, standard output, and standard error output). Note that the remote shell command might not terminate even when processing for starting JP1/IM - Manager has finished.

The jco_start_cluster command cannot be executed together with the jco_spmd_status command.

Return values

0

Normal termination

1

More than one argument is specified, the event service is not running, or the IM database service cannot be started

2

There is no log directory

jco_stop (UNIX only)

Function

This command is a script for terminating JP1/IM - Manager automatically.

# cd /etc/opt/jp1cons

# cp -p jco_stop.model jco_stop

Once the foregoing procedure has been executed, JP1/IM - Manager terminates automatically when the system terminates. If the IM database service is running, the IM database service is stopped automatically after JP1/IM - Manager has terminated.

If JP1/IM - Manager does not terminate, the command outputs the KAVB8800-E message to standard output.

If the IM database service does not terminate, the command outputs the KAVB8801-E message to standard output.

To stop JP1/IM - Manager manually, execute the /etc/opt/jp1cons/jco_stop.model script, or a file to which the script has been copied.

Format

jco_stop

Execution permission

Superuser permissions

Storage directory

/etc/opt/jp1cons/

Note

Execute this command in an environment in which the environment variable JP1_HOSTNAME has not been set. If you execute this command in an environment in which the environment variable JP1_HOSTNAME has been set, the command will attempt to stop JP1/IM - Manager on the logical host that is set in the environment variable JP1_HOSTNAME rather than on the physical host. Because this command does not support logical hosts, you must delete the environment variable JP1_HOSTNAME if you want to stop JP1/IM - Manager on the physical host.

The jco_stop command cannot be executed together with the jco_spmd_status command.

Return values

0

Normal termination

1

More than one argument is specified or the termination request resulted in a timeout

Example 1

JP1/IM - Manager and the IM database service are running:

Input value:

jco_stop

Result:

KAVB3674-I Termination processing of JP1_CONS has started.
KAVB3675-I The stop command terminated normally.
KNAN11185-I Processing to stop the IM database service will now start.
KNAN11028-I Please wait.
KNAN11187-I The IM database service stopped normally.
KNAN11186-I Processing to stop the IM database service ended normally.
KNAN11188-I The status of the IM database service will now be confirmed.
KNAN11183-I The IM database service is stopped.
KNAN11189-I The status of the IM database service was successfully confirmed.

Example 2

JP1/IM - Manager is running and the IM database service is not running:

Input value:

jco_stop

Result:

KAVB3674-I Termination processing of JP1_CONS has started.
KAVB3675-I The stop command terminated normally.
KNAN11188-I The status of the IM database service will now be confirmed.
KNAN11183-I The IM database service is stopped.
KNAN11189-I The status of the IM database service was successfully confirmed.

Example 3

Neither JP1/IM - Manager nor the IM database service is running:

Input value:

jco_stop

Result:

KAVB3674-I Termination processing of JP1_CONS has started.
KAVB3662-I The process management is not running.
KNAN11188-I The status of the IM database service will now be confirmed.
KNAN11183-I The IM database service is stopped.
KNAN11189-I The status of the IM database service was successfully confirmed.

Example 4

JP1/IM - Manager is not running and the IM database service is running:

Input value:

jco_stop

Result:

KAVB3674-I Termination processing of JP1_CONS has started.
KAVB3662-I The process management is not running.
KNAN11185-I Processing to stop the IM database service will now start.
KNAN11028-I Please wait.
KNAN11187-I The IM database service stopped normally.
KNAN11186-I Processing to stop the IM database service ended normally.
KNAN11188-I The status of the IM database service will now be confirmed.
KNAN11183-I The IM database service is stopped.
KNAN11189-I The status of the IM database service was successfully confirmed.

jco_stop.cluster (UNIX only)

Function

When you are operating in a cluster system, this command terminates JP1/IM - Manager on the logical host.

If the IM database service is running on the logical host, the command terminates JP1/IM - Manager and then terminates the IM database service on the same logical host.

When you execute this command, the JP1/IM - Manager processes and the IM database service are terminated. If this command is executed but the processes do not terminate, use the jco_killall.cluster command to forcibly terminate all processes.

To execute this command, you must have executed jp1cc_setup_cluster and jp1cs_setup_cluster after installing and setting up JP1/IM - Manager. For the IM database service to terminate, you must have set up the cluster system for that IM database service. For details about setting up a cluster system, see Chapter 8. Operation and Environment Configuration in a Cluster System (for UNIX) in the JP1/Integrated Management 2 - Manager Configuration Guide.

Format

jco_stop.cluster [logical-host-name]

Execution permission

Superuser permissions

Storage directory

/etc/opt/jp1cons/

Arguments

logical-host-name

When you are operating in a cluster system, this option specifies the name of the logical host where this command is to be executed. The permitted length is from 1 to 63 bytes characters. If this option is omitted, the command assumes the logical host name specified in the JP1_HOSTNAME environment variable. If the JP1_HOSTNAME environment variable is not specified, the command assumes the physical host name.

ote

The jco_stop.cluster command cannot be executed together with the jco_spmd_status command.

Return values

0

Normal termination

1

More than one argument is specified or the termination request resulted in a timeout

jcoappexecfcheck (Windows only)

Function

This command checks the contents of a definition file for executing applications.

The definition file for executing applications in a specified directory is checked for any definition errors. Analysis results of the checking are output to standard output.

The analysis results are output in the following format:

application-execution-definition-identifier,execution-path[,text]

The analysis results contain the application execution definition identifier defined in the system ("default_browser" indicating the default Web browser definition used in Central Console).

Format

jcoappexecfcheck application-execution-definition-directory-name

Execution permission

None

Storage directory

View-path\bin\

Arguments

application-execution-definition-directory-name

Specifies the directory containing the definition file for executing applications that is to be checked, expressed as an absolute path or a path relative to the current directory. This cannot be a file name.

Example

Execute the command to check the following definition file:

@file type="application-execution-definition", version="0300";
@define-block type="application-execution-def";
id="notepad";
path="C:\winnt\system32\notepad.exe";
@define-block-end;
@define-block type="application-execution-def";
id="dmp";
path="[\HKEY_LOCAL_MACHINE\SOFTWARE\HITACHI\NETM/DM/P\0521/A\PathName\Path00]\bin\DMPSTS.exe";
@define-block-end;

The analysis results are output as follows:

"dmp","C:\NETMDMP\bin\DMPSTS.exe"
"notepad","C:\winnt\system32\notepad.exe"
"default_browser","C:\Program Files\Netscape\Communicator\Program\netscape.exe"

jcoattrfcheck

Function

This command checks the contents of definition files for extended event attributes.

The definition files for extended event attributes that are in a specified directory are checked for any definition errors. Analysis results of the checking are output to standard output. Error information, such as definition errors, is output to standard error.

The command outputs the analysis results in CSV format. Each line contains the following information for one event ID:

platform,event-ID,language-type,product-name,attribute-name,display-name,type

Note

The portion ,attribute-name,display-name,type is output as many times as there are event attributes to be displayed.

When definition files for extended event attributes (extended file) are checked, the output of some of the fields is fixed. These fields are shown in the following table.

Table 1‒28: Fixed values that are output when the extended files are checked

No.

Field

What is output

1

Platform

base

2

Event ID

DEFAULT

3

Language type

When extend_attr_ja.conf is checked: japanese

When extend_attr_en.conf is checked: english

When extend_attr_zh.conf is checked: chinese

4

Product name

/HITACHI/DEFAULT

JP1 event attributes displayed in the Event Details window contain this command's analysis results and the information common to the basic and extended attributes.

Format

jcoattrfcheck extended-event-attribute-definition-directory-name

Execution permission

In Windows: Administrator permissions (If the Windows UAC feature is enabled, the command must be executed from the administrator console.)

In UNIX: None

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

extended-event-attribute-definition-directory-name

Specifies the name of the directory that contains the definition files for extended event attributes that are to be checked. Express the directory name as an absolute path or a path relative to the current directory.

Files to be checked must have the extension .conf and their file type will be extended-attributes-definition.

If you want to check definition files for extended event attributes (extended files), you must create an extend subdirectory in the directory specified in the argument of the jcoattrfcheck command and place the extended files in the extend directory. The files in the extend directory are checked as the extended files.

Note that, in checking the extended files, this command reads the standard files installed in JP1/IM - Manager and the extended file located in the directory specified in the argument of the jcoattrfcheck command, and checks whether the specified extended attributes are duplicated. The path of the standard files that are read when the extended file is checked is as follows:

In Windows

Console-path\conf\console\attribute\default.conf

In UNIX

/etc/opt/jp1cons/conf/console/attribute/default.conf

jcochafmode (UNIX only)

Function

This command changes the location of the event acquisition filter from Event Console Service to Event Base Service.

If you execute this command while you are using an event acquisition filter (for compatibility), the filter becomes applicable to the automated action functions and to Central Scope, as well as to JP1 event monitoring. You can then define detailed filter conditions. However, if you want to use the event acquisition filter (for compatibility) as is, there is no need to change the filter location.

Information specified in the event acquisition filter version 07-00 or earlier, or the event acquisition filter (for compatibility) is inherited as shown in the table below. Change the settings and condition group names as appropriate to your operation.

Table 1‒29: Inheritance of event acquisition filter settings

Settings before execution of jcochafmode command

After execution of jcochafmode command

None

Inherited as Existing conditions group with no settings

Only event IDs are set

Inherited as Existing conditions group

Only event levels are set

Inherited as Existing conditions group

Only JP1/SES events are set

Inherited as Existing conditions group_SES

JP1/SES events and event IDs are set

The JP1/SES event and event ID# settings are inherited as Existing conditions group_SES.

The event ID# settings are inherited as Existing conditions group.

Event levels and event IDs are set

Inherited as Existing conditions group

JP1/SES events and event levels are set

The JP1/SES event settings are inherited as Existing conditions group_SES.

The event level settings are inherited as Existing conditions group.

JP1/SES events, event levels, and event IDs are set

The JP1/SES event and event ID# settings are inherited as Existing conditions group_SES.

The event level and event ID# settings are inherited as Existing conditions group.

#

The event ID settings are inherited to both condition groups.

Format

jcochafmode [-h logical-host-name]

Execution permission

Superuser permissions

Storage directory

/opt/jp1cons/bin/

Note: This command is not included in JP1/IM - Manager for Linux.

Arguments

-h logical-host-name

Specifies the logical host name for the event acquisition filter (for compatibility). If this option is omitted, the command assumes the physical host. If you do not use a cluster system, specification of this option is not needed.

Notes

If you wish to execute this command to change the location and definitions of an event acquisition filter, you must first terminate JP1/IM - Manager at the target host whose event acquisition filter is to be changed. If this command is executed while the JP1/IM - Manager is running, an error results.

If you execute this command more than once, the converted event acquisition filter is overwritten and the customized condition definitions are discarded. Execute this filter only once when you convert an event acquisition filter.

Once you convert an event acquisition filter, you can no longer restore the previous event acquisition filter or event acquisition filter (for compatibility) to the filter location and definitions existing before upgrading.

An event acquisition filter version 08-01 or later cannot be converted to an event acquisition filter (for compatibility).

If you have newly installed JP1/IM - Manager, there is no need to execute this command.

If you change the location of an event acquisition filter to Event Base Service by executing this command, that filter becomes applicable to the correlation event generation function thereafter.

Return values

0

Normal termination

1

Abnormal termination

Example

Convert the event acquisition filter (for compatibility) at the logical host01 to the event acquisition filter that is run on Event Base Service:

jcochafmode -h host01

Output example 1

JP1/IM - Manager at the target host whose event acquisition filter is to be changed is not running:

KAVB1005-I The command (jcochafmode) has started.
KAVB0836-I The event acquisition filter was switched from interchangeability to the ordinary mode.
KAVB1002-I The command (jcochafmode) terminates normally.

Output example 2

JP1/IM - Manager at the target host whose event acquisition filter is to be changed is running:

KAVB1005-I The command (jcochafmode) has started.
KAVB0831-E JP1/IM - Manager has started.
KAVB1003-I The command (jcochafmode) terminates abnormally.

jcochcefmode

Function

This command changes the operating mode for the common exclusion-conditions of JP1/IM - Manager. Executing the command changes the common exclusion-conditions mode from normal to extended, and vice versa. If the mode is changed from extended to normal, common exclusion-conditions and additional common exclusion-conditions are not passed to the normal-mode common exclusion-conditions. To change the common exclusion-conditions mode to extended, the regular expressions of JP1/Base must be extended. For details about how to extend regular expressions of JP1/Base, see the JP1/Base User's Guide.

If you execute this command with the -m option specified, JP1/IM - Manager must not be running. If this command is executed without stopping JP1/IM - Manager, the command terminates with an error and a message is displayed.

In addition, multiple instances of this command cannot be executed concurrently.

Note that the operating mode of the common exclusion-conditions can be changed to extended when common exclusion-conditions have already been set.

The backup file of the extended definition file for the common exclusion-conditions is output as common_exclude_filter_backup.conf when either of the following applies:

The operating mode is changed from normal to extended, and there is a problem with the regular expressions.

The operating mode is changed from extended to normal.

The following shows the output destination of the backup file.

In Windows:

For a physical host:

Console-path\conf\console\filter\

For a logical host:

shared-folder\jp1cons\conf\console\filter\

In UNIX:

For a physical host:

/etc/opt/jp1cons/conf/console/filter/

For a logical host:

shared-directory/jp1cons/conf/console/filter/

If there are regular expressions that cannot be used in extended mode, an error is displayed, and extended-mode common exclusion-conditions are not set. Edit the output file, and then use the -ef option of the jcochfilter command to apply the changes to JP1/IM - Manager.

For details about the extended definition file for common exclusion-conditions, see Common-exclusion-conditions extended definition file in Chapter 2. Definition Files.

For details about the jcochfilter command, see jcochfilter in Chapter 1. Commands.

Format

jcochcefmode [-m {normal | extended}]
             [-h logical-host-name]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-m {normal | extended}

Specifies the operating mode of the common exclusion-conditions.

normal: Specify this value to set the operating mode of the common exclusion-conditions to normal mode. The default value is normal.

If the operating mode is changed back to normal from extended, the definition of normal-condition common exclusion-conditions becomes empty. The definition of the common exclusion-conditions used in extended mode is saved as a backup. In addition, all definitions of additional common exclusion-conditions are deleted. For details about backup files, see Function.

extended: Specify this value to set the operating mode of the common exclusion-conditions to extended mode. The definition for the common exclusion-conditions used in normal mode is passed to the definition of the extended-mode common exclusion-conditions. Note that if the operating mode of the common exclusion conditions is changed to extended mode, the regular expressions in JP1/Base must be extended, which will affect your ability to use those regular expressions in JP1/Base. For details about extended regular expressions in JP1/Base, see the JP1/Base User's Guide.

normal and extended are not case sensitive.

-h logical-host-name

For operation in a cluster system, this option specifies the logical host name. The operating mode for the specified host is set in the common exclusion-conditions for JP1/IM - Manager. If this option is omitted, the logical host name specified for the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

If JP1_DEFAULT or a non-existent logical host is set for the JP1_HOSTNAME environment variable, an error is displayed.

Notes

If the -m option is not specified, the operating mode in the common exclusion-conditions is displayed.

If either of the following conditions, or both, applies, extended mode cannot be used:

An event acquisition filter (for compatibility) is used

Extended regular expressions are not used in JP1/Base on the manager host

To change the operation mode of the common exclusion conditions on a logical host by using the -h option, a shared disk must be mounted.

If you are using a cluster system, you must copy the common definition information from the active server to the standby server.

For details about how to copy the information, see 7.7.2 Using commands to change settings (for Windows) or 8.7.2 Using commands to change settings (for UNIX) in the JP1/Integrated Management 2 - Manager Configuration Guide.

The jcochcefmode command cannot be executed together with the jco_spmd_status command.

Return values

0

Normal termination

1

Abnormal termination

2

Argument error

3

JP1/IM - Manager is running

4

Prerequisite conditions for extended mode are not satisfied, or an event acquisition filter (for compatibility) is running

5

Prerequisite conditions for extended mode are not satisfied or regular expressions in JP1/Base are not extended

6

The same operating mode as the current mode is specified

7

No execution permission for the jcochcefmode command assigned (Windows only)

8

Backup of the extended definition file for common exclusion-conditions failed

9

Invalid logical host specification

10

Concurrent execution error

255

Other error

Example 1

Change the operating mode to normal mode:

Input value:

jcochcefmode -m normal

Result:

KAVB1005-I The command (jcochcefmode) has started.
KAVB0895-I The operation mode of the common exclusion conditions was changed to basic mode.
KAVB1002-I The command (jcochcefmode) terminates normally.

Example 2

Change the operating mode to extended mode:

Input value:

jcochcefmode -m extended

Result:

KAVB1005-I The command (jcochcefmode) has started.
KAVB0896-I The operation mode of the common exclusion conditions was changed to extended mode.
KAVB1002-I The command (jcochcefmode) terminates normally.

Example 3

Check the operating mode for the common exclusion-conditions (in this example, the name of the physical or logical host is hostA, and the operating mode is extended):

Input value:

jcochcefmode

Result:

KAVB1005-I The command (jcochcefmode) has started.
KAVB0894-I The operation mode of the common exclusion conditions will be displayed. (host name = host A)
operation mode = extended mode
KAVB1002-I The command (jcochcefmode) terminates normally.

jcochfilter

Function

This command switches the event acquisition filter that is enabled in the correlation event generation function and Event Base Service of JP1/IM - Manager to the event acquisition filter indicated by a specified filter ID. In addition, the specified common exclusion-conditions can be enabled or disabled.

The command can display a list of the event acquisition filter's filter IDs, filter names, common exclusion-conditions group IDs, and common exclusion-conditions group names.

If JP1/IM - Manager is not running on the specified host, and an event acquisition filter (for compatibility) is used, this command cannot be used.

In addition, if the mode of the common exclusion-conditions is extended mode, the following operations can be performed:

Enabling or disabling of the extended-mode common exclusion-conditions for each condition group

Reading of the definition file for common exclusion-conditions and batch-application of the definitions for extended-mode common exclusion-conditions

Reading of the definition file for the common exclusion-conditions and checking of the definitions for extended-mode common exclusion-conditions

Enabling or disabling of the defined additional common exclusion-conditions group for each conditions group

Format 1

jcochfilter [-i filter-ID]
            [-e [common-exclusion-conditions-group-ID
            [,common-exclusion-conditions-group-ID...]|ALL]]
            [-on common-exclusion-conditions-group-ID[,common-exclusion-conditions-group-ID...]]#
            [-off common-exclusion-conditions-group-ID[,common-exclusion-conditions-group-ID...]]#
            [-ef name-of-extended-definition-file-for-common-exclusion-conditions]#
            [-h logical-host-name]

#: Can be specified only for extended-mode common exclusion-conditions.

Format 2

jcochfilter -check name-of-extended-definition-file-for-common-exclusion-conditions

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-i filter-ID

Specifies the filter ID of the event acquisition filter to be switched.

-e [common-exclusion-conditions-group-ID,common-exclusion-conditions-group-ID...]|ALL

Specifies the IDs of the common exclusion-conditions groups that you want to enable. The common exclusion-conditions whose group IDs are not specified will be disabled. If the common exclusion-conditions mode is extended mode, the ID of an additional common exclusion-conditions group can be specified. Separate multiple IDs with the comma. To enable all common exclusion-conditions, specify ALL.

You can specify the following values for common-exclusion-conditions-group-ID:

Basic mode: 0 to 29

Extended mode: 0 to 2,499

Note that if you specify nothing following -e, all common exclusion-conditions will be disabled. For the ID of an additional common exclusion-conditions group, specify a numeric value prefixed with A.

This option can be specified together only with the -i and -h options.

-on common-exclusion-conditions-group-ID[,common-exclusion-conditions-group-ID...]

Specifies the ID of the extended-mode common exclusion-conditions you want to enable or the ID of additional common exclusion-conditions. This option can be set only when the common exclusion-conditions mode is extended mode. If you specify multiple extended-mode common exclusion-conditions IDs, separate them with a comma (,). You can specify the following values for common-exclusion-conditions-group-ID:

Basic mode: 0 to 29

Extended mode: 0 to 2,499

For the ID of an additional common exclusion-conditions group, specify a numeric value prefixed with A.

This option cannot be specified together with the -e, -ef, or -check option.

-off common-exclusion-conditions-group-ID[,common-exclusion-conditions-group-ID...]

Specifies the ID of the extended-mode common exclusion-conditions that you want to disable or the ID of additional common exclusion-conditions. This option can be set only when the common exclusion-conditions mode is extended mode. If you specify multiple extended-mode common exclusion-conditions IDs, separate them with a comma (,). You can specify the following values for common-exclusion-conditions-group-ID:

Basic mode: 0 to 29

Extended mode: 0 to 2,499

For the ID of an additional common exclusion-conditions group, specify a numeric value prefixed with A.

This option cannot be specified together with the -e, -ef, or -check option.

-ef name-of-extended-definition-file-for-common-exclusion-conditions

Specifies the name of the definition file for common exclusion-conditions you want to apply to JP1/IM - Manager in relative or absolute path format. This option can be set only when the common exclusion-conditions mode is extended mode. By specifying this option, you can batch-apply to JP1/IM - Manager the definitions of the extended-mode common exclusion-conditions described in the extended definition file for common exclusion-conditions#.

If an additional common exclusion-conditions group is set, all definitions are deleted. This option can be specified together only with the -h option.

#: The definition cannot be applied if the definition includes any environment-dependent character or other character that might cause character corruption.

-check name-of-extended-definition-file-for-common-exclusion-conditions

This option checks whether the definitions of the extended-mode common exclusion-conditions specified in the extended definition file for common exclusion-conditions are correct. This also checks whether the definitions include any environment-dependent character or other character that might cause character corruption.

Specify the name of the definition file for the common exclusion-conditions you want to apply to JP1/IM - Manager in relative or absolute path format. This option cannot be specified together with other options.

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed. This option cannot be specified together with the -check option.

Notes

If -h is the only option specified, the following items are listed:

Filter IDs and filter names of the event acquisition filters that are currently enabled

IDs and names of the common exclusion-conditions groups currently enabled

Filter IDs and filter names of the event acquisition filters that have been set

IDs and names of the common exclusion-conditions groups that have been set

When the common exclusion-conditions operating mode is extended mode, the ID of the extended-mode common exclusion-conditions and the common exclusion-conditions group name

If JP1/IM - Manager is not running at the specified host and the event acquisition filter is used for compatibility, the jcochfilter command cannot be executed.

If you execute more than one jcochfilter command at the same time, it might cause an error depending on the timing.

Executing the jcochfilter command concurrently many times might cause timeouts or a degraded performance of managers.

The jcochfilter command cannot be executed together with the jco_spmd_status command.

Return values

0

Normal termination

1

Argument error

2

Connection cannot be established with JP1/IM - Manager (Central Console) (communication error)

3

Operating status of JP1/IM - Manager cannot be verified

4

There was no response from JP1/IM - Manager within a specific amount of time

5

Event acquisition filter is running in the compatibility mode

6

Error from JP1/IM - Manager

7

Filter ID specified in the -i option does not exist

8

User does not have permissions to execute the jcochfilter command (Windows only)

9

The maximum length for an event acquisition filter was exceeded

10

The common exclusion-conditions specified in the -e option do not exist

11

The common exclusion-conditions group (extended mode) specified for the -on or -off option not found

12

The common exclusion-conditions group (extended mode) cannot be used (the setting is not for extended mode)

13

Application of the definition of common exclusion-conditions group (extended mode) failed

14

The definition of common exclusion-conditions group (extended mode) contains an error

255

Other error

Example 1

List the event acquisition filters on logical host hostA:

jcochfilter -h hostA

Example 2

Change the filter ID of the event acquisition filter on logical host hostA to 3:

jcochfilter -i 3 -h hostA

Example 3

Enable common exclusion-conditions groups (ID: 0, 2) for the event acquisition filter on the logical host (hostA), and disable all other groups:

jcochfilter -e 0,2 -h hostA

jcochstat

Function

This command changes information about the response status for severe events.

The command accesses the event database on the host specified in -h and changes the response status of the JP1 events whose serial numbers are specified in -n.

When a response status is changed, the change is also applied to the response status displayed by other JP1/IM - Views that are logged in to the same manager. If a JP1 event whose response status is to be changed has been forwarded from another host or is set to be forwarded to another host, the response status is not changed at the source or target host.

This command can also be used to change the response status of JP1 events that are not displayed on the Severe Events page in the Event Console window. In such a case, you must use one of the following methods to check the change:

If the JP1 event whose response status has been changed is displayed on the Monitor Events page in the Event Console window: Check the Monitor Events page.

If the JP1 event whose response status has been changed is not displayed on the Monitor Events page in the Event Console window: Search for the event to check its status.

You can use this command while JP1/IM - Manager is running.

Format

jcochstat [-h manager-host-name]
          {-k severe-event-response-status-key | -d |
           -k severe-event-response-status-key -d}
           -n serial-number-1[,...,serial-number-100]

Execution permission

In Windows: Administrator permissions (If the Windows UAC feature is enabled, the command must be executed from the administrator console.)

In UNIX: None

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h manager-host-name

Specifies the manager that has the event database in which the severe events are registered. You can specify host names, domain names, and IPv4 addresses. If this option is omitted, the command assumes the logical host. If this option is omitted during cluster system operation, the command assumes the name of the physical host where the command is executed. If JP1/IM - Manager is not running at the specified manager, an error results.

Specify the manager host name as a string of from 1 to 255 characters.

Note that the ability to specify the manager of another host in manager-host-name is supported for compatibility with version 6.

-k severe-event-response-status-key

Specifies the key value that represents the new severe event response status. The severe event response status of the severe events specified in the -n option is changed to the response status indicated by this key. If you use JP1/IM - View to display the status, the response status symbol changes.

A severe event response status key is case sensitive.

You must specify one or both of the -k and -d options. When both options are specified, the command changes the response status and then deletes the events from the JP1/IM - View window. The -k and -d options cannot both be omitted.

Table 1‒30: Severe event response status keys

Key value

Response status

Response status symbol displayed in JP1/IM - View

PROCESSED

Processed

PROCESSING

Being processed

HELD

On hold

UNPROCESSED

Unprocessed

(No symbol)

-d

Deletes the severe events specified in the -n option on the Severe Events page of the Event Console window. These events are not deleted from the event database.

A deleted event can no longer be displayed on the Severe Events page.

You must specify either the -k or -d option, or both.

If you specify both options, change the response status first, and then delete the event on the Severe Events page of the Event Console window. You cannot omit both the -k and -d options.

-n serial-number

Specifies the serial number of a severe event whose response status is to be changed. This option is mandatory. The permitted value is a decimal integer in the range from 0 to 2,147,483,647.

You can specify a maximum of 100 serial numbers. Separate multiple serial numbers with the comma. Do not specify any spaces before or after a delimiter comma.

Return values

0

Normal termination

1

Argument error

2

Network failure

3

Updating of the event database failed

4

Specified key is not supported

5

A specified event cannot be updated

7

No permission to execute the command (Windows)

255

Other error

Example

Change to processed status the response status of the events that are registered in the event database on the host01 manager and whose serial numbers are 35 and 400, and then delete those events from the window:

jcochstat -h host01 -k PROCESSED -n 35,400 -d

jcodbsetup

Function

This is a setup command for creating an integrated monitoring database area for storing JP1 events. You must have already specified in advance in the setup information file the database's size, port number, and storage location.

In Windows, if this command is executed in an environment where the IM Configuration Management database is not set up, the following services are registered in the OS:

When setting up a physical host: JP1/IM-Manager DB Server, JP1/IM-Manager DB Cluster Service

When setting up a cluster configuration: JP1/IM-Manager DB Server_logical-host-name, JP1/IM-Manager DB Cluster Service_logical-host-name

In UNIX, if this command is executed in an environment where the IM Configuration Management database is not set up, an entry containing the path to the IM database is added to the /etc/inittab file. The entry is added to the respective physical and logical hosts on which this command was executed. Do not delete, edit, or comment out the entry in the /etc/inittab file that is added when this command is executed.

Format

jcodbsetup {-f setup-information-file-name|-s}
           [-h logical-host-name -c {online|standby}]
           [-q]
           [-v 0]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-f setup-information-file-name

Specifies the setup information file that contains the requisite information, such as the IM database installation folder and the size of the database area. If neither the IM Configuration Management database nor an integrated monitoring database has been set up, you must specify this option. If the IM Configuration Management database has already been set up, specify in this option the setup information file that you specified when you set up the IM Configuration Management database. Alternatively, if the IM Configuration Management database has already been set up, you can specify the -s option instead. In such a case, the command uses the setup information that was specified when the IM Configuration Management database was set up.

This option cannot be specified together with the -s option. Additionally, the -f and -s options cannot both be omitted.

If the path contains a space, enclose the entire path in double-quotation marks ("). If you configure a cluster environment, specify the cluster setup information file name.

-s

If the IM Configuration Management database has already been set up, you can specify this option instead of the -f option. When this option is specified, the command sets up the integrated monitoring database by using the setup information that was specified when the IM Configuration Management database was set up.

If the IM Configuration Management database has not been set up but this option is specified, the command displays the KNAN11193-E message.

This option cannot be specified together with the -f option. Additionally, the -s and -f options cannot both be omitted.

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host that executes the command. The command sets up the integrated monitoring database for the specified logical host. If you do not use a cluster system, specification of this option is not needed. Note that this logical host name cannot be JP1_DEFAULT. In addition, the logical host name is case sensitive. For the logical host name, specify a logical host name set in JP1/Base in the correct form, especially case.

-c {online|standby}

Specifies the setup type in the cluster configuration (primary node or secondary node). If you have specified the -h option, you must specify this option. If the IM Configuration Management database has already been set up on the same host, specify the value that you used when you created the IM Configuration Management database. If you are running a logical host in a non-cluster environment, specify online.

online: Specifies that the primary node is to be set up.

standby: Specifies that the secondary node is to be set up.

If you specify online, mount the shared disk and establish a connection to the logical host.

-q

Specifies that the command is to be executed without requesting confirmation from the user.

-v 0

Specifies that you want to recover a backup for expansion that was backed up using a table schema from JP1/IM - Manager 09-00 to 10-50. In JP1/IM - Manager 11-00, you can specify 0 as the version of the backup for expansion.

When 0 is specified, the integrated monitoring database is set up using the same table schema as JP1/IM - Manager 09-00 to 10-50.

If the -v option is omitted, the integrated monitoring database is set up using the table schema of JP1/IM - Manager 11-00 or later.

The -v option is ignored if standby is specified for the -c option.

Return values

0

Normal termination

1

Abnormal termination

Notes

The contents of the cluster setup information files must be identical between the primary and secondary nodes. When you set up the secondary node, copy the cluster setup information file used for the primary node and then use that file. If the contents of the files specified for the primary and secondary nodes are different, cancel the setup at the secondary node, copy the cluster setup information file from the primary node, and then re-execute the command.

If you execute the command with the -c option specified, do not switch servers during execution. If you switch servers during execution, cancel the setup after the command has terminated, and then re-execute the command.

If you have canceled the command's execution by pressing Ctrl + C or Ctrl + Break, make sure that the pdistup, pdfmkfs, pddef, and pdload processes are not executing, execute the jcodbunsetup command, and then re-execute this command.

If the IM Configuration Management database has already been set up and the IM database is being used, JP1/IM - Manager Service must be stopped.

If you are using the IM Configuration Management database in Windows, the IM database (JP1/IM2-Manager DB Server) must be running and the cluster service for the IM database (JP1/IM2-Manager DB Cluster Service) must be stopped.

If you are using JP1/IM - MO, the JP1/IM - Message Optimizer service of JP1/IM - MO on the connection source must be stopped.

Before executing the command, verify that the logical host name specified in the argument matches the JP1/Base logical host name in JP1/Base, and that the logical host name can be resolved.

If you perform unsetup of the IM database by executing the jcodbunsetup or jcfdbunsetup command, you must restart the OS before re-executing the jcfdbsetup command.

Before executing the command in Windows, in case of existing the Application Experience service, make sure that the startup type of the Application Experience service is not set to Disabled.

jcodbunsetup

Function

This command cancels setup of the integrated monitoring database that stores JP1 events.

Execute this command when you stop using the integrated monitoring database, uninstall JP1/IM - Manager, re-create the integrated monitoring database, or expand the database size.

In an environment in which an IM Configuration Management database has been set up, the IM Configuration Management database is still available even after execution of this command.

In Windows, if this command is executed in an environment where the IM Configuration Management database is not set up, the following services are deleted:

When removing setup of a physical host: JP1/IM-Manager DB Server, JP1/IM-Manager DB Cluster Service

When removing setup of a cluster configuration: JP1/IM-Manager DB Server_logical-host-name, JP1/IM-Manager DB Cluster Service_logical-host-name

In UNIX, if this command is executed in an environment where the IM Configuration Management database is not set up, entries in the /etc/inittab file registered by the jcodbsetup or jcfdbsetup command are deleted. The entries that are deleted are only those for processing related to the physical and logical hosts on which the command was executed.

Format

jcodbunsetup [-h logical-host-name -c {online|standby}]
             [-q]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host that executes the command. The command cancels setup of the integrated monitoring database for the specified logical host. If you do not use a cluster system, specification of this option is not needed. Note that this logical host name cannot be JP1_DEFAULT. In addition, the logical host name is case sensitive. For the logical host name, specify a logical host name set in JP1/Base in the correct form, especially case.

-c {online|standby}

Specifies the type of setup being canceled in the cluster configuration (primary node or secondary node). If you have specified the -h option, you must specify this option.

online: Specify this value if you specified online during setup of the integrated monitoring database.

standby: Specify this value if you specified standby during setup of the integrated monitoring database.

If you specify online, mount the shared disk and establish a connection to the logical host. In addition, if you perform unsetup of the integrated monitoring database on a logical host running in a non-cluster environment, specify online.

-q

Specifies that the command is to be executed without requesting confirmation from the user.

Return values

0

Normal termination

1

Abnormal termination

Notes

If you expand the database size in an environment in which the IM Configuration Management database has been created, you must execute the command that cancels setup of IM Configuration Management database after you've executed this command.

If you execute the command with the -c option specified, do not switch servers during execution. If you switch servers during execution, re-execute the command after the command has terminated.

If you have canceled the command's execution by pressing Ctrl + C or Ctrl + Break, make sure that the pdirst process is not executing, and then re-execute this command.

In Windows, the service must be in the following status:

For a physical host:

The cluster service for the IM database (JP1/IM2-Manager DB Cluster Service) must be stopped, and the IM database service (JP1/IM2-Manager DB Server) must be started. In addition, if the IM Configuration Management database is set up and the IM database is being used, the JP1/IM - Manager service (JP1/IM2-Manager) must be stopped.

For a logical host:

The cluster service for the IM database (JP1/IM2-Manager DB Cluster Service_logical-host-name) on the logical host must be stopped, and the IM database service (JP1/IM2-Manager DB Server_logical-host-name) on the logical host must be started. In addition, when the IM Configuration Management database is set up and the IM database is being used, the JP1/IM - Manager service (JP1/IM2-Manager_logical-host-name) must be stopped.

In UNIX, when the IM Configuration Management database is set up, and the IM database is being used, the JP1/IM-Manager service must be stopped.

If you are using JP1/IM - MO, the JP1/IM - Message Optimizer service of JP1/IM - MO on the connection source must be stopped.

Before executing the command in Windows, in case of existing the Application Experience service, make sure that the startup type of the Application Experience service is not set to Disabled.

jcoegschange

Function

This command changes correlation event generation definitions. You can execute this command while the status of the correlation event generation function is stopped, running, or standby, but not while the status is starting or stopping.

The following notes apply to execution of the jcoegschange command:

When you execute the jcoegschange command to change correlation event generation definitions, the new definitions take effect immediately. If there are JP1 events under correlation event generation processing when the new definitions take effect, all these events will fail.

If no conditions are defined in the correlation event generation definition file when the jcoegschange command is issued, the command executes processing with no correlation event generation conditions. This means that no correlation events are issued.

If the correlation event generation function is in running status and the correlation event generation definitions to be changed by the jcoegschange command contain an error, the definitions are not changed and processing continues.

If the correlation event generation function is not running, the only processing that occurs is that the correlation event generation definitions are set. Once you start the correlation event generation function, the correlation event generation definitions take effect.

The jcoegschange command cannot be executed together with the jcoegsstatus command in which the -d option is specified.

Format

jcoegschange [-h logical-host-name]
             -f correlation-event-generation-definition-file-name

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-f correlation-event-generation-definition-file-name

Specifies the relative or absolute path of the correlation event generation definition file.

Return values

0

Correlation event generation definitions were changed successfully

1

Attempt to change correlation event generation definitions failed

2

A timeout occurred during communication with the Event Generation Service (when the integrated monitoring database is not used) or with Event Base Service (when the integrated monitoring database is used)

100

Execution permission error (Windows only)

101

Argument error

102

Communication error

255

Other abnormal termination (system error)

Example

Change the correlation event generation definitions for the physical host hostP to the definitions specified in the correlation event generation definition file /tmp/teigi1.conf:

Input value:

jcoegschange -f /tmp/teigi1.conf

Result:

KAJV3201-I The correlation event generation definition file (/tmp/teigi1.conf) has been read, and the definitions for the correlation event generation function on (hostP) have been updated.

The same result is output even if no correlation event generation definitions are set for the correlation event generation function.

jcoegscheck

Function

This command checks the contents of a correlation event generation definition file.

This command looks for definition errors and redundant definitions in the correlation event generation definition file.

Format

jcoegscheck -f correlation-event-generation-definition-file-name

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-f correlation-event-generation-definition-file-name

Specifies the relative or absolute path of the correlation event generation definition file.

Return values

0

Contents of the correlation event generation definition file were correct

1

Correlation event generation definition file contained invalid contents

100

No execution permissions (Windows only)

Execution permissions are only granted to root (UNIX only)

101

Argument error

255

Other abnormal termination (system error)

Example

Check the contents of correlation event generation definition file /tmp/teigi1.conf at the physical host hostP:

Input value:

jcoegscheck -f /tmp/teigi1.conf

Result (when the definitions were correct):

KAJV3311-I The content of the correlation event generation definition file (/tmp/teigi1.conf) will now be checked.
KAJV3312-I No mistakes were found in the content of the correlation event generation definition file (/tmp/teigi1.conf).

Result (when there were errors in the definitions):

KAJV3311-I The content of the correlation event generation definition file (/tmp/teigi1.conf) will now be checked.
Contents of the correlation event generation definition file (/tmp/teigi1.conf) are now checked.
KAJV3313-E There is an invalid definition in the correlation event generation definition.
KAJV3314-E There is an error in the contents of the correlation event generation definition file. (file name = /tmp/teigi1.conf, line = 5, incorrect contents = The correlation event generation condition name has not been specified.)
KAJV3314-E There is an error in the contents of the correlation event generation definition file. (file name = /tmp/teigi1.conf, line = 25, incorrect contents=The number of specified event conditions exceeds the maximum for a single correlation event generation condition.)

jcoegsstart

Function

This command changes the status of the correlation event generation function from standby to running. When the correlation event generation function is placed in running status, it starts processing in accordance with the correlation event generation definitions.

You can use the jcoegsstart command only after you have used the jcoegsstop command to place the correlation event generation function on standby status. The jcoegsstart command cannot start the correlation event generation function when it is stopped (service start and stop are controlled by process management (jco_spmd)).

When the status is changed successfully by the jcoegsstart command, a JP1 event (00003F25) is issued. For details about the 00003F25 JP1 event, see 3.2.2 Details of JP1 events.

If the correlation event generation function is already in running status when the jcoegsstart command is executed, the status remains unchanged.

Format

jcoegsstart [-h logical-host-name]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

Return values

0

Correlation event generation function restarted successfully

1

Restart of the correlation event generation function failed

2

A timeout occurred during communication with the correlation event generation function

100

No execution permissions (Windows only).

In UNIX, execution permissions are only granted to root.

101

Argument error

102

Communication error

255

Other abnormal termination (system error)

Example

Restart the correlation event generation function at the physical host hostP:

Input value:

jcoegsstart

Result:

KAJV3291-I The correlation event generation function for hostP has restarted.

jcoegsstatus

Function

This command displays the status of the correlation event generation function and the start options. By using the options, you can also display the correlation event generation definitions that are currently in use and the date and time at which correlation event generation definitions were applied.

Format

jcoegsstatus [-h logical-host-name]
             [-d]

Execution permission

In Windows: Administrator permissions (If the Windows UAC feature is enabled, the command must be executed from the administrator console.)

In UNIX: None

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-d

Specifies that the following are to be displayed: the status of the correlation event generation function, start options, correlation event generation definitions that are currently in use, and the date and time at which the correlation event generation definitions were applied by the jcoegschange command.

The jcoegsstatus command with the -d option specified cannot be executed together with the jcoegschange command.

Output format

In Windows and UNIX (when the LANG environment variable is not C)

When you execute the jcoegsstatus command, the status of the correlation event generation function is displayed in the following format:

KAJV3261-I The status of the correlation event generation service for hostP will now be displayed.

Correlation event generation function: status

Start option : start-option

When the -d option is specified, the status is displayed in the following format:

KAJV3261-I The status of the correlation event generation service for hostP will now be displayed.

Correlation event generation function: status

Start option : start-option

KAJV3281-I The correlation event generation definition for hostP will now be displayed.

File name : absolute-path-of-file

Reflection time : YYYY/MM/DD hh:mm:ss

VERSION=0002

# comment

[generation-condition-name]

TARGET=filtering-condition-for-the-correlation-target-range

CON=event-condition

SAME_ATTRIBUTE=duplicate-attribute-value-condition

CORRELATION_NUM=maximum-correlation-number

TIMEOUT=timeout-period

TYPE=event-correlation-type

SUCCESS_EVENT=correlation-event-information

In UNIX (when the LANG environment variable is C)

When you execute the jcoegsstatus command, the status of the correlation event generation function is displayed in the following format:

KAJV3261-I The status of the correlation event generation service for host-name will now be displayed.

Correlation event generation function : status

Start option : start-option

When the -d option is specified, the status is displayed in the following format:

KAJV3261-I The status of the correlation event generation service for host-name will now be displayed.

Correlation event generation function : status

Start option : start-option

KAJV3281-I The correlation event generation definition for host-name will now be displayed.

File name : absolute-path-of-file

Reflection time : YYYY/MM/DD hh:mm:ss

VERSION=0002

# comment

[generation-condition-name]

TARGET=filtering-condition-for-the-correlation-target-range

CON=event-condition

SAME_ATTRIBUTE=duplicate-attribute-value-condition

CORRELATION_NUM=maximum-correlation-number

TIMEOUT=timeout-period

TYPE=event-correlation-type

SUCCESS_EVENT=correlation-event-information

The following table lists and describes the character strings that are displayed as status.

Table 1‒31: Character strings displayed as status

Character string displayed as status

Operating status

Description

STARTING

Starting

The correlation event generation function is executing startup processing.

RUNNING

Running

The correlation event generation function is running and is ready to perform correlation event generation processing.

This status occurs in the following cases:

The correlation event generation function has started.

The jcoegsstart command is executed while the correlation event generation function is in standby status.

STANDBY

Standby

The correlation event generation function is running, but correlation event generation processing has stopped.

Correlation event generation processing is not performed on a JP1 event that is issued while the function is in standby status.

Even when the function status changes from standby to running, the correlation event generation processing is not performed on a JP1 event that was issued while the function was in standby status.

Remarks:

A correlation event that was being generated before the function was placed in standby status results in a failure after the function is placed in standby status.

STOPPING

Stopping

The correlation event generation function is engaged in termination processing.

STOP

Stopped

The correlation event generation function has stopped.

The following table lists and describes the character strings that are displayed as start-option.

Table 1‒32: Character strings displayed as start-option

Character string displayed as start-option

Start option

Description

cold

Cold start

Do not inherit the information that was under correlation event generation processing when the function went into stop status during the previous session.

warm

Warm start

Inherit the information that was under correlation event generation processing when the function went into stop status during the previous session.

For details about the format of a correlation event generation definition file, see Correlation event generation definition file in Chapter 2. Definition Files.

Return values

0

Status was displayed successfully

1

Status display failed

2

A timeout occurred during communication with the correlation event generation function

100

No permission to execute the command (Windows)

101

Argument error

102

Communication error

255

Other abnormal termination (system error)

Example 1

Display the status of the correlation event generation function on the physical host hostP (status: running; start option: cold):

Input value:

jcoegsstatus

Result:

KAJV3261-I The status of the correlation event generation service for hostP will now be displayed.
Correlation event generation function : RUNNING
Start option                          : cold

Example 2

Display the status of the correlation event generation function on the physical host hostP and the correlation event generation definitions (status: running; start option: cold):

Input value:

jcoegsstatus  -d

Result:

KAJV3261-I The status of the correlation event generation service for hostP will now be displayed.
Correlation event generation function : RUNNING
Start option                          : cold

KAJV3281-I The correlation event generation definition for hostP will now be displayed.
File name             :  /tmp/teigi1.conf
Reflection time :  2005/11/05 20:35:30

VERSION=2
[CONDITION]
TARGET=B.SOURCESERVER==host1;host2;host3
CON=CID:1, B.ID==100, E.SEVERITY==Emergency;Critical;Alert;Error
SAME_ATTRIBUTE=B.SOURCESERVER
CORRELATION_NUM=20
SUCCESS_EVENT=B.ID:A00, E.SEVERITY:Emergency, B.MESSAGE:$EV1_B.MESSAGE

Example 3

Display the status of the correlation event generation function on the physical host hostP and the correlation event generation definitions (status: standby; start option: warm):

The following condition applies:

When JP1/IM - Manager is newly installed

KAJV3283-I is displayed because the correlation event generation definition file has not been set.

Input value:

jcoegsstatus -d

Result:

KAJV3261-I The status of the correlation event generation service for hostP will now be displayed.
Correlation event generation function : STANDBY
Start option                          : warm

KAJV3283-I The correlation event generation definition for hostP has not been defined.

Example 4

Display the status of the correlation event generation function on the physical host hostP and the correlation event generation definitions (status: stopped (process down); start option: cold):

Input value:

jcoegsstatus  -d

Result:

KAJV3261-I The status of the correlation event generation service for hostP will now be displayed.
Correlation event generation function : STOP
Start option                          : cold

KAJV3281-I The correlation event generation definition for hostP will now be displayed.
File name             :  /tmp/teigi1.conf
Reflection time :  2005/11/05 20:35:30

VERSION=2
[CONDITION]
TARGET=B.SOURCESERVER==host1;host2;host3
CON=CID:1, B.ID==100, E.SEVERITY==Emergency;Critical;Alert;Error
SAME_ATTRIBUTE=B.SOURCESERVER
CORRELATION_NUM=20
SUCCESS_EVENT=B.ID:A00, E.SEVERITY:Emergency, B.MESSAGE:$EV1_B.MESSAGE

Example 5

Load an invalid correlation event generation definition file while the correlation event generation function is running:

Input value:

jcoegsstatus  -d

Result:

KAJV3261-I The status of the correlation event generation service for hostP will now be displayed.
Correlation event generation function : RUNNING
Start option                          : cold

KAJV3281-I The correlation event generation definition for hostP will now be displayed.
File name             :  /tmp/teigi1.conf
Reflection time :  2005/11/05 20:35:30

KAJV3285-I  Operations will continue while ignoring an invalid correlation event generation definition of hostP.

[CONDITION]
CON=CID:1, B.ID==ZZZ    ...#Message ID is invalid
SUCCESS_EVENT=B.ID:A00, E.SEVERITY:Emergency, B.MESSAGE:$EV1_B.MESSAGE

jcoegsstop

Function

This command changes the status of the correlation event generation function from running to standby. When the correlation event generation function is placed in standby status, it stops correlation event generation processing.

Use the jcoegsstop command when you want to stop correlation event generation processing without stopping the correlation event generation function. To restore the correlation event generation function to running status, either execute the jcoegsstart command or restart JP1/IM - Manager.

When the status is changed successfully by the jcoegsstop command, a JP1 event (00003F26) is issued. For details about the 00003F26 JP1 event, see 3.2.2 Details of JP1 events.

Format

jcoegsstop [-h logical-host-name]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

Notes

If you execute this command during correlation event generation processing, all correlation events undergoing generation processing will result in failure.

A JP1 event that is issued while the correlation event generation function is in standby status is not subject to correlation event generation processing.

If the correlation event generation function is already in standby status when the jcoegsstop command is executed, the status remains unchanged.

Return values

0

Correlation event generation function was terminated successfully

1

Termination of the correlation event generation function failed

2

A timeout occurred during communication with the correlation event generation function

100

No execution permissions (Windows only)

Execution permissions are only granted to root (UNIX only)

101

Argument error

102

Communication error

255

Other abnormal termination (system error)

Example

Terminate the correlation event generation function on the physical host hostP:

Input value:

jcoegsstop

Result:

KAJV3301-I The correlation event generation function for hostP has stopped.

jcoevtreport

Function

This command outputs to a CSV file information about the JP1 events registered in the integrated monitoring database. Only one instance of this command can be executing at the same time.

The jcoevtreport command can output JP1 event information to a CSV file as long as the IM database service is running, even if the integrated monitoring database is disabled or Central Console is not running.

Important

Because the jcoevtreport command acquires an event from the integrated monitoring database, operations such as searching for events from JP1/IM - View, switching response statuses, and acquiring events from JP1/IM - Manager are affected. Therefore, if the jcoevtreport command is executed when many events are running, other processes of JP1/IM - View or JP1/IM - Manager are delayed, and overall operation might be affected. If you want to execute the jcoevtreport command, do so during a time when it will not affect operation.

For details about the CSV output format, see 4.15.2 Saving event information in the integrated monitoring database (CSV report) in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

The command outputs error information to standard error, such as invalid definitions or a file size that exceeds the maximum value.

The following table describes the output functions.

Function

Description

Output of event report

Function that outputs to a CSV file information about the JP1 events registered in the integrated monitoring database

Output of maintenance information

Function that outputs all information about the JP1 events registered between an output start date/time and an output end date/time in the event of an integrated monitoring database failure

Output-and-save

Function that saves JP1 event information from the output of event report function before the information is deleted from the integrated monitoring database

Output-and-save status display

Function that displays the size and percentage of the JP1 events in the integrated monitoring database that have not been output and saved (percentage representing the ratio between the events that have not been output and the maximum number of records in the integrated monitoring database), as well as the deletion warning notification level

Format

Output of event report

jcoevtreport [-h logical-host-name]
             [-o output-file-name]
              -s output-start-date -e output-end-date
             [-user]
             [-f filter-file-name-for-output-of-event-report]
             [-k item-file-name-for-output-of-event-report]
             [-t {ON|OFF}]
             [-a {EVTATTR|DISP}]

Output of maintenance information

jcoevtreport [-h logical-host-name]
             [-o output-file-name]
              -s output-start-date -e output-end-date
              -sys

Output-and-save

jcoevtreport [-h logical-host-name]
             [-o output-file-name]
              -save
             [-t {ON|OFF}]
             [-a {EVTATTR|DISP}]

Output-and-save status display

jcoevtreport [-h logical-host-name]
              -showsv

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host that executes the command. The command acquires JP1 event information from the integrated monitoring database that is running at the specified logical host and performs output of event reports, output of maintenance information, output-and-save, or output-and-save status display. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-o output-file-name

Specifies the relative or absolute path name of the CSV file to which the JP1 event information acquired from the integrated monitoring database is to be output.

If you specify a file name that begins with a hyphen (-), use a relative or absolute path that includes a directory (such as ./-hoge) in order to distinguish the file name from an option. The permitted file name is a maximum of 250 bytes including the path.

Note that the following characters cannot be specified in a file name in Windows:

Characters: : ? " < > |

A character string that completely matches any of the following strings (not case sensitive): CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9

The following describes the relationship between the specified output file name and the file name that is actually created.

Event information in the integrated monitoring database is output to a CSV file named output-file-name_serial-number.csv. The serial number is a number from 000 to 999. A maximum of 50,000 event information items can be output to a file. If a file with the same name already exists, the command does not overwrite the file. Instead, the command creates a new file by incrementing the serial number until an unused file name is obtained. If the serial number exceeds 999, the command ends without creating a file. If this option is omitted, the command outputs a CSV file named jcoevtreport_serial-number.csv to the current directory.

If the current directory (.) or the root directory (/) is specified in the file name, the command handles it as shown below:

-o argument

Windows

UNIX

.

._xxx.csv is created in the current directory.

_xxx.csv is created in the current directory.

/

_xxx.csv is created in the root directory.

_xxx.csv is created in the root directory.

"" (null character)

_xxx.csv is created in the current directory.

Insufficient argument error

-s output-start-date

Specifies the start date/time of the event arrival time that is used for outputting events.

The specification format is YYYYMMDDhhmmss.

The specified date/time must be within the period from 1970/01/01 00:00:00 to 2038/01/19 03:14:07 (GMT). When the time zone of the host on which the command is executed is Japan, the period is (GMT + 9:00) 1970/01/01 09:00:00 to 2038/01/19 12:14:07.

-e output-end-date

Specifies the end date/time of the event arrival time that is used for outputting events .

The specification format is YYYYMMDDhhmmss.

The specified date/time must be within the same period as for the -s option.

-k item-file-name-for-output-of-event-report

Specifies the relative or absolute path name of the item file name for output of event report.

If you specify a file name that begins with a hyphen (-), use a relative or absolute path that includes a directory (such as ./-hoge) in order to distinguish the file name from an option.

For details about the format of the item file for event report output, see Item file in Chapter 2. Definition Files.

-f filter-file-name-for-output-of-event-report

Specifies the name of a filter file in relative or absolute path format.

If you specify a file name that begins with a hyphen (-), use a relative or absolute path that includes a directory (such as ./-hoge) in order to distinguish the file name from an option.

For details about the filter file formats, see Filter file in Chapter 2. Definition Files.

-t {ON|OFF}

Specifies whether the registration time, arrival time, and START_TIME and END_TIME (common information for the extended attributes) are to be output in the format YYYYMMDDhhmmss or in absolute time in seconds.

ON: Specifies that the registration time, arrival time, and START_TIME and END_TIME (common information for the extended attributes) are to be output in the format YYYYMMDDhhmmss (i.e., they are to be converted from absolute time in seconds from January 1, 1970, to the calendar format YYYYMMDDhhmmss).

OFF: Specifies that the time is not to be converted to the calendar format.

This option takes precedence over the item file specification.

ON and OFF are not case sensitive.

-a {EVTATTR|DISP}

Specifies the output format for the header. If the -a option is omitted, no header is output.

When EVTATTR is specified, the command displays attribute names (such as B.ID and E.SEVERITY); when DISP is specified, the command displays item names (such as event ID and severity).

EVTATTR and DISP are not case sensitive.

If DISP is specified in the -a option, the character string to be output varies according to the value set for the LANG environment variable. Note that the LANG environment variable that is used to display the character string in the header depends on the OS. In Windows, the language of the header character string will be the language of the OS. In UNIX, the LANG environment variable that is used is the variable of the prompt where the command is executed.

In addition, when program-specific extended attributes and user-defined item names are specified in the definition file for extended event attributes (extended file), you can assign one column per attribute for output to a CSV file, in the same way as for basic attributes and common extended attributes. You can also output the names of attributes and specified items to the header. For details about the CSV output format, see 4.15.2 Saving event information in the integrated monitoring database (CSV report) in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

Specify whether you want to enable the function for assigning a column to each program-specific extended attribute for output in the environment definition file for event report output (evtreport.conf). For details, see Environment definition file for event report output (evtreport.conf) in Chapter 2. Definition Files.

The following table shows the character strings for the header that is output by the jcoevtreport command.

Table 1‒33: Header character string output by the jcoevtreport command

-a EVTATTR

-a DISP

LANG is Japanese

LANG is English

B.SEQNO

Serial number

Serial number

B.ID

Event ID

Event ID

B.PROCESSID

Source process ID

Source process ID

B.TIME

Registered time

Registered time

B.ARRIVEDTIME

Arrived time

Arrived time

B.REASON

Registered reason

Registered reason

B.USERID

Source user ID

Source user ID

B.GROUPID

Source group ID

Source group ID

B.USERNAME

Source user name

Source user name

B.GROUPNAME

Source group name

Source group name

B.SOURCESERVER

Registered host name

Source event server name

B.DESTSERVER

Destination event server name

Destination event server name

B.SOURCEIPADDR

Source IP address

Source IP address

B.DESTIPADDR

Destination IP address

Destination IP address

B.SOURCESEQNO

Source serial number

Source serial number

B.CODESET

Code set

Code set

B.MESSAGE

Message

Message

E.SEVERITY

Event level

Event level

E.USER_NAME

User name

User name

E.PRODUCT_NAME

Product name

Product name

E.OBJECT_TYPE

Object type

Object type

E.OBJECT_NAME

Object name

Object name

E.ROOT_OBJECT_TYPE

Root object type

Root object type

E.ROOT_OBJECT_NAME

Root object name

Root object name

E.OBJECT_ID

Object ID

Object ID

E.OCCURRENCE

Occurrence

Occurrence

E.START_TIME

Start time

Start time

E.END_TIME

End time

End time

E.RESULT_CODE

Return code

Result code

E.JP1_SOURCEHOST

Event source host name

Event source host

E.JP1_GENERATE_SOURCE_SEQNO

Relation Event serial number

Relation Event serial number

E.JP1_GENERATE_NAME

Correlation event generation condition name

Correlation event generation condition name

E.JP1_IMSUPPRESS_ID

Suppressed event ID

Suppressed event ID

E.JP1_IMSUPPRESS_NAME

Repeated event condition name

Repeated event condition name

E.JP1_TRAP_NAME

Monitoring target name

Monitoring target name

E.JP1_TRAP_ID

Monitoring ID number

Monitoring ID number

E.JP1_IMCOMEXCLUDE_ID

Common exclude conditions group ID

Common exclude conditions group ID

E.JP1_IMCOMEXCLUDE_NAME

Common exclude conditions group name

Common exclude conditions group name

E.JP1_IMCOMEXCLUDE_TARGET

Common exclude conditions group target-for-exclusion

Common exclude conditions group target-for-exclusion

E.@JP1IM_ACTTYPE

Action type

Action type

E.@JP1IM_ACTCONTROL

Action

Action

E.@JP1IM_SEVERE

Server event

Severe Event

E.@JP1IM_CORRELATE

Correlation event

Correlation event

E.@JP1IM_RESPONSE

Response-waiting event

Response-waiting event

E.@JP1IM_ORIGINAL_SEVERITY

Original severity level

Original Severity Level

E.@JP1IM_CHANGE_SEVERITY

New severity level

New Severity Level

E.@JP1IM_DEALT

Response status

Event status

E.@JP1IM_RELEASE

Severe event released

Severe Event Released

E.@JP1IM_DISMISSED

Severe event deleted

Severe Event Deleted

E.@JP1IM_MEMO

Memorandum

Memo

E.@JP1IM_DISPLAY_MESSAGE

Changed display message

Display Message

E.@JP1IM_CHANGE_MESSAGE

New display message

New Message

E.@JP1IM_CHANGE_MESSAGE_NAME

Display message change definition

Message change definition name

E.xxxxxxx#1

Item name#2

Item name#3

Program-specific extended attributes count

Number of program-specific extended attributes#4

Program-specific extended attributes count

Program-specific extended attributes

Program-specific extended attribute

Program-specific extended attribute

#1: The name of the attribute specified in the definition file for extended event attributes (extended file) will be output.

#2: The Japanese name of the item specified in the definition file for extended event attributes (extended file) will be output.

#3: The English name of the item specified in the definition file for extended event attributes (extended file) will be output.

#4: The total number of program-specific extended attributes that are not specified in the definition file for extended event attributes (extended file) will be output.

-user

Specifies that an event report on the JP1 events registered in the integrated monitoring database is to be output.

The -user option is optional.

If you omit all of the -user, -sys, -save, and -showsv options, the output of event report function is assumed.

-sys

Specifies that maintenance information on the JP1 events registered in the integrated monitoring database is to be output.

-save

Specifies that all JP1 events in the integrated monitoring database that have not been output and saved are to be output and saved.

-showsv

The following items are output.

Display item

Description

Percentage of the events that have not been output

The percentage of the JP1 events in the integrated monitoring database that have not been saved and output (percentage representing the ratio between the events that have not been output and the maximum number of records in the integrated monitoring database) is displayed.

Size of the events that have not been output

The data size of the JP1 events in the integrated monitoring database that have not been saved and output is displayed in megabytes.

The displayed size is the data size in the integrated monitoring database. For CSV output, capacity equivalent to the displayed size of the events that were not output × 1.2 is required.

Deletion warning notification level setting

The value set for the deletion warning notification is displayed.

If deletion warning notification is disabled, a hyphen (-) is displayed.

Return values

0

Normal termination

1

Invalid option or argument

2

Invalid filter

3

Invalid item file

4

Report output processing error

5

Execution permission error (Windows only)

6

Concurrent execution error

7

Serial number of the output file has reached the maximum value

101

Integrated monitoring database has not been set up

102

IM database service is not running

103

Error occurred in the connection with the IM database service

254

Memory shortage occurred

255

System error

Notes

Before executing the command in Windows, in case of existing the Application Experience service, make sure that the startup type of the Application Experience service is not set to Disabled.

Example 1

Output to a report the events that arrived at the manager from 2008/06/01 12:00:00 to 2009/01/01/00:00:00:

jcoevtreport -s 20080601120000 -e 20090101000000 -user

Example 2

Set report_xxx.csv as the output destination and output an event report on the JP1 events dated from 2009/07/08 08:45:00 to 2009/07/14 17:15:00:

jcoevtreport -s 20090708084500 -e 20090714171500 -o report

Example 3

Set report_xxx.csv as the output destination and output maintenance information on the JP1 events dated from 2009/07/08 08:45:00 to 2009/07/14 17:15:00:

jcoevtreport -sys -s 20090708084500 -e 20090714171500 -o report

Example 4

Set report_xxx.csv as the output destination and perform output-and-save:

jcoevtreport -save -o report

Example 5

Displays the output-and-save status:

jcoevtreport -showsv

jcofuncfcheck (Windows only)

Function

This command checks for definition errors in the definition files for executing applications and the definition file for the Tool Launcher window in a specified directory, and then outputs the analysis results to standard output.

The analysis results are output in the following formats:

Function tree definition

tree-hierarchy "displayed-character-string" [,"execution-command-path"]

Function toolbar definition

row = column

"displayed-character-string"[,"execution-command-path"]

Note:

The Function toolbar definition heading and information are displayed only when one of the following directories is specified as the Tool Launcher window definition directory:

View-path\conf\function\ja

View-path\conf\function\en

The analysis results contain the application execution definition identifier defined in the system ("default_browser" indicating the default Web browser definition used in Central Console) and the Tool Launcher window identifier ("root" indicating the highest node of the menu tree).

Format

jcofuncfcheck application-execution-definition-directory-name
              Tool-Launcher-window-definition-directory-name

Execution permission

None

Storage directory

View-path\bin\

Arguments

application-execution-definition-directory-name

Specifies the directory containing the definition files for executing applications that are to be checked, expressed as an absolute path or a path relative to the current directory. This cannot be a file name.

Tool-Launcher-window-definition-directory-name

Specifies the directory containing the definition file for the Tool Launcher window that is to be checked, expressed as an absolute path or a path relative to the current directory. This cannot be a file name.

Example

Execute the command on the following definition files:

Definition file for executing applications

@file type="application-execution-definition", version="0300";
@define-block type="application-execution-def";
id="notepad";
path="C:\winnt\system32\notepad.exe";
@define-block-end;
@define-block type="application-execution-def";
id="dmp";
path="[\HKEY_LOCAL_MACHINE\SOFTWARE\HITACHI\NETM/DM/P\0521/A\PathName\Path00]\bin\DMPSTS.exe";
@define-block-end;

Definition file for the Tool Launcher window

@file type="function-definition", version="0300";
@define-block type="function-tree-def";
id="node1";
parent_id="root";
name="Node 1";
@define-block-end;
@define-block type="function-tree-def";
id="node11";
parent_id="node1";
name="Node 11";
icon="%JCO_INSTALL_PATH%\image\1206.gif";
execute_id="default_browser";
args="http://";
@define-block-end;
@define-block type="function-tree-def";
id="node2";
parent_id="root";
name="Node 2";
icon="%JCO_INSTALL_PATH%\image\1206.gif";
execute_id="notepad";
@define-block-end;
@define-block type="function-tree-def";
id="node3";
parent_id="root";
name="Node 3";
icon="%JCO_INSTALL_PATH%\image\1206.gif";
execute_id="dmp";
@define-block-end;

The analysis results are output as follows:

Function tree definition
  "Integrated Management"
   "Node-1"
     "Node 11","C:\Program Files\Netscape\Communicator\Program\netscape.exe"
     "Node 2","C:\winnt\system32\notepad.exe"
     "Node 3","C:\NETMDMP\bin\DMPSTS.exe"
Function toolbar definition
  row=1
   "Node 11","C:\Program Files\Netscape\Communicator\Program\netscape.exe"
   "Node 2","C:\winnt\system32\notepad.exe"

jcogencore

Function

With the exception of the Central Scope Service (jcsmain), the Intelligent Integrated Management Base Service (jddmain), these commands outputs dumps in the event of a JP1/IM - Manager process failure. After executing the jcogencore command, you must restart JP1/IM - Manager.

The jcogencore command is not a command for regular use. Execute it if a hang-up occurs in a process or if you are instructed to do so in the course of investigation by support.

To detect failures, use the health check function of JP1/IM - Manager (for details about the health check function, see 8.2 JP1/IM - Manager health check function in the JP1/Integrated Management 2 - Manager Overview and System Design Guide).

When you execute the jcogencore command, it displays a message asking you to choose the processes for which failure data is to be output. Select the processes that have failed. The following table shows the files that are output when the jcogencore command is executed.

Table 1‒34: Files that are output

OS

Process name

Name of output file

Java thread dump

Core dump

Windows

evflow

javacore-process-ID.XXXXXXXXXX.txt

--

jcamain

--

--

evtcon#1

javacore-process-IDID.XXXXXXXXXX.txt

--

evgen#1, #2

javacore-process-ID.XXXXXXXXXX.txt

--

jcfmain

javacore-process-ID.XXXXXXXXXX.txt

--

UNIX

evflow

javacore-process-ID.XXXXXXXXXX.txt

core.evflow

jcamain

--

core.jcamain

evtcon#1

javacore-process-ID.XXXXXXXXXX.txt

core.java

evgen#1, #2

javacore-process-ID.XXXXXXXXXX.txt

core.evgen

jcfmain

javacore-process-ID.XXXXXXXXXX.txt

core.jcfmain

core.process-ID.jcfallogtrap

Legend:

XXXXXXXXXX: Unique ID assigned automatically by the OS

--: Not output

#1

evtcon and evgen are function names.

#2

This function name is used when the integrated monitoring database is not used.

The output files are stored in the following folders:

When the process name is not jcfmain

In Windows:

Physical host: Console-path\log\

Logical host: shared-disk\jp1cons\log\

In UNIX:

Physical host: /var/opt/jp1cons/log/

Logical host: shared-disk/jp1cons/log/

When the process name is jcfmain

In Windows:

Physical host: Manager-path\log\imcf\

Logical host: shared-disk\jp1imm\log\imcf\

In UNIX:

Physical host: /var/opt/jp1imm/log/imcf

Logical host: shared-disk/jp1imm/log/imcf

In addition to the thread and core dumps that are output, other failure data can be obtained by using the data collection tool.

Once you have executed this command, you must restart JP1/IM - Manager.

In Windows:

Physical host: After the command has executed, stop JP1/IM - Manager Service by choosing Control Panel, Administrative Tools, Services, and JP1/IM-Manager Service, and then restart JP1/IM - Manager. After JP1/IM - Manager has restarted, use the jco_spmd_status command to check the process statuses.

Logical host: After the command has executed, stop the JP1/IM-Manager_logical-host-name service by choosing Control Panel, Administrative Tools, and Services, and then restart JP1/IM - Manager. If you use cluster software to monitor the JP1/IM-Manager_logical-host-name service, use the cluster software to either restart the service or trigger failover.

In UNIX:

Physical host: After the command has executed, the selected processes are terminated forcibly. Use the jco_stop command to terminate all processes and then restart the processes with the jco_start command. After the processes have restarted, use the jco_spmd_status command to check the process statuses.

Logical host: After the command has executed, the selected processes are forcibly terminated. Use the jco_stop.cluster command to terminate all processes and then restart the processes with the jco_start.cluster command. If you use cluster software to monitor JP1/IM - Manager, use the cluster software to either restart the service or trigger failover.

Format

jcogencore [-h logical-host-name]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. The command outputs the thread or core dump of the JP1/IM - Manager processes at the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

Notes

When you execute the jcogencore command in UNIX, the processes are terminated forcibly after the dump has been output. Execute this command only in the event of process hang-up. You can use health checking to detect process hang-ups.

Take precautions when you execute the jcogencore command during cluster system operation.

Before you execute this command in UNIX, first check the available disk space on your machine. If you output a core dump for five processes (jcfmain excluded), the total size of the core dump might be as much as 8,419 megabytes.

In addition, if you output a core dump for jcfmain, the total size of the core dump might be as much as of 560 + 230 × number-of-jcfallogtrap-processes megabytes.

If multiple processes have failed, execute the following commands in the order at which they are listed:

In Windows: Event Console Service (evtcon), Event Base Service (evflow)

In UNIX: Event Console Service (evtcon), Automatic Action Service (jcamain), Event Base Service (evflow)

You can execute the command on the correlation event generation function (evgen) and the IM configuration management service (jcfmain) in any order because there are no dependencies with other processes.

In UNIX, the jcogencore command might not generate core dump files if the operating system is configured to block core dump files from being generated.

For details about the settings for core dump files, see 2.17.5 Specifying settings for handling JP1/IM - Manager failures (for UNIX) in the JP1/Integrated Management 2 - Manager Configuration Guide.

Return values

0

Normal termination

1

Option or argument analysis error

2

Process check error

3

Logical host error

4

Execution permission error (Windows only)

5

Pipe creation error (Windows only)

6

Thread dump output processing error

10

Other error

Example 1

Execute the command because a hang-up occurred in the Event Console Service (evtcon) process on the physical host in Windows:

jcogencore

Example 2

Execute the command because a hang-up occurred in the Event Console Service (evtcon) process on the logical host hostA in Windows:

jcogencore -h hostA

Example 3

Execute the command because a hang-up occurred in the Event Console Service (evtcon) process on the physical host in UNIX:

/opt/jp1cons/bin/jcogencore

Example output

When a hang-up occurred in the Event Console Service (evtcon) process on the physical host in UNIX, and core and thread dumps were output:

     ProcessName    PID
[1] : evflow        1234
[2] : jcamain       94320
[3] : evtcon        3333
[4] : evgen         65654
[6] : jcfmain       3316
[7] : Exit
KAVB8427-I When outputting dumps for the three processes evflow, jcamain, and evtcon at the same time, output the dumps in order of evtcon, jcamain, and evflow.
KAVB8417-I Please enter a number for the process to output the core dump file [1-7]:3
KAVB8414-I The thread dump output request has been sent.
KAVB8407-I When the core dump is output, evtcon will stop. Is this OK? (y/n):y
KAVB8406-I The core dump file will be output.
KAVB8416-I The core dump file has been output.

jcohctest

Function

This command tests the health check definition file (jcohc.conf) that is used by the health check function of JP1/IM - Manager to determine whether the specified definitions will execute correctly. You can test the notification command on the basis of the health check definition file.

The jcohctest command can be executed only when JP1/IM - Manager is running.

If you have made changes to the health check definition file (jcohc.conf), you cannot execute the jcohctest command unless you have first applied the new settings in the health check definition file by means of a method such as executing the jco_spmd_reload command.

During testing by the jcohctest command, the variables specified in the health check definition file (HCHOST, HCFUNC, HCPNAME, HCPID, HCDATE, and HCTIME) are displayed as shown below.

Table 1‒35: Values displayed during execution of the jcohctest command

Variable name

Value displayed during execution of the jcohctest command

HCHOST

Physical host name or logical host name specified in the -h option

HCFUNC

evflow

HCPNAME

evflow

HCPID

Process ID of evflow

HCDATE

Notification command execution date (YYYY/MM/DD)

HCTIME

Notification command execution time (hh:mm:ss)

For details about the health check definition file (jcohc.conf), see Health check definition file (jcohc.conf) in Chapter 2. Definition Files.

Format

jcohctest [-h logical-host-name]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. The command tests the notification command that is set in the health check definition file for the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

Return values

0

Normal termination

1

Argument error

2

Logical host does not exist

3

Notification command execution failure

7

Execution permission error (Windows only)

10

Other error

jcoimdef

Function

This command sets up a system environment for JP1/IM - Manager or references settings.

When this command is executed, the settings are output to standard output.

For details about the setting values that are enabled by setting the -i option, see the description for the -i option.

Format

jcoimdef  [-r {EXE | OUTPUT | OFF}]
          [-b event-acquisition-location]
          [-s {ON | OFF}]
          [-egs {ON | OFF}]
          [-rulehost host-name]
          [-ruleuser user-name]
          [-rule {ON | OFF}]
          [-resevent {ON | OFF}]
          [-e retry-interval]
          [-t timeout-period]
          [-c retry-count:retry-interval]
          [-o retry-count:retry-interval]
          [-i]
          [-h logical-host-name]
          [-memo {ON | OFF}]
          [-chsev {ON | OFF}]
          [-db {ON | OFF}]
          [-dbntc {ON | OFF}]
          [-dbntcpos deletion-warning-notification-level]
          [-cf {ON | OFF}]
          [-cmdbtn {ON | OFF}]
          [-hostmap {ON | OFF}]
          [-bizmonmode {ON | OFF}]
          [-ignorecasehost {ON | OFF}]
          [-storm {ON | OFF}]
          [-dd {ON | OFF}]

The -resevent option is used for linking with BJEX or JP1/AS. For details about the -resevent option, see 10.5.1 jcoimdef in the JP1/Integrated Management 2 - Manager Administration Guide.

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

No arguments specified

Specifies that a list of current settings is to be displayed at standard output.

The display format is as follows:

setting-item-name=setting

The figure below shows the information that is output by this command when the default values are used. You can change the settings for the items by specifying arguments.

Figure 1‒1: jcoimdef command output format

-r {EXE | OUTPUT | OFF}

This option is used for setting Automatic Action Service. For the option, specify the operation of an action whose status is any of the following when Automatic Action Service starts:

Wait

Wait (being canceled)

Wait (cancellation failed)

Sending

Sending (being canceled)

Sending (cancellation failed)

Queuing

Queuing (being canceled)

Queuing (cancellation failed)

Running

Running (being canceled)

Running (cancellation failed)

When EXE is specified, actions whose status is any of the above are re-executed. When the status of such an action is displayed in the Action Log window (or by executing the jcashowa command), the displayed status name contains -R.

OUTPUT: Outputs a list of actions whose status is any of the above to the action re-execution file (actreaction).

When the status of such an action is displayed (by a method such as executing the jcashowa command or in the Action Log window), Ended -R is displayed as the status.

As many sets of the following information items are output as there are actions in the action re-execution file:

### date#Δtime#Δevent-IDΔserial-number ###[linefeed]

[u=execution-user-name][e=environment-variable-file-name][d=execution-host-name]

execution-command[linefeed]

#: Date and time the re-execution function was executed.

OFF: Performs no processing for actions whose status is any of the above and leaves the action as is.

-b event-acquisition-start-position

Specifies the position at which event acquisition is to start when JP1/IM - Manager starts. The permitted value is from -1 to 144.

If you specify -1, processing continues from the status existing the last time JP1/IM - Manager was terminated. The default is that -1 is set.

For example, if -1 is specified, JP1/IM - Manager has received events through serial number 12000, events with serial numbers from 10001 to 12000 (2,000 events) have been stored in the event buffer, and JP1/IM - Manager is restarted, the following takes place:

Event buffer of JP1/IM - Manager:

The events that were in the event buffer the last time JP1/IM - Manager was terminated (events with serial numbers from 10001 to 12000) are stored in the event buffer again.

Automated action:

Automated action is performed on the events starting with the event (serial number 12001) that immediately follows the event with serial number 12000. The automated action processing involves matching events with action definitions.

If you specify 0, acquisition processing starts from the first event that is registered after JP1/IM - Manager starts.

Event buffer of JP1/IM - Manager:

The events that are registered in the event database after the start are stored in the event buffer.

Automated action:

The events that are registered in the event database after the start are subject to automated action processing.

If you specify a value in the range from 1 to 144, the command acquires the events from the event database starting with the event that was registered at the specified number of hours before JP1/IM - Manager started.

This value is in units of hours. For example, to collect events starting from an event that was registered 1 hour before JP1/IM - Manager startup, specify 1.

Event buffer of JP1/IM - Manager:

The events that have been registered in the event database at the manager since the specified number of hours before the startup are stored in the event buffer.

Automated action:

The events that have been registered in the event database at the manager since the specified number of hours before the startup are subject to automated action processing.

Note that an event that has already been processed by an automated action is no longer subject to automated action processing. In other words, action matching is performed only once per event.

In all cases, the events that are transmitted to Central Scope Service are the same as for the automated actions.

-s {ON | OFF}

Specifies whether Central Scope Service is to be started and whether events are to be transmitted to Central Scope Service.

If you specify ON, Central Scope Service starts when JP1/IM - Manager starts and events are transmitted to Central Scope Service. Also, in the Event Console window, the Central Scope button and menu are enabled.

If you specify OFF, events cannot be set to be transmitted to Central Scope Service because Central Scope Service is not started when JP1/IM - Manager starts. In this case, the Central Scope button and menu are disabled in the Event Console window. The default is OFF.

To enable the -s setting, you must also restart the connected JP1/IM - View.

-egs {ON | OFF}

Specifies whether the correlation event generation function is to be enabled.

If you specify ON, the following occurs when JP1/IM - Manager starts:

If the integrated monitoring database is not used, the Event Generation Service is started.

If the integrated monitoring database is used, the correlation event generation function of Event Base Service is enabled.

If you specify OFF, the following occurs when JP1/IM - Manager starts:

If the integrated monitoring database is not used, the Event Generation Service is not started.

If the integrated monitoring database is used, the correlation event generation function of Event Base Service is disabled.

The default is OFF.

-rulehost host-name

Specifies the host name of the linked JP1/IM - Rule Operation. This must be a host name that was set as a managed host in the system configuration definition. Express the host name using from 1 to 255 ASCII characters excluding the space, tab, and control characters. A host group cannot be specified. If you specify "" as the host name, the null character (none) is set, in which case the host executing the command is assumed.

-ruleuser user-name

Specifies the name of the JP1 user who is to execute the linked JP1/IM - Rule Operation. Express the user name using from 1 to 31 ASCII characters excluding the space, tab, and control characters and the following special characters: * " ' / \ [ ] { } ( ) : ; | = , + ? < >. If you specify "" as the user name, the null character (none) is set, in which case the user is assumed based on the following priority:

The JP1 user specified with ACTIONEXECUSER of the common definition information in the automated action environment definition file (action.conf.update)

jp1admin

-rule {ON | OFF}

Specifies whether the items for JP1/IM - Rule Operation linkage are to be displayed in JP1/IM - View.

If you specify ON, the function for displaying the items for JP1/IM - Rule Operation linkage in JP1/IM - View is enabled when JP1/IM - Manager starts.

If you specify OFF, the function for displaying the items for JP1/IM - Rule Operation linkage in JP1/IM - View is disabled when JP1/IM - Manager starts. The default is OFF.

To enable the -rule setting, you must also restart the connected JP1/IM - View.

-resevent {ON | OFF}

Specifies whether to enable the response-waiting event management function.

If you specify ON, the response function for JP1/IM - Manager events is enabled.

If you specify OFF, the response function for JP1/IM - Manager events is disabled. The default is OFF. The value set for this command takes effect when JP1/IM - Manager has been restarted, in which case you must also restart the connected JP1/IM - View. You cannot use the -i option or the jco_spmd_reload command to enable or disable the response-waiting event management function.

-e retry-interval

Specifies the interval at which connection establishment with the event service is to be retried automatically when a connection establishment attempt fails or connection is lost while the event service is acquiring events from Event Base Service. The permitted value is from 1 to 86,400 (seconds). This is a setting for Event Base Service.

-t timeout-period

Specifies the timeout period for retry processing when event transmission from Event Base Service to Central Scope Service or Event Console Service fails and automatic transmission is retried. The permitted value is from 1 to 3,600 (seconds). When Event Base Service issues a transmission request to Central Scope Service or Event Console Service and there is no response within the time specified in this option, Event Base Service stops event transmission to that control. This is a setting for Event Base Service.

-c retry-count:retry-interval

Specifies a retry count and a retry interval at which connection establishment is to be retried automatically if an attempt to establish connection with Central Scope Service or Event Console Service, fails or if connection is lost when events are transmitted from Event Base Service to Central Scope Service or Event Console Service. The permitted retry count is from 0 to 100, and the permitted retry interval is from 0 to 3600 (seconds). This is a setting for Event Base Service.

-o retry-count:retry-interval

Specifies a retry count and a retry interval at which events are to be transmitted automatically when event transmission from Event Base Service to Central Scope Service or Event Console Service fails. The permitted retry count is from 0 to 100, and the permitted retry interval is from 0 to 3600 (seconds). This is a setting for Event Base Service.

-i

Specifies that the values of the specified options are to be enabled. When this option is specified, the values set in the options specified in this command are loaded into Event Base Service and the Automatic Action Service and those values take effect.

The following options can be applied immediately by using the -i option:

-rulehost

-ruleuser

-e

-t

-c

-o

-memo

-cmdbtn

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. The command sets up the system environment of JP1/IM - Manager at the specified logical host or references the settings for the specified logical host. However, the local host inherits the system environment from the physical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-memo {ON | OFF}

Specifies whether the memo entry setting function is to be used.

If the integrated monitoring database is enabled and ON is specified in this option, the memo entry setting function is enabled. If OFF is specified, the memo entry setting function is disabled. If the integrated monitoring database is disabled, specifying ON in this option will not enable the memo entry setting function. The default is OFF.

-chsev {ON | OFF}

Specifies whether the severity changing function is to be used.

If the integrated monitoring database is enabled and ON is specified in this option, the severity changing function is enabled. If OFF is specified, the severity changing function is disabled. If the integrated monitoring database is disabled, specifying ON in this option will not enable the severity changing function. The default is OFF.

-db {ON | OFF}

Specifies whether the event storage function is to be used.

ON: Enable the event storage function; events can be stored in the integrated monitoring database.

OFF: Disable the event storage function; events cannot be not stored in the integrated monitoring database.

If the integrated monitoring database is disabled, specifying ON in this option will not enable the event storage function. The default is OFF.

If you want to specify ON, you must set up the integrated monitoring database.

If you start JP1/IM - Manager when the integrated monitoring database has not been set up, or when the IM database service is not running, Event Base Services outputs a message to the integrated trace log, and terminates abnormally.

-dbntc {ON | OFF}

Specifies whether a deletion warning notification event is to be issued when the number of JP1 events (expressed as the percentage of the maximum number of records in the integrated monitoring database) in the integrated monitoring database on which output-and-save has not been performed exceeds the deletion warning notification level.

ON: Issue a deletion warning notification event when the ratio of JP1 events in the integrated monitoring database on which output-and-save has not been performed exceeds the deletion warning notification level.

OFF: Do not issue a deletion warning notification event even if the ratio of JP1 events in the integrated monitoring database on which output-and-save has not been performed exceeds the deletion warning notification level. The default is OFF.

If the integrated monitoring database is disabled, specifying ON in this option will not result in issuance of a deletion warning notification event if the ratio of JP1 events in the integrated monitoring database on which output-and-save has not been performed has exceeded the deletion warning notification level.

-dbntcpos deletion-warning-notification-level

Specifies the number of JP1 events (expressed as the percentage of the maximum number of records in the integrated monitoring database) in the integrated monitoring database on which output-and-save has not been performed that is to trigger issuance of a deletion warning notification event.

The permitted value range is from 20 to 80 (%). The default is 80.

For example, if you specify -dbntcpos 70, the deletion warning notification level is set to 70%.

-cf {ON | OFF}

Specifies whether IM Configuration Management Service is to be started.

ON: Start IM Configuration Management Service when JP1/IM - Manager starts.

OFF: Do not start IM Configuration Management Service when JP1/IM - Manager starts. The default is OFF.

If you specify ON, make sure that IM Configuration Management has already been set up.

If you start JP1/IM - Manager when IM Configuration Management has not been set up or the IM database service has not started, Event Base Services outputs a message to the integrated trace log, and terminates abnormally.

-cmdbtn {ON | OFF}

Specifies whether to enable the command button in the Execute Command window.

ON: Enables the command button. When enabled, the command button is displayed in the Execute Command window. By default, ON is set.

OFF: Disables the command button. When disabled, the command button is not displayed in the Execute Command window.

-hostmap {ON | OFF}

Specifies whether to enable mapping on the event source host.

ON: Enables mapping on the event source host.

OFF: Disables mapping on the event source host. By default, OFF is set.

If the integrated monitoring database is disabled, mapping on the event source host will be disabled even when ON is specified.

-bizmonmode {ON | OFF}

Specifies whether to enable restrictions on referencing and operations by business groups.

ON: Enables restrictions on referencing and operations by business groups.

OFF: Disables restrictions on referencing and operations by business groups. By default, OFF is set.

If the integrated monitoring database, the IM Configuration Management service, or mapping on the event source host is disabled, restrictions on referencing and operations by business groups will be disabled even when ON is specified.

-ignorecasehost {ON | OFF}

Specifies whether to distinguish letter case when event conditions related to a host name are compared.

ON: Letter case is ignored. However, if regular expressions are used in the comparison keyword, uppercase and lowercase are distinguished.

OFF: Letter case is distinguished. By default, OFF is set.

The following table describes the correspondence between functions and attributes for which the case of a host name is ignored when this option is enabled.

Table 1‒36: Correspondence between functions and event conditions

Function

Attribute (event condition)

Filtering using the severe event(s) filter

Event-issuing server name (registered host name) (B.SOURCESERVER)

Event source host name (E.JP1_SOURCEHOST)

Event search

When search object is the integrated monitoring database

Event-issuing server name (registered host name) (B.SOURCESERVER)

Target event server name (B.DESTSERVER)

Event source host name (E.JP1_SOURCEHOST)

When the search object is the event database

Not supported

Filtering using the event acquisition filter (extended-mode common exclusion-conditions)

Event-issuing server name (registered host name) (B.SOURCESERVER)

Event source host name (E.JP1_SOURCEHOST)

Filtering using the view filter

Event-issuing server name (registered host name) (B.SOURCESERVER)

Event source host name (E.JP1_SOURCEHOST)

Filtering using the user filter

Event-issuing server name (registered host name) (B.SOURCESERVER)

Event source host name (E.JP1_SOURCEHOST)

Automated action

Event-issuing server name (registered host name) (B.SOURCESERVER)

Event source host name (E.JP1_SOURCEHOST)

Repeated event monitoring suppression

Event-issuing server name (registered host name) (B.SOURCESERVER)

Target event server name (B.DESTSERVER)

Event source host name (E.JP1_SOURCEHOST)

Consolidated display of repeated events

Event conditions cannot be specified, but the -ignorecasehost option settings is applied.

Generating a correlation event

Event-issuing server name (registered host name) (B.SOURCESERVER)

Target event server name (B.DESTSERVER)

Event source host name (E.JP1_SOURCEHOST)

Changing the severity

Event-issuing server name (registered host name) (B.SOURCESERVER)

Target event server name (B.DESTSERVER)

Event source host name (E.JP1_SOURCEHOST)

Changing the display format of the message

Event-issuing server name (registered host name) (B.SOURCESERVER)

Target event server name (B.DESTSERVER)

Event source host name (E.JP1_SOURCEHOST)

Outputting an event report

Event-issuing server name (registered host name) (B.SOURCESERVER)

Target event server name (B.DESTSERVER)

Event source host name (E.JP1_SOURCEHOST)

Event source host mapping

Event-issuing server name (registered host name) (B.SOURCESERVER)

Target event server name (B.DESTSERVER)

Event source host name (E.JP1_SOURCEHOST)

-storm {ON | OFF}

Specifies whether to enable the repeated event monitoring suppression function.

ON: Enables the repeated event monitoring suppression function.

OFF: Disables the repeated event monitoring suppression function. The default is OFF.

If you specify ON when the integrated monitoring database is disabled, the repeated event monitoring function is disabled.

-dd {ON | OFF}

Specifies whether to start the Intelligent Integrated Management Base.

ON: Starts the Intelligent Integrated Management Base when JP1/IM - Manager starts.

OFF: Does not start the Intelligent Integrated Management Base when JP1/IM - Manager starts. The default is OFF.

If you specify ON, you must set up the integrated monitoring database in advance. You also must enable the event-source-host mapping.

If JP1/IM - Manager is started when the integrated monitoring database is not set up, the event-source-host mapping is disabled, or the IM database service is not running, the Intelligent Integrated Management Base terminates abnormally and outputs messages to the integrated trace log.

Return values

0

Normal termination

1

Abnormal termination

7

Execution permission error (Windows only)

When definition enabled

Option

Trigger event

Restarting of JP1/IM - Manage

Execution of the jco_spmd_reload command

-i option specified

-r

Y

--

--

-b

Y

--

--

-s

Y#

--

--

-egs

Y

--

--

-rulehost

Y

Y

Y

-ruleuser

Y

Y

Y

-rule

Y#

--

--

-resevent

Y#

--

--

-e

Y

Y

Y

-t

Y

Y

Y

-c

Y

Y

Y

-o

Y

Y

Y

-memo

Y#

Y#

Y#

-chsev

Y#

--

--

-db

Y#

--

--

-dbntc

Y

Y

--

-dbntcpos

Y

Y

--

-cf

Y

--

--

-cmdbtn

Y

--

Y#

-hostmap

Y#

--

--

-bizmonmode

Y#

--

--

-ignorecasehost

Y#

--

--

-storm

Y#

--

--

-dd

Y

--

--

Legend:

Y: Enabled

--: Not applicable

#

The JP1/IM - View instance being connected must be restarted.

jcomonitorfcheck

Function

This command checks the definition file for opening monitor windows.

When this command is executed, it checks a specified definition file for opening monitor windows for any definition errors and then outputs the analysis results to standard output. Error information, such as definition errors, is output to standard error.

An analysis result is output for each event ID in the following format:

product-name, event-ID

start-version, end-version

[subkey-name, attribute-name-used-as-key

[attribute-value-used-as-key, interface-name]]

[interface-name, application-execution-definition-identifier,

command-argument, replacement-event-attribute]

If there is only one version specification, such as 0600, the same value is output for both the start version and the end version. Similarly, if ALL is specified, ALL is displayed for both the start version and the end version.

If SUBKEY is set in the DEF_KEY key definition, the contents of the subkey are displayed. SUBKEY is duplicated if it is also used in another DEF_KEY key definition.

This command does not check whether the application execution definition identifier is defined in the definition file for executing applications.

Format

jcomonitorfcheck monitor-window-opening-definition-directory-name

Execution permission

In Windows: Administrator permissions (If the Windows UAC feature is enabled, the command must be executed from the administrator console.)

In UNIX: None

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

monitor-window-opening-definition-directory-name

Specifies the name of the monitor window opening definition directory, expressed as an absolute path or a path relative to the current directory.

Example

Execute the command for the following definition file:

DESC_VERSION=0300
# Monitor window transition definition file for AJS-View
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004102 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004103 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004104 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004105 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004106 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004107 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004108 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004109 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004120 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004121 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004122 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004123 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004124 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=00004125 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=000041A7 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=000041A8 INTERFACE=AJS2_MONITOR
DEF_KEY PRODUCT_NAME=/HITACHI/JP1/AJS2 EVENT_ID=000041A9 INTERFACE=AJS2_MONITOR

DEF_MTR_CALL NAME=AJS2_MONITOR EXEC_ID=jco_JP1_AJS2 PATH="-j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%" PARAM=B.SOURCESERVER,E.A0,E.A1,E.A3

The analysis results are as follows:

/HITACHI/JP1/AJS2, 41a9
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4109
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 41a8
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4108
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 41a7
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4107
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4106
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4125
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4105
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4124
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4104
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4123
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4103
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4122
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4102
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4121
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3
/HITACHI/JP1/AJS2, 4120
 ALL, ALL
   AJS2_MONITOR, jco_JP1_AJS2, -j %IM_EVC_PARAMETER_1%::%IM_EVC_PARAMETER_2%/%IM_EVC_PARAMETER_3% -t %JCO_JP1TOKEN% -v monitor -l %IM_EVC_PARAMETER_4%, B.SOURCESERVER, E.A0, E.A1, E.A3

jcothreaddmp (Windows only)

Function

This command outputs a thread dump in the event of a JP1/IM - View failure.

A thread dump output by the jcothreaddmp command is stored in the following folder:

View-path\log\

You can use the data collection tool to collect other failure data in addition to the output thread dump.

Format

jcothreaddmp process-ID

Execution permission

None

Storage directory

View-path\bin\

Arguments

process-ID

Specifies the process ID of the java.exe process of the disabled JP1/IM - View. You can specify only one process ID. It is not permissible to omit the process ID or to specify multiple process IDs.

If you are running multiple instances of JP1/IM - View, you must determine the process ID of the JP1/IM - View that can no longer be controlled by the Windows Task Manager.

In Windows Task Manager, JP1/IM - View is displayed as java.exe. If another java program is running at the same time, that program is also displayed as java.exe, making it difficult to distinguish between the programs. For details about how to identify the process ID of JP1/IM - View, see 11.4.1(2) Outputting a thread dump for JP1/IM in the JP1/Integrated Management 2 - Manager Administration Guide.

Notes

If the jcothreaddmp command is executed on a JP1/IM - View that is running normally, operation of JP1/IM - View may become unstable. In such a case, restart JP1/IM - View.

Return values

0

Normal termination

1

Option analysis error

2

Process checking error

3

Thread dump output request transmission error

10

Other error

jcovcfsetup (Windows only)

Function

This command registers into or deletes from the Windows Start menu the menu item for starting IM Configuration Management - View. Note that when IM Configuration Management - View is installed, it is not registered into the Windows Start menu.

This command works only when executed in the command prompt invoked from Run as Administrator.

Format

jcovcfsetup [-i | -u]

Execution permission

Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

Storage directory

View-path\bin\

Arguments

If no options are specified, the command executes in the same manner as when the -i option is specified.

-i

Specifies that the menu for starting IM Configuration Management - View is to be registered into the Windows Start menu.

-u

Specifies that the menu for starting IM Configuration Management - View is to be removed from the Windows Start menu.

Note that if you have manually changed the menu name or its storage location, the command cannot remove the menu. In such a case, you must remove the menu manually.

Notes

The maximum length of the command arguments (in bytes) depends on the OS. Specify the command arguments within the limitation of the applicable OS.

Return values

0

Normal termination

1

Abnormal termination

Example 1

Add Configuration Management to the menu of JP1/IM - View:

jcovcfsetup or jcovcfsetup -i

Example 2

Remove Configuration Management from the menu of JP1/IM - View:

jcovcfsetup -u

jcoview (Windows only)

Function

This command opens a JP1/IM - View window.

The window to be opened depends on the option specifications, as shown below:

Starting the Login window for JP1/IM - View

When any option other than -p or -e is specified or no option is specified, the Login window opens.

-c option is specified: The Central Console check box is selected in the Login window.

-s option is specified: The Central Scope check box is selected in the Login window.

-h option is specified: A value is entered in Host to connect in the Login window.

-u option is specified: A value is entered in User name in the Login window.

Opening the Event Console window and the Monitoring Tree window of JP1/IM - View

When the -h, -u, or -p option is specified, the Event Console window and the Monitoring Tree window open. To open the Event Console window and the Monitoring Tree window, you must specify the -h, -u, or -p option.

-c option is specified: The Event Console window opens.

-s option is specified: The Monitoring Tree window opens.

Neither the -c nor the -s option is specified: The Event Console window opens.

Opening the Monitoring Tree (Editing) window of JP1/IM - View

When the -e option is specified, the Monitoring Tree (Editing) window opens.

Format

jcoview [[[-c] [-s]]
         [-h connection-target-host-name] [-u user-name] [-p password]
         | -e]

Execution permission

None

Storage directory

View-path\bin\

Arguments

-c

Specifies that the Event Console window is to open.

If the password (-p option) is omitted, the Login window opens with the Central Console check box selected. This option cannot be specified together with the -e option.

This option is optional.

If the -h, -u, and -p options are specified and none of the -c, -s, and -e options is specified, the command assumes that the -c option is specified.

-s

Specifies that the Monitoring Tree window is to open.

If the password (-p option) is omitted, the Login window opens with the Central Scope check box selected. This option cannot be specified together with the -e option.

This option is optional.

-h connection-target-host-name

Specifies the name of the connection-target host. For the host name, from 1 to 255 bytes of characters are permitted. You can specify only a host where JP1/IM - Manager is running.

For the connection-target host name, you can specify the following:

Host name defined on the host where the command is used

Host name whose address can be resolved on the host where the command is used

IP address

Only addresses in IPv4 address format can be specified. Addresses in IPv6 address format cannot be specified.

This option is optional, but if you specify the -p option, you must also specify this option.

-u user-name

Specifies the name of a JP1 user that has been registered in the authentication server. For the JP1 user name, from 1 to 31 alphanumeric characters are permitted (for alphabetic characters, only lowercase letters are permitted).

This option is optional, but if you specify the -p option, you must also specify this option.

-p password

Specifies the specified user's password. For the password, from 6 to 32 alphanumeric characters are permitted. Alphabetic characters are case sensitive.

If you specify this option, you must also specify the -h and -u options.

This option is optional.

-e

Specifies that the Monitoring Tree (Editing) window is to open.

When you specify this option, you must not specify any other options.

This option is optional.

Important

If you attempt to start JP1/IM - View by executing the jcoview command with an incorrect argument specified, the login window appears after either of the following messages is output:

- KAVB0104-E Failed to authenticate the user.

- KAVB1210-E A communication error occurred while establishing a connection.

Cannot convert the host name into an IP address. Confirm the host name.

Host name: <host-name>, Port number: <port-number>

Details: <detail-information>

In the login window displayed in this status, you may be unable to select the input fields even with the mouse to enter information in them. If this problem occurs, click the taskbar button for a program other than JP1/IM - View, and then click the login window.

If the program jcoview.exe is executed from a command prompt where the code page is set to a value other than 932, the characters displayed on the screen might be garbled.

If the program jcoview.exe is executed from a command prompt where the code page is set to a value other than 936, the characters displayed on the screen might be garbled.

Return values

0

Normal termination

1

Argument error

2

Insufficient memory

3

Resource acquisition failed

4

Error message creation failed

255

System error

Example 1

Start JP1/IM - View and open the Login window:

jcoview

Example 2

Start JP1/IM - View and display the Login window with host set in Host to connect and jp1admin set in User name:

jcoview -h host -u jp1admin

Example 3

Start JP1/IM - View, log in by specifying jp1admin as the user name, jp1admin as the password, and host as the connection-target host, and then open the Event Console window:

jcoview -h host -u jp1admin -p jp1admin

Example 4

Start JP1/IM - View, log in by specifying jp1admin as the user name, jp1admin as the password, and host as the connection-target host, and then open the Monitoring Tree window:

jcoview -s -h host -u jp1admin -p jp1admin

Example 5

Start JP1/IM - View, log in by specifying jp1admin as the user name, jp1admin as the password, and host as the connection-target host, and then open the Event Console window and the Monitoring Tree window:

jcoview -c -s -h host -u jp1admin -p jp1admin

Example 6

Start JP1/IM - View and open the Monitoring Tree (Editing) window:

jcoview -e

Example 7

You can create a command shortcut, such as for Examples 2 and 3, for each host and each user.

jcoview_log.bat (Windows only)

Function

This command is a tool for collecting data in the event of a JP1/IM - View failure. The data collected by this tool includes JP1/IM - View maintenance data, OS system information, and integrated trace logs. If JP1/IM - Manager and JP1/Base are installed on the same machine, data from JP1/IM - Manager and JP1/Base is also collected.

This tool constitutes a batch file, which cannot be customized by the user.

When you execute this tool, the target folders or files used for data collection are classified into primary and secondary data categories and the collected data is stored directly under a specified data storage folder.

The primary data, which consists of a minimum amount of logs and settings files, is collected for purposes such as identifying failures and investigating minor errors. The secondary data consists of the Windows event log, and provides the detailed information needed to investigate failures in depth.

If you execute jcoview_log.bat during a thread dump of JP1/IM - View, the tool displays the KAVB8946-I message asking whether the thread dump is to be deleted. If you enter y, the tool deletes the thread dump.

If necessary, compress the collected data by using a program such as a compression tool.

For details about the data that can be collected by this tool, see 11.3 Data that needs to be collected when a problem occurs in the JP1/Integrated Management 2 - Manager Administration Guide.

The following tables show the organization of the folders directly under the data storage folder and the details of the data that is stored.

Table 1‒37: Organization of the internal folders for the primary data

Folder name

Stored data

data-storage-folder\jp1_default\imm_1st\coview

JP1/IM - View patch information

data-storage-folder\jp1_default\imm_1st\coview\conf

JP1/IM - View settings and definition files

data-storage-folder\jp1_default\imm_1st\coview\default

Common definition information for JP1/IM - View

data-storage-folder\jp1_default\imm_1st\coview\log

Log files for JP1/IM - View

data-storage-folder\jp1_default\imm_1st\oslog

OS log information

data-storage-folder\jp1_default\imm_1st\spool

Integrated trace logs (32-bit)

data-storage-folder\jp1_default\imm_1st\spoolx64

Integrated trace logs (64-bit)

Table 1‒38: Organization of the internal folders for the secondary data

Folder name

Stored data

data-storage-folder\jp1_default\imm_2nd\oslog

Windows event log

Format

jcoview_log.bat -f data-storage-folder
               [-t]
               [-q]

Execution permission

Administrator permissions (If the Windows UAC feature is enabled, the command must be executed from the administrator console.)

Storage directory

View-path\tools\

Arguments

-f data-storage-folder

Specifies the name of the folder to which the collected data is to be output, expressed as a full path or a path relative to the location where the command is executed. If the path contains a space, enclose the entire path in double-quotation marks ("). This option is mandatory.

If a nonexistent folder is specified, a new folder with that name is created. If an existing folder is specified, the contents of that folder are deleted and then the specified folder is created.

-t

Specifies that the hosts and services files are not to be collected.

-q

Specifies that the command is to be executed without requesting confirmation from the user.

Notes

If you wish to collect JP1/IM - View data at the same host as for JP1/IM - Manager, use the jim_log.bat command.

Do not execute this tool more than once. If it is executed multiple times, collected data may be overwritten or data collection may fail.

If a file to be collected cannot be found, the tool may display a message such as The file was not found; however, no action is necessary.

Return values

0

Normal termination

8

Abnormal termination

Example

Collect data in the F:\tmp\bat folder:

jcoview_log.bat -f F:\tmp\bat

The output results are as follows:

KAVB8925-I The directory does not exist. ("F:\tmp\bat")
           The directory will be created.
Press any key to continue...
KAVB8925-I The directory does not exist. ("F:\tmp\bat\jp1_default\imm_1st")
           The directory will be created.
Press any key to continue...
KAVB8925-I The directory does not exist. ("F:\tmp\bat\jp1_default\imm_2nd")
           The directory will be created.
Press any key to continue...
KAVB8926-I Data acquisition processing will start.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetConfInfo.exe" command will start.
KAVB8921-I The information for JP1/IM - View will be acquired.
KAVB8922-I The information for JP1/IM - View has been acquired.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetConfInfo.exe" execution is ended. (ERRORLEVEL=0)
KAVB8929-I The system information will be acquired. Please wait.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetMsInfo.exe" command will start.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetMsInfo.exe" execution is ended. (ERRORLEVEL=0)
KAVB8922-I The system information has been acquired.
KAVB8929-I "Watson log and crash dump" will be acquired. Please wait.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetWtsnInfo.exe" command will start.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetWtsnInfo.exe" execution is ended. (ERRORLEVEL=0)
KAVB8922-I "Watson log and crash dump" has been acquired.
KAVB8921-I Windows Eventlog(Application) will be acquired.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetEvLog.exe" command will start.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetEvLog.exe" execution is ended. (ERRORLEVEL=0)
KAVB8922-I Windows Eventlog(Application) has been acquired.
KAVB8921-I Windows Eventlog(System) will be acquired.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetEvLog.exe" command will start.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetEvLog.exe" execution is ended. (ERRORLEVEL=0)
KAVB8922-I Windows Eventlog(System) has been acquired.
KAVB8921-I The setup.ini of JP1/IM - Manager will be acquired.
KAVB8922-I The setup.ini of JP1/IM - Manager has been acquired.
KAVB8921-I The setup.ilg of JP1/IM - Manager will be acquired.
KAVB8922-I The setup.ilg of JP1/IM - Manager has been acquired.
KAVB8921-I The setup.ini of JP1/Base will be acquired.
KAVB8922-I The setup.ini of JP1/Base has been acquired.
KAVB8921-I The setup.ilg of JP1/Base will be acquired.
KAVB8922-I The setup.ilg of JP1/Base has been acquired.
KAVB8921-I The setup.ini of JP1/IM - View will be acquired.
KAVB8922-I The setup.ini of JP1/IM - View has been acquired.
KAVB8921-I The setup.ilg of JP1/IM - View will be acquired.
KAVB8922-I The setup.ilg of JP1/IM - View has been acquired.
KAVB8921-I The integrated trace log will be acquired.
KAVB8922-I The integrated trace log has been acquired.
KAVB8921-I The integrated installer log will be acquired.
KAVB8922-I The integrated installer log has been acquired.
KAVB8921-I The installer log file will be acquired.
KAVB8922-I The installer log has been acquired.
KAVB8921-I The hosts will be acquired.
KAVB8922-I The hosts has been acquired.
KAVB8921-I The services will be acquired.
KAVB8922-I The services has been acquired.
KAVB8921-I The registry information will be acquired.
KAVB8922-I The registry information has been acquired.
KAVB8921-I The netstat information will be acquired.
KAVB8922-I The netstat information has been acquired.
KAVB8921-I The ipconfig information will be acquired.
KAVB8922-I The ipconfig information has been acquired.
KAVB8921-I The net start information will be acquired.
KAVB8922-I The net start information has been acquired.
KAVB8921-I The set information will be acquired.
KAVB8922-I The set information has been acquired.
KAVB8918-I The data was successfully acquired.

jcschstat

Function

This command changes the status of monitoring nodes (monitoring objects or monitoring groups). It also clears the logs of status change events at the monitoring nodes. It cannot change the monitoring status of monitoring nodes.

You can include this command in batch processing in order to automatically initialize the status of monitoring nodes as the last processing step of error recovery, or you can use this command to automatically initialize the status of monitoring nodes after eliminating the cause of an error by linking with the help desk system.

You can use this command when the Central Scope functions are enabled.

If you execute this command while JP1/IM - Manager (Central Scope) is already processing 32 or more command requests, communication is lost at the server end, which causes this command to fail.

Format

jcschstat [-h logical-host-name]
          -n monitoring-node-ID-1, monitoring-node-ID-2, monitoring-node-ID-3...
          [-s status-value]
          [-i]
          [-t timeout-period]
          [-d]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Scope-path\bin\

In UNIX:

/opt/jp1scope/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-n monitoring-node-ID-1, monitoring-node-ID-2, monitoring-node-ID-3...

Specifies the IDs of the monitoring nodes (monitoring object IDs or monitoring group IDs) whose status is to be changed, expressed in hexadecimal notation.

You can specify a maximum of 10 monitoring node IDs. When you specify multiple IDs, separate them with the comma (,). The monitoring nodes are processed in the order in which they are specified.

-s status-value

Specifies the new status for the specified monitoring nodes. The status value is case sensitive. For monitoring objects, you can specify Emergency, Alert, Critical, Error, Warning, Normal, Debug, or Initial. For monitoring groups, you can specify only Initial.

When the status of a specified monitoring node changes, the status is propagated to the higher nodes and the lower nodes are initialized.

If this option is omitted, Initial is assumed.

-i

Specifies that a confirmation message is to be displayed when the status of a monitoring node is to be changed.

-t timeout-period

Specifies a timeout period for communication with the server. The permitted value is from 1 to 32,767 (seconds). The default is 1,800 seconds (30 minutes).

-d

Specifies that command processing is to be canceled and the command is to be terminated with an error if a monitoring node specified in the -n option does not exist or if a monitoring node status change fails.

If this option is omitted, the command skips processing on any monitoring node that does not exist or on which status change processing fails, and then processes the next monitoring node.

Return values

0

Normal termination

1

Logical host name was not found

2

Argument error

4

No permission to execute the command

12

Insufficient memory

32

Data access error

33

Specified monitoring tree ID or monitoring node ID was not found in the database

37

No response from the server (connection establishment request failed)

38

Communication with the server failed (the server was terminated during communication or the server's connection count exceeded the maximum value)

39

A timeout occurred (after a request was sent to the server, the timeout period was exceeded before a response was received)

40

An invalid response was sent from the server

42

Another command or request is being processed

43

A monitoring node for which not monitor is set is specified in -n

44

A monitoring group is specified in -n

99

Other error

Example

Change the status of monitoring node ID 8 to Error:

jcschstat -n 8 -s Error

Example output

jcschstat -n 5 -s Normal
KAVB7630-I The status of the monitoring node (5) has been set to Normal.

jcsdbexport

Function

This command acquires monitoring object database storage information and outputs it locally to a file as a configuration file for monitoring tree. The information that is output to the file includes monitoring tree configuration information, common event monitoring conditions, and Visual Monitoring window configuration information.

You can use this command to store multiple generations of storage information in the monitoring object database. To copy the storage information in the monitoring object database to another server, execute this command and then use the jcsdbimport command to copy the storage information to the monitoring object database of the other server.

You can use this command when the Central Scope functions are enabled.

If you execute this command while updating data for Central Scope Service, the command terminates with an error. For example, if you execute this command while updating the server's tree from the Monitoring Tree (Editing) window or while changing the status of a monitoring node with the jcschstat command, the command terminates with an error.

A configuration file for monitoring tree that was output by JP1/IM - Manager version 08-10 or later cannot be imported by JP1/IM - Manager version 08-01 or earlier.

Format

jcsdbexport [-h logical-host-name]
            -o file-name
            [-t timeout-period]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Scope-path\bin\

In UNIX:

/opt/jp1scope/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-o file-name

Specifies the full path of the file to which tree configuration information is to be output. The file name must end with .dat. If the path contains a space, enclose the entire path in double-quotation marks (").

-t timeout-period

Specifies the timeout period for communication with the server. The permitted value is from 10 to 32,767 (seconds). The default is 1,800 seconds (30 minutes).

Return values

0

Normal termination

1

Logical host name was not found

2

Argument error

3

Specified file is invalid

4

No permission to execute the command

6

No permission to access the specified file

12

Insufficient memory

13

Insufficient disk capacity

31

Database initialization failed at the server

32

Database access failed at the server

33

Specified monitoring tree ID or monitoring node ID was not found in the database

37

No response from the server (connection establishment request failed)

38

Communication with the server failed (the server was terminated during communication or the server's connection count exceeded the maximum value)

39

A timeout occurred (after a request was sent to the server, the timeout period was exceeded before a response was received)

40

An invalid response was sent from the server

42

Another command or request is being processed

99

Other error

Example

Output monitoring object database storage information to c:\temp\output.dat:

jcsdbexport -o c:\temp\output.dat

Example output

KAVB7670-I Exporting of the monitoring tree definition to the file c:\temp\output.dat was successful.

jcsdbimport

Function

This command applies monitoring object database storage information that was output by the jcsdbexport command (monitoring tree configuration information, common event monitoring conditions, and Visual Monitoring window configuration information) to the monitoring object database of JP1/IM - Manager.

Use this command together with the jcsdbexport command to migrate JP1/IM - Manager monitoring object database storage information to another server.

You can use this command when the Central Scope functions are enabled.

If you execute this command while updating data for Central Scope Service, the command terminates with an error. For example, if you execute this command while updating the server's tree from the Monitoring Tree (Editing) window or while changing the status of a monitoring node with the jcschstat command, the command terminates with an error.

Format

jcsdbimport [-h logical-host-name]
            -o file-name
            [-t timeout-period]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Scope-path\bin\

In UNIX:

/opt/jp1scope/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-o file-name

Specifies the full path of a file that was output by the jcsdbexport command and that is to be applied to the monitoring object database of JP1/IM - Manager. The file name must end with .dat. If the path contains a space, enclose the entire path in double-quotation marks (").

-t timeout-period

Specifies the timeout period for communication with the server. The permitted value is from 10 to 32,767 (seconds). The default is 1,800 seconds (30 minutes).

Notes

Importing information with the jcsdbimport command initializes the status of the monitoring tree.

Return values

0

Normal termination

1

Logical host name was not found

2

Argument error

3

Specified file is invalid

4

No permission to execute the command

6

No permission to access the specified file

12

Insufficient memory

31

Database initialization failed at the server

32

Database access failed at the server

34

Format error in the configuration file for monitoring tree

37

No response from the server (connection establishment request failed)

38

Communication with the server failed (the server was terminated during communication or the server's connection count exceeded the maximum value)

39

A timeout occurred (after a request was sent to the server, the timeout period was exceeded before a response was received)

40

Invalid response was sent from the server

41

Specified input file was not found

42

Another command or request is being processed

48

The file is not compatible with the file version specified by the server

99

Other error

Example

Apply the file input.dat output by the jcsdbexport command to the monitoring object database of JP1/IM - Manager:

jcsdbimport -o input.dat

Example output

KAVB7660-I Importing of the monitoring tree definition from the file input.dat was successful.

jcsdbsetup

Function

This command creates a new ISAM file for storing the monitoring object database. When you execute this command, the existing monitoring object database is deleted and a new monitoring object database is created.

You must terminate JP1/IM - Manager before you can create a monitoring object database.

Make sure that you execute this command if you use any Central Scope functions.

Format

jcsdbsetup [-h logical-host-name]
           [-f]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Scope-path\bin\

In UNIX:

/opt/jp1scope/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

-f

You must specify this option when there is an existing monitoring object database (if this option is omitted in such a case, an error results). If there is no existing monitoring object database, you can omit this option.

When this option is specified and there is a monitoring object database, the command displays the confirmation message Database files are existed. Delete these files? [y/n]. Entering Y and then pressing the Enter key will cause the existing monitoring object database to be deleted and a new monitoring object database to be created. If there is no existing monitoring object database, the command will create a new monitoring object database without displaying the confirmation message.

Return values

0

Normal termination

1

Logical host name is invalid

2

Argument error

4

No permission to execute the command

10

Setup has not been completed

12

Insufficient memory

13

Insufficient disk capacity

20

Database already exists

42

Another command or request is running

99

Other error

jcshostsexport

Function

This command acquires host information from the host information database. When this command is executed, it loads host information from the host information database and stores it in a specified host information file (if no host information file name is specified, the host information is output to standard output).

You can use this command when the Central Scope functions are enabled.

Format

jcshostsexport [-h logical-host-name] > host-information-file-name

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Scope-path\bin\

In UNIX:

/opt/jp1scope/bin/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

host-information-file-name

Specifies the name of the file in which the host information is to be stored.

Return values

0

Normal termination

1

Logical host name is invalid

2

Argument error

4

No permission to execute the command

10

Setup has not been completed

11

There is no host information database

12

Insufficient memory

14

Host information database is corrupted

15

Message initialization failed

16

Host information database is in use

99

Other error

jcshostsimport

Function

This command registers host information into and deletes host information from the host information database. You can apply the host information while JP1/IM - Manager is running by executing the jco_spmd_reload command after this command has executed. While JP1/IM - Manager is stopped, you can apply the host information by starting JP1/IM - Manager.

You can use this command when the Central Scope functions are enabled.

Format

jcshostsimport { { -o | -r } host-information-file-name | -d}
               [-h logical-host-name]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Scope-path\bin\

In UNIX:

/opt/jp1scope/bin/

Arguments

-r host-information-file-name

Specifies the name of the file that contains the host information that is to be registered into the host information database. When the -r option is specified, the command deletes all host information from the existing host information database and then registers the specified host information into the database.

For details about the format of the host information file, see Host information file (jcs_hosts) in Chapter 2. Definition Files.

-o host-information-file-name

Specifies the name of the file that contains the host information that is to be registered into the host information database. When the -o option is specified, the command adds to the host information database the host information contained in the host information file without deleting the existing host information from the database (if an identical IP address exists, the information for that host is overwritten).

For details about the format of the host information file, see Host information file (jcs_hosts) in Chapter 2. Definition Files.

-d

Specifies that all the existing host information is to be completely deleted from the host information database.

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.

Return values

0

Normal termination

1

Logical host name is invalid

2

Argument error

3

File name is invalid

4

No permission to execute the command

5

Syntax error in the specified host information file

6

No permission to access the specified host information file

10

Setup has not been completed

11

There is no host information database

12

Insufficient memory

13

Insufficient disk capacity

14

Host information database is corrupted

15

Message initialization failed

16

Host information database is in use

99

Other error

jim_log.bat (Windows only)

Function

This is a tool for collecting data in the event of a failure in JP1/IM - Manager or JP1/IM - View. The data collected by this tool includes maintenance information for JP1/IM - Manager, JP1/IM - View, and JP1/Base, system information from the OS, and integrated trace logs.

This tool is a batch file, which cannot be customized by the user.

When you execute this tool, the target folders or files used for data collection are classified into primary and secondary data categories and the collected data is stored directly under the specified data storage folder.

The primary data is collected for such purposes as identifying a failure and investigating the causes of minor failures. It consists of the minimum amount of logs and settings files. The secondary data provides the detailed information needed for an in-depth investigation of a failure. It consists of such data as the Windows event log and the JP1/Base event database.

If you execute jim_log.bat while a thread dump of JP1/IM - Manager (Central Console) or JP1/IM - View is available, the tool displays the KAVB8946-I message asking whether you want to delete the thread dump. If you enter y, the tool deletes the thread dump.

If necessary, use a program such as a compression tool to compress the collected data.

For details about the data that can be collected by this tool, see 11.3 Data that needs to be collected when a problem occurs in the JP1/Integrated Management 2 - Manager Administration Guide.

The following tables show the organization of folders directly under the data storage folder and the data that is stored.

Table 1‒39: Organization of the internal folders for the primary data of the physical host

Folder name

Stored data

data-storage-folder\jp1_default\imm_1st\imm

Data storage folder for JP1/IM - Manager

JP1/IM - Manager patch information

data-storage-folder\jp1_default\imm_1st\imm\conf

JP1/IM - Manager settings and definition files

data-storage-folder\jp1_default\imm_1st\imm\log

Log files for JP1/IM - Manager

data-storage-folder\jp1_default\imm_1st\cons

Data storage folder for JP1/IM - Manager (Central Console)

data-storage-folder\jp1_default\imm_1st\cons\conf

JP1/IM - Manager (Central Console) settings and definition files

data-storage-folder\jp1_default\imm_1st\cons\default

Common definition information for JP1/IM - Manager (Central Console)

data-storage-folder\jp1_default\imm_1st\cons\log

Log files for JP1/IM - Manager (Central Console)

data-storage-folder\jp1_default\imm_1st\scope

Data storage folder for JP1/IM - Manager (Central Scope)

data-storage-folder\jp1_default\imm_1st\scope\conf

JP1/IM - Manager (Central Scope) settings and definition files

data-storage-folder\jp1_default\imm_1st\scope\default

Common definition information for JP1/IM - Manager (Central Scope)

data-storage-folder\jp1_default\imm_1st\scope\log

Log files for JP1/IM - Manager (Central Scope)

data-storage-folder\jp1_default\imm_1st\coview

Data storage folder for JP1/IM - View

JP1/IM - View patch information

data-storage-folder\jp1_default\imm_1st\coview\conf

JP1/IM - View settings and definition files

data-storage-folder\jp1_default\imm_1st\coview\default

Common definition information for JP1/IM - View

data-storage-folder\jp1_default\imm_1st\coview\log

Log files for JP1/IM - View

data-storage-folder\jp1_default\imm_1st\imm\Patchlog_jp1imm.txt

JP1/IM - Manager patch information

data-storage-folder\jp1_default\imm_1st\imm\conf\tools

JP1/IM - Manager settings and definition files

data-storage-folder\jp1_default\imm_1st\imm\log\operationlog

JP1/IM - Manager operation log

data-storage-folder\jp1_default\imm_1st\imcf\conf\imcf

IM Configuration Management settings and definition files

data-storage-folder\jp1_default\imm_1st\imdb\conf\imdb

IM database settings and definition files

data-storage-folder\jp1_default\imm_1st\imcf\system\default\new\imcf

Common definition information for IM Configuration Management

data-storage-folder\jp1_default\imm_1st\imdb\database\imdb

Detailed log information for the IM database

data-storage-folder\jp1_default\imm_1st\imcf\log\imcf

Log files for IM Configuration Management

data-storage-folder\jp1_default\imm_1st\imdb\log\imdb

Log files for the IM database

data-storage-folder\jp1_default\imm_1st\base

Data storage folder for JP1/Base

JP1/Base patch information

data-storage-folder\jp1_default\imm_1st\base\conf

JP1/Base settings and definition files

data-storage-folder\jp1_default\imm_1st\base\default

Common definition information for JP1/Base

data-storage-folder\jp1_default\imm_1st\base\log

Log files for JP1/Base

data-storage-folder\jp1_default\imm_1st\base\plugin\conf

Settings file for JP1/Base plug-in services

data-storage-folder\jp1_default\imm_1st\base\sys\tmp

Logs and temporary files for JP1/Base

data-storage-folder\jp1_default\imm_1st\oslog

OS log information

data-storage-folder\jp1_default\imm_1st\spool

Integrated trace logs (32-bit)

data-storage-folder\jp1_default\imm_1st\spoolx64

Integrated trace logs (64-bit)

data-storage-folder\jp1_default\imm_1st\imdd

Data storage folder for JP1/IM - Manager (Intelligent Integrated Management Base)

data-storage-folder\jp1_default\imm_1st\imdd\conf

Settings and definition files for JP1/IM - Manager (Intelligent Integrated Management Base)

data-storage-folder\jp1_default\imm_1st\imdd\log

Log files for JP1/IM - Manager (Intelligent Integrated Management Base)

data-storage-folder\jp1_default\imm_1st\imdd\plugin

Plug-in for JP1/IM - Manager (Intelligent Integrated Management Base)

Table 1‒40: Organization of the internal folders for the secondary data of the physical host

Folder name

Stored data

data-storage-folder\jp1_default\imm_2nd\cons

Data storage folder for JP1/IM - Manager (Central Console)

data-storage-folder\jp1_default\imm_2nd\cons\operation\evgen

Correlation event generation history files for JP1/IM - Manager (Central Console)

data-storage-folder\jp1_default\imm_2nd\cons\operation\comexclude

Common exclusion history file and common exclusion-conditions definition history file for JP1/IM - Manager (Central Console)

data-storage-folder\jp1_default\imm_2nd\scope

Data storage folder for JP1/IM - Manager (Central Scope)

data-storage-folder\jp1_default\imm_2nd\scope\database

Database information for JP1/IM - Manager (Central Scope)

data-storage-folder\jp1_default\imm_2nd\base

Data storage folder for JP1/Base

data-storage-folder\jp1_default\imm_2nd\base\log\COMMAND

Command execution log files for JP1/Base

data-storage-folder\jp1_default\imm_2nd\base\sys\event\servers\default

Event database for JP1/Base

data-storage-folder\jp1_default\imm_2nd\oslog

Windows event log

data-storage-folder\jp1_default\imm_2nd\imcf\data\imcf

Data files for IM Configuration Management

data-storage-folder\jp1_default\imm_2nd\imdb\database\imdb\imdbbackup.dat

Windows event log

Backup files of the IM database

data-storage-folder\jp1_default\imm_2nd\imdd\data\imdd

Data files for JP1/IM - Manager (Intelligent Integrated Management Base)

Table 1‒41: Organization of the internal folders for the primary data of the logical host

Folder name

Stored data

data-storage-folder\logical-host-name\imm_1st\cons

Data storage folder for the logical host of JP1/IM - Manager (Central Console)

data-storage-folder\logical-host-name\imm_1st\cons\conf

Logical host settings and definition files for JP1/IM - Manager (Central Console)

data-storage-folder\logical-host-name\imm_1st\cons\log

Log files for the logical host of JP1/IM - Manager (Central Console)

data-storage-folder\logical-host-name\imm_1st\scope

Data storage folder for the logical host of JP1/IM - Manager (Central Scope)

data-storage-folder\logical-host-name\imm_1st\scope\conf

Logical host settings and definition files for JP1/IM - Manager (Central Scope)

data-storage-folder\logical-host-name\imm_1st\scope\log

Log files for the logical host of JP1/IM - Manager (Central Scope)

data-storage-folder\logical-host-name\imm_1st\base

Data storage folder for the logical host of JP1/Base

data-storage-folder\logical-host-name\imm_1st\base\conf

Logical host name settings and definition files for JP1/Base

data-storage-folder\logical-host-name\imm_1st\base\event

Event server settings for the logical host of JP1/Base

data-storage-folder\logical-host-name\imm_1st\base\log

Log files for the logical host of JP1/Base

data-storage-folder\logical-host-name\imm_1st\oslog

OS log information

data-storage-folder\logical-host-name\imm_1st\imm\Patchlog_jp1imm.txt

JP1/IM - Manager patch information

data-storage-folder\logical-host-name\imm_1st\imm\log\operationlog

JP1/IM - Manager operation log

data-storage-folder\logical-host-name\imm_1st\imcf\conf\imcf

IM Configuration Management settings and definition files

data-storage-folder\logical-host-name\imm_1st\imdb\database\imdb

Detailed log information for the IM database

data-storage-folder\logical-host-name\imm_1st\imcf\log\imcf

Log files for IM Configuration Management

data-storage-folder\logical-host-name\imm_1st\imdb\log\imdb

Log files for the IM database

data-storage-folder\logical-host-name\imm_1st\imdd

Data storage folder for JP1/IM - Manager (Intelligent Integrated Management Base)

data-storage-folder\logical-host-name\imm_1st\imdd\conf

Settings and definition files for JP1/IM - Manager (Intelligent Integrated Management Base)

data-storage-folder\logical-host-name\imm_1st\imdd\log

Log files for JP1/IM - Manager (Intelligent Integrated Management Base)

data-storage-folder\logical-host-name\imm_1st\imdd\plugin

Plug-in for JP1/IM - Manager (Intelligent Integrated Management Base)

Table 1‒42: Organization of the internal folders for the secondary data of the logical host

Folder name

Stored data

data-storage-folder\logical-host-name\imm_2nd\cons

Data storage folder for the logical host of JP1/IM - Manager (Central Console)

data-storage-folder\logical-host-name\imm_2nd\cons\operation\evgen

Correlation event generation history file for the logical host of JP1/IM - Manager (Central Console)

data-storage-folder\logical-host-name\imm_2nd\cons\operation\comexclude

Common exclusion history file and common exclusion-conditions definition history file for the logical host of JP1/IM - Manager (Central Console)

data-storage-folder\logical-host-name\imm_2nd\scope

Data storage folder for the logical host of JP1/IM - Manager (Central Scope)

data-storage-folder\logical-host-name\imm_2nd\scope\database

Database information for the logical host of JP1/IM - Manager (Central Scope)

data-storage-folder\logical-host-name\imm_2nd\base

Data storage folder for the logical host of JP1/Base

data-storage-folder\logical-host-name\imm_2nd\base\log\COMMAND

Command execution log files for the logical host of JP1/Base

data-storage-folder\logical-host-name\imm_2nd\base\event

Event database for the logical host of JP1/Base

data-storage-folder\logical-host-name\imm_2nd\imcf\data\imcf

Data files for IM Configuration Management

data-storage-folder\logical-host-name\imm_2nd\imdb\database\imdb\imdbbackup.dat

Backup files of the IM database

data-storage-folder\logical-host-name\imm_2nd\imdd\data\imdd

Data files for the logical host of JP1/IM - Manager (Intelligent Integrated Management Base)

Format

jim_log.bat -f data-storage-folder
            [-h logical-host-name]
            [-t]
            [-n]
            [-p]
            [-r]
            [-g]
            [-a]
            [-s]
            [-c]
            [-d]
            [-x]
            [-w]
            [-q]
            [-b]

The -a option is used for linking with BJEX or JP1/AS. For details about the -a option, see 10.5.2 jim_log.bat (Windows only) in the JP1/Integrated Management 2 - Manager Administration Guide.

Execution permission

Administrator permissions (If the Windows UAC feature is enabled, the command must be executed from the administrator console.)

Storage directory

Manager-path\tools\

Arguments

-f data-storage-folder

Specifies the name of the folder to which the collected data is to be output, expressed as a full path or a path relative to the location where the command is executed. If the path contains a space, enclose the entire path in double-quotation marks ("). This option is mandatory.

If a nonexistent folder is specified, a new folder with the specified name is created. If an existing folder is specified, the contents of that existing folder are deleted and the specified folder is created.

-h logical-host-name

When you are operating in a cluster system, this option specifies a logical host name and that the command is to collect data for that logical host as well as for the physical host. If this option is omitted, the command collects data for the physical host only. If you are not using a cluster system, there is no need to specify this option.

Note that this command will not use the logical host name that is set in the JP1_HOSTNAME environment variable. Therefore, if you use this command in a cluster system, make sure that you specify the logical host name in this option.

-t

Specifies that the hosts and services files are not to be collected.

-n

Specifies that maintenance data for JP1/Base is not to be collected.

-p

Specifies that the event database for JP1/Base is not to be collected.

-r

Specifies that the command execution log files for JP1/Base are not to be collected.

-g

Specifies that the correlation event generation history file is not to be collected.

-a

Specifies that the file for accumulated response-waiting events is not to be collected.

-s

Specifies that maintenance data for JP1/IM - Manager (Central Scope) is not to be collected.

-c

Specifies that maintenance data for IM Configuration Management is not to be collected.

-d

Specifies that maintenance data for the IM database is not to be collected.

This argument cannot be specified together with the -x option.

-x

Specifies that IM database backup files are to be collected.

This argument cannot be specified together with the -d option.

The IM database backup files are not included in the maintenance data for the IM database that is collected by default. If the IM database service is not running, the maintenance data is not collected; in such a case, start the IM database service and then re-execute the data collection command. The backup files can be collected even when JP1/IM - Manager is running.

-w

Specifies that maintenance data for JP1/IM - View is not to be collected.

-q

Specifies that the command is to be executed without requesting confirmation from the user.

-b

Specifies that maintenance data for Intelligent Integrated Management Base is not to be collected.

Notes

This tool might collect a large amount of data. Before you execute this tool, you need to estimate the amount of disk space required and then check the capacity available on your machine. For details, see 11.4 Collecting data in the JP1/Integrated Management 2 - Manager Administration Guide.

Do not execute this tool more than once.

If a file to be collected is not found, the tool might display a message such as The file was not found. However, it is not necessary to take any action.

When you start JP1/Base or JP1/IM - Manager, it might display a message such as Sharing violation. However, it is not necessary to take any action.

When you run the tool to collect the data, it places a certain amount of load on the computer (on disk I/O and other resources).

If you send data to the support service without using this tool or send it with some of it excluded, detailed investigation may not be possible.

Return values

0

Normal termination

8

Abnormal termination

Example 1

Collect data for the physical host and for logical host hostA into the D:\temp folder:

jim_log.bat -f D:\temp -h hostA

The output result is as follows:

KAVB8925-I The directory does not exist. ("D:\temp\jp1_default\imm_1st")
           The directory will be created.
Press any key to continue...
KAVB8925-I The directory does not exist. ("D:\temp\jp1_default\imm_2nd")
           The directory will be created.
Press any key to continue...
KAVB8925-I The directory does not exist. ("D:\temp\hostA\imm_1st")
           The directory will be created.
Press any key to continue...
KAVB8925-I The directory does not exist. ("D:\temp\hostA\imm_2nd")
           The directory will be created.
Press any key to continue...
KAVB8926-I Data acquisition processing will start.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetConfInfo.exe" command will start.
KAVB8921-I The information for JP1/IM - Manager will be acquired.
KAVB8921-I The physical host information will be acquired.
KAVB8922-I The physical host information has been acquired.
KAVB8922-I The information for JP1/IM - Manager has been acquired.
KAVB8921-I The information for JP1/IM - Central Console will be acquired.
KAVB8921-I The physical host information will be acquired.
KAVB8922-I The physical host information has been acquired.
KAVB8921-I The logical host (hostA) information will be acquired.
KAVB8922-I The logical host (hostA) information has been acquired.
KAVB8922-I The information for JP1/IM - Central Console has been acquired.
KAVB8921-I The information for JP1/IM - Central Scope will be acquired.
KAVB8921-I The physical host information will be acquired.
KAVB8922-I The physical host information has been acquired.
KAVB8921-I The logical host (hostA) information will be acquired.
KAVB8922-I The logical host (hostA) information has been acquired.
KAVB8922-I The information for JP1/IM - Central Scope has been acquired.
KAVB8921-I The information for JP1/Base will be acquired.
KAVB8921-I The physical host information will be acquired.
KAVB8922-I The physical host information has been acquired.
KAVB8921-I The logical host (hostA) information will be acquired.
KAVB8922-I The logical host (hostA) information has been acquired.
KAVB8922-I The information for JP1/Base has been acquired.
KAVB8921-I The information for JP1/IM - View will be acquired.
KAVB8922-I The information for JP1/IM - View has been acquired.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetConfInfo.exe" execution is ended. (ERRORLEVEL=0)
KAVB8929-I The system information will be acquired. Please wait.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetMsInfo.exe" command will start.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetMsInfo.exe" execution is ended. (ERRORLEVEL=0)
KAVB8922-I The system information has been acquired.
KAVB8929-I "Watson log and crash dump" will be acquired. Please wait.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetWtsnInfo.exe" command will start.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetWtsnInfo.exe" execution is ended. (ERRORLEVEL=0)
KAVB8922-I "Watson log and crash dump" has been acquired.
KAVB8921-I Windows Eventlog(Application) will be acquired.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetEvLog.exe" command will start.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetEvLog.exe" execution is ended. (ERRORLEVEL=0)
KAVB8922-I Windows Eventlog(Application) has been acquired.
KAVB8921-I Windows Eventlog(System) will be acquired.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetEvLog.exe" command will start.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetEvLog.exe" execution is ended. (ERRORLEVEL=0)
KAVB8922-I Windows Eventlog(System) has been acquired.
KAVB8921-I The setup.ini of JP1/IM - Manager will be acquired.
KAVB8922-I The setup.ini of JP1/IM - Manager has been acquired.
KAVB8921-I The setup.ilg of JP1/IM - Manager will be acquired.
KAVB8922-I The setup.ilg of JP1/IM - Manager has been acquired.
KAVB8921-I The setup.ini of JP1/IM - View will be acquired.
KAVB8922-I The setup.ini of JP1/IM - View has been acquired.
KAVB8921-I The setup.ilg of JP1/IM - View will be acquired.
KAVB8922-I The setup.ilg of JP1/IM - View has been acquired.
KAVB8921-I The setup.ini of JP1/Base will be acquired.
KAVB8922-I The setup.ini of JP1/Base has been acquired.
KAVB8921-I The setup.ilg of JP1/Base will be acquired.
KAVB8922-I The setup.ilg of JP1/Base has been acquired.
KAVB8921-I The integrated trace log will be acquired.
KAVB8922-I The integrated trace log has been acquired.
KAVB8921-I The integrated installer log will be acquired.
KAVB8922-I The integrated installer log has been acquired.
KAVB8921-I The installer log file will be acquired.
KAVB8922-I The installer log file has been acquired.
KAVB8921-I The hosts will be acquired.
KAVB8922-I The hosts has been acquired.
KAVB8921-I The services will be acquired.
KAVB8922-I The services has been acquired.
KAVB8921-I The registry information will be acquired.
KAVB8922-I The registry information has been acquired.
KAVB8921-I The netstat information will be acquired.
KAVB8922-I The netstat information has been acquired.
KAVB8921-I The ipconfig information will be acquired.
KAVB8922-I The ipconfig information has been acquired.
KAVB8921-I The net start information will be acquired.
KAVB8922-I The net start information has been acquired.
KAVB8921-I The set information will be acquired.
KAVB8922-I The set information has been acquired.
KAVB8918-I The data was successfully acquired.

Example 2

Collect data for the physical host into the nonexistent folder D:\temp, but do not specify the existing logical host (hostA):

jim_log.bat -f D:\temp

The output result is as follows:

KAVB8925-I The directory does not exist. ("D:\temp")
           The directory will be created.
Press any key to continue...
KAVB8925-I The directory does not exist. ("D:\temp\jp1_default\imm_1st")
           The directory will be created.
Press any key to continue...
KAVB8925-I The directory does not exist. ("D:\temp\jp1_default\imm_2nd")
           The directory will be created.
Press any key to continue...
KAVB8926-I Data acquisition processing will start.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetConfInfo.exe" command will start.
KAVB8921-I The information for JP1/IM - Manager will be acquired.
KAVB8921-I The physical host information will be acquired.
KAVB8922-I The physical host information has been acquired.
KAVB8922-I The information for JP1/IM - Manager has been acquired.
KAVB8921-I The information for JP1/IM - Central Console will be acquired.
KAVB8921-I The physical host information will be acquired.
KAVB8922-I The physical host information has been acquired.
KAVB8922-I The information for JP1/IM - Central Console has been acquired.
KAVB8921-I The information for JP1/IM - Central Scope will be acquired.
KAVB8921-I The physical host information will be acquired.
KAVB8922-I The physical host information has been acquired.
KAVB8922-I The information for JP1/IM - Central Scope has been acquired.
KAVB8921-I The information for JP1/Base will be acquired.
KAVB8921-I The physical host information will be acquired.
KAVB8922-I The physical host information has been acquired.
KAVB8922-I The information for JP1/Base has been acquired.
KAVB8921-I The information for JP1/IM - View will be acquired.
KAVB8922-I The information for JP1/IM - View has been acquired.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetConfInfo.exe" execution is ended. (ERRORLEVEL=0)
KAVB8929-I The system information will be acquired. Please wait.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetMsInfo.exe" command will start.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetMsInfo.exe" execution is ended. (ERRORLEVEL=0)
KAVB8922-I The system information has been acquired.
KAVB8929-I "Watson log and crash dump" will be acquired. Please wait.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetWtsnInfo.exe" command will start.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetWtsnInfo.exe" execution is ended. (ERRORLEVEL=0)
KAVB8922-I "Watson log and crash dump" has been acquired.
KAVB8921-I Windows Eventlog(Application) will be acquired.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetEvLog.exe" command will start.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetEvLog.exe" execution is ended. (ERRORLEVEL=0)
KAVB8922-I Windows Eventlog(Application) has been acquired.
KAVB8921-I Windows Eventlog(System) will be acquired.
KAVB8927-I Execution of the "D:\Program Files\Hitachi\JP1IMM\bin\jimGetEvLog.exe" command will start.
KAVB8928-I "D:\Program Files\Hitachi\JP1IMM\bin\jimGetEvLog.exe" execution is ended. (ERRORLEVEL=0)
KAVB8922-I Windows Eventlog(System) has been acquired.
KAVB8921-I The setup.ini of JP1/IM - Manager will be acquired.
KAVB8922-I The setup.ini of JP1/IM - Manager has been acquired.
KAVB8921-I The setup.ilg of JP1/IM - Manager will be acquired.
KAVB8922-I The setup.ilg of JP1/IM - Manager has been acquired.
KAVB8921-I The setup.ini of JP1/IM - View will be acquired.
KAVB8922-I The setup.ini of JP1/IM - View has been acquired.
KAVB8921-I The setup.ilg of JP1/IM - View will be acquired.
KAVB8922-I The setup.ilg of JP1/IM - View has been acquired.
KAVB8921-I The setup.ini of JP1/Base will be acquired.
KAVB8922-I The setup.ini of JP1/Base has been acquired.
KAVB8921-I The setup.ilg of JP1/Base will be acquired.
KAVB8922-I The setup.ilg of JP1/Base has been acquired.
KAVB8921-I The integrated trace log will be acquired.
KAVB8922-I The integrated trace log has been acquired.
KAVB8921-I The integrated installer log will be acquired.
KAVB8922-I The integrated installer log has been acquired.
KAVB8921-I The installer log file will be acquired.
KAVB8922-I The installer log file has been acquired.
KAVB8921-I The hosts will be acquired.
KAVB8922-I The hosts has been acquired.
KAVB8921-I The services will be acquired.
KAVB8922-I The services has been acquired.
KAVB8921-I The registry information will be acquired.
KAVB8922-I The registry information has been acquired.
KAVB8921-I The netstat information will be acquired.
KAVB8922-I The netstat information has been acquired.
KAVB8921-I The ipconfig information will be acquired.
KAVB8922-I The ipconfig information has been acquired.
KAVB8921-I The net start information will be acquired.
KAVB8922-I The net start information has been acquired.
KAVB8921-I The set information will be acquired.
KAVB8922-I The set information has been acquired.
KAVB8918-I The data was successfully acquired.
KAVB8934-I The following logical host(s) exist on this machine:
hostA
To acquire information about a logical host, execute "jim_log.bat -f output-directory-name -h logical-hostname".
Press any key to continue...

jim_log.sh (UNIX only)

Function

This is a tool for collecting data in the event of a failure in JP1/IM - Manager. The data collected by this tool includes maintenance information for JP1/IM - Manager and JP1/Base, system information from the OS, and integrated trace logs.

This tool is a shell script, which cannot be customized by the user.

When you execute this tool, it classifies the target directories or files used for data collection into primary and secondary data categories, uses the tar command to archive the data directly under the specified data storage directory, and then uses the compress command to create compressed files.

The primary data is collected for such purposes as identifying a failure and investigating the causes of minor failures. It consists of the minimum amount of logs and settings files. The secondary data provides the detailed information needed for an in-depth investigation of a failure. It consists of such data as core analysis information and data from the JP1/Base event database.

If you execute the jim_log.sh command while a core dump and a thread dump of JP1/IM - Manager (Central Console) are available, the tool displays the KAVB8941-I and KAVB8942-I messages asking whether you want to delete the core dump or the thread dump. If you enter y or yes, the tool deletes the core dump or thread dump.

For details about the data that can be collected by this tool, see 11.3 Data that needs to be collected when a problem occurs in the JP1/Integrated Management 2 - Manager Administration Guide.

The following table lists and describes the compressed files containing the collected data.

Table 1‒43: Compressed files containing the collected data

File name

Description

jp1_default_imm_1st.tar.Z

Primary data for the physical host

jp1_default_imm_2nd.tar.Z

Secondary data for the physical host

logical-host-name_imm_1st.tar.Z#

Primary data for the logical host

logical-host-name_imm_2nd.tar.Z#

Secondary data for the logical host

#: Created only when a logical host was specified in the -h option.

The compressed files are stored in the data storage directory. The following tables show the organization of the internal directories for the compressed files.

Table 1‒44: Organization of the internal directories for the primary data of the physical host

Directory and file name

Stored data

./etc/opt/jp1base

Automated startup and stop scripts for JP1/Base

./etc/opt/jp1base/conf

JP1/Base settings and definition files

./etc/opt/jp1base/default

Common definition information for JP1/Base

./etc/opt/jp1cons

Automated startup and stop scripts for JP1/IM - Manager (Central Console)

./etc/opt/jp1cons/conf

JP1/IM - Manager (Central Console) settings and definition files

./etc/opt/jp1cons/default

Common definition information for JP1/IM - Manager (Central Console)

./etc/opt/jp1imm/conf/tools

JP1/IM - Manager settings and definition files

./etc/opt/jp1imm/conf/imcf

IM Configuration Management settings and definition files

./etc/opt/jp1imm/conf/imdb

IM database settings and definition files

./etc/opt/jp1imm/conf/imdd

Settings and definition files for JP1/IM - Manager (Intelligent Integrated Management Base)

./etc/opt/jp1imm/plugin

Plug - in for JP1/IM - Manager (Intelligent Integrated Management Base)

./etc/opt/jp1imm/default/imcf

Common definition information for IM Configuration Management

./etc/opt/jp1scope/conf

JP1/IM - Manager (Central Scope) settings and definition files

./etc/opt/jp1scope/default

Common definition information for JP1/IM - Manager (Central Scope)

./opt/jp1/hcclibcnf

Common definition information

./opt/jp1base

Patch application history and patch log information for JP1/Base

./opt/jp1base/conf

Settings file for JP1/Base plug-in services

./opt/jp1imm

Patch application history and patch log information for JP1/IM - Manager

./var/opt/jp1base/log

Log files for JP1/Base

./var/opt/jp1base/sys/tmp

Logs and temporary files for JP1/Base

./var/opt/hitachi/HNTRLib2/spool

Integrated trace logs

./var/opt/jp1cons/log

Log files for JP1/IM - Manager (Central Console)

./var/opt/jp1imm/database/imdb

Detailed log information for the IM database

./var/opt/jp1imm/log/imcf

Log files for IM Configuration Management

./var/opt/jp1imm/log/imdb

Log files for the IM database

./var/opt/jp1imm/log/imdd

Log files for JP1/IM - Manager (Intelligent Integrated Management Base)

./var/opt/jp1imm/log/_jp1_default/oslog

OS log information

./var/opt/jp1imm/log/_jp1_default/operationlog

JP1/IM - Manager operation log

./var/opt/jp1scope/log

Log files for JP1/IM - Manager (Central Scope)

Table 1‒45: Organization of the internal directories for the secondary data of the physical host

Directory and file name

Stored data

./var/opt/jp1base/log/COMMAND

Command execution log files for JP1/Base

./var/opt/jp1base/sys/event/servers/default

Event database for JP1/Base

./var/opt/jp1cons/operation/comexclude

Common exclusion history file and common exclusion-conditions definition history file for JP1/IM - Manager (Central Console)

./var/opt/jp1cons/operation/evgen

Correlation event generation history files for JP1/IM - Manager (Central Console)

./var/opt/jp1imm/log/_jp1_default/oslog

OS log information

./var/opt/jp1imm/log/_jp1_default/core

Core file

./var/opt/jp1scope/database

Database information for JP1/IM - Manager (Central Scope)

./var/opt/jp1imm/data/imcf

Data files for IM Configuration Management

./var/opt/jp1imm/database/imdb/imdbbackup.dat

Backup files of the IM database

./var/opt/jp1imm/data/imdd

Data files for JP1/IM - Manager (Intelligent Integrated Management Base)

./tmp/.JP1_SES*

./usr/tmp/jp1_ses

./usr/lib/jp1_ses/log

./usr/lib/jp1_ses/sys

./usr/bin/jp1_ses/jp*

./var/opt/jp1_ses

Log for JP1/SES compatibility

Table 1‒46: Organization of the internal directories for the primary data of the logical host

Directory and file name

Stored data

./shared-disk/jp1base/../event

Event server settings for the logical host of JP1/Base

./shared-disk/jp1base/conf

Logical host settings and definition files for JP1/Base

./shared-disk/jp1base/log

Log files for the logical host of JP1/Base

./shared-disk/jp1cons/conf

Logical host settings and definition files for JP1/IM - Manager (Central Console)

./shared-disk/jp1cons/log

Log files for the logical host of JP1/IM - Manager (Central Console)

./shared-disk/jp1scope/conf

Logical host settings and definition files for JP1/IM - Manager (Central Scope)

./shared-disk/jp1scope/log

Log files for the logical host of JP1/IM - Manager (Central Scope)

./var/opt/jp1imm/log/_logical-host-name/oslog

OS log information

./var/opt/jp1imm/log/_logical-host-name/operationlog

JP1/IM - Manager operation log

./shared-disk/jp1imm/conf/imcf

IM Configuration Management settings and definition files

./shared-disk/jp1imm/conf/imdd

Settings and definition files for JP1/IM - Manager (Intelligent Integrated Management Base)

./var/opt/jp1imm/database/imdb

Detailed log information for the IM database

./shared-disk/jp1imm/log/imcf

Log files for IM Configuration Management

./shared-disk/jp1imm/log/imdd

Log files for JP1/IM - Manager (Intelligent Integrated Management Base)

./var/opt/jp1imm/log/imdb

Log files for the IM database

Table 1‒47: Organization of the internal directories for the secondary data of the logical host

Directory and file name

Stored data

./shared-disk/event

Event database for the logical host of JP1/Base

./shared-disk/jp1base/log/COMMAND

Command execution log files for the logical host of JP1/Base

./shared-disk/jp1cons/operation/evgen

Correlation event generation history files for the logical host of JP1/IM - Manager (Central Console)

./shared-disk/jp1cons/operation/comexclude

Common exclusion history file and common exclusion-conditions definition history file for the logical host of JP1/IM - Manager (Central Console)

./shared-disk/jp1scope/database

Database information for the logical host of JP1/IM - Manager (Central Scope)

./var/opt/jp1imm/log/_logical-host-name/oslog

OS log information

./var/opt/jp1imm/log/_logical-host-name/core

Core file

./shared-disk/jp1imm/data/imcf

Data files for IM Configuration Management

./shared-disk/jp1imm/database/imdb/imdbbackup.dat

Backup files of the IM database

./shared-disk/jp1imm/data/imdd

Data files for JP1/IM - Manager (Intelligent Integrated Management Base)

Format

jim_log.sh -f data-storage-directory
           [-h logical-host-name]
           [-t]
           [-u]
           [-n]
           [-p]
           [-r]
           [-g]
           [-a]
           [-s]
           [-c]
           [-d]
           [-x]
           [-q]
           [-b]
           [directory-name-or-file-name...]

The -a option is used for linking with BJEX or JP1/AS. For details about the -a option, see 10.5.3 jim_log.sh (UNIX only)in the JP1/Integrated Management 2 - Manager Administration Guide.

Execution permission

Superuser permissions

Storage directory

/opt/jp1imm/tools/

Arguments

-f data-storage-directory

Specifies the name of the directory or device to which the collected data is to be output, expressed as a full path or a path relative to the root directory. If you specify a directory name, the tool creates the files containing the collected data under that directory. If the path contains a space, enclose the entire path in double-quotation marks ("). This option is mandatory.

If a nonexistent directory is specified, a new directory with the specified name is created. If an existing directory is specified, that directory is deleted and the specified directory is created.

If a device name is specified, a write operation occurs on that device for each file that is created. If a device file name such as for a tape device is specified, the collected data is stored on the device without being compressed.

If you specify a device name and the -q option, the tool assumes that you have chosen yes for user confirmation. In such a case, you must set the device before you execute the command.

-h logical-host-name

When you are operating in a cluster system, this option specifies a logical host name and that the command is to collect data for that logical host as well as for the physical host. If this option is omitted, the command collects data for the physical host only. If you are not using a cluster system, there is no need to specify this option.

Note that this command will not use the logical host name that is set in the JP1_HOSTNAME environment variable. Therefore, if you use this command in a cluster system, make sure that you specify the logical host name in this option.

-t

Specifies that the hosts, services, and passwd files are not to be collected.

-u

Specifies that core analysis information is not to be collected. The core analysis information consists of a file obtained by using the car command of the Seraph tool to analyze a core dump file.

-n

Specifies that maintenance data for JP1/Base is not to be collected.

-p

Specifies that the event database for JP1/Base is not to be collected.

-r

Specifies that the command execution log files for JP1/Base are not to be collected.

-g

Specifies that the correlation event generation history file is not to be collected.

-a

Specifies that the file for accumulated response-waiting events is not to be collected.

-s

Specifies that maintenance data for JP1/IM - Manager (Central Scope) is not to be collected.

-c

Specifies that maintenance data for IM Configuration Management is not to be collected.

-d

Specifies that maintenance data for the IM database is not to be collected.

This argument cannot be specified together with the -x option.

-x

Specifies that IM database backup files are to be collected.

This argument cannot be specified together with the -d option.

The IM database backup files are not included in the maintenance data for the IM database that is collected by default. If the IM database service is not running, the maintenance data is not collected. In such a case, start the IM database service and then re-execute the data collection command. The backup files can be collected even when JP1/IM - Manager is running.

-q

Specifies that the command is to be executed without requesting confirmation from the user.

-b

Specifies that maintenance data for Intelligent Integrated Management Base is not to be collected.

directory-name-or-file-name

Specifies a file or directory to be collected by the data collection tool. Specify a full path name. To specify multiple names, use the space character to separate the names.

Note that this option must be the last option specified in the command. Specify it after you have specified all the other options that you need to specify. The collected data is stored as the primary data for the physical host.

Notes

This tool might collect a large amount of data. Before you execute this tool, you need to estimate the amount of disk space required and check the capacity available on your machine. For details, see 11.4 Collecting data in the JP1/Integrated Management 2 - Manager Administration Guide.

Do not execute this tool more than once. If it is executed multiple times, previously collected data might be overwritten or data collection might fail.

When you run the tool to collect the data, it places a certain amount of load on the computer (on disk I/O and other resources).

If you send data to the support service without using this tool or send it with some of it excluded, detailed investigation may not be possible.

Return values

0

Normal termination

8

Abnormal termination

Example 1

Collect data for the physical host and the logical host hostA into /tmp/jp1log:

jim_log.sh -f /tmp/jp1log -h hostA

The output result is as follows:

KAVB8925-I The directory does not exist. (/var/opt/jp1imm/log/_jp1_default).
           The directory will be created.
KAVB8925-I The directory does not exist. (/var/opt/jp1imm/log/_hostA).
           The directory will be created.
KAVB8926-I Data acquisition processing will start.
KAVB8921-I The physical host's first material will be acquired.
KAVB8922-I The physical host's first material has been acquired.
KAVB8921-I The physical host's second material will be acquired.
KAVB8922-I The physical host's second material has been acquired.
KAVB8921-I The logical host(hostA)'s first material will be acquired.
KAVB8922-I The logical host(hostA)'s first material has been acquired.
KAVB8921-I The logical host(hostA)'s second material will be acquired.
KAVB8922-I The logical host(hostA)'s second material has been acquired.
KAVB8918-I The data was successfully acquired.

Example 2

Collect data for the physical host into the nonexistent directory /tmp/jp1log/, but do not specify the existing logical host (hostA):

jim_log.sh -f /tmp/jp1log

The output result is as follows:

KAVB8925-I The directory does not exist. (/tmp/jp1log).
           The directory will be created.
KAVB8925-I The directory does not exist. (/var/opt/jp1imm/log/_jp1_default).
           The directory will be created.
KAVB8926-I Data acquisition processing will start.
KAVB8921-I The physical host's first material will be acquired.
KAVB8922-I The physical host's first material has been acquired.
KAVB8921-I The physical host's second material will be acquired.
KAVB8922-I The physical host's second material has been acquired.
KAVB8918-I The data was successfully acquired.
KAVB8935-I The following logical host(s) exist on this machine:
hostA
To acquire information about a logical host, execute "jim_log.sh -f output-directory-name -h logical-hostname".

Example 3

Collect data for the physical host into the /tmp/jp1log/ directory, which contains the jp1_default_imm_1st.tar.Z and jp1_default_imm_2nd.tar files, but do not specify the existing logical host (hostA):

jim_log.sh -f /tmp/jp1log

The output result is as follows (when y is entered for all responses):

KAVB8925-I The directory does not exist. (/var/opt/jp1imm/log/_jp1_default).
           The directory will be created.
KAVB8926-I Data acquisition processing will start.
KAVB8921-I The physical host's first material will be acquired.
KAVB8922-I The physical host's first material has been acquired.
KAVB8921-I The physical host's second material will be acquired.
KAVB8944-I (/tmp/jp1log/jp1_default_imm_2nd.tar.Z) already exists. Do you want to overwrite it? [yes/no]y
KAVB8922-I The physical host's second material has been acquired.
KAVB8918-I The data was successfully acquired.
KAVB8944-I (/tmp/jp1log/jp1_default_imm_1st.tar.Z) already exists. Do you want to overwrite it? [yes/no]y
KAVB8935-I The following logical host(s) exist on this machine:
hostA
To acquire information about a logical host, execute "jim_log.sh -f output-directory-name -h logical-hostname".

jimdbbackup

Function

This command backs up the IM database. The following describes the purposes of making such a backup and the types of data that can be acquired.

Backup for error recovery

You must back up the database periodically in order to recover the database in the event of a database failure. The database backup targets are the integrated monitoring database area, the IM Configuration Management database area, and the system database areas.

Backup for expansion

When you are preparing to expand the size of the database, you must temporarily back up the database's data. The database backup targets are the integrated monitoring database area and the IM Configuration Management database area.

Format

jimdbbackup -o backup-file-name
            -m {MAINT|EXPAND}
              [-h logical-host-name]
              [-q]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imdb\

In UNIX:

/opt/jp1imm/bin/imdb/

Arguments

-o backup-file-name

Specifies the absolute path name of the file to which the database is to be backed up. You must specify a logical drive or a backup file. This option is mandatory.

An error results if you specify a network drive, a UNC path, or a Windows reserved device file. If the specified backup file already exists, the existing file will be overwritten.

Make sure that the value you specify for backup-file-name includes a file path. The characters permitted for the file name are alphanumeric characters, the underscore (_), dot (.), hash mark (#), and at mark (@). The character set also depends on the OS. If the name contains a space or a parenthesis (( or )), the entire name must be enclosed in double-quotation marks ("). In Windows, the backup file name when MAINT is specified must be in all lowercase letters. The maximum length of the file name depends on OS limitations.

If the directory for storing the specified backup file is not found, command execution fails. Make sure that you create the directory before you execute the command.

-m {MAINT|EXPAND}

Specifies the database backup format. The permitted characters are uppercase letters. This option is mandatory.

MAINT: Specifies a backup for error recovery

EXPAND: Specifies a backup for expansion

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host where the command is executed. The command backs up the database that corresponds to the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed. Note that this logical host name cannot be JP1_DEFAULT. In addition, the logical host name is case sensitive.

-q

Specifies that the command is to be executed without requesting confirmation from the user.

Return values

0

Backup terminated normally

1

Backup terminated abnormally

Notes

Before you execute this command, make sure that the execution conditions for the jimdbrecovery command are satisfied.

If you execute another JP1/IM - Manager command or start a JP1/IM - Manager service while this command is executing, execution may fail because this command places the database in the mode that disables referencing and updating.

While this command is executing, do not press Ctrl +C or Ctrl + Break. Because the command executes backup processing in the background, the backup processing will continue even though Ctrl +C or Ctrl + Break is pressed. If you press Ctrl +C or Ctrl + Break and then immediately attempt to execute another JP1/IM - Manager command or start a JP1/IM - Manager service, execution of the requested command or startup of the requested service may fail.

If you have canceled command execution by pressing Ctrl + C or Ctrl + Break, first make sure that the following process is not executing, and then re-execute the command:

pdcopy process if you are performing a backup for error recovery

pdrorg process if you are performing a backup for expansion

The jimdbbackup command creates a backup file during execution. In the case of a backup for expansion or a backup for error recovery, the amount of free space that is needed on the drive where the backup file is to be output is about 2 gigabytes for a small database, about 15 gigabytes for a medium-sized database, and about 50 gigabytes for a large database.

When the IM database is used, JP1/IM - Manager must not be running.

In Windows, the IM database (JP1/IM2-Manager DB Server) must be running, and the cluster service for the IM database (JP1/IM2-Manager DB Cluster Service_logical-host-name) must be stopped.

A backup file for recovery cannot be distinguished from a backup file for expansion. We recommend that you name the backup files so that you can distinguish between the types of backup files.

At the time a backup file is output, it is in a status in which any user can access it. We recommend that immediately after you have made a backup, you change the access permissions or move the file to a protected location so that unauthorized users cannot access it.

If you are using JP1/IM - MO, the JP1/IM - Message Optimizer service of JP1/IM - MO on the connection source must be stopped.

Before executing the command in Windows, in case of existing the Application Experience service, make sure that the startup type of the Application Experience service is not set to Disabled.

jimdbreclaim

Function

This command releases free area (free page area) in the IM Configuration Management database.

If you delete a large number of hosts in the IM Configuration Management database, part of the area that was used to store that data might become used free area. This command changes used free area into unused free area so that it can be reused.

You can execute this command during operations without having to stop JP1/IM - Manager Service.

Format

jimdbreclaim [-h logical-host-name]
             [-q]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imdb\

In UNIX:

/opt/jp1imm/bin/imdb/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host where the command is executed. The command releases free area in the IM Configuration Management database for the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed. Note that JP1_DEFAULT cannot be specified for the logical host name. In addition, the logical host name is case sensitive.

-q

Specifies that the command is to be executed without requesting confirmation from the user.

Return values

0

Normal termination

1

Abnormal termination

Notes

There is no need to execute this command unless you plan to repeatedly add or delete a large number of hosts in the IM Configuration Management database.

If you execute another JP1/IM - Manager command while this command is executing, execution of the other command may fail.

Because CPU load is high during execution of this command, we recommend that you execute it during a time when referencing and updating operations are at a minimum, such as at night.

If you cancel this command's processing by pressing Ctrl + C or Ctrl + Break, release of free area in the database may fail. Before you re-execute the command, check that neither the pdreclaim process nor the pdrorg process is running. If either of these processes is running, wait a while and then check again.

Do not stop the database service while this command is executing.

If you have stopped the database service during execution of this command, you must start the database service and then re-execute the command.

In Windows, the IM database service JP1/IM2-Manager DB Server must be running.

Before executing the command in Windows, in case of existing the Application Experience service, make sure that the startup type of the Application Experience service is not set to Disabled.

jimdbrecovery

Function

This command recovers a database from its backup. The command can recover the following types of data:

Recovery for error recovery

In the event of a database failure, the command recovers the database from backup data that was acquired previously.

Recovery for expansion

Before you expand the size of a database, temporarily back up the data.

Format

jimdbrecovery -i backup-file-name
                -m {MAINT|EXPAND}
                [-h logical-host-name]
                [-q]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imdb\

In UNIX:

/opt/jp1imm/bin/imdb/

Arguments

-i backup-file-name

Specifies the absolute path name of the file to which the database was backed up by the jimdbbackup command. The characters permitted for the file name are alphanumeric characters, the underscore (_), dot (.), hash mark (#), and at mark (@). You must specify a logical drive for the backup file. This option is mandatory.

An error results if you specify a network drive, a UNC path, or a Windows reserved device file.

-m {MAINT|EXPAND}

Specifies the database recovery format. The permitted characters are uppercase letters. This option is mandatory.

MAINT: Specifies recovery for error recovery

EXPAND: Specifies recovery for expansion

When you execute recovery for error recovery, specify the backup file that was acquired by a backup for error recovery; when you execute recovery for expansion, specify the backup file that was acquired by a backup for expansion. An error results if the specified argument does not match the type of backup file.

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host where the command is executed. The command recovers the database that corresponds to the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed. Note that JP1_DEFAULT cannot be specified for the logical host name. In addition, the logical host name is case sensitive.

-q

Specifies that the command is to be executed without requesting confirmation from the user.

Return values

0

Recovery terminated normally

1

Recovery terminated abnormally

Notes

When you execute the jimdbrecovery command to recover backup data acquired by the jimdbbackup command, use the same OS that was used to make the backup. If the backup is recovered to a database under a different OS, the integrity of the operation cannot be guaranteed.

If you execute another JP1/IM - Manager command or start a JP1/IM - Manager service while this command is executing, the requested execution might fail because this command places the database in the mode that disables referencing and updating.

While this command is executing, do not press Ctrl +C or Ctrl + Break. Because the command executes recovery processing in the background, the recovery processing will continue even though Ctrl +C or Ctrl + Break is pressed. If you press Ctrl +C or Ctrl + Break and then immediately attempt to execute another JP1/IM - Manager command or start a JP1/IM - Manager service, execution of the requested command or startup of the requested service might fail.

If you have canceled command execution by pressing Ctrl +C or Ctrl + Break during error recovery processing, make sure that the pdrstr process is not running before you restart JP1/IM - Manager. If you have canceled command execution by pressing Ctrl +C or Ctrl + Break during a recovery for expansion, make sure that the pdrorg process is not running before you start another command or a JP1/IM - Manager service.

This command creates a temporary file during execution. In the case of a recovery for expansion, the amount of free space needed on the drive where the IM database is to be installed is about 1 gigabyte for a small or medium-sized database, and about 4 gigabytes for a large database. In the case of a recovery for error recovery, the amount of free space needed on the drive can vary from about 5 to 50 megabytes, regardless of the database size.

When you execute a recovery for error recovery, the database storage directory used to execute the backup for error recovery must be the same as the database storage directory used to execute the recovery for error recovery.

When you execute a recovery for expansion, the storage space must be larger than when the backup for expansion was executed.

Recovery for expansion might fail if the available capacity is the same as for the backup for expansion. If this occurs, set up the database again and then, with the database free of data, recover the database.

When the IM database is used, JP1/IM - Manager must not be running.

In Windows, the IM database (JP1/IM2-Manager DB Server) must be running and the cluster service for the IM database (JP1/IM2-Manager DB Cluster Service_logical-host-name) must be stopped.

If you are using JP1/IM - MO, the JP1/IM - Message Optimizer service of JP1/IM - MO on the connection source must be stopped.

Before executing the command in Windows, in case of existing the Application Experience service, make sure that the startup type of the Application Experience service is not set to Disabled.

jimdbrorg

Function

This command reorganizes fragmented free space in the IM Configuration Management database. Free space in use is released by reorganization. Therefore, you do not need to execute the jimdbreclaim command many times.

When you perform maintenance of JP1/IM - Manager, you can also resolve low data storage efficiency caused by fragmentation by executing database reorganization.

Format

jimdbrorg [-h logical-host-name]
          [-q]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imdb\

In UNIX:

/opt/jp1imm/bin/imdb/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host where the command is executed. The command reorganizes the database for the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed. Note that this logical host name cannot be JP1_DEFAULT. In addition, the logical host name is case sensitive.

-q

Specifies that the command is to be executed without requesting confirmation from the user.

Return values

0

Reorganization terminated normally

1

Reorganization terminated abnormally

Notes

If you execute another JP1/IM - Manager command or start a JP1/IM - Manager service while this command is executing, the requested execution might fail.

While this command is executing, do not press Ctrl +C or Ctrl + Break. Because the command executes database reorganization processing in the background, the database reorganization processing will continue even though Ctrl +C or Ctrl + Break is pressed. If you press Ctrl +C or Ctrl + Break and then immediately attempt to execute another JP1/IM - Manager command or start a JP1/IM - Manager service, execution of the requested command or startup of the requested service may fail.

If you have canceled command execution by pressing Ctrl +C or Ctrl + Break, you must use a method such as the Windows Task Manager to make sure that the pdrorg process is not running before you execute another JP1/IM - Manager command or use JP1/IM - Manager. If the pdrorg process is running, wait until it terminates before executing another JP1/IM - Manager command or using JP1/IM - Manager.

We recommend that you make a backup for error recovery before and after you execute this command.

This command creates a temporary file during execution. For this reason, the amount of free space needed on the drive where the IM database is to be installed is about 1 gigabyte for a small or medium-sized database and about 4 gigabytes for a large database.

When the IM database is used, JP1/IM - Manager must not be running.

In Windows, the IM database (JP1/IM2-Manager DB Server) must be running and the cluster service for the IM database (JP1/IM2-Manager DB Cluster Service_logical-host-name) must be stopped.

If you are using JP1/IM - MO, the JP1/IM - Message Optimizer service of JP1/IM - MO on the connection source must be stopped.

Before executing the command in Windows, in case of existing the Application Experience service, make sure that the startup type of the Application Experience service is not set to Disabled.

jimdbstatus

Function

This command checks the operating status of the IM database, such as running or stopped.

Format

jimdbstatus [-h logical-host-name]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imdb\

In UNIX:

/opt/jp1imm/bin/imdb/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host where the command is executed. The command then checks the operating status of the IM database for the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed. Note that the logical host name is case sensitive.

Return values

0

IM database is running

1

jimdbstatus command terminated abnormally

4

IM database is engaged in startup or termination processing

8

Database has been terminated (IM database restart processing was canceled and the IM database became unstable)

12

IM database was terminated (normal termination status)

16

IM database has not been started (applicable to Windows)

20

IM database has not been set up

Notes

Before executing the command in Windows, in case of existing the Application Experience service, make sure that the startup type of the Application Experience service is not set to Disabled.

jimdbstop

Function

This command terminates the IM database. Use this command to set the termination command with the start sequence control function of JP1/Base.

If the IM database is in restart canceled status, you can forcibly terminate it by executing this command with the -f option specified.

Format

jimdbstop [-h logical-host-name]
          [-f]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imdb\

In UNIX:

/opt/jp1imm/bin/imdb/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host where the command is executed. The command then stops the IM database for the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed. Note that the logical host name is case sensitive.

-f

Specifies that the IM database is to be terminated forcibly.

Return values

0

Normal termination

1

Abnormal termination

4

IM database is engaged in startup or termination processing

8

Database has been terminated (IM database restart processing was canceled and the IM database became unstable)

12

IM database was terminated (normal termination status)

20

IM database has not been set up

Notes

If you cancel processing by pressing Ctrl + C or Ctrl + Break, termination of the IM database might fail. If you re-execute the command in such a case, first make sure that the pdstop process is not running. If the pdstop process is running, wait a while and then check again.

JP1/IM - Manager must not be running while the IM database is being used.

If you are using JP1/IM - MO, the JP1/IM - Message Optimizer service of JP1/IM - MO on the connection source must be stopped.

Before executing the command in Windows, in case of existing the Application Experience service, make sure that the startup type of the Application Experience service is not set to Disabled.

jimdbupdate

Function

This command updates an IM database that has already been set up. Execute this command after upgrading JP1/IM - Manager.

Format

jimdbupdate [-h logical-host-name] [-i] [-q]

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\imdb\

In UNIX:

/opt/jp1imm/bin/imdb/

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the name of the logical host where this command is to be executed. Execution of the command updates the IM database for the specified logical host. If you do not use a cluster system, specification of this option is not needed. Note that JP1_DEFAULT cannot be specified for the logical host name. In addition, the logical host name is case sensitive. For the logical host name, specify a logical host name set in JP1/Base in the correct form, especially case.

-i

Specify this option to update the IM database. If this option is omitted, a message asking whether the IM database needs to be updated is displayed.

-q

Specify this option to execute the command without requiring user confirmation.

Return values

0

Normal termination

1

Abnormal termination

Notes

Before executing this command, make sure that the following execution conditions for this command are satisfied.

Execution conditions

When this command is executed on the active server, the shared disk must be online and the logical host name must be able to be resolved.

In Windows, the IM database must be started.

For a physical host:

- JP1/IM - Manager DB Server

For a logical host:

- JP1/IM - Manager DB Server _logical-host-name

In addition, the JP1/IM-Manager service and the cluster server of the IM database indicated below must be stopped. Note, however, that if the integrated monitoring database and the IM configuration management database are not used, it is not necessary to stop the JP1/IM - Manager service.

For a physical host:

- JP1/IM-Manager service (JP1/IM2-Manager)

- Cluster service for the IM database (JP1/IM2-Manager DB Cluster Service)

For a logical host:

- JP1/IM-Manager service (JP1/IM2-Manager_logical-host-name)

- Cluster service for the IM database (JP1/IM2 - Manager DB Cluster Service_logical-host-name)

In UNIX, the JP1/IM-Manager service must be stopped. Note, however, that if the integrated monitoring database and the IM configuration management database are not used, it is not necessary to stop the JP1/IM - Manager service.

If the command is stopped during execution by pressing the Ctrl and C keys or the Ctrl and Break keys, re-execute the command after making sure that the pdeinstall process is not being executed.

After executing the jimdbupdate command, you will not be able to recover the expansion backup from the previous execution of the jimdbupdate command. We recommend that you make another expansion backup after executing the jimdbupdate command.

After executing the command, do not attempt to recover backup data from the existing IM database that was acquired before this command was executed. We recommend that you use the jimdbbackup command to make another backup after executing this command.

During execution of the jimdbupdate command, do not execute jimdbstatus or other commands related to the IM database. If you do, you might not be able to uninstall the IM database.

Before executing the command in Windows, in case of existing the Application Experience service, make sure that the startup type of the Application Experience service is not set to Disabled.

jimmail (Windows only)

Function

This command sends an email to a specified email address.

To use the jimmail command to send an email, you must set the email environment definition file.

You can execute this command independently regardless of whether the JP1/IM - Manager service is running. The following table describes the functions of JP1/IM - Manager that can be used to send an email.

Table 1‒48: JP1/IM - Manager functions used to send an email by using the jimmail command

Function

Description

Automated action

An email can be sent by automated action.

Monitoring action and delay statuses

An email can be sent by using the notification command when an action error is detected.

Health check

An email can be sent by using the notification command when a JP1/IM - Manager process error is detected.

Command execution (Command button)

An email can be sent by pressing a command button.

If the maximum length of a command line is exceeded, redefine the email contents so that the command line of the jimmail command can fit within the limit.

Format

jimmail [-to destination-email-address[,destination-email-address...]]
        [-s email-subject]
        [-b email-text]
        [-rh logical-host-name]

Execution permission

Administrator permissions (If the Windows UAC feature is enabled, the command is executed from the administrator console.)

Storage directory

Console-path\bin\

Arguments

-to destination-email-address[,destination-email-address...]

This option specifies the email destination address.

A maximum of 20 email addresses can be specified. Note, however, that addresses exceeding the maximum command line length cannot be specified. When specifying multiple email addresses, use a comma (,) as a separator. Any one-byte space or tab between an email address and a comma is ignored. Consecutive commas (,) are treated as a single comma, and commas at the beginning and at the end are ignored. If the same email address is specified more than once, the email message is sent to the specified address only once.

If the number of specified email addresses exceeds the maximum limit, the KAVB8725-E message is output, and the operation terminates abnormally.

You can specify 1 to 256 bytes of characters for the destination email address. One-byte alphanumeric characters, at marks (@), hyphens (-), underscores (_), and periods (.) can be specified.

This option can be omitted. If you omit this option, processing continues using the email address specified for the DefaultTo parameter (default destination email address) in the email environment definition file as the destination. When an email is being processed, the message sent to the email address of the DefaultTo parameter is not output.

If the -to option is omitted, and no email address is specified for the DefaultTo parameter, the jimmail command outputs an error message, and the operation terminates abnormally.

If both the -to option and the DefaultTo parameter are set, the -to option takes precedence.

The jimmail command does not check if the specified email address is valid.

-s email-subject

This option specifies the email subject.

You can specify 1 to 512 bytes of characters. The character count is determined by calculating the byte count based on the email character encoding specified by the Charset parameter in the email environment definition file. When event or action information is to be inherited, the maximum-length check is performed by calculating the length after $variable-name has been replaced. If the calculated length exceeds the maximum length, the value specified for the MailSubjectCutting parameter in the email environment definition file determines whether the subject is to be cut to allow the email to be sent.

When the MailSubjectCutting parameter value is OFF, the KAVB8708-E message is output, and the command terminates abnormally.

When the MailSubjectCutting parameter value is ON, characters for the email subject exceeding 512 bytes are discarded according to the character encoding specified for the Charset parameter, and the email is sent. When an email subject exceeds 512 bytes, characters exceeding 512 bytes are discarded. If an email is sent after the exceeding characters in the subject are discarded, the KAVB8724-W message appears before the KAVB8729-I message (indicating the email is sent successfully).

This option can be omitted. If you omit this option, the subject of the email will be a null character ("").

If the email subject contains blank characters, enclose the subject in double-quotation marks (").

Even if you specify \n, a line break is not created in the email subject. If you specify \n, it appears as is. Line feed codes and control characters are converted into one-byte spaces.

-b email-text

This option specifies the email text.

You can specify 1 to 4,096 byte characters for the email text. The number of characters is checked by the number of bytes, according to the character encoding of the email specified by the Charset parameter in the email environment definition file. To inherit event or action information, check the maximum length after replacing $variable-name.

You can specify 1 to 512 byte characters including linefeed codes for a line. If the characters exceed 512 bytes, insert a linefeed code so that the line will be a maximum of 512 bytes including linefeed codes. When a line exceeds the number, no warning message is output.

This option can be omitted. If you omit this option, the email text will be null characters ("").

If there is no linefeed code at the end of the last line, a linefeed code is inserted.

If the email text contains null characters, enclose and specify the email text by the double-quotation marks (").

When \n is specified in the email text, a new line starts after the linefeed code specified by the MailNewLine parameter in the email environment definition file. If the value of the parameter is not CRLF, CR, or LF, \n is converted to a single-byte space.

To enter \n as a character string, specify it as \\n.

-rh logical-host-name

When JP1/IM - Manager is used in a cluster, the -rh option specifies the email environment definition file to use. With this option, specify if the jimmail command uses the email environment definition file on a physical host, or in the shared folder on a logical host.

If you specify this option, the email environment definition file is loaded to a shared folder on the specified logical host, and the email is sent.

If you omit this option, the email environment definition file is loaded to a physical host, and then the email is sent.

Note that if you omit this option, the logical hostname specified for the JP1_HOSTNAME environment variable is assumed. If he JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you do not use JP1/IM - Manager in a cluster, it is not necessary to specify this option.

Note

Specify the subject and text of the email specified in the command line within the range of character encoding defined in the email environment definition file. For details about the email environment definition file, see Email environment definition file (jimmail.conf) in Chapter 2. Definition Files.

The following control characters included in the event information passed to an email sent by the jimmail command (executed as an automated action or by clicking a command button) are converted to a single-byte space (0x20):

0x01 to 0x1F excluding 0x09 (tab), and 0x7F

For example, if the message obtained by $EVMSG includes 0x0A (line feed code), 0x0A is converted to 0x20 (single-byte space).

Return values

Return value

Description

0

Normal termination

1

Argument error

2

Destination email address is not specified.

3

Error while reading the email environment definition file

4

Format error of the email environment definition file

(Invalid setting value, essential item not specified, invalid parameter)

5

A timeout error occurred while connecting to the SMTP server

6

SMTP server rejected the login

7

Connection to the SMTP server could not be established

8

A timeout error occurred while connecting to the POP3 server

9

POP3 server rejected the login

10

Connection to the POP3 server could not be established

11

Sending an email failed

12

Insufficient memory

13

Execution permission error

255

Other errors

Example

The following is an email notification example from the manager host (jp1imhost001) to the system administrator (user@hitachi.com) about a failure on the monitored host (gyoumu001) through automated action, and the contents of the email to be sent:

jimmail.exe -to user@hitachi.com -s "[severity:$EVSEV] Failure notification" -b "A failure occurred on the business server. \n---\n event DB serial number=$EVSEQNO\nevent-occurrence-date-and-time=$EVDATE $EVTIME\nEvent ID=$EVIDBASE\nSeverity=$EVSEV\nProduct name=$EV"PRODUCT_NAME"\nMessage=$EVMSG\n---\nFrom:IM-M host ($ACTHOST)"

Example of email notification:

Source (From)

admin@hitachi.com

Destination (To)

user@hitachi.com

Email subject

[Severity:Error] Failure notification

Email text

A failure occurred on the business server.

---

Serial number in the event database=1234567

Event occurrence date and time=2014/01/01 10:00:00

Event ID=000A

Severity=Error

Product name=/HITACHI/XXXXX/JP1

Message=A system error occurred on the business server

---

From:IM-M host (jp1imhost001)

jimmailpasswd (Windows only)

Function

Sets the POP before SMTP or SMTP-AUTH authentication password in the email environment definition file. This command can be executed independently regardless of the running status of the JP1/IM - Manager service.

Before executing this command, set the following items in the email environment definition file:

Specify POP or SMTP for the AuthMethod parameter.

Specify the authentication account name for the AuthUser parameter.

If you execute this command without specifying these parameters, the KAVB8714-E or KAVB8736-E message is output, and the operation terminates abnormally.

Format

jimmailpasswd {-p new-authentication-password | -d}
              [-rh logical-host-name]

Execution permission

Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console).

Storage directory

Console-path\bin\

Arguments

-p new-authentication-password

This option sets the authentication password when POP before SMTP or SMTP-AUTH authentication is used to connect to an email server in the email environment definition file.

Specify an authentication password from 1 to 127 bytes for the argument of the option. The authentication password of the argument cannot be omitted.

Permitted characters are one-byte characters other than control characters (0x00 to 0x1F, and 0x7F to 0x9F). Multi-byte characters cannot be specified. The password is case sensitive.

If you omit a password for the argument of the option, the KAVB8704-E message is output, and the operation terminates abnormally.

-d

This option deletes an authentication password from the email environment definition file. If you execute this command with this option specified, the setting value for the AuthPassword parameter (password section) in the email environment definition file is deleted.

The -d option cannot be specified with the -p option.

-rh logical-host-name

When JP1/IM - Manager is used in a cluster, the -rh option specifies the email environment definition file to use. With this option, specify if the jimmail command uses the email environment definition file on a physical host, or in the shared folder on a logical host.

When you specify this option, an authentication password is set in the email environment definition file in a shared folder on the specified logical host.

If you omit this option, an authentication password is set in the email environment definition file on a physical host.

Note that if you omit its option, the logical host name specified for the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you do not use JP1/IM - Manager in a cluster, you do not need to specify this option.

Example 1

Specify the authentication password ABCD in the email environment definition file:

$ jimmailpasswd -p ABCD
KAVB8731-I Command (jimmailpasswd) started.
KAVB8730-I Password was set successfully.
KAVB8732-I Command (jimmailpasswd) ended normally.

Example 2

Set the authentication password ABCD in the email environment definition file on the logical host (ronri):

$ jimmailpasswd -p ABCD -rh ronri
KAVB8731-I Command (jimmailpasswd) stated.
KAVB8730-I Password was set successfully.
KAVB8732-I Command (jimmailpasswd) ended normally.

Example 3

Delete the authentication password from the email environment definition file:

$ jimmailpasswd -d
KAVB8731-I Command (jimmailpasswd) started.
KAVB8734-I Password was deleted successfully.
KAVB8732-I Command (jimmailpasswd) ended normally.

jimnodecount

Function

This command counts the number of nodes managed by JP1/IM - Manager. This command also outputs a file that contains a list of managed nodes.

This command can be executed regardless of whether JP1/IM - Manager is running.

The nodes that this command can count (as nodes managed by JP1/IM - Manager) are JP1/Base on the host defined in the configuration definition information and remotely monitored hosts.

Note that JP1/Base installed on a host that is not defined in the configuration definition information is not counted as a managed node. JP1/Base on such a host must be counted by the user manually.

Format

jimnodecount[ -h logical-host-name | -m]
            [ -o output-file-name]

Execution permission

In Windows: Administrator permissions

In UNIX: Superuser permissions

Storage directory

In Windows:

Manager-path\bin\

In UNIX:

/opt/jp1imm/bin/

Arguments

-h logical-host-name

If JP1/IM - Manager is operating in a cluster system, use this option to specify which type of host (physical or logical) the nodes to be counted by the jimnodecount command are managed by.

If the -h option is specified, the command counts the nodes managed by the specified logical host.

If the -h option is not specified, the command counts the nodes managed by the logical host specified in the JP1_HOSTNAME environment variable. If no logical host name is specified in that environment variable, the command counts the nodes managed by the physical node.

If JP1/IM - Manager is not operating in a cluster system, you do not need to specify this option.

-m

If JP1/IM - Manager is operating in a cluster system, use this option to specify whether the jimnodecount command counts the total number of nodes managed by the physical host and logical host.

If the -m option is specified, the command counts the number of all managed nodes.

If the -m option is not specified, the command counts the number of nodes managed by the logical host specified in the JP1_HOSTNAME environment variable. If no logical host name is specified in that environment variable, the command counts the number of nodes managed by the physical host.

-o output-file-name

This option specifies the managed-node list file to which a list of managed nodes is to be output. If the specified file already exists, the contents of the existing file are overwritten.

The output file name can be specified as a relative path or absolute path. If a relative path is used to specify the output file name, the directory where the jimnodecount command is executed is used as the base of the relative path. If you specify a file whose name begins with a hyphen (-), to distinguish the file name from an option name, use a relative path that begins with the current directory (for example, ./-foo) or an absolute path. Note that the length of the file name you specify must not exceed 250 bytes including the length of the path.

Network paths cannot be specified as the output file name.

Also note that in Windows, the file name you specify must not include the following character strings:

Colon (:), question mark (?), double quotation mark ("), left angle bracket (<), right angle bracket (>), and vertical bar(|)

A string that completely matches one of the following strings (ignoring case): CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, or LPT9

Output format

When you execute the jimnodecount command, the number of managed nodes is output in the format below.

Note that if an error occurs during execution of the command, the number of managed nodes is not output.

number-of-managed-nodes

Note

In a cluster system configuration in which JP1/IM - Managers on multiple logical hosts manage the same host as a managed node, each logical host is counted as a single host by the jimnodecount -m command. In this case, reduce the number of managed nodes appropriately:

Return values

0

Normal termination

43

The jimnodecount command was executed while the remote configurations were being applied or the jcfimport command was being executed.

84

Argument error

85

Execution permission error

127

Other error

Format of the managed-node list file

The following describes the format of the managed-node list file. The numbers at the beginning of each line (1 to 12) indicate line numbers, which are not output in the actual file.

 1  output-time
 2  The number of managed nodes : number-of-managed-nodes
 3  M  /manager-host-name
 4  B  /manager-host-name/host-name-for-JP1/Base-on-host-defined-in-configuration-definition-information
 5  R  /manager-host-name/name-of-remotely-monitored-host
 6  BR /manager-host-name/host-name-for-JP1/Base-on-remotely-monitored-host-defined-in-configuration-definition-information
 7  B  /manager-host-name/site-manager-host-name
 8  B  /manager-host-name/site-manager-host-name/host-name-for-JP1/Base-on-host-defined-in-configuration-definition-information
 9  R  /manager-host-name/site-manager-host-name/name-of-remotely-monitored-host
10  BR /manager-host-name/site-manager-host-name/host-name-for-JP1/Base-on-remotely-monitored-host-defined-in-configuration-definition-information
11  B  /manager-host-name/relay-manager-host-name
12  B  /manager-host-name/relay-manager-host-name/host-name-for-JP1/Base-on-host-defined-in-configuration-definition-information

Lines 2 to 12 are the managed-node block, which consists of the number of managed nodes on line 2 and the managed-node list on lines 3 to 12.

Description of the elements output to the managed-node list file

output-time

The time that the jimnodecount command was executed and the managed-node list file was output is indicated here.

YYYY/MM/DD hh:mm:ss

(YYYY: year, MM: month, DD: day, hh: hour, mm: minute, ss: second)

Managed-node block

The elements of a managed-node block are as follows:

The number of managed nodes : number-of-managed-nodes

The number of managed nodes counted by the command is indicated here.

Managed-node list

type-of-managed-node/host-name[/host-name...]

The strings output for type-of-managed-node are described below.

Type

Description

MΔ Δ

Manager host on which the jimnodecount command was executed

BΔ Δ

JP1/Base on a host that is defined in the configuration definition information and is not the Manager host on which the jimnodecount command was executed

RΔ Δ

Remotely monitored host

BΔ

JP1/Base on a remotely monitored host that is defined in the configuration definition information

Legend: Δ: A single-byte space

The managed-node block output format differs depending on whether the -m option is specified.

If the -m option is not specified:

Only one managed-node block is output.

The following shows an example of the file output if the -m option is not specified.

Integrated manager

Site manager

Agent

Physical host (kanri)

tokyo

jp1ag1

osaka

rhost1

jp1ag2

2016/04/28 09:00:00
The number of managed nodes : 6
M  /admin
B  /admin/tokyo
B  /admin/tokyo/jp1ag1
B  /admin/osaka
R  /admin/osaka/rhost1
BR /admin/osaka/jp1ag2

If the -m option is specified:

Multiple managed-node blocks are output. The managed-node block for the physical host is output before the managed-node blocks for logical hosts. The managed-node blocks for logical hosts are output in the ascending order of logical host names.

The following shows an example of the file output if the -m option is specified.

Integrated manager

Site manager

Agent

Physical host (admin)

tokyo

jp1ag1

Logical host (adminL1)

osakaA

jp1ag2

osakaB

jp1ag3

Logical host (adminL2)

nagoyaA

jp1ag4

Logical host (adminL3)

nagoyaB

jp1ag5

2016/11/26 09:00:00
The number of managed nodes : 3
M  /admin
B  /admin/tokyo
B  /admin/tokyo/jp1ag1
The number of managed nodes : 5
M  /adminL1
B  /adminL1/osakaA
B  /adminL1/osakaA/jp1ag2
B  /adminL1/osakaB
B  /adminL1/osakaB/jp1ag3
KAVB8201-E-or-KAVB8202-E-message-text#
The number of managed nodes : 3
M  /adminL3
B  /adminL3/nagoyaB
B  /adminL3/nagoyaB/jp1ag5

#: Because the command failed to count the number of nodes managed by logical host adminL2, a message (KAVB8201-E or KAVB8202-E) was output. For details about the message, see the JP1/Integrated Management 2 - Manager Messages.

jp1cc_setup (UNIX only)

Function

This command sets up an operating environment for JP1/IM - Manager (Central Console).

Use this command only after you have uninstalled JP1/Base on a computer where both JP1/IM - Manager and JP1/Base were installed and you have then re-installed JP1/Base. When you use Hitachi Program Product Installer to perform a new installation or an overwrite installation of JP1/IM - Manager, there is no need to execute this command.

Format

jp1cc_setup

Execution permission

Superuser permissions

Storage directory

/opt/jp1cons/bin/

Return values

0

Normal termination

1

Abnormal termination

jp1cc_setup_cluster (UNIX only)

Function

This command sets up an operating environment for a logical host of JP1/IM - Manager (Central Console). Use this command for environment setup in a cluster system.

Set up the environment for the primary node first, and then set up the standby node.

In the environment setup for the primary node, you must specify the logical host name and shared directory name. When you execute this command, information such as definition files is copied to the specified shared directory; therefore, you must have already made the shared disk available for use.

In the environment setup for the standby node, specify only the logical host name. The operating environment is set up on the basis of the information specified for the executing node.

Before you start setting up an environment for the secondary node, you must use the jbsgetcnf and jbssetcnf commands of JP1/Base to copy to the standby node the common definition information set at the executing node.

When you execute this command, the socket binding method used for TCP/IP communication is changed to the IP binding method. The command changes this setting for the physical host and for the logical host that is to be created. For details about the socket binding method used for TCP/IP communication, see the documentation for the applicable OS.

Format

jp1cc_setup_cluster -h logical-host-name
                   [-d shared-directory-name]

Execution permission

Superuser permissions

Storage directory

/opt/jp1cons/bin/

Arguments

-h logical-host-name

Specifies a host name for the logical host whose environment is to be set up. The permitted length is from 1 to 63 bytes characters.

Set the specified logical host name in the hosts file and in the name server to enable TCP/IP communication.

-d shared-directory-name

Specifies a shared directory for storing the information that is to be inherited during node switching. Specify a directory on the shared disk. The permitted length is from 1 to 165 bytes characters.

The command creates the directories listed below in the specified shared directory and then copies definition files from /etc/opt/jp1cons/conf/. Appropriate permissions are set for the created directories. Do not change the set permissions of the directories.

Table 1‒49: Directories created by the jp1cc_setup_cluster command

Type of files to be stored

Directory

Definition files

shared-directory-name/jp1cons/conf/

Log files

shared-directory-name/jp1cons/log/

Temporary files

shared-directory-name/jp1cons/tmp/

History files#

shared-directory-name/jp1cons/operation/

#: The processing of the correlation event generation function is output as history data.

Change the definition files, if necessary.

Notes

You must set a logical host for each node.

You must make the shared disk available for use before you set up an environment for the primary node by executing the jp1cc_setup_cluster command.

Return values

0

Normal termination

1

Abnormal termination

Examples

Set up an environment with the following conditions:

Logical host name: lnode0
Shared disk: /shdsk/lnode0

Setting up the logical host environment at the primary server

jp1cc_setup_cluster -h lnode0 -d /shdsk/lnode0

Setting up the logical host environment at the secondary server

jp1cc_setup_cluster -h lnode0

jp1cf_setup (UNIX only)

Function

This command sets up an operating environment for the IM Configuration Management process of JP1/IM - Manager.

Use this command only after you have uninstalled JP1/Base on a computer where both JP1/IM - Manager and JP1/Base were installed and you have then re-installed JP1/Base.

Format

jp1cf_setup

Execution permission

Superuser permissions

Storage directory

/opt/jp1imm/bin/imcf

Return values

0

Normal termination

1

Abnormal termination

jp1cf_setup_cluster (UNIX only)

Function

This command sets up an environment for IM Configuration Management when you are operating in a cluster system.

This cluster setup for IM Configuration Management applies to both the primary node and the standby node of the logical host. When the -d option is specified, the command sets up the primary node; when the -d option is omitted, the command sets up the secondary node.

The following table lists and describes the settings for the primary and secondary nodes.

Table 1‒50: Settings for the primary and secondary nodes

Host where command is executed

Setting item

Overview of setting

Primary node

Common definition settings for the logical host

Use the jbsgetcnf and jbssetcnf commands to set the common definitions of IM Configuration Management for the physical host to also be the common definitions for the logical host. Some information (such as directory names) must be changed.

Creating the shared directory

Create the required directories under the shared directory.

Copying the definition files

Copy the definition files from /opt/jp1imm/conf/imcf to the directories under shared-directory/jp1imm/conf/imcf.

Setting startup of IM Configuration Management for the instance of Central Console on the logical host

Use the jcoimdef command to set IM Configuration Management Service to start according to process management of the instance of Central Console on the logical host.

Changing the communication method for IM Configuration Management on the physical host

Change the communication method for IM Configuration Management on the physical host to the IP binding method.

Secondary node

Changing the communication method on the physical host

Same as above

Setting the common definitions

Cluster setup of IM Configuration Management sets the values shown below in the common definitions for the logical host.

Table 1‒51: Common definitions for the logical host

Path

Key name

Setting

logical-host-name\JP1CONF\

JP1CONFIG_CONFDIR

shared-directory-name/jp1imm/conf/imcf

JP1CONFIG_TMPDIR

shared-directory-name/jp1imm/tmp

JP1CONFIG_LOGDIR

shared-directory-name/jp1imm/log/imcf

JP1CONFIG_DATADIR

shared-directory-name/jp1imm/data/imcf

JP1_BIND_ADDR

IP

Creating the shared directory

Cluster setup of IM Configuration Management creates the directories shown below. Appropriate permissions are set for the created directories. Do not change the set permissions of the directories.

Table 1‒52: Directories created when the jp1cf_setup_cluster command is executed

Type of files to be stored

Directory

Definition files

shared-directory-name/jp1imm/conf/imcf

Log files

shared-directory-name/jp1imm/log/imcf

Temporary files

shared-directory-name/jp1imm/tmp

Data for the system hierarchy and profiles

shared-directory-name/jp1imm/data/imcf

Setting startup of IM Configuration Management for the instance of Central Console on the logical host

Execute the jcoimdef command to add the IM Configuration Management startup settings to the process management of the instance of Central Console on the same logical host.

Changing the communication method for IM Configuration Management on the physical host

Cluster setup of IM Configuration Management changes the communication method for the physical host to the IP binding method by changing the value of JP1_BIND_ADDR under the JP1_DEFAULT\JP1CONFIG\ common definition to IP.

Format

jp1cf_setup_cluster  -h logical-host-name
                     [-d shared-directory-name]

Execution permission

Superuser permissions

Storage directory

/opt/jp1imm/bin/imcf

Arguments

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host where the command is executed. The command reorganizes the database for the specified logical host. The permitted length is from 1 to 63 bytes characters. If this option is omitted, an error results.

-d shared-directory-name

Specifies the shared directory for the logical host in order to set up the primary node. When this option is omitted, the command sets up the secondary node. The permitted length is from 1 to 165 bytes characters.

Return values

0

Normal termination

1

Abnormal termination

Notes

When you set up the primary node, you must mount the shared disk in order to copy the definition files to the shared directory and create a monitoring object database.

You must set up a logical host for each node.

When you execute this command, the socket binding method used for TCP/IP communication is changed to the IP binding method. The command changes this setting for the physical host and for the logical host that is to be created. For details about the socket binding method used for TCP/IP communication, see the documentation for the applicable OS.

jp1cfhasetup (Windows only)

Function

This command sets up an environment for IM Configuration Management when you are operating in a cluster system.

Before you execute this command, you must set up the logical host of JP1/Base.

When you execute this command, the socket binding method used for TCP/IP communication is changed to the IP binding method. The command changes this setting for the physical host and for the logical host that is to be created. For details about the socket binding method used for TCP/IP communication, see the documentation for the applicable OS.

Format

jp1cfhasetup

Execution permission

Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

Storage directory

Manager-path\bin\imcf\

Notes

If you want to execute the jp1cfhasetup command, execute the jp1cohasetup command first.

Set a logical host for each node.

You must have set up the logical host for JP1/Base beforehand. For details about how to set up JP1/Base, see the JP1/Base User's Guide.

jp1cohasetup (Windows only)

Function

This command displays the Settings for Central Console Cluster System dialog box, which is used to set up an operating environment for the logical host of JP1/IM - Manager (Central Console). Use this command to set up an environment for JP1/IM - Manager (Central Console) in a cluster system.

When you execute this command, the socket binding method used for TCP/IP communication is changed to the IP binding method. The command changes this setting for the physical host and for the logical host that is to be created. For details about the socket binding method used for TCP/IP communication, see the documentation for the applicable OS.

Format

jp1cohasetup

Execution permission

Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

Storage directory

Console-path\bin\

Notes

Use this command to set up an environment for JP1/IM - Manager (Central Console) in a cluster system. Use the jp1cshasetup command to set up an environment for JP1/IM - Manager (Central Scope).

Set a logical host for each node.

You must have set up the logical host for JP1/Base beforehand. For details about how to set up JP1/Base, see the JP1/Base User's Guide.

jp1cohaverup

Function

This command upgrades a logical host environment that was set up for JP1/IM - Manager. Use this command after you have upgraded your JP1/IM - Manager in a logical host environment.

Format

jp1cohaverup -h logical-host-name

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-h logical-host-name

Specifies the name of the logical host to be upgraded. If this option is omitted, an error results.

Notes

You must terminate JP1/IM - Manager before you execute this command. An error results if this command is executed while JP1/IM - Manager is running.

Execute this command only on the primary host. Make sure that the shared disk is mounted when the command executes. Do not execute this command on the secondary host.

After you have executed this command, you must back up the common definition information from the primary host, copy the backup common definition information to the secondary host, and then use the jbssetcnf command to set the information.

If you have installed a corrected edition of the same version by overwriting, there is no need to execute this command.

Return values

0

Normal termination

1

Abnormal termination

Examples

Upgrade logical host host01:

jp1cohaverup -h host01

Example output

jp1cohaverup -h host01
KAVB9101-I The upgrading of the logical host environment will now start.
KAVB9102-I The upgrading of the logical host environment has finished.

jp1cs_setup (UNIX only)

Function

This command sets up an operating environment for JP1/IM - Manager (Central Scope).

Use this command only after you have uninstalled JP1/Base on a computer where both JP1/IM - Manager and JP1/Base were installed and you have then re-installed JP1/Base. When you use Hitachi Program Product Installer to perform a new installation or an overwrite installation of JP1/IM - Manager, there is no need to execute this command.

You must terminate JP1/IM - Manager before you use this command.

Format

jp1cs_setup

Execution permission

Superuser permissions

Storage directory

/opt/jp1scope/bin/

Return values

0

Normal termination

1

Abnormal termination

jp1cs_setup_cluster (UNIX only)

Function

This command sets up an operating environment for a logical host of JP1/IM - Manager (Central Scope). Use this command for environment setup in a cluster system.

Set up the environment for the primary node first, and then set up the standby node.

In the environment setup for the primary node, you must specify the logical host name and shared directory name. When you execute the command, information such as definition files is copied to the specified shared directory; therefore, you must have already made the shared disk available for use.

In the environment setup for the standby node, specify only the logical host name. The operating environment is set up based on the information specified for the executing node.

Before you start setting up an environment for the secondary node, you must use the jbsgetcnf and jbssetcnf commands of JP1/Base to copy to the standby node the common definition information set at the executing node.

Before you use this command, terminate JP1/IM - Manager.

When you execute this command, the socket binding method used for TCP/IP communication is changed to the IP binding method. The command changes this setting for the physical host and for the logical host that is to be created. For details about the socket binding method used for TCP/IP communication, see the documentation for the applicable OS.

Format

jp1cs_setup_cluster -h logical-host-name
                   [-d shared-directory-name]

Execution permission

Superuser permissions

Storage directory

/opt/jp1scope/bin/

Arguments

-h logical-host-name

Specifies a host name for the logical host whose environment is to be set up. The permitted length is from 1 to 63 bytes characters.

Set the specified logical host name in the hosts file and in the name server to enable TCP/IP communication.

-d shared-directory-name

Specifies a shared directory for storing the information that is to be inherited during node switching. Specify a directory on the shared disk. The permitted length is from 1 to 165 bytes characters.

The command creates the directories listed below in the specified shared directory and then copies definition files from /etc/opt/jp1scope/conf/. Appropriate permissions are set for the created directories. Do not change the set permissions of the directories.

Table 1‒53: Directories created by the jp1cs_setup_cluster command

Type of files to be stored

Directory

Definition files

shared-directory-name/jp1scope/conf/

Log files

shared-directory-name/jp1scope/log/

Temporary files

shared-directory-name/jp1scope/tmp/

Database information

shared-directory-name/jp1scope/database/

Change the definition files, if necessary.

Notes

You must set a logical host for each node.

You must make the shared disk available for use before you set up an environment for the primary node by executing the jp1cs_setup_cluster command.

Return values

0

Normal termination

1

Abnormal termination

Examples

Set up an environment with the following conditions:

Logical host name: lnode0
Shared disk: shdsk/lnode0

Setting up the logical host environment at the primary server

jp1cs_setup_cluster -h lnode0 -d /shdsk/lnode0

Setting up the logical host environment at the secondary server

jp1cs_setup_cluster -h lnode0

jp1cshasetup (Windows only)

Function

This command displays the Settings for Central Scope Cluster System dialog box that is used to set up an operating environment for the logical host of JP1/IM - Manager (Central Scope). Use this command to set up an environment for JP1/IM - Manager (Central Scope) in a cluster system.

When you execute this command, the socket binding method used for TCP/IP communication is changed to the IP binding method. The command changes this setting for the physical host and for the logical host that is to be created. For details about the socket binding method used for TCP/IP communication, see the documentation for the applicable OS.

Format

jp1cshasetup

Execution permission

Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

Storage directory

Scope-path\bin\

Notes

Use this command to set up an environment for JP1/IM - Manager (Central Scope) in a cluster system. Use the jp1cohasetup command to set up an environment for JP1/IM - Manager (Central Console).

Set a logical host for each node.

You must have set up the logical host for JP1/Base beforehand. For details about how to set up JP1/Base, see the chapter that describes setup for operation in a cluster system in the JP1/Base User's Guide.

You must have already set up a logical host for JP1/IM - Manager (Central Console).

jp1cshaverup (UNIX only)

Function

This command upgrades a logical host environment that was set up for JP1/IM - Manager (Central Scope). Use this command after you have upgraded your JP1/IM - Manager (Central Scope) in a logical host environment.

Format

jp1cshaverup -h logical-host-name
             [-w work-directory]

Execution permission

Superuser permissions

Storage directory

/opt/jp1scope/bin/

Arguments

-h logical-host-name

Specifies the name of the logical host to be upgraded. If this option is omitted, an error results.

-w work-directory

Specifies the full path of a work directory that will be used to upgrade the logical host environment for JP1/IM - Manager (Central Scope).

If this option is omitted, /opt/jp1scope/tmp/ is assumed.

Notes

You must terminate JP1/IM - Manager before you execute this command. An error results if this command is executed while JP1/IM - Manager is running.

Once the jp1cshaverup command has been executed, JP1/IM - Manager (Central Scope) runs under the new version that has been installed, and you can no longer log in from the Monitoring Tree (Editing) window of JP1/IM - View version 08-01 or earlier.

Return values

0

Normal termination

1

Specified logical host name was not found

2

Argument error

4

No permission to execute the command

12

Insufficient memory

13

Insufficient disk capacity

31

Database initialization error

32

Data access error

42

A service is running

45

An attempt was made to execute the command on the new version of the database

99

Other error

Examples

Upgrade the logicalhost logical host environment for the JP1/IM - Manager (Central Scope) instance that is running under version 08-01; use the /temp/ work directory:

jp1cshaverup -h logicalhost -w /temp

Example output

The upgrade processing started.
KAVB7750-I Upgrading of the database version has finished.
KAVB7624-I The jcsdbconvert command finished successfully.
The upgrade processing ends successfully.

jp1cshaverup.bat (Windows only)

Function

This command upgrades a logical host environment that was set up for JP1/IM - Manager (Central Scope). Use this command after you have upgraded your JP1/IM - Manager (Central Scope) in a logical host environment.

Format

jp1cshaverup.bat -h logical-host-name
                [-w work-directory]

Execution permission

Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

Storage directory

Scope-path\bin\

Note: This command is not included in JP1/IM - Manager for Linux.

Arguments

-h logical-host-name

Specifies the name of the logical host that is to be upgraded. If this option is omitted, an error results.

-w work-directory

Specifies the full path of a work folder that will be used to upgrade the logical host environment for JP1/IM - Manager (Central Scope). If the path contains a space, enclose the entire path in double-quotation marks (").

If this option is omitted, Scope-path\tmp\ is assumed.

Notes

You must terminate JP1/IM - Manager before you execute this command. An error results if this command is executed while JP1/IM - Manager is running.

Once the jp1cshaverup.bat command has been executed, JP1/IM - Manager (Central Scope) runs under the new version that has been installed, and you can no longer log in from the Monitoring Tree (Editing) window of JP1/IM - View version 08-01 or earlier.

Return values

0

Normal termination

1

Specified logical host name was not found

2

Argument error

4

No permission to execute the command

12

Insufficient memory

13

Insufficient disk capacity

31

Database initialization error

32

Data access error

42

A service is running

45

An attempt was made to execute the command on the new version of the database

99

Other error

Examples

Upgrade the logicalhost logical host environment for the JP1/IM - Manager (Central Scope) instance that is running under version 08-01; use the C:\temp\ work folder:

jp1cshaverup -h logicalhost -w C:\temp

Example output

The upgrade processing started.
KAVB7750-I Upgrading of the database version has finished.
KAVB7624-I The jcsdbconvert command finished successfully.
The upgrade processing ends successfully.

jp1csverup (UNIX only)

Function

This command upgrades a physical host environment that has been set up for JP1/IM - Manager (Central Scope) under version 08-01 or earlier. Use this command after you have upgraded your JP1/IM - Manager (Central Scope) from version 08-01 or earlier.

You must execute this command in order to use the functions of a new version of JP1/IM - Manager (Central Scope) that has been installed. However, if you want to use only the functions supported by version 08-01 or earlier, do not execute this command.

Format

jp1csverup [-w work-directory]

Execution permission

Superuser permissions

Storage directory

/opt/jp1scope/bin/

Note: This command is not included in JP1/IM - Manager for Linux.

Arguments

-w work-directory

Specifies the full path of a work directory that will be used to upgrade the physical host environment for JP1/IM - Manager (Central Scope).

If this option is omitted, /opt/jp1scope/tmp/ is assumed.

Notes

You must terminate JP1/IM - Manager before you execute this command. An error results if this command is executed while JP1/IM - Manager is running.

Before you execute this command, check the available disk space. To execute this command, you need free space equivalent to the size of the monitoring object database. The monitoring object database consists of all data in the following directory:

/var/opt/jp1scope/database/jcsdb/

Once the jp1csverup command has been executed, JP1/IM - Manager (Central Scope) runs under the new version that has been installed, and you can no longer log in from the Monitoring Tree (Editing) window of JP1/IM - View version 08-01 or earlier.

Return values

0

Normal termination

2

Argument error

4

No permission to execute the command

12

Insufficient memory

13

Insufficient disk capacity

31

Database initialization error

32

Data access error

42

A service is running

45

An attempt was made to execute the command on the new version of the database

99

Other error

Examples

Upgrade the physical host environment for the JP1/IM - Manager (Central Scope) that is running under version 08-01; use the /temp/ work directory:

jp1csverup -w /temp

Example output

The upgrade processing started.
KAVB7750-I Upgrading of the database version has finished.
KAVB7624-I The jcsdbconvert command finished successfully.
The upgrade processing ends successfully.

jp1csverup.bat (Windows only)

Function

This command upgrades a physical host environment that has been set up for JP1/IM - Manager (Central Scope) under version 08-01 or earlier. Use this command after you have upgraded your JP1/IM - Manager (Central Scope) from version 08-01 or earlier.

You must execute this command in order to use the functions of a new version of JP1/IM - Manager (Central Scope) that has been installed. However, if you want to use only the functions supported by version 08-01 or earlier, do not execute this command.

Format

jp1csverup.bat [-w work-directory]

Execution permission

Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

Storage directory

Scope-path\bin\

Arguments

-w work-directory

Specifies the full path of a work folder that will be used to upgrade the physical host environment for JP1/IM - Manager (Central Scope). If the path contains a space, enclose the entire path in double-quotation marks (").

If this option is omitted, Scope-path\tmp\ is assumed.

Notes

You must terminate JP1/IM - Manager before you execute this command. An error results if this command is executed while JP1/IM - Manager is running.

Before you execute this command, check the available disk space. To execute this command, you need free space equivalent to the size of the monitoring object database. The monitoring object database consists of all data in the following folder:

Scope-path\database\jcsdb\

Once the jp1csverup.bat command has been executed, JP1/IM - Manager (Central Scope) runs under the new version that has been installed, and you can no longer log in from the Monitoring Tree (Editing) window of JP1/IM - View version 08-01 or earlier.

Return values

0

Normal termination

2

Argument error

4

No permission to execute the command

12

Insufficient memory

13

Insufficient disk capacity

31

Database initialization error

32

Data access error

42

A service is running

45

An attempt was made to execute the command on the new version of the database

99

Other error

Examples

Upgrade the physical host environment for the JP1/IM - Manager (Central Scope) that is running under version 08-01; use the C:\temp work folder:

jp1csverup -w C:\temp

Example output

The upgrade processing started.
KAVB7750-I Upgrading of the database version has finished.
KAVB7624-I The jcsdbconvert command finished successfully.
The upgrade processing ends successfully.

SpmSetSvcCon (Windows only)

Function

This command sets or cancels dependencies between the JP1/IM-Manager service and the JP1/Base Event service. If only JP1/IM - Manager needs to be deleted from a logical host, this command can also delete only the JP1/IM-Manager service on the logical host.

Format

SpmSetSvcCon {-setdepend {yes|no} | -d -h logical-host-name}

Execution permission

Administrator permissions (If the Windows UAC feature is enabled, the command is executed from the administrator console)

Storage directory

Console-path\bin\

Arguments

-setdepend {yes|no}

Sets the dependencies for a registered service.

yes: Sets the dependencies between the JP1/IM-Manager service and the JP1/Base Event service.

no: Cancels the dependencies between the JP1/IM-Manager service and the JP1/Base Event service.

-d -h logical-host-name

Specify this option to delete only JP1/IM - Manager from a logical host. For details about the procedure for deleting only JP1/IM - Manager from a logical host, see 7.6.1(3) Deleting only JP1/IM - Manager and IM databases on a logical host in the JP1/Integrated Management 2 - Manager Configuration Guide.

Return values

0

Normal termination

1

Argument error

2

Execution permission error

3

The JP1/IM-Manager service is not registered

255

Other error

2 Definition Files

This chapter describes the format and syntax of JP1/IM definition files.

List of definition files

The following table lists the JP1/Integrated Management definition files.

List of definition files

Table 2‒1: List of definition files

Product name

Definition file name

Description

JP1/Base

Configuration definition file

Defines the system hierarchy that is to be managed by JP1/IM. For details about the configuration definition file (jbs_route.conf), see the JP1/Base User's Guide.

Environment variable file

Defines environment variables to be used when commands are executed at managed hosts in JP1/IM. For details about the environment variable file, see the JP1/Base User's Guide.

Host group definition file

Defines a group of managed hosts in JP1/IM. For details about the host group definition file, see the JP1/Base User's Guide.

JP1/IM - Manager

JP1/IM - Manager

Common definition settings file (changing the attribute of JP1 events)

Changes the attribute of JP1 events.

Operation log definition file (imm_operationlog.conf)

Defines whether to output operation log data, the output destination, log file size, and number of files.

Intelligent Integrated Management Base

Intelligent Integrated Management Base definition file (imdd.properties)

Defines system settings for the Intelligent Integrated Management Base.

System node definition file (imdd_systemnode.conf)

Contains settings to define the hierarchical structure of the system to represent the structure in a sunburst or tree chart, and settings to group collected data into defined hosts.

Category name definition file for IM management nodes (imdd_category_name.conf)

Defines IM management node category names for management groups to be displayed in a sunburst or tree chart.

Target host definition file for configuration collection (imdd_target_host.conf)

Defines the hosts from which to collect information regarding monitoring objects of each linked product.

Host name definition file (imdd_host_name.conf)

Defines mapping between aliases and real host names.

IM management node link definition file (imdd_nodeLink_def.conf)

Defines relationships between IM management nodes.

Central Console

Event-source-host mapping definition file (user_hostmap.conf)

Defines mapping on the event source host.

Automated action environment definition file (action.conf.update)

Defines an execution environment for automated actions.

Automated action definition file (actdef.conf)

Defines conditions for executing an automated action and the command to be executed as the action.

Automated action definition file (actdef.conf) (for conversion)

Defines (for conversion) conditions for executing an automated action and the command to be executed as the action.

Automatic action notification definition file (actnotice.conf)

Defines the automated action status notification function.

Extended startup process definition file (jp1co_service.conf)

Defines process information for the functions that constitute JP1/IM - Manager.

IM parameter definition file (jp1co_param_V7.conf)

Defines whether a JP1 event is to be issued when JP1/IM - Manager processes fail or when JP1/IM - Manager processes are recovered automatically from abnormal termination.

System profile (.system)

Defines environment information for the basic operation of the event console.

User profile (defaultUser | profile_user-name)

Defines environment information for how the Event Console window is displayed.

Communication environment definition file (console.conf.update)

Defines communication processing (timeout period) among JP1/IM - Manager, the viewer, and the jcochstat command.

Health check definition file (jcohc.conf)

Defines whether the health check function is to be enabled.

Event guide information file (jco_guide.txt)

Defines event guide information for JP1 events that occur in the system and create problems.

Status event definition file (processupdate.conf)

Defines whether a JP1 event is to be issued when the action status changes.

Correlation event generation system profile (egs_system.conf)

Defines the start and stop operations for the Event Generation Service.

Correlation event generation definition file

Defines the JP1 event conditions that result in generation of correlation events and the correlation events that are generated when the JP1 event conditions are satisfied.

Correlation event generation environment definition file

Defines the size and number of correlation event generation history files.

Definition file for manually registering incidents (incident.conf)

A definition file for linkage with JP1/Service Support. The file defines JP1/Service Support for linkage with JP1/IM - View.

Configuration file for incident inheritance information(incident_info.conf)

A configuration file for linkage with JP1/Service Support. The file defines JP1 events' attributes and character strings to be inherited by incidents.

Severity changing definition file (jcochsev.conf)

Defines conditions for changing the severity of JP1events and the new severity level.

Command button definition file (cmdbtn.conf)

Defines command buttons to be displayed in the Execute Command window.

File that defines which items are displayed for event conditions (attr_list.conf)

Specifies the conversion rules for the automated action and command execution event inheritance function.

Configuration file for converting information (event_info_replace.conf)

Specifies the conversion rules for the automated action event inheriting function.

Item file

Specifies the JP1 event attributes that are to be output during output of event reports.

Environment definition file for event report output (evtreport.conf)

Defines the execution environment of the event report output function.

Filter file

Defines filter conditions to be applied during output of event reports.

System color definition file (systemColor.conf)

Defines the color settings used for an event list.

Definition file for extended event attributes

Defines extended attributes of JP1 events.

Definition file for extended event attributes (extended file)

Defines the settings for displaying program-specific extended attributes of JP1 events as item names on the screen and in the output of event reports.

Definition file for object types

Defines the object types of the extended attributes of JP1 events.

Common-exclusion-conditions extended definition file

Defines the event conditions or the applicable period of the extended-mode common exclusion-conditions.

Common-exclusion-conditions display item definition file (common_exclude_filter_attr_list.conf)

Specifies the items to be displayed in the Attribute name display area in the Common Exclusion-Conditions Settings (Extended) window.

Common-exclusion-conditions auto-input definition file (common_exclude_filter_auto_list.conf)

Defines JP1 event attributes that are set automatically when the Common Exclusion-Conditions Settings (Extended) window opens.

Display item definition file for the repeated event condition (event_storm_attr_list.conf)

Specifies the items to be displayed in the Attribute name display area in the Repeated Event Condition Settings window.

Auto-input definition file for the repeated event condition (event_storm_auto_list.conf)

Defines the attribute of a JP1 event that is set automatically when the Repeated Event Condition Settings window opens.

Display item definition file for the severity change definition (chsev_attr_list.conf)

A definition file that specifies the items to display in the Attribute name display area of the Severity Change Definition Settings window.

Auto-input definition file for the severity change definition (chsev_auto_list.conf)

Defines the JP1 event attribute that is set automatically when the Severity Change Definition Settings window opens.

Definition file for opening monitor windows

Defines settings for opening monitor windows.

Email environment definition file (jimmail.conf)

A definition file that sets information necessary to send an email by using JP1/IM - Manager.

Display message change definition file (jcochmsg.conf)

Defines the JP1 event conditions and new messages when changing the display of messages using the event display message change function.

Display item definition file for a display message change definition (chmsg_attr_list.conf)

Specifies the items to be displayed in the Attribute name display area of the Display Message Change Definition Settings window.

Automatic input definition file for a display message change definition (chmsg_auto_list.conf)

Specifies the conditions to be automatically set when the Display Message Change Definition Settings window opens.

Environment definition file for events after the display message is changed (chmsgevent.conf)

Defines the behavior of the function for issuing an event when a display message is changed.

Central Scope

Host information file (jcs_hosts)

Defines the host information that is managed by JP1/IM - Manager (Central Scope).

Guide information file (jcs_guide.txt)#1

Defines guide information about the JP1 events that trigger a change in monitoring object status.

Settings file for the maximum number of status change events (evhist_warn_event_xxx.conf)#2

Defines whether a JP1 event is to be issued when the number of status change events for a monitoring object exceeds a maximum value.

Settings file for the completed-action linkage function (action_complete_xxx.conf)#2

Defines whether the completed-action linkage function is to be enabled.

Definition file for automatic delete mode of status change event

Defines whether the function that automatically deletes the status change events when a JP1 event's status becomes Processed is to be enabled.

Definition file for monitoring object initialization mode

Defines whether the function that initializes monitoring objects when a specific JP1 event is received is to be enabled.

Automatic backup and recovery settings file for the monitoring object database (auto_dbbackup_xxx.conf)#2

Defines whether the function that protects the monitoring object database from corruption caused by OS shutdown or cluster system switching during monitoring tree update processing is to be enabled.

Definition file for on memory mode of status change condition

Specifies whether the memory-resident status change condition function is to be enabled.

System profile of Central Scope (jcs_sysprofile_xxx.def)#1

Common definition information for Central Scope viewer.

When you log in to Central Scope, this file is sent to Central Scope viewer.

IM Configuration Management

Operation definition file for IM Configuration Management - View (jcfview.conf)

Specifies the operation of IM Configuration Management - View.

Apply-IM-configuration-method definition file (jp1cf_applyconfig.conf)

Defines how to apply the system hierarchy.

Host input information file (host_input_data.csv)

An export file for host input information related to managed hosts of IM Configuration Management.

Collected host information file (host_collect_data.csv)

An export file for collected host information related to managed hosts of IM Configuration Management.

Profile management environment definition file (jp1cf_profile_manager.conf)

Defines information about the execution environment for the profile management function.

Remote log trap environment definition file (jp1cf_remote_logtrap.conf)

Defines the execution environment for the remote-monitoring log file trap function and the remote-monitoring event log trap function.

Remote-monitoring log file-trap action definition file

Defines actions for the remote monitoring log trap function.

Remote-monitoring event log trap action-definition file

Defines actions for the remote monitoring event log trapping function.

IM database

Setup information file (jimdbsetupinfo.conf)

Specifies setup information, such as the size of the IM database and the directory for storing data for the IM database, when the integrated monitoring database and IM Configuration Management database are set up.

Cluster setup information file (jimdbclustersetupinfo.conf)

A file that describes the directory to store the size or data of the IM database for a logical host when the integrated monitoring database and IM Configuration Management database are set up in a cluster environment.

JP1/IM - View

Communication environment definition file (view.conf.update)

Defines timeout periods for communication between JP1/IM - View and JP1/IM - Manager (Central Console).

Communication environment definition file (tree_view.conf.update)

Defines timeout periods for communication between JP1/IM - View and JP1/IM - Manager (Central Scope).

Non-encryption communication host configuration file (nosslhost.conf)

Configures hosts that use non-encrypted communication.

IM-View settings file (tuning.conf)

Defines the operation of JP1/IM - View, such as the number of connected-host log entries in the Login window and the operation when the Event Console window is displayed.

Web page call definition file (hitachi_jp1_product-name.html)

Used for calling another product's Web page from the Tool Launcher window.

Start program definition file (!JP1_CS_APP0.conf)

Defines the start path for a program that is added to the toolbar in the Monitoring Tree window.

Toolbar definition file (!JP1_CS_FTOOL0.conf)

Defines the order of programs that are added to the toolbar in the Monitoring Tree window.

Icon operation definition file (!JP1_CS_FTREE0.conf)

Defines the operation of icons that are added to the toolbar in the Monitoring Tree window.

Configuration file for monitoring tree

Defines the configuration of the monitoring tree that is displayed in the Monitoring Tree window.

Definition file for executing applications

Defines the IDs and paths of applications that are executed by the viewer.

Definition file for the Tool Launcher window

Defines the tree that is to be displayed in the Tool Launcher window.

System profile of the Central Scope viewer (system.conf)

Central Scope Viewer common definition information.

Defines the Monitoring Tree (Editing) window and the Visual Monitoring (Editing) window.

Performance report display definition file (performance.conf)

Defines the function for displaying the performance report of the host that issued the event. This file defines the URL of the connection-target instance of JP1/PFM - Web Console.

#1: The file name of the guide information file used in the system profile of Central Scope, and UNIX version of JP1/IM - Manager depend on the language used by the JP1/IM - Manager. The xxx part of the guide information file is explained later in the section describing details of each file.

#2: There are two settings files for the maximum number of status change events, two settings files for the completed-action linkage function, and two automatic backup and recovery settings files for the monitoring object database. Either on or off is set in xxx.

Format of definition file explanations

This section describes the format of the definition file. Note that some of the items shown below might be omitted in some definition file explanations. Do not use any environment-dependent character in definition files or definition file names. Such a character might cause character corruption.

Format

Describes the format of the definition file.

File

Shows the name of the definition file.

Storage directory

Describes the definition file's storage location.

Description

Describes the use of the definition file.

When the definitions are applied

Describes when the definition file's contents are applied.

Information that is specified

Describes the information that is specified in the definition file.

Example definition

Provides an example of the definition file.

Definition files for displaying user-specific event attributes

You can extend the functions for linking JP1/IM to other applications by customizing JP1/IM definition files.

Customizing JP1/IM definition files

Extending functions enables you to do the following:

Display user-specific event attributes

Display the monitor window from JP1 events displayed in JP1/IM - View

Add new menus to the Tool Launcher window

Note:

If you use UTF-8 as the encoding to save a customized definition file, save the file without attaching a BOM (byte order mark).

For details about the functions, see 4.14 Displaying user-defined event attributes in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

Overview of definition files

In a definition file, blocks that specify definitions are related to each other. Moreover, the definition files are related to each other. The following figure shows these relationships.

Figure 2‒1: Relationships between definition blocks and definition files

Naming rules for definition files

The following shows the naming rules for definition files.

Table 2‒2: Naming rules for definition files

Definition file

Naming rule

Definition file for extended event attributes

company-name_product-name_attr_en.conf

Definition file for object types

company-name_product-name_obj.en

Definition file for executing applications

company-name_product-name_app.conf

Definition file for opening monitor windows

company-name_product-name_mon.conf

Definition file for the Tool Launcher window

company-name_product-name_tree.conf

Note that product-name may also be specified as series-name_product-name. We recommend that for JP1 event issuance you use as the file name the value specified in PRODUCT_NAME, with the forward slash (/) replaced by the underscore (_). Because hitachi is used as the default file name, use a name other than hitachi for company-name.

Storage locations for definition files

The following shows the storage location for each definition file.

Table 2‒3: Storage locations for definition files

Definition file

Storage location

Definition file for extended event attributes

Machine where JP1/IM - Manager is installed

Definition file for opening monitor windows

Machine where JP1/IM - Manager is installed

Definition file for object types

Machine where JP1/IM - Manager is installed

Definition file for executing applications

Machine where JP1/IM - View is installed

Definition file for the Tool Launcher window

Machine where JP1/IM - View is installed

Structures of definition files

This section provides information that is common to the JP1/IM definition files that can be customized in order to link with the Event Console window and Tool Launcher window.

The information provided in this section is applicable to the following three definition files:

Definition file for extended event attributes

Definition file for executing applications

Definition file for the Tool Launcher window

The definition file for object types and the definition file for opening monitor windows have different structures.

Components of definition files

The principal components of a definition file are the statement, blocks, and comments. A definition file begins with the statement that represents the attributes of the entire file (definition information header), followed by blocks that describe the details of the definition and any comments.

The following describes these components of a definition file.

Statement

Structure of a statement

A statement consists of multiple components that form a single meaning. A statement always begins at the beginning of a line and ends with a semicolon (;), followed by a linefeed code.

Types of statements

Statements are classified as in-file statements and in-block statements.

In-file statements

An in-file statement indicates attributes of the definition file. There are two types of in-file statements: statements for the definition information header, and statements for block control. Each statement in a file is prefixed with @.

In-block statements

An in-block statement indicates attributes of a block. All statements that can be specified between the start-of-block statement (@define-block) and the end-of-block statement (@define-block-end) are in-block statements, except for comments. The in-block statements that can be specified depend on the block.

In-block statements are not prefixed (i.e., there is no @).

Block

Structure of a block

A block consists of a set of statements. The set of statements includes a statement that declares the start of the block (@define-block), statements within the block that describe the actual definitions, comments, and a statement that declares the end of the block (@define-block-end).

Nested blocks are not allowed in a definition file.

Block type

A block's type is specified in the type= parameter of the start-of-block statement (@define-block). For details about the types of blocks, see @define-block statement.

Block priority

A block contains a key item that must be unique within the definition. If the definition contains multiple key items, one of the blocks is selected according to a priority ranking. The block priorities are as follows:

Block in the last file when file names are sorted in ascending order

Last block specified in the file

In other words, when definition files are linked into a single file in ascending order of the file names, the last block in the linked file has priority.

Comment

A comment is a line beginning with a hash mark (#) or a line consisting of only spaces, tabs, or a linefeed code. Comments do not contain definition information.

A comment is processed as a single statement. Because comments are evaluated by line, there is no need to delineate comments with a semicolon (;). If a comment ends with a semicolon (;), the semicolon is treated as part of the comment.

Rules for generating common Statements

The two types of in-file statements are statements for the definition information header and statements for block control.

The following table lists and describes the in-file statements.

Table 2‒4: List of in-file statements

Statement name

Description

Type

@file

Declares the definition version.

For the definition information header

@product

Declares program product information in the definition.

For the definition information header

@define-block

Declares the beginning of a block.

For block control

@define-block-end

Declares the end of a block.

For block control

In these statements, a statement for the definition information header defines attributes that are common to the entire definition file. The available statements for the definition information header depend on the definition file. The parameters for the statements for the definition information header also depend on the definition file.

A statement for block control is used to declare a block unit that is defined in the definition file. The rules for generating statements for block control are common to all definition files. These rules are described below.

For the rules for generating statements for the definition information header, see the descriptions of the individual definition files.

@define-block statement

Syntax

@define-block type="block-type";

Function

Declares the beginning of a block. Statements from this statement to the @define-block-end statement are treated as a single definition block.

Parameter

type="block-type"

Specifies the type of definition block. The following lists the block types that can be specified.

Table 2‒5: List of block types

Block name

Value in the parameter

Event attribute definition block

"event-attr-def"

Event attribute group definition block

"event-attr-group-def"

Event display sequence definition block

"event-attr-order-def"

Application execution definition block

"application-execution-def"

Menu tree definition block

"function-tree-def"

If an invalid block type is specified, the entire block is ignored and a warning is displayed, but file analysis processing continues.

Note:

Nested definition blocks are not allowed.

Example definition

See the description of the @define-block-end statement.

@define-block-endstatement

Syntax

@define-block-end;

Function

Declares the end of a definition block that begins with @define-block.

Note:

If there is no corresponding @define-block statement, file analysis processing is canceled.

Example definition

This example includes @define-block and @define-block-end statements:

@define-block type="event-attr-def";
block lang="English", platform="base", extended="false";
attr name="E.SEVERITY", title="Severity";
attr name="B.TIME", title="Registered time";
attr name="B.SOURCESERVER", title="Registration host";
attr name="E.USER_NAME", title="User name";
@define-block-end;

Common definition settings file (changing the attribute of JP1 events)

Format

[JP1_DEFAULT\JP1CONFIG]
"ATTR_EVENT_LOGTRAP_SOURCEHOST"=dword:{00000000 | 00000001}

File

Use any file.

jp1im_jp1_event_attributes.conf.model (model file for the common definition settings file (changing the attribute of JP1 events)

Storage directory

The storage directory of the model file for the common definition settings file (changing the attribute of JP1 events) is shown below. Copy the model file to create a new file, and give it any file name.

In Windows

Manager-path\conf

In UNIX

/etc/opt/jp1imm/conf

Description

This file sets information about the source attribute of an event log trap as common definition information.

When the definitions are applied

When the jbssetcnf command is executed, information about the common definition settings file (changing the attribute of JP1 events) is registered as common definition information. Thereafter, when JP1/IM - Manager is restarted, the setting for the common definition information takes effect. If the common definition is changed, JP1/IM - Manager must be restarted.

Information that is specified

The following rules apply to the common definition settings file (changing the attribute of JP1 events):

If # (0x23) is specified at the beginning of a line, the line is treated as a comment line.

Do not enter a space or a tab before or after an equal sign (=) or a comma (,), at the beginning of a line, or at the end of a line. If you do so, an error occurs when the jbssetcnf command is executed.

A line containing only a linefeed is invalid.

[JP1_DEFAULT\JP1CONFIG]

Do not change this line.

"ATTR_EVENT_LOGTRAP_SOURCEHOST"=dword:{00000000 | 00000001}

Determines the JP1/Base event log trap to be monitored by JP1/IM - Manager, and the attribute to be mapped to the event source host name attribute of a JP1 event for a remote-monitoring event log trap.

Specify either 00000000 or 00000001. The default value is 00000000.

If 00000000 is specified, a computer name is mapped to the event source host name of the JP1 event (event ID = 3A71).

If 00000001 is specified, the event server name is mapped to the event source host name of the JP1 event (3A71). In addition, the attribute of the event source host name is added to the JP1 event (3A71) for the remote-monitoring event log trap, and the monitored host name is displayed as the source host name.

For details about the attributes to be mapped to the event source host name of the JP1 event (3A71) for JP1/Base event log traps, see 13.3.11(2)(b) Changing JP1 event attributes (Setting for JP1/IM - Manager) in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

For details about the JP1 event (3A71) for the remote-monitoring event log trap, see 3.2.2(97) Details of event ID: 00003A71, or the event ID specified in the filter block of the remote-monitoring event log trap action-definition file.

Operation log definition file (imm_operationlog.conf)

Format

[logical-host-name\JP1IMM\OPERATION]
"ENABLE"=dword:hexadecimal-number
"LOGFILEDIR"="output-destination"
"LOGSIZE"=dword:hexadecimal-number
"LOGFILENUM"=dword:hexadecimal-number

Files

imm_operationlog.conf

imm_operationlog.conf.model (model file for the operation log definition file)

Storage directory

In Windows

Manager-path\conf

In UNIX

/etc/opt/jp1imm/conf

Description

This file specifies the common definition contents used by the operation log output function. Specify whether to output data to the operation log, the output destination and size of the operation log file, and the maximum number of log files that can be saved.

When the definitions are applied

When the jbssetcnf command is executed, the settings in the operation log definition file (imm_operationlog.conf) are registered in the common definition information. After that, the settings in the common definition information take effect when JP1/IM - Manager is restarted. If you change the common definition, you must restart JP1/IM - Manager.

Information that is specified

[logical-host-name\JP1IMM\OPERATION]

This entry indicates the key name of JP1/IM - Manager environment settings.

For the physical host, specify JP1_DEFAULT for logical-host-name. For a logical host, specify its name for logical-host-name.

"ENABLE"=dword:hexadecimal-number

Specify (using a hexadecimal number) whether to enable operation log output. The system assumes the initial value if this item is not defined or if you specify a value other than the following:

Initial value: 0x00000000

To disable operation log output, specify 0x00000000.

To enable operation log output, specify 0x00000001.

"LOGFILEDIR"="output-destination"

Specify (in absolute path format) the output destination of the operation log file (imm_operation.log). The maximum length of the output destination is 217 bytes. Specify an existing write-enabled directory for the output destination. We recommend that for the operation log of a logical host, specify an output destination on the shared disk.

Initial value

In Windows: Manager-path\log\operationlog

In UNIX: /var/opt/jp1imm/log/operationlog

Output destination example for a logical host:

In Windows: shared-folder\JP1IMM\log\operationlog

In UNIX: shared-directory/jp1imm/log/operationlog

Network paths cannot be specified as the output destination.

If the execution environment is a Windows environment, the following character strings cannot be specified for the output destination:

Character strings that contain colons (:), question marks (?), double quotation marks ("), left angle brackets (<), right angle brackets (>), or vertical bars (|)

Any of the following character strings (not case sensitive):

CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8,or LPT9

"LOGSIZE"=dword:hexadecimal-number

Specify (by using a hexadecimal number in megabytes) the size of the operation log file (imm_operation.log) by using a hexadecimal number. The system assumes the initial value if this item is not defined or if you specify a value outside the specifiable range.

Initial value: 0x00000005 (5 MB)

Specifiable range: 0x00000001 to 0x00000800 (1 MB to 2,048 MB)

"LOGFILENUM"=dword:hexadecimal-number

Specify (using a hexadecimal number) the maximum number of operation log files (imm_operation.log) that can be saved. The system assumes the initial value if this item is not defined or if you specify a value outside the specifiable range.

Initial value: 0x0000000A (10 files)

Specifiable range: 0x00000001 to 0x00000010 (1 to 16 files)

Example definition

The following shows an example of the operation log definition file for setting the log file size to 5 MB and for setting the maximum number of files that can be saved to 10. Note that the definition example shown below applies when JP1/IM - Manager is installed on a physical host whose OS is UNIX.

[JP1_DEFAULT\JP1IMM\OPERATION]
"ENABLE"=dword:00000001
"LOGFILEDIR"="/var/opt/jp1imm/log/operationlog"
"LOGSIZE"=dword:00000005
"LOGFILENUM"=dword:0000000A

Intelligent Integrated Management Base definition file (imdd.properties)

Format

server.port=port-number
jp1.imdd.proxy.server[n].host=host-name-of-proxy-server[n]
jp1.imdd.proxy.server[n].port=port-number-of-proxy-server[n]
jp1.imdd.proxy.server[n].user=authentication-user-ID-of-proxy-server[n]
jp1.imdd.proxy.target[n].host=target-host[n]-of-REST-API-that-uses-proxy-server
jp1.imdd.proxy.target[n].serverHost=target-host-name[n]-of-destination-proxy-server
jp1.imdd.gui.settings.contentViews.<custom UI Id>.title=title-displayed-on-custom-UI-tab
jp1.imdd.gui.settings.contentViews.<custom UI Id>.url=path-to-html-file-displayed-in-user-defined-window-display-area
jp1.imdd.gui.settings.contentViews.<custom UI Id>.sid=tree-SID-of-IM-management-node-on-which-user-defined-windows-are-displayed
jp1.imdd.gui.settings.contentViews.<custom UI Id>.target=SID-of-IM-management-node-on-which-user-defined-windows-are-displayed
jp1.im.db.DEFAULT.portNo=port-number-used-by-IM-database
jp1.im.db.DEFAULT.logicalHostNum=number-used-by-IM-database-for-logical-host-to-identify-logical-host
jp1.imdd.gui.settings.linkedUnit.impact.unKnownDisplay=whether-to-show/hide-impact-unknown-icon
jp1.imdd.event.stormCompatible=Compatible-setting-of-the-repeated-event-viewing-suppression-function
jp1.imdd.gui.settings.eventSearchCount=number-of-searches-in-event-acquisition
jp1.imdd.authBasic=whether-to-enable/disable-Basic-authentication

Files

imdd.properties

imdd.properties.model (model file for the Intelligent Integrated Management Base definition file)

Storage directory

In Windows

For a physical host:

Manager-path\conf\imdd\

For a logical host:

shared-folder\jp1imm\conf\imdd\

In UNIX

For a physical host:

/etc/opt/jp1imm/conf/imdd/

For a logical host:

shared-folder/jp1imm/conf/imdd/

Description

This file defines system settings for the Intelligent Integrated Management Base.

When the definitions are applied

The specified definitions take effect when JP1/IM - Manager starts.

Information that is specified

The following rules apply to the Intelligent Integrated Management Base definition file:

If # (0x23) is specified at the beginning of a line, the line is treated as a comment line.

Property names are case sensitive.

The definition file must be saved in UTF-8 without BOM (byte order mark).

If an invalid property is found, the system ignores the line to continue.

We cannot guarantee the behavior when a property is set to an unacceptable value.

server.port=port-number

Specifies a port number on which the Intelligent Integrated Management Base will receive HTTP connections.

The specified port number must be unique across the system and across the host that is created during the setup.

Acceptable values are from 5001 to 65535. The default value is 20703.

jp1.imdd.proxy.server[n].host=host-name-of-proxy-server[n]

Specifies the host name of proxy server [n].

The specified host name of the proxy server must be able to be resolved. If an invalid host name is specified, product plug-ins fail to execute APIs.

Use ASCII characters to specify it.

If you specify this property multiple times, use serial numbers starting from 0 for [n].

jp1.imdd.proxy.server[n].port=port-number-of-proxy-server[n]

Specifies the port number of proxy server [n].

Possible values are 1 to 65535. If the specified value is beyond the range of the possible values, the KAJY52016-W message is output and the proxy server [n] setting is disabled.

If you specify this property multiple times, use serial numbers starting from 0 for [n].

jp1.imdd.proxy.server[n].user=authentication-user-ID-of-proxy-server[n]

Specifies the user ID of the authentication user for proxy server [n].

If you use proxy server authentication, you must specify this option and configure authentication information for the proxy server. For details about the authentication information settings for the proxy server, see jddsetproxyuser in Chapter 1. Commands.

If you specify this property multiple times, use serial numbers starting from 0 for [n].

If you do not use proxy server authentication, you can omit this option.

jp1.imdd.proxy.target[n].host=target-host[n]-of-REST-API-that-uses-proxy-server

Specifies the host for target [n] that is a target of REST API which uses the proxy server. The host name of target [n] must have the host section in the URL of the REST API.

For example, if the REST API has the http://hitachi.co.jp/api/v1/restApi value, specify hitacih.co.jp.

Use ASCII characters to specify it.

If you specify this property multiple times, use serial numbers starting from 0 for [n].

jp1.imdd.proxy.target[n].serverHost=target-host-name[n]-of-destination-proxy-server

Specifies the host name of proxy server [n] working as the destination.

If the specified value is not configured for proxy server [n] or is invalid, the KAJY52018-W message is output and the settings for target host [n] are disabled.

Use ASCII characters to specify it.

If you specify this property multiple times, use serial numbers starting from 0 for [n].

jp1.imdd.gui.settings.contentViews.<custom UI Id>.title=title-displayed-on-custom-UI-tab

Specifies the title displayed on the custom UI tab when the custom UI display function is used.

The title must be a string with 255 or fewer characters that contains neither control nor machine-dependent characters.

If you use multi-byte characters, convert them into Unicode format (which is expressed as \udddd). In this case, the number of characters is counted as the number of them converted into Unicode.

You must specify this option for every <custom UI Id>.

jp1.imdd.gui.settings.contentViews.<custom UI Id>.url=path-to-html-file-displayed-in-user-defined-window-display-area

Specifies the path to the html file displayed in User-defined window display area in relative path format to public when the custom UI display function is used. The html file is located in the following location:

In Windows

Manager-path\public\customUI\

In UNIX

/opt/jp1imm/public/customUI/

Specify the path to the html file as a string with 255 or fewer characters that contains neither control nor machine-dependent characters. Use a forward slash (/) as a delimiter.

If you use multi-byte characters, convert them into Unicode format (which is expressed as \udddd). In this case, the number of characters is counted as the number of them converted into Unicode. You do not have to enclose a space character ( ) with double quotation marks (").

You must specify this option for every <custom UI Id>.

jp1.imdd.gui.settings.contentViews.<custom UI Id>.sid=tree-SID-of-IM-management-node-on-which-user-defined-windows-are-displayed

Specifies the tree SID of the IM management node on which user-defined windows are displayed when the custom UI display function is used.

The tree SID of the IM management node you specify must have 1,048,576 or less characters. The characters allowed conform to the specifications of the tree SID specified.

You can use regular expressions when specifying the tree SID of an IM management node. When regular expressions are used, it may take time for searching if .*, which matches any string, is used many times. If you want to use .*, do so only when it is really necessary.

Note that the system does not check whether the specified tree SID exists.

You must specify either sid or target for every <custom UI Id>.

jp1.imdd.gui.settings.contentViews.<custom UI Id>.target=SID-of-IM-management-node-on-which-user-defined-windows-are-displayed

Specifies the SID of the IM management node on which user-defined windows are displayed when the custom UI display function is used.

The SID of the IM management node you specify must have 1,048,576 or less characters. The characters allowed conform to the specifications of the SID specified.

You can use regular expressions when specifying the SID of an IM management node. When regular expressions are used, it may take time for searching if .*, which matches any string, is used many times. If you want to use .*, do so only when it is really necessary.

Note that the system does not check whether the specified SID exists.

You must specify either sid or target for every <custom UI Id>.

jp1.im.db.DEFAULT.portNo=port-number-used-by-IM-database

Specifies the port number used by the IM database.

For a physical host, use the value specified for the IMDBPORT option in the setup information file that is used during setup of the integrated monitoring database. If the IMDBPORT option is set to its default, you do not have to specify the jp1.im.db.DEFAULT.portNo value.

For details about the setup information file, see Setup information file (jimdbsetupinfo.conf).

For a logical host, use the value specified for the IMDBPORT option in the cluster setup information file that is used during setup of the integrated monitoring database.

For details about the cluster setup information file, see Cluster setup information file (jimdbclustersetupinfo.conf).

jp1.im.db.DEFAULT.logicalHostNum=number-used-by-IM-database-for-logical-host-to-identify-logical-host

Specifies the number used by the IM database for a logical host to identify the host.

Specify the value used for the LOGICALHOSTNUMBER option in the cluster setup information file that is used during setup of the integrated monitoring database.

If a logical host is specified for jp1.im.db.DEFAULT.portNo, specify this option.

For details about the cluster setup information file, see Cluster setup information file (jimdbclustersetupinfo.conf).

jp1.imdd.gui.settings.linkedUnit.impact.unKnownDisplay=whether-to-show/hide-impact-unknown-icon

Specifies whether to show an icon indicating that it is unknown whether there is any impact on following root jobnets ( icon) in the Job flow tab and the Linked unit dialog box.

Specify either true or false. Use true if you want to show the icon, or false if not. The default value is true.

jp1.imdd.event.stormCompatible=Compatible-setting-of-the-repeated-event-viewing-suppression-function

In version 12-00, repeated-event display is not suppressed even if the -storm option of the jcoimdef command is set to ON. Therefore, if you upgraded from version 12-00, to use the repeated event viewing suppression function, the compatible setting of the Repeated event viewing suppression function must be disabled (false).

If you new install a version 12-10, the compatible setting of the repeated event viewing suppression Function is setting to Disabled (false) beforehand.

Specify either true or false.

If you set it to true, display of repeated events is not suppressed just like in 12-00. If you set it to false, display of repeated events is suppressed.

The default value is true.

The repeated-event display suppression function is enabled when suppression of repeated event monitoring in the -storm option of the jcoimdef command is set to ON and the jp1.imdd.event.stormCompatible option is set to false.

The repeated-event display suppression function is disabled when suppression of repeated event monitoring in the -storm option of the jcoimdef command is set to OFF, regardless of the jp1.imdd.event.stormCompatible option.

jp1.imdd.gui.settings.eventSearchCount=number-of-searches-in-event-acquisition

Specifies the number of searches during event acquisition that is performed by the integrated operation viewer to show the event list.

In event acquisition, the system searches for events mapped with the selected IM management node. Depending on the pages to be displayed, the search start position, search direction, and 100 events to be searched for are determined. If 100 events cannot be obtained due to an event receiver filter, the search is repeated for the next 100 events.

You specify the upper limit for the number of these repeated event searches. If the number of searches reaches the specified value, the search operation is interrupted and the events obtained before the interruption are displayed in the event list.

Possible values are 0 to 120000 (times). The number of times is unlimited if you specify 0 for it. The default is 10. If a value beyond the possible values is specified, the default value is assumed for operation.

jp1.imdd.authBasic=whether-to-enable/disable-Basic-authentication

In any REST API of the Intelligent Integrated Management Base, you can use an authentication method with login information added to the REST API (Basic authentication). This option specifies whether to enable the Basic authentication.

Specify either true or false.

The Basic authentication is enabled if the option is set to true.

The default is false.

For details about the REST API, see the manual provided separately.

Notes

If this definition file does not exist or could not be read when the Intelligent Integrated Management Base service starts, the service starts using the default values as properties and outputs the messages KAJY00015-W and KAJY00016-W to the integrated trace log.

Example definition

server.port=20703
jp1.imdd.proxy.server[0].host=ProxyServer
jp1.imdd.proxy.server[0].port=443
jp1.imdd.proxy.server[0].user=UserID
jp1.imdd.proxy.target[0].host=HostA
jp1.imdd.proxy.target[0].serverHost=ProxyServer

jp1.imdd.gui.settings.contentViews.sample.title=\u30ab\u30b9\u30bf\u30e0UI1
jp1.imdd.gui.settings.contentViews.sample.url=./customUI/sample/index.html
jp1.imdd.gui.settings.contentViews.sample.target=^(?=.*MYHOST).*$

jp1.imdd.gui.settings.contentViews.sample2.title=\u30ab\u30b9\u30bf\u30e0UI2
jp1.imdd.gui.settings.contentViews.sample2.url=./customUI/sample2/index.html
jp1.imdd.gui.settings.contentViews.sample2.sid=_ROOT_AllSystems

jp1.im.db.DEFAULT.portNo=20700
jp1.im.db.DEFAULT.logicalHostNum=[1-9]

jp1.imdd.gui.settings.linkedUnit.impact.unKnownDisplay=true
jp1.imdd.event.stormCompatible=false

jp1.imdd.gui.settings.eventSearchCount=10

jp1.imdd.authBasic=false

System node definition file (imdd_systemnode.conf)

Format

{
  "meta":{
    "version":"2"
  },
  "allSystem":[
    {
      "id":"first-system-name-ID",
      "displayName":"system-name-to-be-displayed",
      "jp1ResourcesGroup":"JP1-resource-group",
      "hostName":[{"host-name-string":"type"},...],
                   ...
                 ],
       "objectRoot":[
             {"type":"object-root-node-type",
              "name":[
                 {"object-root-node-string":"type"},
                    ...
                     ]
                    },
                    ...
             ],
      "children":[
        {
          "id":"first-subsystem-name-ID",
          "displayName":"subsystem-name-to-be-displayed",
          "jp1ResourcesGroup":"JP1-resource-group",
          "hostName":[
                       {"host-name-string":"type"},...],
                        ...
                     ],
            "objectRoot":[
                {"type":"object-root-node-type",
                 "name":[
                    {"object-root-node-string":"type"},
                       ...
                        ]
                       },
                       ...
                ],
          "children":[
            {
              "id":"subsystem-name-ID-under-second -subsystem",
              "displayName":"subsystem-name-to-be-displayed",
              "jp1ResourcesGroup":"JP1-resource-group",
              "hostName":[{"host-name-string":"type"},...],
              "objectRoot":[
                    {"type":"object-root-node-type",
                     "name":[
                        {"object-root-node-string":"type"},
                           ...
                            ]
                           },
                           ...
                    ]
              "children":[
                {
                  ...
                },
                ...
              ]
            },
            ...
          ]
        },
        {
          "id":"second-subsystem-name-ID",
          "displayName":"subsystem-name-to-be-displayed",
          "jp1ResourcesGroup":"JP1-resource-group",
          "hostName":[{"host-name-string"":"type"},...],
          "objectRoot":[
                {"type":"object-root-node-type",
                 "name":[
                    {"object-root-node-string":"type"},
                       ...
                        ]
                       },
                       ...
             ]
          "children":[
            {
              ...
            },
            ...
          ]
        },
        ...
      ]
    },
    {
      "id":"second-system-name-ID",
      ...
    },
    ...
  ]
}

Files

imdd_systemnode.conf

imdd_systemnode.conf.model (model file for the system node definition file)

Storage directory

In Windows

For a physical host:

Manager-path\conf\imdd\

For a logical host:

shared-folder\jp1imm\conf\imdd\

In UNIX

For a physical host:

/etc/opt/jp1imm/conf/imdd/

For a logical host:

shared-directory/jp1imm/conf/imdd/

Description

This setting file defines the hierarchical structure of the system to represent it in a sunburst or tree chart, and sorts collected data into different groups of defined hosts or other object root nodes.

It defines in what system each host or other object root node in the configuration information collected by the Intelligent Integrated Management Base is located.

Displayed items include hosts and other object root nodes in the agent configuration or remote monitoring configuration of JP1/IM - Manager and any node contained in the configuration information collected from other products. If the AJS manager or PFM manager is included in the linking host of JP1/IM - Manager (Intelligent Integrated Management Base), child AJS agents and PFM monitoring agents are also displayed in the tree.

The list of hosts and other object root nodes is obtained when the jddcreatetree command is executed, and the hosts and other object root nodes are allocated under the system according to the system node definition file (imdd_systemnode.conf) to create the hierarchical structure. Therefore, even a host or other object root node defined in the system node definition file (imdd_systemnode.conf) is not displayed in the tree if it is not found in the configurations of JP1/IM, JP1/AJS, or JP1/PFM.

If one node is used in more than one system or subsystem, the host must be defined to be included in one of those systems. One node cannot be managed by more than one system.

When the definitions are applied

The settings in the system node definition file are applied to the Intelligent Integrated Management Base when the jddcreatetree and jddupdatetree commands are completed successfully.

For details about the jddcreatetree and jddupdatetree commands, see jddcreatetree and jddupdatetree in Chapter 1. Commands.

Information that is specified

The system node definition file must be saved in UTF-8 without BOM (byte order mark). If you specify a backslash (\) as part of a character string, immediately before \, specify \ as an escape character.

version

Specifies the version of the system node definition file. Set this to 2. This option is mandatory.

id

Specifies a system ID to be set in the SID (a unique ID representing a component of a linked product) with alphanumeric characters. id can be up to 255 characters in length. The total maximum number of systems and system components that you can specify is 1,000. This option is mandatory.

For a system:

The value must be unique across systems directly under allSystem.

For a subsystem:

The value must be unique across subsystems directly under children.

To merge the system node definition files due to system consolidation, check for the uniqueness of the identifiers and change the id values if necessary.

displayName

Specifies the name of the system that will appear in a sunburst or tree chart.

The name can be up to 255 characters in length and must not include any control characters or machine-dependent characters. The value of displayName does not have to be unique in the system node definition file. It can be used multiple times.

jp1ResourcesGroup

Specifies a JP1 resource group to indicate an area to be monitored by the system. This field is not required unless you want to use JP1 resource groups to control access.

The value of jp1ResourcesGroup can be up to 64 characters in length and can include alphanumeric characters and the following symbols: exclamation mark (!), at mark (@), hash mark (#), dollar sign ($), percent sign (%), ampersand (&), underscore (_), hyphen (-), asterisk (*), single quotation mark ('), caret (^), left curly bracket ({), right curly bracket (}), left parenthesis((), right parenthesis ()),period (.), backslash (\), grave accent mark (`), and tilde (~).

hostName

Specifies a list of hosts in the IM configuration and hosts that belong to the system, such as registration agents for linked products, with a combination of a host name string and type as follows.

Host name string

Type (6 or less characters)

Specify a host name directly

"" (Empty string)

Specify hosts using regular expressions#

regexp

# For the regular expression, use an extended regular expression. For details about regular expressions, see Appendix G. Regular Expressions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

The host name can be up to 255 characters in length and can include alphanumeric characters and the following symbols: exclamation mark (!), dollar sign ($), left parenthesis ((), right parenthesis ()), asterisk (*), plus sign (+), comma (,), hyphen (-), period (.), forward slash (/), colon (:), left angle bracket (<), equal sign (=), left square bracket ([), backslash (\), right square bracket (]), caret (^), left curly bracket ({), vertical bar (|), and right curly bracket (}).

Example:

"hostName":[{"host1":""},{".+[1-5]+":"regexp"}]

The list of hosts specified in hostName is used to group data. The grouping proceeds from the top to the bottom of the list and handles host names case-insensitively. If a subsystem is not defined and type and name are not specified by children, this option cannot be omitted.

If duplicate host names are found, the second and further occurrences of the host name are ignored.

objectRoot

Specifies the object root node type, object root node string, and type of an object root node that belongs to a system or subsystem.

type

Specifies the type of the object root node name specified as name.

The specified object root node type is not case sensitive. For details about values that can be specified for type, see the manual for each product. You can specify only the value of HOST when JP1/AJS or JP1/PFM is linked.

If a subsystem is not defined by children and hostName is not specified, this option cannot be omitted.

You can specify single-byte alphanumeric characters and symbols including hyphen (-), period (.), colon (:), and tilde (~) as type.

name

Specifies the object root node string and type of an object root node that belongs to the system or a subsystem as follows.

Object root node string

Type

Specify an object root node string directly

"" (Empty string)

Specify hosts using regular expressions#

regexp

# For the regular expression, use an extended regular expression. For details about regular expressions, see Appendix G. Regular Expressions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

Example 1:

"name":{"switch1":""}

Example 2:

"name":{".+[1-5]+":"regexp"}

The list of object root nodes specified in name is used to group data. The grouping proceeds from the top to the bottom of the list and handles object root nodes case-insensitively. If the object root node name specified for name and the object root node type specified for type are duplicated, the second and subsequent object root node names are ignored.

If a subsystem is not defined by children and hostName is not specified, this option cannot be omitted.

children

Specifies a list of subsystems that are directly under the system with the values of the fields from id to children to define a hierarchical structure. A hierarchical structure can have up to 10 levels including the top system. The children field is not required unless the system has subsystems directly under itself.

For details about hierarchical structures that can be represented in a sunburst or tree chart in the integrated operation viewer, see the section describing the hierarchical structure of a sunburst or tree chart in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

Example definition 1

Definition of the example configuration

To define a structure that includes systems, subsystems, and their hosts described in the following figure:

Example configuration

{
  "meta":{
    "version":"2"
  },
  "allSystem":[
    {
      "id":"systemA",
      "displayName":"System A",
      "jp1ResourcesGroup":"SYSTEM_A",
      "hostName":[{"HOST-A0":""}],
      "children":[
        {
          "id":"subA1",
          "displayName":"System A-1",
          "jp1ResourcesGroup":"SYSTEM_A",
          "hostName":[{"HOST-A10":""},{"HOST-A11":""}]
        },
        {
          "id":"subA2",
          "displayName":"System A-2",
          "jp1ResourcesGroup":"SYSTEM_A",
          "children":[
            {
              "id":"subA21",
              "displayName":"System A-2-1",
              "jp1ResourcesGroup":"SYSTEM_A",
              "hostName":[{"^HOST-A21.*":"regexp"},{"HOST-A10-1":""}]
            },
            {
              "id":"subA22",
              "displayName":"System A-2-2",
              "jp1ResourcesGroup":"SYSTEM_A",
              "hostName":[{"HOST-A22":""}]
            }
          ]
        }
      ]
    },
    {
      "id":"systemB",
      "displayName":"System B",
      "jp1ResourcesGroup":"SYSTEM_B",
      "hostName":[{"HOST-B10":""},{"HOST-B11":""}]
    }
  ]
}

Example definition 2

Definition of a configuration where one host and root object node are used in more than one system or subsystem

As one host cannot be managed by more than one system, the host must be defined to be included in either System A or System B.

Example configuration

{
  "meta":{
    "version":"1"
  },
  "allSystem":[
    {
      "id":"systemA",
      "displayName":"System A",
      "hostName":[{"HOST1":""},{"HOST-A":""}]
    },
    {
      "id":"systemB",
      "displayName":"System B",
      "hostName":[{"HOST1":""},{"HOST-B":""}]
    }
  ]
}

Example definition to include the host in System A

{
  "meta":{
    "version":"1"
  },
  "allSystem":[
    {
      "id":"systemA",
      "displayName":"System A",
      "hostName":[{"HOST1":""},{"HOST-A":""}]
    },
    {
      "id":"systemB",
      "displayName":"System B",
      "hostName":[{"HOST-B":""}]
    }
  ]
}

Example definition to include the host in System B

{
  "meta":{
    "version":"1"
  },
  "allSystem":[
    {
      "id":"systemA",
      "displayName":"System A",
      "hostName":[{"HOST-A":""}]
    },
    {
      "id":"systemB",
      "displayName":"System B",
      "hostName":[{"HOST1":""},{"HOST-B":""}]
    }
  ]
}

Category name definition file for IM management nodes (imdd_category_name.conf)

Format

{
  "meta":{
    "version":"1"
  },
  "categoryData":[
    {"categoryId":"category-ID","categoryName":"category-name"},
    ...
  ]
}

Files

imdd_category_name.conf

imdd_category_name.conf.model (model file for the category name definition file for IM management nodes)

Storage directory

In Windows

For a physical host:

Manager-path\conf\imdd\

For a logical host:

shared-folder\jp1imm\conf\imdd\

In UNIX

For a physical host:

/etc/opt/jp1imm/conf/imdd/

For a logical host:

shared-directory/jp1imm/conf/imdd/

Description

This file defines the category names and orders of IM management nodes in management groups to display a sunburst or tree chart of data that is collected by the Intelligent Integrated Management Base. The IM management node categories are displayed in the order they are defined.

When the definitions are applied

The settings in the category name definition file for IM management nodes are applied to the Intelligent Integrated Management Base when the jddcreatetree or jddupdatetree command is completed successfully.

For details about the jddcreatetree and jddupdatetree commands, see jddcreatetree and jddupdatetree in Chapter 1. Commands.

Information that is specified

The category name definition file for IM management nodes must be saved in UTF-8 without BOM(byte order mark).

version

Specifies the version of the category name definition file for IM management nodes. Set this to 1.

categoryId

The specified default value. Do not edit the value.

categoryName

Specifies a category name of the management group that will appear in a sunburst or tree chart. The value of categoryName can be up to 255 characters in length and must not include any control characters or machine-dependent characters.

Example definition

Example of the definition for changing the order of the underlined categories

Before the change

{
  "meta":{
    "version":"1"
  },
  "categoryData":[
    {"categoryId":"job","categoryName":"Job"},
    {"categoryId":"serviceResponse","categoryName":"Service Response"},
    {"categoryId":"enterprise","categoryName":"Enterprise"},
    {"categoryId":"transactionProcessing","categoryName":"Transaction Processing"},
    {"categoryId":"applicationServer","categoryName":"Application Server"},
    {"categoryId":"database","categoryName":"Database"},
    {"categoryId":"platform","categoryName":"Platform"},
    {"categoryId":"virtualMachine","categoryName":"Virtual Machine"},
    {"categoryId":"managementApplications","categoryName":"Management Applications"},
    {"categoryId":"otherApplications","categoryName":"Other Applications"}
  ]
}

After the change

{
  "meta":{
    "version":"1"
  },
  "categoryData":[
    {"categoryId":"job","categoryName":"Job"},
    {"categoryId":"serviceResponse","categoryName":"Service Response"},
    {"categoryId":"enterprise","categoryName":"Enterprise"},
    {"categoryId":"platform","categoryName":"Platform"},
    {"categoryId":"database","categoryName":"Database"},
    {"categoryId":"virtualMachine","categoryName":"Virtual Machine"},
    {"categoryId":"managementApplications","categoryName":"Management Applications"},
    {"categoryId":"transactionProcessing","categoryName":"Transaction Processing"},
    {"categoryId":"applicationServer","categoryName":"Application Server"},
    {"categoryId":"otherApplications","categoryName":"Other Applications"}
  ]
}

Target host definition file for configuration collection (imdd_target_host.conf)

Format

{
  "meta":{
    "version":"1"
  },
  "target":[
    {
      "product":"product",
      "hostName":["host-name-1","host-name-2",...]
    },
    ...
  ]
}

Files

imdd_target_host.conf

imdd_target_host.conf.model (model file for the target host definition file for configuration collection)

Storage directory

In Windows

For a physical host:

Manager-path\conf\imdd\

For a logical host:

shared-folder\jp1imm\conf\imdd\

In UNIX

For a physical host:

/etc/opt/jp1imm/conf/imdd/

For a logical host:

shared-directory/jp1imm/conf/imdd/

Description

When the Intelligent Integrated Management Base collects configuration data of the monitoring objects of the linked products, the hosts from which to collect data are set for each linked product based on this file.

When the definitions are applied

The settings in the target host definition file for configuration collection are applied to the Intelligent Integrated Management Base when the jddcreatetree and jddupdatetree commands are completed successfully.

For details about the jddcreatetree and jddupdatetree commands, see jddcreatetree and jddupdatetree in Chapter 1. Commands.

Information that is specified

The target host definition file for configuration collection must be saved in UTF-8 without BOM (byte order mark). If you specify a backslash (\) as part of a character string, immediately before \, specify \ as an escape character.

version

Specifies the version of the target host definition file for configuration collection. Set this to 1.

product

Specifies an alphanumeric string to represent a product to be linked. The maximum length is 255 characters. If a target host for configuration collection is specified, this option cannot be omitted.

AJS3

Specifies that JP1/AJS is linked.

PFM

Specifies that JP1/PFM is linked.

hostName

Lists the names of hosts from which you want to collect configuration data with a string up to 255 characters.

Acceptable characters are alphanumeric characters and the following symbols: exclamation mark (!), dollar sign ($), left parenthesis ((), right parenthesis ()), asterisk (*), plus sign (+), comma (,), hyphen (-), period (.), forward slash (/), colon (:), left angle bracket (<), equal sign (=), left square bracket ([), backslash (\), right square bracket (]), caret (^), left curly bracket ({), vertical bar (|), and right curly bracket (}).

Specify physical host names or logical host names that are registered with the IM configuration. You cannot specify hosts with the same name within linked products. If a target host for configuration collection is specified, this option cannot be omitted.

Example definition

Example to link with JP1/AJS and JP1/PFM

{
  "meta":{
    "version":"1"
  },
  "target":[
    {
      "product":"AJS3",
      "hostName":["host-01","host-02","host-03"]
    },
    {
      "product":"PFM",
      "hostName":["host-01","host-04"]
    }
  ]
}

Host name definition file (imdd_host_name.conf)

Format

{
  "meta":{
    "version":"1"
  },
  "hostNameDef":[
    {
      "sourceHostName":["host-name-1-in-configuration-information","host-name-2-in-configuration-information"],
      "hostName":"host-name-in-tree",
      "label":"display-name-on-screen"
    },
    ...
  ]
}

Files

imdd_host_name.conf

imdd_host_name.conf.model (model file for the host name definition file)

Storage directory

In Windows

For a physical host:

Manager-path\conf\imdd\

For a logical host:

shared-folder\jp1imm\conf\imdd\

In UNIX

For a physical host:

/etc/opt/jp1imm/conf/imdd/

For a logical host:

shared-directory/jp1imm/conf/imdd/

Description

A structure of IM management nodes can include products that can have aliases for host names. In such a case, this file is used for mapping between aliases and real host names. If aliases are mapped to their real host name, the real host name is used as a host name in a tree chart. This allows the tree chart to group aliases into the same host even when different management tools use different aliases.

You also use this definition file when you change the host name displayed in the integrated operation viewer.

When the definitions are applied

The settings in the host name definition file are applied to the Intelligent Integrated Management Base when the jddcreatetree and jddupdatetree commands are completed successfully.

For details about the jddcreatetree and jddupdatetree commands, see jddcreatetree and jddupdatetree in Chapter 1. Commands.

Information that is specified

The host name definition file must be saved in UTF-8 without BOM (byte order mark). If you specify a backslash (\) as part of a character string, immediately before \, specify \ as an escape character.

hostNameDef

Either sourceHostName or label must be specified. Specifying hostName is required.

sourceHostName

List the host names that you want to represent a particular host. You can specify up to 10 host names. Each host name can be up to 255 characters in length.

Acceptable characters are alphanumeric characters and the following symbols: exclamation mark (!), dollar sign ($), left parenthesis ((), right parenthesis ()), asterisk (*), plus sign (+), comma (,), hyphen (-), period (.), forward slash (/), colon (:), left angle bracket (<), equal sign (=), left square bracket ([), backslash (\), right square bracket (]), caret (^), left curly bracket ({), vertical bar (|), and right curly bracket (}).

hostName

Specify a host name in the tree data. The host name can be up to 255 characters in length.

Acceptable characters are alphanumeric characters and the following symbols: exclamation mark (!), dollar sign ($), left parenthesis ((), right parenthesis ()), asterisk (*), plus sign (+), comma (,), hyphen (-), period (.), forward slash (/), colon (:), left angle bracket (<), equal sign (=), left square bracket ([), backslash (\), right square bracket (]), caret (^), left curly bracket ({), vertical bar (|), and right curly bracket (}).

label

Specify a label name to be displayed on the screen. Specify it as a string no more than 255 characters, without any control and machine-dependent characters.

Host names displayed on the screen

Host names displayed on the screen are determined by the priorities as shown in the table below.

Priority

Matched with the value of hostName?

Is label specified?

Is label of value in the host's SID specified?

Host name displayed on the screen

High

Match

Yes

--

The value of label

↑

Match

No

--

The value of hostName

↓

Unmatch

--

Yes

The value of label specified for the value of value of the host's SID

Low

Unmatch

--

No

The host name specified in the SID (XXXXX in _HOST_XXXXX)

Legend: --: Not applicable

Example definition

Example 1: Display hostX as Host X on the screen

{
  "meta":{
    "version":"1"
  },
  "hostNameDef":[
    {
      "hostName":"hostX",
      "label":"Host X"
    }
  ]
}

Example 2: Display hostX as Host X on the screen when hosts defined as alias hostA and alias hostB are represented as hostX

{
  "meta":{
    "version":"1"
  },
  "hostNameDef":[
    {
      "sourceHostName":["hostA","hostB"],
      "hostName":"hostX",
      "label":"Host X"
    }
  ]
}

IM management node link definition file (imdd_nodeLink_def.conf)

Format

{
  "meta":{
    "version":"1"
  },
  "links":[
    {
      "from":"tree-SID-of-the-preceding-node or SID-of-the-preceding-node ",
      "to":"tree-SID-of-the-subsequent-node or SID-of-the-subsequent-node",
      "type":"information-type"
      "value":{
        "unit":[
          {
              "precedingJob":"complete-name-of-preceding-linked-unit",
              "succeedingJob":"complete-name-of-subsequent-linked-unit",
              "succeedingJobTimeType":"format-of-scheduled-date-and-time-for-linkage"
              ]
      }
    }, ...
  ]
}

Files

imdd_nodeLink_def.conf

imdd_nodeLink_def.conf.model (model file for the IM management node link definition file)

Storage directory

In Windows

For a physical host:

Manager-path\conf\imdd\

For a logical host:

shared-folder\jp1imm\conf\imdd\

In UNIX

For a physical host:

/etc/opt/jp1imm/conf/imdd/

For a logical host:

shared-directory/jp1imm/conf/imdd/

Description

This file defines relationships between IM management nodes. You can use this definition file to define new relationships between IM management nodes. If you define the same relationship as that in the IM management node link file (imdd_nodeLink.json) (which is the one with the same from, to, and type), the relationship defined in this file takes effect in the system.

If JP1/AJS or JP1/PFM is linked, a relationship between monitoring targets is registered automatically by the related node display function. If you want to add other relationships separately and show them in the integrated operation viewer, you can specify them in this definition file. For details about the related node display function, see 3.6 Related node display function in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

When defined relationships do not support the related node display function, the relationships in question do not show up in the integrated operation viewer. However, if you use the REST API, you can get the settings as data. However, if you use the REST API, you can get the settings as data. For details about the REST API, see the manual provided separately.

When the definitions are applied

The settings in the IM management node link definition file are applied to the Intelligent Integrated Management Base when the jddupdatetree command is completed successfully.

Information that is specified

The IM management node link definition file must be saved in UTF-8 without BOM (byte order mark).

version

Specifies the version of the IM management node link definition file. Set this to 1.

from

This node is the preceding node. Specifies the tree SID or the SID. The SID can be up to 1 megabyte in size and must not include any control characters. Acceptable characters are alphanumeric characters and the following symbols: underscore (_), forward slash (/), percent sign (%), hyphen (-), period (.), colon (:), and tilde (~). This option is mandatory.

The Job flow tab displays relationships between IM management nodes only when rootJobnetExecutionOrder is specified for type and an SID is specified. If you specify a tree SID, you cannot view relationships between IM management nodes in the window. However, by using the link information acquisition API, you can acquire link information specified with the tree SID. For details, see the document provided separately.

The Related node tab, on the other hand, displays relationships between IM management nodes regardless of the value specified for type or whether an SID or tree SID is specified.

Example to specify a root jobnet:

_JP1AJS-M_HOST1/_HOST_HOST1/_JP1SCHE_schedulerserv/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet1

to

This node is the subsequent node. Specifies the tree SID or the SID. The SID can be up to 1 megabyte in size and must not include any control characters. Acceptable characters are alphanumeric characters and the following symbols: underscore (_), forward slash (/), percent sign (%), hyphen (-), period (.), colon (:), and tilde (~). This option is mandatory.

The Job flow tab displays relationships between IM management nodes only when rootJobnetExecutionOrder is specified for type and an SID is specified. If you specify a tree SID, you cannot view relationships between IM management nodes in the window. However, by using the link information acquisition API, you can acquire link information specified with the tree SID. For details, see the document provided separately.

The Related node tab, on the other hand, displays relationships between IM management nodes regardless of the value specified for type or whether an SID or tree SID is specified.

Example to specify a root jobnet:

_JP1AJS-M_HOST1/_HOST_HOST1/_JP1SCHE_schedulerserv/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet2

type

Specifies the type indicated by the link information set by from and to. Control characters are not acceptable. This option is mandatory.

The following type is supported as standard:

rootJobnetExecutionOrder (relationship of execution order of a root jobnet)

managerAgent (relationship between a manager and agent of a JP1 product)

rootJobnetAgent (relationship between a root jobnet and an AJS agent)

sameNode (relationship between nodes having the same name)

If you specify rootJobnetExecutionOrder for type, specify the SID of the IM management node for from and to.

value

Specifies additional link information. This option is optional.

unit

Specify it if the information type is an execution order of a root jobnet. Specify the information of a linked unit. This option is optional.

precedingJob

Specifies the complete name of a preceding linked unit. Specify a string of one megabyte or less other than control characters. This option is mandatory.

Example :

/jobnet1/JP1 event sending job

succeedingJob

Specifies the complete name of a subsequent linked unit. Specify a string of one megabyte or less other than control characters. This option is mandatory.

Example :

/jobnet2/JP1 event reception monitoring job

succeedingJobTimeType

Specify it if the information type is an execution order of a root jobnet. Specify a scheduled date and time for linkage. This option is optional. If it is omitted, endtime is assumed for operation.

startTime

Specify it if the link is configured so that execution of the subsequent unit is started after the preceding unit ends. For example, use it for the link through cancellation of holding operation or a wait condition.

endTime

Specify it if the link is configured so that the wait condition of the subsequent unit is met after the preceding unit ends. For example, use it for the link through event jobs (such as a file monitoring job or incoming email monitoring job).

Example definition

{
    "meta":{
        "version":"1"
    },
        "links": [
    {
     "from":_JP1AJS-M_HOST1/_HOST_HOST1/_JP1SCHE_schedulerserv
/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet1",
     "to":_JP1AJS-M_HOST1/_HOST_HOST1/_JP1SCHE_schedulerserv
/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet2",
     "type":"rootJobnetExecutionOrder",
     "value":{
          "unit":[
           {
              "precedingJob":"/jobnet1/job1",
              "succeedingJob":"/jobnet2/Job2",
              "succeedingJobTimeType":"startTime"
           }, ...
         ]
      }

        }, ...
    ],
}

Event-source-host mapping definition file (user_hostmap.conf)

Format

[DESC_VERSION=version-information]
#Comment
def definition-name-1
    cnd
        event-condition
    end-cnd
    source_attr attribute-name
end-def
def definition-name-2
    cnd
        event-condition
    end-cnd
    source_attr attribute-name
end-def

File

user_hostmap.conf (Event-source-host mapping definition file)

user_hostmap.conf.model (model file for the event-source-host mapping definition file)

Storage directory

In Windows

For a physical host:

Console-path\conf\hostmap\

For a logical host:

shared-folder\jp1cons\conf\hostmap\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/hostmap/

For a logical host:

shared-directory/jp1cons/conf/hostmap/

Description

This file defines the conditions and the mapping source for a JP1 event to which the event source host is mapped by using the event source host mapping function. The maximum size of the event-source-host mapping definition file is 17 megabytes.

The event source host mapping function maps the event source host for the JP1 event that matches the event condition according to the definition in this file.

When the definitions are applied

The definition takes effect when the event source host mapping function is enabled and either of the following conditions is satisfied:

JP1/IM is running

The jco_spmd_reload command is executed

Information that is specified

DESC_VERSION=version-information

Specify 1, which is the file version of the event-source-host mapping definition file. Specify DESC_VERSION on the first line of the definition file (the first line in the file that is not a null line or a comment line). If there is no file version on the first line, 1 is assumed as the file version.

# comment

Provides an explanation of the event-source-host mapping definition file.

def to end-def

These parameters mark the start and end of the mapping definition block. The block from def to end-def can be omitted.

After def comes the definition name of the event source host mapping definition. If you specify defΔdefinition-1Δdefinition-2Δ, then Δdefinition-1Δdefinition-2Δ are treated as the definition names (Δ indicates a single-byte space).

Each definition name must be unique within the event-source-host mapping definition file. The length of a character string is from 1 to 50 bytes.

Permitted characters are all characters other than control characters.

The control characters are ASCII 0x00 to 0x1F and 0x7F to 0x9F.

cnd to end-cnd

These parameters mark the start and the end of the block that specifies conditions for the JP1 events to be mapped. You must specify one event condition block in a mapping definition block. The event condition block cannot be omitted. If a received JP1 event satisfies multiple event conditions, the definition block closest to the beginning of the event-source-host mapping definition file takes precedence. Tabs and spaces before and after the cnd and end-cnd parameters are ignored.

event-condition

Specifies conditions for the JP1 event to be mapped. You can specify from 1 to 256 event conditions for each event condition block. Event conditions are connected with the AND condition. Specify an event condition in the following format:

attribute-name comparison-keyword operand

attribute-name

Specifies the name of the attribute you want to compare. To specify a basic attribute, prefix the name with B.. To specify an extended attribute (common information or user-specific information), prefix the name with E.. The attribute name is case sensitive.

The following table lists and describes the combinations of attribute names and comparison keywords and the operands that can be specified.

Table 2‒6: Combinations of attribute names and comparison keywords and the operands that can be specified

No.

Item

Attribute name

Comparison keyword

Operand

1

Event ID

B.ID

Match

Do not match

A maximum of 100 event IDs can be specified.

Specify event IDs in hexadecimal notation. Event IDs are not case sensitive.

The permitted range is from 0 to 7FFFFFFF.

2

Reason for registration

B.REASON

Match

Do not match

A maximum of 100 reasons can be specified.

3

Source process ID

B.PROCESSID

Match

Do not match

A maximum of 100 source process IDs can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

4

Source user ID

B.USERID

Match

Do not match

A maximum of 100 source user IDs can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

5

Source group ID

B.GROUPID

Match

Do not match

A maximum of 100 source group IDs can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

6

Source user name

B.USERNAME

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 source user names can be specified. However, if a regular expression is used, only one source user name is allowed.

7

Source group name

B.GROUPNAME

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 source group names can be specified. However, if a regular expression is used, only one source group name is allowed.

8

Event-issuing server name (source host)#

B.SOURCESERVER

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 event-issuing server names can be specified. However, if a regular expression is used, only one event-issuing server name is allowed.

9

Target event server name#

B.DESTSERVER

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 target event server names can be specified. However, if a regular expression is used, only one target event server name is allowed.

10

Message

B.MESSAGE

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 messages can be specified. However, if a regular expression is used, only one message is allowed.

11

Event level

E.SEVERITY

Match

Multiple event levels can be specified. If multiple event levels are specified, the same event level cannot be specified twice. However, if a regular expression is used, only one event level is allowed. The following values can be specified: Emergency, Alert, Critical, Error, Warning, Notice, Information, or Debug

12

User name

E.USER_NAME

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 user names can be specified. However, if a regular expression is used, only one user name is allowed.

13

Product name

E.PRODUCT_NAME

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 product names can be specified. However, if a regular expression is used, only one product name is allowed.

14

Object type

E.OBJECT_TYPE

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 object types can be specified. However, if a regular expression is used, only one object type is allowed.

15

Object name

E.OBJECT_NAME

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 object names can be specified. However, if a regular expression is used, only one object name is allowed.

16

Root object type

E.ROOT_OBJECT_TYPE

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 root object types can be specified. However, if a regular expression is used, only one root object type is allowed.

17

Root object name

E.ROOT_OBJECT_NAME

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 root object names can be specified. However, if a regular expression is used, only one root object name is allowed.

18

Object ID

E.OBJECT_ID

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 object IDs can be specified. However, if a regular expression is used, only one object ID is allowed.

19

Occurrence

E.OCCURRENCE

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 occurrences can be specified. However, if a regular expression is used, only one occurrence is allowed.

20

Return code

E.RESULT_CODE

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 return codes can be specified. However, if a regular expression is used, only one return code is allowed.

21

Program-specific extended attribute

E.xxxxxxx

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

For the attribute name, you can specify a character string with a maximum of 32 bytes that begins with an uppercase letter and consists of uppercase letters, numeric characters, and the underscore (_).

A maximum of 100 program-specific extended attributes can be specified. However, if a regular expression is used, only one program-specific extended attribute is allowed.

#

If the integrated monitoring database and the IM Configuration Management database are enabled, and the comparison keyword is Match or Do not match, the business group name can be specified in a path format.

If the integrated monitoring database and the IM Configuration Management database are disabled, and a comparison keyword other than Match or Do not match is selected, a business group name specified in a path format is treated as a host name.

If the -ignorecasehost option of the jcoimdef command is set to ON and a comparison keyword other than Regular expression is selected, the character string is no longer case sensitive.

comparison-keyword

Specifies BEGIN (begins with), IN (matches), NOTIN (does not match), SUBSTR (includes), NOTSUBSTR (does not include), or REGEX (regular expression) as the comparison keyword. The comparison keyword is case sensitive.

operand

Specifies a character string as the value that is to be compared with the attribute value specified for the comparison keyword. The operand is case sensitive.

If you specify two or more operands, separate them by one or more consecutive spaces or tabs. The OR condition is applied to the specified operands. Note that if a regular expression is specified, only one operand is allowed.

If you want to a space or a tab as part of an operand, use the format shown in the following table.

No.

Value to be specified

How to specify

1

Tab (0x09)

%09

2

Space (0x20)

%20

3

% (0x25)

%25

4

CR (0x0d)

%0d

5

LF (0x0a)

%0a

During maximum value checking of the definition format, %20 and %25 are each treated as a single character. The following shows an example of defining ID matches 100 and 200, which selects multiple operands:

B.IDΔINΔ100Δ200

Legend: Δ indicates a single-byte space (0x20)

You can specify a maximum of 4,096 bytes of operands per event condition and per event condition block (total length in bytes of all operands that are specified in the event condition block).

source_attr

Specifies the attribute value of the mapping source. For source_attr, you can specify a value that stores the event source host name. This parameter cannot be omitted. Specify the source_attr in the following format:

source_attr mapping-source-attribute-value

You can specify an attribute name or a variable name for the mapping source attribute value. If you specify an attribute name, all information related to the attribute value is stored. If you specify a variable name, part of an attribute value is extracted (partial extraction) and stored.

The attribute you can specify for the mapping source attribute value is an extended attribute (program-specific information). Extended attributes (program-specific information) are attributes that are not included in the common information described in Table 3-2 List of common information provided by extended attributes. You can specify $EVENV1 to $EVENV9 for the variable name.

Example definition

The following example shows how to set the host name (AGENT_A) contained in a message as the event source host name when the event ID is 100, the event level is Warning, and the message is An error with error code 1111 occurred on the AGENT_A host. (where AGENT_A is a host name):

DESC_VERSION=1
#Maps the host name in the message to the event source host name.
def event-source-host-mapping-1
    cnd
        B.ID IN 100
        E.SEVERITY IN Warning
        B.MESSAGE REGEX An error occurred on the host ([a-zA-Z0-9\-_]+) with error code 1111.
    end-cnd
    source_attr $EVENV1
end-def

Automated action environment definition file (action.conf.update)

Format

[logical-host-name\JP1CONSOLEMANAGER\ACTION]
"ACTIONINFSIZE"=dword:hexadecimal-value
"EVENTALIVEPERIOD"=dword:hexadecimal-value
"ACTIONEXECUSER"="JP1-user-name"
"ACTIONDEFFILE"="file-name"
"HOSTINEVENT"="{remote | local}"
"ACTIONINFFILE"="file-name"
"ACTIONLIMIT"=dword:hexadecimal-value
"SENDABLE_EVENT"="event-ID"
"REGEXP"="{JP1|EXTENDED}"
"ACTIONPRIORITY"="{DEFAULT|V8COMPATIBLE}"

[logical-host-name\JP1CONSOLEMANAGER\LOG_CONTROL\JCAMAIN]
"LOGSIZE"=dword:hexadecimal-value

This is the format of the parameters in the common definition information. Do not edit any other parameters because they are used internally.

File

action.conf.update (model file for the automated action environment definition file)

Storage directory

In Windows

Console-path\default\

In UNIX

/etc/opt/jp1cons/default/

Description

This file defines an execution environment for automated actions.

The required definitions are provided as a model file. To change the settings, copy the model file and then edit the copy.

To reduce the size of the action information file

Make a backup of the action information file, delete the action information file, and then change the settings.

When the definitions are applied

The specified definitions take effect when JP1/IM - Manager starts after you have executed the jbssetcnf command to apply the definitions to the JP1 common definition information.

You can also apply the following parameters by reloading them with the jco_spmd_reload command:

EVENTALIVEPERIOD

ACTIONEXECUSER

HOSTINEVENT

SENDABLE_EVENT

Information that is specified

[logical-host-name\JP1CONSOLEMANAGER\ACTION]

Specifies a key name for the action execution environment settings.

For logical-host-name, specify JP1_DEFAULT for a physical host and logical-host-name for a logical host.

"ACTIONINFSIZE"=dword:hexadecimal-value

Specifies the size of the action information file as a hexadecimal value (kilobytes).

The permitted value is from dword:00000001 to dword:00001000 (1 to 4,096 kilobytes). The default value is dword:00001000 (4,096 kilobytes).

The action information file stores automated action execution information. The file is referenced when an action is referenced from the event console or by the jcashowa command as well as when an action status notification event is issued.

This is a wrap-around file that is overwritten when the specified ACTIONINFSIZE value is reached. Once overwritten, old action information might no longer be viewable in the event console or with the jcashowa command and action status notification events might no longer be issued. If you will reference past action execution results or issue action information notification events, you must estimate the size of the action information that you will want to reference and then set that value in ACTIONINFSIZE.

For details about how to estimate the size of the action information file, see the Release Notes for JP1/IM - Manager.

When you set the action information file size to the default value, you can reference information equivalent to 65,535 actions.

"EVENTALIVEPERIOD"=dword:hexadecimal-value

Specifies the AND event storage period in minutes.

The permitted value is from 1 to 1,440 (minutes), expressed as a hexadecimal value. The default is dword:0000003c (60 minutes).

"ACTIONEXECUSER"="JP1-user-name"

Specifies a JP1 user as the default user who executes actions.

Express the JP1 user as a character string of no more than 15 bytes. The default is "" (none). If this parameter is omitted, jp1admin is assumed.

When no execution user is specified in an automated action definition, the action will be executed by the JP1 user defined here.

"ACTIONDEFFILE"="file-name"

Specifies a name for the automated action definition file.

The default is actdef.conf; you cannot change this default value.

Use this automated action definition file to define conditions for executing actions by the automated action function and the commands to be executed.

"HOSTINEVENT"="{remote | local}"

Specifies the method to be used to acquire the host name at the event source.

The permitted values are remote and local. The default is remote.

When remote is set, the event attribute event-issuing server name is used as the event source host name.

When local is specified, if the source IP address in the event attribute is an IPv6 address in JP1/IM - Manager, the host name found by using getnameinfo is used as the event source host name. If, however, the source IP address is an IPv4 address, the host name found by using gethostbyaddr is used as the event source host name. If the host name cannot be found, the IP address is used as the event source host name.

Note:

If "local" is specified, the action matching might take a longer time due to DNS queries or other reasons.

"ACTIONINFFILE"="file-name"

Specifies a name for the action information file.

The default is actinf.log. You cannot change this default value.

"ACTIONLIMIT"=dword:hexadecimal-value

Specifies the number of commands to be pre-loaded.

If you use JP1/Base version 06-51 or earlier at the automated action execution host, specify the number of commands that are to be pre-loaded at the execution host. The permitted value is from dword:00000001 to dword:00000040 (1 to 64). The default is dword:0000000a (10).

If you use JP1/Base version 06-71 or later at the automated action execution host, set the number of pre-loaded commands in JP1/Base at the execution host. In this case, use the jcocmddef command at the execution host to set the number of pre-loaded commands. The default is 1,024 commands.

For details, see 13.7.6 Command execution environment in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

"SENDABLE_EVENT"="event-ID"

Specifies an automated action issuance event (JP1 event whose event ID is 20A0, 20A1, 20A2, 20A3, or 20A4).

The permitted values are 20A0, 20A1, 20A2, 20A3, and 20A4. To specify multiple event IDs, separate them with the space.

The default is "20A0 20A3 20A4".

For details about the JP1 events, see 3.2.2 Details of JP1 events.

"REGEXP"="{JP1|EXTENDED}"

Specifies the type of regular expressions to be used.

The permitted values are JP1 and EXTENDED. The default is EXTENDED.

If you specify JP1, you can use JP1-specific regular expressions to define automated actions. If you specify EXTENDED, you can use extended regular expressions to define automated actions.

Note that this parameter is used only for Windows, and is not necessary for UNIX.

"ACTIONPRIORITY"="{DEFAULT|V8COMPATIBLE}"

Specifies the priority order for actions.

The permitted values are DEFAULT and V8COMPATIBLE. These values are case sensitive.

If this parameter is omitted altogether, V8COMPATIBLE is assumed.

When JP1/IM - Manager is initially installed, DEFAULT is set.

When JP1/IM - Manager is upgraded from version 8 or earlier, the ACTIONPRIORITY parameter is not set.

If DEFAULT is specified and multiple action definitions are specified for the same parameter, the first action definition specified in the automated action definition file takes effect.

If V8COMPATIBLE is specified, the same priority order is applied as is used for the automated action function in JP1/IM - Manager versions earlier than 09-00. In other words, if multiple action definitions are specified for the same parameter, an action definition with an event ID specified takes precedence over an action definition for all events, and an action definition with an event ID that is specified closest to the beginning of the automated action definition file takes precedence over all other action definitions with event IDs specified.

[logical-host-name\JP1CONSOLEMANAGER\LOG_CONTROL\JCAMAIN]

Specifies a key name for the automated action log definition.

For logical-host-name, specify JP1_DEFAULT for the physical host and logical-host-name for a logical host.

"LOGSIZE"=dword:hexadecimal-value

Specifies the maximum size of an automated action trace log (1 file).

The permitted value is from 65,536 to 104,857,600 bytes (64 kilobytes to 100 megabytes), expressed in bytes as a hexadecimal value. The default is dword:00500000 (5,242,880 bytes (5 megabytes)).

The default value will not cause wrap-around in the file even when 300 commands with a maximum length of 100 bytes per command are executed for actions. To change the log size, see the Release Notes for JP1/IM - Manager and then estimate the log size.

Example definition

[JP1_DEFAULT\JP1CONSOLEMANAGER\ACTION]
"ACTIONINFSIZE"=dword:00001000
"EVENTALIVEPERIOD"=dword:0000003c
"ACTIONEXECUSER"="JP1USER"
"ACTIONDEFFILE"="actdef.conf"
"HOSTINEVENT"="remote"
"ACTIONINFFILE"="actinf.log"
"SENDABLE_EVENT"="20A0 20A3 20A4"
"REGEXP"="JP1"

[JP1_DEFAULT\JP1CONSOLEMANAGER\LOG_CONTROL\JCAMAIN]
"LOGSIZE"=dword:00100000

Make sure that the end of the file is at the beginning of the last line.

Automated action definition file (actdef.conf)

Format

[#automated-action-definition-file-version]
[DESC_VERSION=version-information]

[#automated-action-status-monitoring-parameter]
cmn
    [sta {true|false}]
end-cmn

[#automated-action-definition-parameter]
act action-name
    [prm parameter-group]
    [cmt comment]
    aid action-ID
    [valid true|false]
    eid event-ID

    cnd
        event-conditions
    end-cnd

    [usr user-name]
    [hst {execution-host-name|group-name|business-group-name|monitoring-group-name}]
    [{cmd action|rul}]
    [var environment-variable-file-name]

    [det suppress-period]
    [ret delay-monitoring-period]
end-act

File

actdef.conf (automated action definition file)

actdef.conf.model (model file for the automated action definition file)

Storage directory

In Windows

For a physical host:

Console-path\conf\action\

For a logical host:

shared-folder\jp1cons\conf\action\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/action/

For a logical host:

shared-directory/jp1cons/conf/action/

Description

This file defines conditions for executing actions by the automated action function of JP1/IM and the commands to be executed as the actions. To use the language encoding that is used by JP1/IM - Manager, specify this file.

The maximum size of an automated action definition file is 22 megabytes (23,068,672 bytes).

The automated action function automatically executes a specified command on the basis of the definition specified in this file when a JP1 event satisfying specified conditions is received.

Each line of action definition information is called a parameter. There are three types of parameters in an automated action definition file:

Automated action definition file version

Defines the format version of the automated action definition file.

Automated action status monitoring parameter (common block)

Specify the cmn parameter in the common block to define whether the status of automated actions is to be monitored.

Automated action definition parameters (action block)

Specify parameters, such as prm and cmt, in the action block to define conditions for executing an action and the command to be executed as the action.

You must specify the automated action definition file version and the automated action status monitoring parameter before the automated action definition parameters. If you specify the automated action definition file version and/or the automated action status monitoring parameter after the automated action definition parameters, the specified definition is ignored.

If you specify the automated action definition file version or the automated action status monitoring parameter more than once, the first definition specified takes effect and subsequent definitions are ignored.

Definition specification

Use the space or the tab to separate the words in a parameter.

Any space or tab character at the beginning or at the end of a line is ignored.

A line beginning with hash mark (#) is regarded as a comment except when the hash mark (#) is preceded by a character string.

Use lowercase letters to specify the parameter names in action definitions. A specified parameter name that contains uppercase letters is treated as being invalid and results in a definition error.

Action priority

If a received JP1 event satisfies the execution conditions in multiple automated action definitions, only the automated action that has the highest priority is executed (for each parameter group discussed below). The automated action priority order is determined by the following rule:

The first action specified in the automated action definition file (in GUI, the first action displayed in the Action Parameter Definitions) takes precedence over the other actions.

You can change the action priority order in the common definition. For details about the priority order of automated actions, see 6.3.2 Precedence of execution conditions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

Parameter groups and AND conditions

Each automated action definition parameter belongs to a parameter group. A parameter group is a unit for checking the conditions for executing an automated action. Use of parameter groups enables you to specify complex conditions, such as when multiple actions are to be executed for a single JP1 event or when an action is to be executed only when multiple conditions are satisfied.

When a single JP1 event arrives at the manager host of JP1/IM, the automated action definition parameters and execution conditions are compared for each parameter group in order of priority. When execution conditions that are satisfied are found, only the automated action definition parameter that has the highest priority is executed for each parameter group.

If you specify an ampersand (&) in a parameter group, an AND condition with the automated action definition parameter defined on the preceding line is created. When automated action definition parameters are specified in an AND condition, the corresponding action is executed when all the conditions are satisfied.

Checking the specified information

Use the jcamakea command to check the information specified in the definition file.

When the definitions are applied

The definition of an automated action takes effect when you click the Apply button in the Action Parameter Definitions window in JP1/IM - View when JP1/IM - Manager starts, or when you execute the jcachange command.

If you want to execute the jcachange command to re-load the definition, execute the jcamakea command first to make sure there are no errors in the definition.

Information that is specified (automated action definition file version)

This subsection describes the information to be specified as the automated action definition file version.

DESC_VERSION=version-information

Defines the format version of the automated action definition file. Specify this definition on the first line of the automated action definition file (the first line in the file excluding null lines and comment lines). If this information is specified on a line other than the first line, a definition error results.

Table 2‒7: Automated action definition file format version information

Version information

Description

1

Automated action definition file version is 07-11 to 07-51.

2

Automated action definition file version is 08-01 to 08-50.

3

Automated action definition file version is 09-00 to 11-10.

4

Automated action definition file version is 11-50 or later.

If this parameter is omitted or 1 is specified, the value 2 is assumed for reading the file. When the Apply button is clicked in the Action Parameter Definitions window in JP1/IM - View, the value 2 is set.

If a value other than 1, 2, 3, or 4 is specified in this parameter, an error is output to the integrated trace log and the value 3 is assumed as the version information for reading the file.

In such a case, the Action Parameter Definitions window cannot be displayed in JP1/IM - View. To change the version information, directly edit the definition file.

Because the format of an old automated action definition file version is compatible with the automated action definition file format for version 08-01 or later, the format for version 08-01 or later is assumed for reading the file.

If this parameter is specified on a line that is subsequent to a line containing an automated action definition parameter, the Action Parameter Definitions window can no longer be displayed in JP1/IM - View.

Use the jcamakea command to check the contents of the automated action definition file.

Information that is specified (automated action status monitoring parameter)

This subsection describes the information to be specified in the automated action status monitoring parameter.

cmn to end-cmn

These are the start and end parameters for the block that specifies a parameter that is applicable to all action definitions. The portion between cmn and end-cmn is called a common block. This block must be specified before the automated action definition parameters. Specify this parameter only once in the automated action definition file. Specification of this block is optional. If this block is omitted, false is assumed for the sta parameter. The AND condition is applied to each event condition.

sta {true|false}

Specifies whether the action status is to be monitored.

Specify either true or false. To monitor the action status, specify true. To not monitor the action status, specify false. The default is false.

Information that is specified (automated action definition parameters)

This subsection describes each item that is specified in the automated action definition parameters.

act action-name to end-act

Specifies the start and end parameters of an automated action definition. There is no limit to the number of actions that can be defined between act and end-act; however, at least one action must be specified. The portion between act action-name and end-act is called an action block.

After act, specify an action name, expressed using from 1 to 50 bytes of characters. The permitted characters are all characters other than the control characters (from 0x00 to 0x1F and from 0x7F to 0x9F).

Each action name must be unique among the action names specified in all the action blocks. The parameters that can be specified in the action block are as follows:

prm, cmt, eid, cnd to end-cnd, usr, hst, cmd, rul, var, det, ret, aid, valid

prm parameter-group

Specifies a number for the parameter group. If this parameter is omitted, 0 is assumed.

You can specify a single numeric digit (from 0 to 9) or the ampersand (&). If you specify a numeric digit, you cannot omit the action name. If you specify an ampersand (&), this parameter becomes part of an AND condition with the immediately preceding action block, which means that the automated action definition parameter in this action block belongs to the same parameter group as the immediately preceding action block. When an ampersand (&) is specified, the action name cannot be specified.

Following an action block for which the ampersand is not specified, you can specify a maximum of 9 action blocks as members of an AND condition (for a total of 10 action blocks including the first action block).

Within the same parameter group, the first action block specified (in the GUI, the top action block displayed in the Action Parameter Definitions window) has precedence over the other action blocks. When a JP1 event arrives at the manager, it is matched against the event conditions in the action block for each parameter group in the order of priority. When event conditions are found that match the JP1 event, the action in the action block that has the highest priority is executed for the parameter group and no more matching is performed for the action blocks that follow the executed action block. Events are matched in ascending order of parameter groups. For details about the priority order of automated actions, see 6.3.2 Precedence of execution conditions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

cmt comment

Specifies a comment about the action block. This parameter is optional. Specify a comment using from 1 to 1,040 bytes of characters. All characters are permitted. If a comment exceeds 1,040 bytes in length, the portion in excess of 1,040 bytes is deleted.

aid action-id

Specifies the action ID. This parameter cannot be omitted. The action ID can be any number from 0 to 2,147,483,647. However, this parameter cannot be specified when you have specified & for the parameter-group.

This parameter can be specified only when the version information is 4.

valid true|false

Enables or disables (specifies true or false, respectively) the automated action definition. This parameter is optional. If this parameter is omitted, the value is assumed to be true. However, this parameter cannot be specified when you have specified & for the parameter-group. When you have specified & for the parameter-group, the status (enabled or disabled) of the automated action definition depends on the status of the previous action execution condition.

This parameter can be specified only when the version information is 4.

eid event-ID

Specifies the event ID for the action conditions. This parameter is mandatory and can be specified only once.

An event ID consists of a base part and an extension part. Express each part of an event ID as a string of from 1 to 8 hexadecimal characters, and separate the base part from the extension part with a colon (:). An event ID is not case sensitive. The extension part can be omitted. To specify any event ID, use an asterisk (*). When an asterisk is specified, all events become subject to the action. If JP1 events occur frequently, a large number of actions will be implemented, in which case execution may be delayed. When you specify an asterisk, you should narrow down the applicable events by using other conditions (such as a message, basic event information, detailed event information, and extended event information).

The following shows an example:

Example: Specify event ID A as follows:

eid a

eid A

eid 0000000a

eid 0000000A

eid 0000000A:0

eid 0000000A:00000000

Example: Specify any event ID as follows:

eid *

cnd event-conditions to end-cnd

Specifies the start and end parameters of the block that specifies event conditions for executing an action. Specification of an event condition block is mandatory. Specify only one event condition block within an action block. You can specify from 0 to 256 event conditions in an event condition block. The AND condition is applied to each event condition.

event-conditions

Specifies the event conditions in the following format (Δ indicates a single-byte space):

attribute-nameΔcomparison-keywordΔoperand[Δoperand]...

Note that a line consisting of only spaces or tabs is ignored during processing.

attribute-name

Specifies the name of an attribute that you want to compare. To specify a basic attribute, place B. immediately before the name. To specify an extended attribute (common information or user-specific information), place E. immediately before the name. Attribute names are case sensitive.

comparison-keyword

Specifies one of BEGIN (begins with), IN (matches), NOTIN (does not match), SUBSTR (includes), NOTSUBSTR (does not include), or REGEX (regular expression) as the comparison keyword. The comparison keyword is case sensitive.

operand

Specifies a character string as the value that is to be compared with the attribute value by the specified comparison keyword. Operands are case sensitive.

To specify multiple operands, separate them with one or more consecutive spaces or a tab. The OR condition is applied to the specified operands. Note that when a regular expression is specified, only one operand can be specified.

To use a space, tab, end-of-line code (CR or LF), or % as part of an operand value, you must specify a value shown below:

No.

Value to be used

What to specify

1

Tab (0x09)

%09

2

Space (0x20)

%20

3

% (0x25)

%25

4

Linefeed code LF (0x0a)

%0a

5

Carriage return code CR (0x0d)

%0d

The character code specified after % is not case sensitive. When a JP1 regular expression is used, %0d cannot be specified. The following shows an example of defining ID matches 100 and 200, which selects multiple operands:

B.IDΔINΔ100Δ200

Legend: Δ indicates a single-byte space (0x20)

You can specify a maximum of 4,096 bytes of operands per event condition and per event condition block (total length in bytes of all operands that are specified in the event condition block).

Basic event information

If you specify B.BASIC as the attribute name, you can set the same conditions as for basic event information in the automated action definition file (for conversion).

When you specify B.BASIC as the attribute name, you must specify REGEX as the comparison keyword.

You can specify the operands in the same format as is used for basic event information in the automated action definition file (for conversion). Note that to use a space, tab, end-of-line code (CR or LF), or percent sign (%), specify %. Specify a forward slash (/) as /; there is no need to specify it as \/.

Detailed event information

If you specify B.DETAIL as the attribute name, you can set the same conditions as for detailed event information in the automated action definition file (for conversion).

When you specify B.DETAIL as the attribute name, you must specify REGEX as the comparison keyword.

You can specify the operands in the same format as is used for detailed event information in the automated action definition file (for conversion). Note that to use a space, tab, end-of-line code (CR or LF), or percent sign (%), specify %. Specify a forward slash (/) as /; there is no need to specify it as \/.

The following table lists and describes the attribute names, comparison keywords, and operands that can be specified in an event condition.

Table 2‒8: Attribute names, comparison keywords, and operands that can be specified in an event condition

No.

Item

Attribute name

Comparison keywords

Operand

1

Event ID

B.ID

Match

Does not match

Regular expression

Specifies an event ID.

A maximum of 100 event IDs can be specified. However, if a regular expression is used, only one event ID is allowed.

In the case of Match or Does not match, the event ID is not case sensitive.

The permitted range is from 0 to 7FFFFFFF.

In the case of a regular expression, the event ID of an event to be compared is treated as having the following format:

• When the extended part of the event ID is 0:

basic-part-of-event-ID (8-digit hexadecimal value consisting of uppercase letters and numbers)

• When the extended part of the event ID is not 0:

basic-part-of-event-ID (8-digit hexadecimal value consisting of uppercase letters and numbers):extended-part-of-event-ID (8-digit hexadecimal value consisting of uppercase letters and numbers)

If the basic part or extended part of an event ID is a value that consists of fewer than 8 characters, leading 0s are added to obtain a string of 8 characters.

2

Source process ID

B.PROCESSID

Match

Does not match

Regular expression

Specifies the process ID of the application program that issues the event.

A maximum of 100 source process IDs can be specified. However, if a regular expression is used, only one source process ID is allowed.

The permitted value range is from -2,147,483,648 to 2,147,483,647.

3

Registered time

B.TIME

Regular expression

Specifies the time the JP1 event was registered into the event database at the source host.

A regular expression in the format YYYYMMDDhhmmss must be used.

4

Arrived time

B.ARRIVEDTIME

Regular expression

Specifies the time the JP1 event arrived at the event database at the source host.

A regular expression in the format YYYYMMDDhhmmss must be used.

5

Source user ID

B.USERID

Match

Does not match

Regular expression

Specifies the user ID (numeric value) of the source process.

A maximum of 100 source user IDs can be specified. However, if a regular expression is used, only one source user ID is allowed.

The permitted value range is from -2,147,483,648 to 2,147,483,647.

6

Source group ID

B.GROUPID

Match

Does not match

Regular expression

Specifies the group ID (numeric value) of the source process.

A maximum of 100 source group IDs can be specified. However, if a regular expression is used, only one source user ID is allowed.

The permitted value range is from -2,147,483,648 to 2,147,483,647.

7

Source user name

B.USERNAME

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the user name of the source process.

A maximum of 100 source user names can be specified. However, if a regular expression is used, only one source user name is allowed.

8

Source group name

B.GROUPNAME

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the group name of the source process.

A maximum of 100 source group names can be specified. However, if a regular expression is used, only one source group name is allowed.

9

Source IP address

B.SOURCEIPADDR

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the IP address of the event-issuing server.

A maximum of 100 source IP addresses can be specified. However, if a regular expression is used, only one source IP address is allowed.

To specify an IPv6 address, use a four-digit value in hexadecimal (0 to 9 and a to f) as shown below. The alphabetic characters are case sensitive.

Example: 0011:2233:4455:6677:8899:aabb:ccdd:eeff

Lowercase letters cannot be changed to uppercase alphabetic characters, and IPv4-mapped address, IPv4-compatible addresses, and abbreviated IPv6 addresses cannot be specified.

10

Event-issuing server name (source host)#

B.SOURCESERVER

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the host name of the host (event server name) where the JP1 event occurred.

A maximum of 100 event-issuing server names can be specified. However, if a regular expression is used, only one event-issuing server name is allowed.

11

Message

B.MESSAGE

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the message for a basic attribute of the event.

A maximum of 100 messages can be specified. However, if a regular expression is used, only one message is allowed.

12

Detailed event information

B.DETAIL

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies detailed information for a basic attribute of the event.

A maximum of 100 detailed information items can be specified. However, if a regular expression is used, only one detailed information item is allowed.

If binary data is set in the detailed information for the JP1 event, the detailed information is treated as being the null character "" (0 bytes) for performing comparison.

Available for compatibility purposes.

13

Reason for registration

B.REASON

Match

Does not match

Specifies a reason for registration.

A maximum of 100 reasons for registration can be specified.

14

Start time

E.START_TIME

Regular expression

Specifies the execution start or restart time.

This item cannot be specified more than once.

Specify the absolute time in seconds using a regular expression.

15

End time

E.END_TIME

Regular expression

Specifies the execution end time.

This item cannot be specified more than once.

Specify the absolute time in seconds using a regular expression.

16

Product name

E.PRODUCT_NAME

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the name of the product that issued the JP1 event.

A maximum of 100 product names can be specified. However, if a regular expression is used, only one product name is allowed.

17

Object type

E.OBJECT_TYPE

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the type of object.

A maximum of 100 object types can be specified. However, if a regular expression is used, only one object type is allowed.

18

Object name

E.OBJECT_NAME

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the object name of the JP1 event.

A maximum of 100 object names can be specified. However, if a regular expression is used, only one object name is allowed.

19

Root object type

E.ROOT_OBJECT_TYPE

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the root object type of the JP1 event.

A maximum of 100 root object types can be specified. However, if a regular expression is used, only one root object type is allowed.

20

Root object name

E.ROOT_OBJECT_NAME

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the root object name of the JP1 event.

A maximum of 100 root object names can be specified. However, if a regular expression is used, only one root object name is allowed.

21

Object ID

E.OBJECT_ID

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the object ID of the JP1 event.

A maximum of 100 object IDs can be specified. However, if a regular expression is used, only one object ID is allowed.

22

Occurrence

E.OCCURRENCE

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the occurrence of the JP1 event.

A maximum of 100 occurrences can be specified. However, if a regular expression is used, only one occurrence is allowed.

23

User name

E.USER_NAME

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the user name of the user who issued the JP1 event.

A maximum of 100 user names can be specified. However, if a regular expression is used, only one user name allowed.

24

Result code

E.RESULT_CODE

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the termination code.

A maximum of 100 termination codes can be specified. However, if a regular expression is used, only one termination code is allowed.

25

Severity

E.SEVERITY

Match

Regular expression

Specifies the severity of the JP1 event.

The following severity levels can be specified: Emergency, Alert, Critical, Error, Warning, Notice, Information, or Debug.

Multiple severity values can be specified. However, if a regular expression is used, only one severity value is allowed.

26

Event source host name#

E.JP1_SOURCEHOST

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

Specifies the event source host name of the JP1 event.

A maximum of 100 reasons for registration can be specified. However, if a regular expression is used, only one reason for registration is allowed.

27

Basic event information

B.BASIC

Regular expression

You can specify basic event information for compatibility with version 8 or earlier.

28

Program-specific extended attribute

--

Match

Does not match

Is contained

Is not contained

First characters

Regular expression

Specifies the attribute name of a program-specific extended attribute.

You can specify a name with a maximum length of 32 bytes that begins with an uppercase letter and consists of uppercase letters, numeric characters, and the underscore (_).

A maximum of 100 extended attribute names can be specified. However, if a regular expression is used, only one extended attribute name is allowed.

Legend:

--: None

#

If the integrated monitoring database and the IM Configuration Management database are enabled, and the comparison keyword is Match or Do not match, the business group name can be specified in a path format.

If the integrated monitoring database and the IM Configuration Management database are disabled, and a comparison keyword other than Match and Do not match is selected, a business group name specified in a path format is treated as a host name.

If the -ignorecasehost option of the jcoimdef command is set to ON, and a comparison keyword other than Regular expression is selected, the character string is no longer case sensitive.

usr user-name

Specifies the user name of the JP1 user who executes the action. The usr parameter is optional. If this parameter is omitted, the system assumes the JP1 user name specified as the default action execution user in the definition of the automated action execution environment. If the default action execution user is also omitted, jp1admin is assumed.

The number of characters you can specify is 1 to 31 bytes for the user name. Only one-byte alphanumeric characters can be used. Alphabetic characters are not case sensitive. You can specify a variable for the user name. You specify a variable when you want to set information contained in the received JP1 event as the user name.

You can set event information for the user name.

When the action is executed, the JP1 user specified here is mapped to the OS user at the execution host that will execute the command, according to the JP1/Base definition. In UNIX, the shell environment of the mapped OS user is used for execution. Note that this parameter cannot be specified together with the rul parameter.

hst {execution-host-name|group-name|business-group-name|monitoring-group-name}

Specifies the name of the host on which an action is executed, a host group name, a business group name, or a monitoring group name. For a host name, specify a name set as a managed host in the system configuration definition. The hst parameter is optional. If it is omitted, the local host is assumed.

Express the execution host name or host group name using from 1 to 255 bytes of characters. The execution host name or host group name cannot contain the space character. You can specify a variable for the execution host name or host group name. You specify a variable when you want to set information contained in the received JP1 event as the execution host name or host group name. For example, to execute the action on the host that issues the event, specify $EVHOST.

You can set event information for the execution host name or host group name.

For a business group name and monitoring group name, you can specify a character string with a maximum of 2,048 bytes. If the specified character string begins with a slash (/), it is treated as a business group name or a monitoring group name. Note, however, that the character string is treated as a host name or a host group name if the integrated monitoring database and the IM Configuration Management database are disabled.

Note that this parameter cannot be specified together with the rul parameter.

cmd action

Specifies the command that is to be executed as the action. For details about the specifiable commands, see Chapter 6. Command Execution by Automated Action in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

The cmd parameter is optional. If this parameter is omitted, no action is taken even when conditions for action execution are satisfied.

Note that if any of the following parameters is omitted, omitting the cmd parameter results in a definition error:

usr, var, hst, det, ret

The cmd parameter cannot be specified more than once. Specify the parameter using from 1 to 4,096 bytes of characters. Any tabs or spaces preceding the action are deleted, but spaces following the action are not deleted.

This parameter cannot be specified together with the rul parameter.

You can set event information for the action.

You can use a variable to specify information contained in the received JP1 event. For example, if the execution host is UNIX, the following specification sets the name of the host that issued the JP1 event in the HOSTNAME environment variable:

HOSTNAME="$EVHOST" action

xxx_BASIC="$EVBASE" xxx_MESSAGE="$EVMSG" action

Notes about the length of an action command

The maximum length of a command that can be executed as an action is 4,096 bytes including the information obtained after converting variables to be used in the action definition (such as $EVMSG). If the command length exceeds 4,096 bytes, the execution status becomes Fail, in which case the command is not executed. In such a case, the message KAVB4421-W is displayed in the Message field in the Action Log Details window.

The length of a command that can be executed as an action also depends on the system where JP1/IM - Manager and JP1/Base are running.

If any of the hosts on the automated action execution route (including the source manager host and target execution host) runs JP1/IM - Manager or JP1/Base version 6 or version 7, the maximum length of a command must not exceed 1,024 bytes. For notes about the length of a command, see 12.4.1 Notes regarding the considerations for automated actions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

Notes about codes that cannot be recognized as characters in an action

If codes (ASCII codes and characters not included in the character set of the multi-byte characters encoding specified in the environment settings) that are not recognizable as characters are included in an action, the action might not be executed, or if it is executed, might result in an error because of the shell or other specifications on the execution host. In such a case, the action results in terminated status, not an execution failure. Even though there might be no invalid code in the definition file, an invalid code might be generated when a variable used in the action definition is replaced with the actual value. For details about the correct specification of variables in an action definition, consult the documentation for the products that issue action-related events.

rul

Specifies that a rule startup request to JP1/IM - RL is to be set. This parameter cannot be specified together with the var, cmd, usr, or hst parameter.

var environment-variable-file-name

Specifies the full path name of the environment variable file that specifies environment variables for the command that is to be executed as the action. This parameter is optional. If this parameter is omitted, it is assumed that there is no environment variable file. For details about the format of an environment variable file, see the JP1/Base User's Guide.

Express the environment variable file name using from 1 to 255 bytes of characters. You can set event information for the environment variable file name. You can specify a variable for the environment variable file name. You specify a variable when you want to set information contained in the received JP1 event as the environment variable file name. For example, to set the JP1 event extended attribute named ENVFILE as the environment variable file name, specify $EV"ENVFILE".

Note that this parameter cannot be specified together with the rul parameter. Spaces before and after the environment variable file name are not deleted. Only one tab or one space character following var is deleted.

det suppress-period

Specifies a period during which action execution is to be suppressed. The action for the action conditions is suppressed if it would otherwise occur during the period specified in this parameter. This parameter is optional. If this parameter is omitted, the action is not suppressed. The permitted value range for the suppression period is from 1 to 3,600 (seconds). This parameter cannot be specified when you have specified & for the parameter group. In the case of AND conditions, specify the suppression period in the first automated action definition parameter that is defined for the AND conditions.

ret delay-monitoring-period

Specifies a period during which monitoring for the action execution is performed. If the amount of time specified in this parameter expires before a command control action termination message is received from the execution host after a JP1 event arrived at JP1/Base at the manager, a delay of action is reported by using a method such as JP1 event issuance or command execution. This parameter is optional. If this parameter is omitted, no monitoring for action delay is performed. The permitted value range for the delay monitoring period is from 1 to 86,400 (seconds).

#comment-line

A line beginning with a hash mark (#) is treated as a comment. Note that if you set an action definition from JP1/IM - View, comment lines with the # mark are deleted.

Variables that can be used in the action definition

In a definition of automated action definition parameters, you can use variables in the usr, var, hst, and cmd parameters to specify information contained in the JP1 events.

When the action is executed, the variables are replaced with the actual information in the JP1 event.

To specify a variable in an automated action definition parameter, use a format such as $EVID. If you want to specify $ as a character, specify the escape character \ before the $.

The following table lists and describes the available variables.

Table 2‒9: Variables that can be used in action definitions

Type of information

Variable name

Description

Information contained in the basic attributes of JP1 events

EVBASE

Entire basic event information#1

EVID

Event ID (basic-code:extended-code)

EVIDBASE

Event ID (basic code)

EVDATE

Event registration date (YYYY/MM/DD)#2

EVTIME

Event registration time (hh:mm:ss)#2

EVPID

Event source process ID

EVUSRID

User ID of the event source process

EVGRPID

Group ID of the event source process

EVUSR

Event source user name

EVGRP

Event source group name

EVHOST

Event source host name

EVIPADDR

Event source IP address

EVSEQNO

Serial number

EVARVDATE

Event arrival date (YYYY/MM/DD)#2

EVARVTIME

Event arrival time (hh:mm:ss)#2

EVSRCNO

Serial number at the event source

EVMSG

Entire message text#3

EVDETAIL

Entire detailed event information#3, #4

Information contained in the extended attributes of JP1 events

EVSEV

Severities in extended event information (Emergency, Alert, Critical, Error, Warning, Notice, Information, Debug)#3

EVUSNAM

User name#3

EVOBTYP

Object type#3

EVOBNAM

Object name#3

EVROBTYP

Registration type#3

EVROBNAM

Root object name#3

EV"PRODUCT_NAME"

Product name#5

EV"OBJECT_ID"

Object ID#5

EV"OCCURRENCE"

Occurrence#5

EV"START_TIME"

Start time#5

EV"END_TIME"

End time#5

EV"RESULT_CODE"

Return code#5

EV"JP1_SOURCEHOST"

Issuing host name#5

EV"extended-attribute-name"

Any extended attribute#5

Other

EV"@JP1IM_CORRELATE"

Correlation event flag

Not a correlation event: 0

Correlation approval event: 1

Correlation failure event: 2

EV"@JP1IM_ORIGINAL_SEVERITY"

Extended event information original severity level

(Emergency, Alert, Critical, Error, Warning, Notice, Information, or Debug)#3

EV"@JP1IM_CHANGE_SEVERITY"

New severity level flag

Severity is not changed: 0

Severity is changed: 1

EV"@JP1IM_DISPLAY_MESSAGE"

Changed display message

EV"@JP1IM_CHANGE_MESSAGE"

Display message change flag

Message has not been changed: 0

Message was changed: 1

ACTHOST

Manager host name at the action request source#3

EVENV1 to EVENV9

Data obtained by specifying parentheses (()) in a regular expression in the specification of an action execution condition #5(applicable only when an extended regular expression is used at the manager host)

#1: The basic information of a JP1 event is converted to the following format and passed to the action (Δ indicates a single-byte space):

event-IDΔevent-source-user-nameΔevent-source-user-IDΔevent-source-group-nameΔevent-source-group-IDΔevent-source-event-server-nameΔevent-source-process-IDΔevent-registration-dateΔevent-registration-timeΔevent-source-host-IP-address

An item that is not set is replaced with the null character.

#2: Converted in the time zone for JP1/IM - Manager and passed to the action.

#3: When an action is executed, if the applicable attribute does not exist, the variable is converted to a null character and passed to the action.

#4: When detailed attribute information for a JP1 event is in binary format, the variable is converted to a null character and passed to the action.

#5: If the applicable attribute does not exist, the character string of the variable is passed to the action as is.

In addition, depending on the type of JP1 event, an action might not be executed, or if executed, might result in an error because the variable itself does not exist or codes (ASCII codes and characters that are not included in the character set of the multi-byte characters encoding specified in the environment settings) not recognizable as characters are included. See the documentation for the JP1 event source product to check the attribute information, and then set the characters that need to be replaced.

Encoding for event inheritance information

For Action of the action-related items, you can use URL encoding or Base64 encoding for the values for event inheritance information. The specification format is $variable-name$encoding-type. To specify a single-byte alphanumeric character or an underscore (_) immediately after encoding-type, use the format ${variable-name$encoding-type}. If you specify a dollar sign ($) as part of a character string, immediate before $, specify \ as an escape character.

In the following cases, $variable-name$encoding-type and ${variable-name$encoding-type} will be treated as character strings and thus will not be converted:

There is no event that corresponds to variable-name.

The specification format is invalid.

The following table describes the encoding types for event inheritance information and shows the specification formats.

Table 2‒10: Encoding types for event inheritance information and specification formats

No.

Encoding type

Specification format

Description

1

URL encoding

$variable-name$URLENC

URL encoding is used to encode the value of event inheritance information as a UTF-8 character string.

${variable-name$URLENC}

2

Base64 encoding

$variable-name$ENC

Base64 encoding is used to encode the value of event inheritance information.

${variable-name$ENC}

3

Both Base64 encoding and URL encoding

$variable-name$ENC$URLENC

The value of event inheritance information is encoded by using Base64 encoding and then by using URL encoding.

${variable-name$ENC$URLENC}

4

No encoding is performed

$variable-name

Neither URL encoding nor Base64 encoding is performed.

${variable-name}

Notes about specifying variables

If you specify a character, such as an alphanumeric character or an underscore (_), immediately after the variable name, the variable will not be converted correctly. In such a case, enclose the variable name in curly brackets ({ }), as shown in the examples below. These examples assume that 100:0 is specified as the event ID ($EVID) and ABC is specified as the extended attribute EX ($EV"EX").

Examples:

action-definition information-after-conversion

$EVID abc 100:0 abc

$EVIDabc $EVIDabc (in Windows), none (in UNIX)

${EVID}abc 100:0abc

$EVID_abc $EVID_abc (in Windows), none (in UNIX)

${EVID}_abc 100:0_abc

$EV"EX" abc ABC abc

$EV"EX"abc ABCabc

If the source character information contains any of the control characters shown below, the control character is converted to a space (0x20).

Control characters that are converted to a space: 0x01 to 0x1F (excluding tab (0x09)), 0x7F

For example, if the message acquired by specifying $EVMSG contains a linefeed code (0x0A), the linefeed code (0x0A) is converted to the space (0x20).

Example: If the action echo $EVMSG is set and the character string "line-1 0x0A line-2", which contains a linefeed code, is received as the message for the event, the command "echo line-1Δline-2" is executed as the action. (Δ indicates a single-byte space.)

When a backslash (\) is specified immediately before a dollar sign ($), the dollar sign is treated as a character string. However, if you attempt to specify a backslash followed by a variable, for example, in a file path, the backslash will be converted instead of being treated as a character string. You can prevent this by one of the following methods:

Using an execution command:

Create a batch file in which the variable is specified for the argument. Use the batch file to specify commands that include backslashes.

Example of how to specify an execution command:

• Execution command: AppTest.bat $ACTHOST

• Batch file: application.exe c:\work\%1\result.txt

In this example, the conversion result of $ACTHOST is set for %1.

Using a variable in a file path:

Add a prefix to the variable.

The following are examples of when IM-VIEW is set for EV"PRODUCT_NAME".

Example when the variable cannot be converted:

• Example specification: C:\$EV"PRODUCT_NAME"

• Conversion result: C:$EV"PRODUCT_NAME"

In this example, EV"PRODUCT_NAME" cannot be converted because \$ is specified.

Example when the variable can be converted:

• Example specification: C:\pre_$EV"PRODUCT_NAME"

• Conversion result: C:\pre_IM-VIEW

In this example, EV"PRODUCT_NAME" can be converted because pre_ is added before the variable.

In UNIX, the final expansion depends on the interpretation by the shell. If the expanded data contains a character that has a special meaning in the shell, such as *, it is replaced by the corresponding data. To prevent such characters from being converted, enclose the entire variable in double-quotation marks ("), such as "$EVMSG".

If JP1 event information specified by a variable contains a double quotation ("), single-quotation mark ('), or another character that has a special meaning when used in a command, the command might not be interpreted correctly. We recommend that you convert such characters in the configuration file for converting information. For details about the configuration file for converting information, see Configuration file for converting information (event_info_replace.conf) in Chapter 2. Definition Files.

Regular expressions in an action definition

This subsection describes how to use regular expressions to specify attributes of JP1 events (message text, basic attributes, and detailed information) in an event monitoring condition of an automated action definition.

The supported regular expressions depend on the OS. The regular expressions supported by Windows and UNIX are described below.

If you share the same action definitions among different OSs, specify conditions using expressions that are supported by all the OSs because interpretation of regular expressions depends on the OS. Regular expressions supported by all OSs are presented in Appendix G. Regular Expressions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide. Consult this information to determine the regular expressions that can be used.

Regular expressions for the Windows version

For the Windows version, you can set the supported regular expressions to either JP1-specific regular expressions or extended regular expressions. The default is extended regular expressions. For details about how to specify JP1-specific regular expressions, see Automated action environment definition file (action.conf.update) in Chapter 2. Definition Files.

Regular expressions for the UNIX version

For the UNIX version, use the extended regular expressions. For details about the supported regular expressions, see the OS-provided regexp(5).

Notes on regular expressions

Because the regular expression of the automated action is a partial match, conditions are the same regardless of whether the same characters (.*) are specified for the first and last characters.

For example, the same conditions can be set for the following examples 1 and 2:

Example 1: Regular expression matching the string containing "A001Δ:ΔWEB-server":

.*A001Δ:ΔWEB-server.*

Example 2: Regular expression matching the string containing "A001Δ:ΔWEB-server":

A001Δ:ΔWEB-server

Do not specify (.*) at the beginning or end because searching might take a long time.

If the jcamakea command is executed to check a file that contains either of the regular expressions below, the KAVB5759-W message appears:

Regular expression beginning or ending with .*

Regular expression containing successive instances of .*

For details about the KAVB5759-W message, see 2.6 Messages related to automated actions and Event Base Service (KAVB4001 to KAVB6000) in the manual JP1/Integrated Management 2 - Manager Messages.

Example definition

The examples below show example definitions for the automated action definition file. Note that the extended regular expression is specified as the regular expression type in these examples.

Example definition 1: Using a variable (1)

The following is an example definition for specifying JP1 event information received by using a variable as an argument of a command to be executed as an action:

Event condition

The event ID (B.ID) is 00000001.

The message format is message-ID#Δ:Δmessage-text.

#: A message ID consists of one alphabetic character and three numeric characters.

Command to be executed as an action

alarm.batΔargument-1Δargument-2

JP1 event information to be specified as a command argument

argument-1: The message value (${EVMSG} is specified as a variable)

argument-2: The extended attribute value AAA (${EV"AAA"} is specified as a variable)

When the value for the received JP1 event message (B.MESSAGE) is A001Δ:ΔThe WEB server goes down. and the value for the AAA extended attribute is kanshi, the action alarm.batΔ"kanshi"Δ"A001Δ:ΔThe WEB server goes down." is performed.

Example definition 2: Using a variable (2)

The following is an example definition for specifying a part of the JP1 event information received by using the variables EVENV1 to EVENV9 as arguments of the command to be executed as an action:

Event condition

The event ID (B.ID) is 00000001.

The message format is message-ID#Δ:Δmessage-text.

#: A message ID consists of one alphabetic character and three numeric characters.

Command to be executed as an action

alarm.batΔargument-1Δargument-2

JP1 event information to be specified as command arguments

argument-1: Message ID value (${EVENV1} is specified as a variable)

argument-2: Message text value (${EVENV2} is specified as a variable)

When the value for the received JP1 event message (B.MESSAGE) is A001Δ:ΔThe WEB server goes down., the action alarm.batΔ"A001"Δ"The WEB server goes down." is performed.

Example definition 3: Specifying an event ID in a regular expression (1)

The following is an example definition when B.ID is specified as the attribute name of an event condition and REGEX is specified as the comparison keyword:

Event condition

The event ID is a value from 00000001 to 00000200 (Hexadecimal A to F not included).

The event-issuing server name (B.SOURCESERVER) is kanshi.

Command to be executed as an action

alarm.bat

To specify an event ID as an event condition, specify * for eid so that the event ID specified as an event condition becomes the target.

Example definition 4: Specifying an event ID in a regular expression (2)

If B.BASIC is specified for the attribute name as an event condition, the conditions can be set in the same format used for the basic event information of the automatic action definition file (for compatibility).

The following is an example definition when B.BASIC is specified as the attribute name of an event condition and REGEX is specified as the comparison keyword:

Event condition

The event ID is a value from 00000001 to 00000200 (Hexadecimal A to F not included).

The event-issuing server name (B.SOURCESERVER) is kanshi.

Command to be executed as an action

alarm.bat

The method for specifying a tab, space, %, or linefeed is different from the method used for the automatic action definition file (for compatibility). For details, see Automated action definition file (actdef.conf) (for conversion) in Chapter 2. Definition Files.

Example definition 5: Using the AND condition

The following is an example definition for setting the action to be executed when event A and event B are received:

Event A conditions

The event ID (B.ID) is 00000201.

The message (B.MESSAGE) is WEB server A goes down..

Event B conditions

The event ID (B.ID) is 00000202.

The message (B.MESSAGE) is Web server B goes down..

Command to be executed as an action

alarm.bat

When the AND condition is applied, we recommend using an automated action by using the correlation event generation function. The correlation event generation function can specify the sequence or the number of JP1 events, a property not available to the AND condition. For details about correlation events, see 4.3 Issue of correlation events in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

Automated action definition file (actdef.conf) (for conversion)

Format

[#automated-action-definition-file-version]
[DESC_VERSION=version-information]

[#automated-action-status-monitoring-parameter]
Δ₀[:state_watch={true | false}]

[#automated-action-definition-parameter]
Δ₀[ {+parameter-group-number|&}Δ₁] {$event-ID|*}Δ₁
[/message/] [,[/basic-event-information/] [,[/detailed-event-information/]
[,[/event-levels-of-extended-event-information/] ] ] ]Δ₁[attribute-name-of-extended-event-information=/attribute-value/
[,attribute-name-of-extended-event-information2=/attribute-value/][,...] ]Δ₀
: Δ₀[u=user-nameΔ₁] [e=environment-variable-file-nameΔ₁]
[d=execution-host-name|group-nameΔ₁] [dt=suppress-periodΔ₁]
[rt=delay-monitoring-periodΔ₁] [action]
   :

File

actdef.conf (automated action definition file) (for conversion)

Storage directory

In Windows

For a physical host:

Console-path\conf\action\

For a logical host:

shared-folder\jp1cons\conf\action\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/action/

For a logical host:

shared-directory/jp1cons/conf/action/

Description

This file defines (for conversion) conditions for executing actions by the automated action function of JP1/IM and the commands to be executed as the actions. Use the language encoding that is used by JP1/IM - Manager to specify this file.

When a JP1 event satisfying specified conditions is received, the automated action function executes automatically a specified command based on the definition specified in this file.

Each line of action definition information is called a parameter. There are three types of parameters in an automated action definition file:

Automated action definition file version

Defines the format version of the automated action definition file.

Automated action status monitoring parameter

Defines whether the status of automated actions is to be monitored.

Automated action definition parameters

Define conditions for executing an action and the command to be executed as the action.

You must specify the automated action definition file version and the automated action status monitoring parameter before the automated action definition parameters. If you specify the automated action definition file version and/or the automated action status monitoring parameter after any automated action definition parameters, the specified definition is ignored.

If you specify the automated action definition file version or the automated action status monitoring parameter more than once, the first definition specified takes effect and subsequent definitions are ignored.

Definition specification

The automated action status monitoring parameter and the automated action definition parameters specify one definition per line. A definition that will not fit on one line can be continued onto the next line.

An automated action definition parameter is specified in the format event-monitoring-condition:action-execution-definition, consisting of two components separated by a colon (:).

The maximum length of one automated action definition parameter is 5,706 bytes.

Spaces are counted, but the \ in a linefeed code or in a continuation line indicator is not counted.

An automated action definition parameter that will not fit on one line can continue onto the next line.

To continue a definition onto the next line, specify \ immediately before the linefeed code at the end of the line. If there is any character, including a space, between \ and the linefeed code, the \ will be regarded as data.

A line containing a hash mark (#) in column 1 is regarded as a comment line.

A comment must be specified on a single line. If a comment consists of multiple lines, all but the first line will be discarded when the GUI is used for specifying the definition. Any hash marks (#) in columns other than column 1 or on continuation lines are treated as data, not as a comment.

Priority order of event monitoring conditions

If a received JP1 event satisfies the execution conditions in multiple automated action definitions, only the automated action that has the highest priority level is executed (for each parameter group discussed below). The automated action priority order is determined by the following rules:

For automated actions with an event ID specified, an automated action that is applied to all event IDs takes precedence.

The first action specified in the automated action definition file (in GUI, the first action displayed in the Action Parameter Definitions) takes precedence.

Parameter groups and AND conditions

Each automated action definition parameter belongs to a parameter group. A parameter group is a unit for checking the conditions for executing an automated action. Use of parameter groups allows you to specify complex conditions, such as when multiple actions are to be executed for a single JP1 event or when an action is to be executed only when multiple conditions are satisfied.

When a single JP1 event arrives at the manager of JP1/IM, the automated action definition parameters and execution conditions are compared for each parameter group in order of priority. When execution conditions that are satisfied are found, only the automated action definition parameter that has the highest priority is executed for each parameter group.

If you specify an ampersand (&) in a parameter group, an AND condition with the automated action definition parameter defined on the preceding line is created. When automated action definition parameters are specified in an AND condition, the corresponding action is executed when all the conditions are satisfied.

Checking the size of an automated action definition parameter

The following lists the items whose size is checked and the respective maximum sizes:

The maximum size of an automated action definition parameter is 5,706 bytes.

In an automated action definition parameter, the maximum size of the event monitoring conditions is 1,040 bytes.

In an automated action definition parameter, the maximum size of an action is 4,096 bytes.

If a maximum size is exceeded, a message is displayed when the definition is applied and the corresponding automated action definition parameter is ignored.

Checking the specified information

Use the jcamakea command to check the information specified in the definition file.

Note that, for the automated action definition file (actdef.conf) (for compatibility), a business group name cannot be used. If a business group name is specified, it is treated as a host name.

When the definitions are applied

The definition of an automated action takes effect when you click the Apply button in the Action Parameter Definitions window in JP1/IM - View when JP1/IM - Manager starts, or when you execute the jcachange command.

If you want to execute the jcachange command to re-load the definition, execute the jcamakea command first to make sure there are no errors in the definition.

Information that is specified (automated action definition file version)

This subsection describes the information to be specified as the automated action definition file version.

DESC_VERSION=version-information

Defines the format version of the automated action definition file.

Table 2‒11: Automated action definition file format version information

Version information

Description

1

Automated action definition file version is 07-11 to 07-51.

2

Automated action definition file version is 08-01 or later.

3

Automated action definition file version is 09-00 or later.

4

Automated action definition file version is 11-50 or later.

If this parameter is omitted or 1 is specified, the value 2 is assumed for reading the file. When the Apply button is clicked in the Action Parameter Definitions window in JP1/IM - View, the value 2 is set.

If a value other than 1, 2, 3, or 4 is specified in this parameter, an error is output to the integrated trace log, and the value 3 is assumed as the version information for reading the file. In such cases, the Action Parameter Definitions window cannot be displayed in JP1/IM - View. To change the version information, edit the definition file.

Because the format of an old automated action definition file version is compatible with the automated action definition file format for version 08-01 or later, the format for version 08-01 or later is assumed for reading the file.

If this parameter is specified on a line that is subsequent to a line containing an automated action definition parameter, the Action Parameter Definitions window can no longer be displayed in JP1/IM - View.

Use the jcamakea command to check the contents of the automated action definition file.

Information that is specified (automated action status monitoring parameter)

This subsection describes the information to be specified in the automated action status monitoring parameter.

state_watch={true | false}

Specifies whether the action status is to be monitored.

Specify either true or false. The default is false.

If true is specified, the Action Parameter Definitions window cannot be displayed in JP1/IM - View version 07-01 or earlier.

This parameter is effective only if it is specified before the automated action definition parameters.

If this parameter is specified on a line that is subsequent to a line containing an automated action definition parameter, the Action Parameter Definitions window can no longer be displayed in JP1/IM - View.

You should use the jcamakea command to check the contents of the automated action definition file.

When JP1/IM - View version 07-11 or later is connected to JP1/IM - Manager (Central Console) version 07-11 or later, the automated action status monitoring parameter will always be output to the automated action definition file even when the action status is not being monitored.

Information that is specified (automated action definition parameters)

This subsection describes each item that is specified in the automated action definition parameters. For details about the JP1 events, see Chapter 3. JP1 Events. Regular expressions and variables that can be specified in the definition are described later.

Event monitoring conditions

The items to be specified as the execution conditions in an automated action definition parameter are described below. The maximum length of a parameter that can be defined as execution conditions is 1,040 bytes.

{+parameter-group-number|&}

Specifies the parameter group number to which the automated action definition parameter on this line belongs, expressed as a single-digit number (from 0 to 9) preceded by a plus sign (+). If this information is omitted, 0 is assumed.

If you specify an ampersand (&), this parameter becomes part of an AND condition with the immediately preceding definition line, which means that the automated action definition parameter on this line belongs to the same parameter group as the parameter on the immediately preceding line.

Note that the parameter group number has nothing to do with the priority order for checking execution conditions or the sequence of executing actions.

$event-ID

Specifies the event ID preceded by the dollar sign ($). The specification format of an event ID is as follows:

basic-part[:extended-part]

Specify the basic and extended parts each using from 1 to 8 hexadecimal numbers (from 0 to 7FFFFFFF). Alphabetic characters must be specified as lowercase letters.

*

Specifies that the target is all event IDs. When an asterisk (*) is specified, all events become subject to the action. If JP1 events occur frequently, a large number of actions will be implemented, in which case execution may be delayed. When you specify an asterisk, you should narrow down the applicable events by using other conditions (such as a message, basic event information, detailed event information, and extended event information).

message

Specifies as an execution condition a message text associated with the JP1 event. You can use a regular expression for the condition. When you use a regular expression, specify the message text without control codes.

To express / in a regular expression, specify \/.

basic-event-information

Specifies information about JP1 event basic attributes that are to be used as an execution condition. You can use a regular expression to specify this information.

To express / in a regular expression, specify \/. For details about regular expressions, see Appendix G. Regular Expressions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

The basic event information is passed as information about JP1 event basic attributes in the format shown below. Use this format to specify a condition for executing an action.

event-IDΔevent-source-user-nameΔevent-source-user-IDΔ

event-source-group-nameΔevent-source-group-IDΔ

event-issuing-server-nameΔevent-source-process-IDΔ

event-registration-year-month-dayΔevent-registration-timeΔevent-source-host-IP-address

For details about the information included in the JP1 event basic attributes, see Chapter 3. JP1 Events.

detailed-event-information

Specifies information about detailed attributes in the JP1 event basic attributes that is to be used as an execution condition.

You can use a regular expression to specify this information.

To express / in a regular expression, specify \/. For details about regular expressions, see Appendix G. Regular Expressions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

The detailed attributes in the JP1 event basic attributes consist of additional JP1 event information. The details and format of this information depend on the JP1 event. If the detailed attribute information is specified in binary format, it is treated as no information (NULL).

Remarks: The detailed attributes in the JP1 event basic attributes are used principally to record detailed information provided by products that issue events that are compatible with the JP1/SES format of version 5 or earlier. Most products whose version is 6 or later use the JP1 event extended attributes to record detailed information.

event-levels-of-extended-event-information

Specifies the severity levels in the extended attributes of the JP1 events that are to be set as an execution condition. Specify the event levels (severities) by combining the applicable characters in the following format:

-------E Event level:Emergency

------A- Event level:Alert

-----C-- Event level:Critical

----E--- Event level:Error

---W---- Event level:Warning

--N----- Event level:Notice

-I------ Event level:Information

D------- Event level:Debug

For example, to set as a condition all severities at the Error and higher event levels, specify /----ECAE/.

attribute-name-of-extended-event-information=/attribute-value/

Specifies a combined name and value of the JP1 event extended attribute used to form an execution condition. You can use a regular expression to specify this information.

To express / in a regular expression, specify \/.

You can specify a maximum of 100 pairs of attribute name and attribute value combinations.

For an attribute name, you can specify from 1 to 32 bytes of uppercase letters, numeric characters, and the underscore (_). The attribute name cannot contain a colon (:) or an equal sign (=). Specify an attribute name in a form such as PRODUCT_NAME or OBJECT_NAME. Unlike the settings in other functions, this attribute name is not prefixed with E..

If you specify an event level in this item (item name SEVERITY), specify the attribute value as a character string, such as Emergency or Alert.

Action execution definition

The following describes the items in an automated action definition parameter that can be used to specify an action execution definition.

u=user-name

Specifies the user name of the JP1 user who executes the action.

You can specify 1 to 31 bytes of characters. Only one-byte alphanumeric characters can be used. Alphabetic characters are not case sensitive.

If this parameter is omitted, the system assumes the JP1 user name specified as the default action execution user in the definition of the automated action execution environment. If the default action execution user is also omitted, jp1admin is assumed.

You can use a variable to specify information contained in the received JP1 event as the JP1 user name.

When the action is executed, the JP1 user specified here is mapped to the OS user at the execution host that will execute the command, according to the JP1/Base definition. In UNIX, the shell environment of the mapped OS user is used for execution.

If <RULE> is specified in action, this item cannot be specified.

e=environment-variable-file-name

Specifies the full path name of the environment variable file that specifies environment variables for the command that is to be executed as the action.

The file name can be a character string with a maximum size of 255 bytes. If the file name contains a space, enclose the entire name in double-quotation marks ("").

You can use a variable to specify information contained in the received JP1 event as the file name. For example, to set the JP1 event extended attribute named ENVFILE as the environment variable file name, specify $EV"ENVFILE".

For details about the format of the environment variable file, see the JP1/Base User's Guide.

If <RULE> is specified in action, this item cannot be specified.

d=execution-host-name|group-name

Specifies the name of the host or host group that is to execute the action. For a host name, specify a name set as a managed host in the system configuration definition. A host name or host group name cannot contain a space.

If this parameter is omitted, the action is executed at the local host (the host that contains the automated action definition file).

You can use a variable to specify information contained in the received JP1 event as the host name or group name. For example, to execute the action on the host that issued the event, specify $EVHOST.

If <RULE> is specified in action, this item cannot be specified.

dt=suppress-period

Specifies a period during which action execution is to be suppressed. The action for the action conditions is suppressed if it would occur during the period specified in this parameter. If this parameter is omitted, the action is not suppressed. Express the suppression period using from 1 to 4 bytes of numeric characters. The permitted value range is from 1 to 3,600 (seconds).

When this parameter is specified, JP1/IM - View version 07-01 or earlier cannot display the Action Parameter Definitions window.

Note that this parameter cannot be specified in the following case:

& is specified.

rt=delay-monitoring-period

Specifies a period during which monitoring for the action execution is performed. If the amount of time specified in this parameter expires before a command control action termination message is received from the execution host after a JP1 event arrived at JP1/Base at the manager, a delay of action is reported by using a method such as JP1 event issuance or command execution. This parameter is optional. If this parameter is omitted, no monitoring for action delay is performed.

Express the delay monitoring period using a maximum of five bytes of numeric characters. The permitted value range for the delay monitoring period is from 1 to 86,400 (seconds).

When this parameter is specified, JP1/IM - View version 07-01 or earlier cannot display the Action Parameter Definitions window.

action

Specifies the command that is to be executed as the action.

For details about the specifiable commands, see Chapter 6. Command Execution by Automated Action in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

If this parameter is omitted, no action is taken even when conditions for action execution are satisfied.

You can use a variable to specify information contained in the received JP1 event as the command parameter.

If the host where the automated action is defined is UNIX, you can use a variable to specify information contained in the received JP1 event as the command environment variable. For example, MESSAGE="$EVMSG" command arg1 arg2 can be specified.

Note that the colon (:) in the automated action definition parameter is followed by the action to be executed. If you simply specify u=, e=, d=, dt=, or rt=, it is treated as being part of the previous information, such as a user name. If you specify information such as u= and omit the action, an error will result.

The maximum length of a command that can be executed as an action is 4,096 bytes, including the information obtained after converting variables to be used in the action definition (such as $EVMSG). If the command length exceeds 4,096 bytes, the execution status becomes Fail, in which case the command is not executed. In such a case, the message KAVB4421-W is displayed in the Message field in the Action Log Details window.

If codes (ASCII codes and characters not included in the character set of the multi-byte characters encoding specified in the environment settings) that are not recognizable as characters are included in an action, the action might not be executed or, if it is executed, might result in an error because of the shell or other specifications on the execution host. If an action contains a code that cannot be recognized as a character, the action might not be executed by the shell at the execution host or might result in an error when the action attempts to execute. In such a case, the action results in terminated status, not an execution failure. Even though there might be no invalid code in the definition file, an invalid code might be generated when a variable used in the action definition is replaced with the actual value. For details about the correct specification of variables in an action definition, consult the documentation for the products that issue action-related events.

To set a rule startup request to JP1/IM - Rule Operation, specify <RULE>. When <RULE> is specified, user-name, execution-host-name, and environment-variable-file-name cannot also be specified. If one of these items is specified together with <RULE>, the KAVB4550-W message is displayed and the automated action definition parameter is not output to the standard output.

Notes about the length of an action command

The maximum length of a command that can be executed as an action depends on the system where JP1/IM - Manager and JP1/Base are running.

If any of the hosts on the automated action execution route (including the source manager host and target execution host) runs JP1/IM - Manager or JP1/Base version 6 or version 7, the maximum length of a command must not exceed 1,024 bytes. For notes about the length of a command, see 12.4.1 Notes regarding the considerations for automated actions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

Variables that can be used in the action definition

In a definition of automated action definition parameters, you can use variables in the specification of the action to be executed (specification following a colon (:)) to set information contained in the JP1 event. When the action is executed, the variables are replaced with the actual information in the JP1 event.

To specify a variable in an automated action definition parameter, use a format such as $EVID.

The following table lists the describes the available variables.

Table 2‒12: Variables that can be used in the action definition

Type of information

Variable name

Description

Information contained in the basic attributes of JP1 events

EVBASE

Entire basic event information

EVID

Event ID (basic-code:extended-code)

EVDATE

Event generation date (YYYY/MM/DD)

EVTIME

Event generation time (hh:mm:ss)

EVPID

Event source process ID

EVUSRID

User ID of the event source process

EVGRPID

Group ID of the event source process

EVUSR

Event source user name

EVGRP

Event source group name

EVHOST

Event source host name

EVIPADDR

Event source IP address

EVSEQNO

Serial number

EVARVDATE

Event arrival date (YYYY/MM/DD)

EVARVTIME

Event arrival time (hh:mm:ss)

EVSRCNO

Serial number at the event source

EVMSG

Entire message text

EVDETAIL

Entire detailed event information

Information contained in the extended attributes of JP1 events

EVSEV

Severities in extended event information (Emergency, Alert, Critical, Error, Warning, Notice, Information, Debug)

EV"extended-attribute-name"

Any extended attribute

Other

ACTHOST

Manager host name at the action request source

EVENV1 to EVENV9

Data obtained by specifying parentheses (()) in a regular expression in the specification of an action execution condition (applicable only when an extended regular expression is used at the manager host)

The value of the variable for an invalid item is NULL. In addition, depending on the type of JP1 event, an action might not be executed, or if executed, might result in an error because the variable itself does not exist or codes (ASCII codes and characters not included in the character set of the multi-byte characters encoding specified in the environment settings) that are not recognizable as characters are included. Consult the documentation for the products that issue JP1 events beforehand for correct specification of the information.

Notes about specifying variables

If you specify a character, such as an alphanumeric character or an underscore (_), immediately after the variable name, the variable will not be converted correctly. In such a case, enclose the variable name in curly brackets ({ }), as shown in the examples below. These examples assume that 100:0 is specified as the event ID ($EVID) and ABC is specified as the extended attribute EX ($EV"EX").

Examples:

action-definition information-after-conversion

$EVID abc 100:0 abc

$EVIDabc $EVIDabc (in Windows), none (in UNIX)

${EVID}abc 100:0abc

$EVID_abc $EVID_abc (in Windows), none (in UNIX)

${EVID}_abc 100:0_abc

$EV"EX" abc ABC abc

$EV"EX"abc ABCabc

If the source character information contains any of the control characters shown below, the control character is converted to a space (0x20).

Control characters that are converted to a space: 0x01 to 0x1F (excluding tab (0x09)), 0x7F

For example, if the message acquired by specifying $EVMSG contains a linefeed code (0x0A), the linefeed code (0x0A) is converted to the space (0x20).

Example: If the action echo $EVMSG is set and the character string "line-1 0x0A line-2", which contains a linefeed code, is received as the message for the event, the command "echo line-1Δline-2" is executed as the action (Δ indicates a space).

In UNIX, the final expansion depends on the interpretation by the shell. If the expanded data contains a character that has a special meaning in the shell, such as *, it is replaced by the corresponding data. To prevent such characters from being converted, enclose the entire variable in double-quotation marks ("), such as "EVMSG".

If a JP1 event specified by using a variable contains a double quotation ("), single-quotation mark ('), or another character that has a special meaning when used in a command, the command might not be interrupted correctly. We recommend that you convert such characters in the configuration file for converting information. For details about configuration file for converting information, see Configuration file for converting information (event_info_replace.conf)in Chapter 2. Definition Files.

Regular expressions in the action definition

This subsection describes how to use regular expressions to specify the attributes of JP1 events (message text, basic attributes, and detailed information) in an event monitoring condition of an automated action definition.

The supported regular expressions depend on the OS. The regular expressions supported by Windows and UNIX are described below.

If you share the same action definitions among different OSs, specify conditions using expressions that are supported by all the OSs because interpretation of regular expressions depends on the OS. Regular expressions supported by all OSs are presented in Appendix G. Regular Expressions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide. Consult this information to determine the regular expressions that can be used.

Regular expressions for the Windows version

For the Windows version, you can set the supported regular expressions to either JP1-specific regular expressions or extended regular expressions. The default is extended regular expressions. For details about how to use the JP1-specific regular expressions, see Automated action environment definition file (action.conf.update) in Chapter 2. Definition Files.

In the case of automated actions in JP1/IM, you can also use the extended notations shown below, in addition to the OS's regular expressions:

\/, \\

Even in an expression enclosed in brackets, / and \ are treated as characters. This method is used to specify / and \ in regular expressions.

Regular expressions for the UNIX version

For the UNIX version, use the extended regular expressions. For details about the supported regular expressions, see the OS-provided regexp(5).

In the case of automated actions in JP1/IM, you can also use the extended notations shown below, in addition to the OS's regular expressions:

\/, \\

Even in an expression enclosed in brackets, / and \ are treated as characters. This method is used to specify / and \ in regular expressions.

Specifying the basic and detailed attributes using regular expressions

This subsection describes how to use regular expressions to specify basic attributes and detailed information about JP1 events in the event monitoring conditions.

The basic attributes of a JP1 event are expressed in the automated action definition parameters in the following format:

event-ID#1Δevent-source-user-nameΔevent-source-user-IDΔ

event-source-group-nameΔevent-source-group-IDΔ

event-issuing-server-name#2Δevent-source-process-IDΔ

event-registration-year-month-day#3Δevent-registration-time#4Δevent-source-host-IP-address

#1

The event ID is expressed in the format basic-code:extended-code. The basic code and extended code are each an 8-digit hexadecimal number (characters from A to F must be uppercase). Any leading zeros in the ID are omitted. If the extended code is 00000000, the event ID is expressed as basic-code:0.

#2

In the event that the server name differs from the host name and the method for acquiring the event issuing host name is set to local, the host name is used, not the event server name.

#3

Expressed in the format YYYY/MM/DD.

#4

The event registration time is expressed in the format hh:mm:ss.

The detailed information about a JP1 event is expressed in the following format:

information-1Δinformation-2Δinformation-3Δ...Δinformation-nΔ

Note:

Depending on the program, the detailed information might not be in this format or it might contain codes that cannot be recognized as characters, such as when only one byte of a multi-byte character is included because of fixed-length requirements. For details about the format, see the documentation for each program.

For both basic attributes and detailed information, each item in the information is separated by a space.

When there is no corresponding information, the item is treated as NULL and multiple consecutive delimiter spaces are displayed. Note that in the future more information might be added after the last item due to functionality extensions.

How to specify each item in the basic attributes and the detailed information is described below.

When you specify the first item in the basic attributes and detailed information, use a caret (^) to indicate the start of a character string. For example, the following specifies the JP1 event whose event ID is 00003A80:

^3A80

In specifying the second and subsequent items, use .* (indicating any character string or space) to skip each unneeded item. For example, to specify the event issuing host name, which is the 6th item in the basic event attributes, repeat .* five times, as follows:

^.*Δ.*Δ.*Δ.*Δ.*Δhost01

The following are examples of specifying event information:

Example 1: JP1 event sent from the user whose user name begins with JP1USER:

^.*ΔJP1USER[_A-Z0-9]+Δ.*Δ.*Δ.*Δ.*Δ.*Δ.*Δ.*Δ.*$

Example 2: JP1 event issued at host01 to host05 (when an extended regular expression is used):

^.*Δ.*Δ.*Δ.*Δ.*Δhost0[1-5]Δ.*Δhost0[1-5]Δ.*Δhost0[1-5]Δ.*Δhost0[1-5]Δ.$

Example 3: JP1 event registered from 08:00 to 08:10 at host02 (when a extended regular expression is used):

^.*Δ.*Δ.*Δ.*Δ.*Δhost02Δ.*Δ.*Δ08:(10|0[0-9]).*Δ.*$

Example 4: JP1 event whose third item begins with prn in the detailed information:

^.*Δ.*Δprn.*$

Note: For the format of detailed information, see the documentation of the program that issues the JP1 events.

Notes about regular expressions

To use extended regular expressions by extending JP1-specific regular expressions (Windows), you must re-evaluate the existing definition settings and redefine them for extended regular expressions in order to avoid any malfunction that might be caused by the extension.

The handling of control codes (such as linefeeds and tabs) might vary depending on the product and OS. If you use a regular expression to specify a message as a condition, specify only the message text without the control codes.

Because the regular expression of the automated action is a partial match, conditions when the same characters (.*) are specified as the first and the last characters and when they are not specified are the same.

For example, the same conditions can be set for the following examples 1 and 2:

Example 1: Regular expression matching the string containing "A001Δ:ΔWEB-server":

.*A001Δ:ΔWEB-server.*

Example 2: Regular expression matching the string containing "A001Δ:ΔWEB-server":

A001Δ:ΔWEB-server

Do not specify (.*) at the beginning or end because searching might take a long time.

The vertical bar |, which is a special character, represents the OR condition. When you use this OR condition in regular expressions, note the following:

Because the vertical bar | indicating an OR condition has a low priority level, you must explicitly specify the range of the OR condition. Omitting the range might result in no operation or a malfunction. To specify the range of an OR condition, enclose it in parentheses (). The example below specifies an OR condition for the event-issuing server name.

Example: JP1 event issued at gyoumu or host:

^.*Δ.*Δ.*Δ.*Δ.*Δ(gyoumu|host)Δ.*Δ.*Δ.*Δ.*$

Example definition

The examples below show example definitions for the automated action definition file. Note that the extended regular expression is specified as the regular expression type in these examples.

Example definition 1: Using a variable (1)

The following is an example definition for specifying JP1 event information received by using a variable as an argument of a command to be executed as an action:

Event condition

The event ID (B.ID) is 00000001.

The message format is message-ID#Δ:Δmessage-text.

#: A message ID consists of one alphabetic character and three numeric characters.

Command to be executed as an action

alarm.batΔargument-1Δargument-2

JP1 event information to be specified as a command argument

argument-1: The message value (${EVMSG} is specified as a variable)

argument-2: The extended attribute AAA (${EV"AAA"} is specified as a variable)

When the value for the received JP1 event message (B.MESSAGE) is A001Δ:ΔThe WEB server goes down., and the value for the AAA extended attribute is kanshi, the action, alarm.batΔ"kanshi"Δ"A001Δ:ΔThe WEB server goes down." is performed.

Example definition 2: Using a variable (2)

The following is an example definition for specifying a part of the JP1 event information received by using the variables EVENV1 to EVENV9 as arguments of the command to be executed as an action:

Event condition

The event ID (B.ID) is 00000001.

The message format is message-ID#Δ:Δmessage-text.

#: A message ID consists of one alphabetic character and three numeric characters.

Command to be executed as an action

alarm.batΔargument-1Δargument-2

JP1 event information to be specified as a command argument

argument-1: Message ID value (${EVENV1} is specified as a variable)

argument-2: Message text value (${EVENV2} is specified as a variable)

When the value for the received JP1 event message (B.MESSAGE) is A001Δ:ΔThe WEB server goes down., the action, alarm.batΔ"A001"Δ"The WEB server goes down." is performed.

Example definition 3: Specifying an event ID in a regular expression

The following is an example definition when REGEX is specified as the comparison keyword and B.ID is specified as the attribute name of an event condition:

Event condition

The event ID is a value from 00000001 to 00000200 (Hexadecimal A to F not included).

The event-issuing server name (B.SOURCESERVER) is kanshi.

Command to be executed as an action

alarm.bat

To specify an event ID in event basic information, specify * for eid so that the event ID specified in event basic information is to be the target.

In addition, specify a hexadecimal value with a maximum of eight bytes for the basic section and the extended section of an event ID and separate the sections by a colon (:).

Example definition 4: Using the AND condition

The following is an example definition for setting the action to be executed when event A and event B are received:

Event A conditions

The event ID (B.ID) is 00000201.

The message (B.MESSAGE) is WEB server A goes down..

Event B conditions

The event ID (B.ID) is 00000202.

The message (B.MESSAGE) is Web server B goes down..

Command to be executed as an action

alarm.bat

When the AND condition is applied, we recommend using an automated action by using the correlation event generation function. The correlation event generation function can specify the sequence or the number of JP1 events, a property not available to the AND condition. For details about the correlation events, see 4.3 Issue of correlation events in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

Automatic action notification definition file (actnotice.conf)

Format

[STATE_WATCH]
EVENT={true | false}
COMMAND=command
[End]
[DELAY_WATCH]
EVENT={true | false}
COMMAND=command
[End]

File

actnotice.conf (automatic action notification definition file)

actnotice.conf.model (model file for the automatic action notification definition file)

Storage directory

In Windows

For a physical host:

Console-path\conf\action\

For a logical host:

shared-folder\jp1cons\conf\action\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/action/

For a logical host:

shared-directory/jp1cons/conf/action/

Description

This file defines whether a notification is to be issued when automated action status monitoring or delay monitoring detects an error in an automated action. The notification can be to issue a JP1 event or to execute a notification command. Specify this file by using the language encoding that is used by JP1/IM - Manager.

When you specify in this definition file that notification is to be performed in the event of an automated action error, you will be able to detect an automated action that terminates abnormally in Fail, Error, or Fail (Miss) status by monitoring the automated action status. In such a case, you can specify that a JP1 event is to be issued or that a notification command is to be executed to prompt the operator to take appropriate action for the erroneous automated action. The automated action delay monitoring function enables you to detect an automated action that does not terminate within a specified amount of time (the delay monitoring period) and to issue a JP1 event or execute a notification command to prompt the operator to take appropriate action for the automated action that is in delayed status.

If you have deleted the automatic action notification definition file (actnotice.conf), copy the model file for automatic action notification definition file (actnotice.conf.model) under the name actnotice.conf and change the definitions as necessary.

When the definitions are applied

The settings in the automatic action notification definition file take effect at the following times

When JP1/IM - Manager starts

When the file is reloaded by the jco_spmd_reload command

Information that is specified

[STATE_WATCH]

Defines whether to provide notification about an automated action error that is detected during automated action status monitoring by issuing a JP1 event or executing a notification command.

EVENT={true | false}

Specifies whether a JP1 event (event ID: 2011) is to be issued when an error is detected during automated action status monitoring.

Specify either true or false. If you want to issue a JP1 event when an error is detected, specify true; otherwise, specify false. The default is true. When true is specified, a JP1 event (event ID: 2016 or 2021) is also issued in the following cases:

Suppression of notification to the action status monitoring function is released (JP1 event with event ID 2016 is issued).

An erroneous action wraps around in the action information file during action status monitoring (JP1 event with event ID 2021 is issued).

For details about the JP1 events, see 3.2.2 Details of JP1 events.

COMMAND=command

Specifies the notification command that is to be executed when an error is detected during automated action status monitoring.

You can execute the following types of commands:

When the host executing the command is Windows:

• Executable file (.com, .exe)

• Batch file (.bat)

• JP1/Script script file (.spt)

(An appropriate association must have been set so that an .spt file can be executed.)

When the host executing the command is UNIX:

• Executable file (with execution permissions)

• Shell script (with execution permissions)

• If neither of the above applies or there is no definition, the default value unspecified is assumed.

The following notes apply to defining a notification command:

• Everything from COMMAND= to the linefeed code is defined as a single command.

• The maximum length of a command is 1,023 bytes.

If the character string obtained by expanding variables exceeds 1,023 bytes, the command will not execute.

In such a case, the message KAVB4409-E is output to the integrated trace log.

• The maximum length in bytes includes spaces, but does not include the linefeed code.

• If you specify a variable, specify it immediately after $. For details about the variables that can be specified, see Table 2-13 Variables that can be specified in the automatic action notification definition file.

The notification command specified in COMMAND inherits the execution environment of JP1/IM - Manager.

• The notification command is executed with the execution permissions of JP1/IM - Manager (Windows: SYSTEM user; UNIX: root).

• Specify in COMMAND the full path of the notification command.

• Specify for a notification command a command that will always terminate. If you set a batch file (Windows) or a shell script (UNIX), make sure that it will terminate with exit 0. If the specified command does not terminate or uses the GUI, processes of the executed notification command will remain unresolved.

• To use $, specify $$.

[DELAY_WATCH]

Defines whether an automated action error that is detected during automated action delay monitoring is to be notified by issuing a JP1 event or by executing a notification command.

EVENT={true | false}

Specifies whether a JP1 event (event ID: 2010) is to be issued when an error is detected during automated action delay monitoring.

Specify either true or false. If you wish to issue a JP1 event when an error is detected, specify true; otherwise, specify false. The default is true. When true is specified, a JP1 event (event ID: 2015 or 2020) is also issued in the following cases:

• Suppression of notification to the action delay monitoring function is released (JP1 event with event ID 2015 is issued).

• The erroneous action wraps around in the action information file during action delay monitoring (JP1 event with event ID 2020 is issued).

For details about the JP1 events, see 3.2.2 Details of JP1 events.

COMMAND=command

Specifies the notification command that is to be executed when an error is detected during automated action delay monitoring.

You can execute the following types of commands:

When the host executing the command is Windows:

• Executable file (.com, .exe)

• Batch file (.bat)

• JP1/Script script file (.spt)

(An appropriate association must have been set so that an .spt file can be executed.)

When the host executing the command is UNIX:

• Executable file (with execution permissions)

• Shell script (with execution permissions)

• If neither of the above applies or there is no definition, the default value unspecified is assumed.

The following notes apply to defining the notification command:

• Everything from COMMAND= to the linefeed code is defined as a single command.

• The maximum length of a command is 1,023 bytes.

If the character string obtained by expanding variables exceeds 1,023 bytes, the command will not execute.

In such a case, the message KAVB4409-E is output to the integrated trace log.

• The maximum length in bytes includes spaces, but does not include the linefeed code.

• If you specify a variable, specify it immediately after $. For details about the variables that can be specified, see Table 2-13 Variables that can be specified in the automatic action notification definition file.

The notification command specified in COMMAND inherits the execution environment of JP1/IM - Manager.

• The notification command is executed with the execution permissions of JP1/IM - Manager (Windows: SYSTEM user; UNIX: root).

• Specify in COMMAND the full path of the notification command.

• Specify for a notification command a command that will always terminate. If you set a batch file (Windows) or a shell script (UNIX), make sure that it will terminate with exit 0. If the specified command does not terminate or uses the GUI, processes of the executed notification command will remain unresolved.

• To use $, specify $$.

Table 2‒13: Variables that can be specified in the automatic action notification definition file

Variable name

Description

ACTSEQNO

Serial number of the action that was placed in delayed or error status.

When status monitoring is specified and the action in error status wraps around in the action information file, (----) is displayed.

EVID

Event ID of the action triggering event that was placed in delayed or error status (basic-code (8 hexadecimal characters): extended-code (8 hexadecimal characters)).

If the action that was placed in delayed or error status wraps around in the action information file, (----:----) is displayed.

EVARVTIME

Event arrival time (YYYY/MM/DD hh:mm:ss) of the action triggering event that was placed in delayed or error status.

If the action that was placed in delayed or error status wraps around in the action information file, (----/--/-- --:--:--) is displayed.

ACTSTAT

Action status of the action that was placed in delayed or error status.

One of the following character strings indicating the action execution status is displayed:

running (running)

ended (terminated)

fail (not executable)

error (execution failed)

unknown (status unknown)

wait (waiting for transmission)

send (transmitting)

queue (queuing)

cancel (canceled)

kill (terminated forcibly)

If you cancel the action from JP1/IM - View, the cancellation status is displayed after the above status.

While cancellation processing is underway:

running (canceling)

send (canceling)

queue (canceling)

wait (canceling)

When cancellation processing failed:

running (miss)

send (miss)

queue (miss)

wait (miss)

ended (miss)

error (miss)

If the command is re-executed when the Automatic Action Service is restarted or is output to the action re-execution file, the above status is suffixed with -R (example: ended-R).

If the command is re-executed from JP1/IM - View, the above status is suffixed with -RU (example: ended-RU).

If a suppressed action is re-executed from JP1/IM - View, the above status is suffixed with -RUD (example: ended-RUD).

If a suppressed action is re-executed from JP1/IM - View and then re-executed again due to a restart (including system switching) of the Automatic Action Service during re-execution processing, or is output to the action re-execution file, the above status is suffixed with -RD (example: ended-RD).

If a suppressed action is placed in fail status (not executable), the above status is suffixed with -D (example: fail-D).

If delay monitoring is used and a delayed action wraps around in the action information file, (----) is displayed.

If status monitoring is used and the action placed in error status wraps around in the action information file, one of the following character strings is displayed:

fail (not executable)

error (execution failed)

ACTSTARTTIME

Action start time of the action that was placed in delayed status (YYYY/MM/DD hh:mm:ss).

This time is displayed only when delay monitoring is used.

If status monitoring is used, (----/--/-- --:--:--) is displayed.

If delay monitoring is used and the delayed action wraps around in the action information file, (----/--/-- --:--:--) is displayed.

ACTENDTIME

Action end time of the action that was placed in error status (YYYY/MM/DD hh:mm:ss).

This time is displayed only when status monitoring is used.

If delay monitoring is used, (----/--/-- --:--:--) is displayed.

If status monitoring is used and the action that was placed in error status wraps around in the action information file, (----/--/-- --:--:--) is displayed.

ACTHOST

Execution host name for the action that was placed in delayed or error status.

If delay monitoring is used and the delayed action wraps around in the action information file, (----) is displayed.

If status monitoring is used and the action issued by an action definition in which execution-host-name is not specified is placed in Fail status, (----) is displayed.

ACTUSR

JP1 user name executing the action that was placed in delayed or error status.

This is the user name registered at the execution host.

If delay monitoring is used and the delayed action wraps around in the action information file, (----) is displayed.

If status monitoring is used and the action issued by an action definition in which execution-host-name is not specified is placed in Fail status, (----) is displayed.

Example definition

This example issues a JP1 event and executes the notification command statenotice01.exe (for status monitoring) or delaynotice01.exe (for delay monitoring) when an error is detected during status monitoring or delay monitoring of automated actions:

[STATE_WATCH]
EVENT=true
COMMAND=C:\Command\statenotice01.exe
[End]
[DELAY_WATCH]
EVENT=true
COMMAND=C:\Command\delaynotice01.exe
[End]

File that defines which items are displayed for event conditions (attr_list.conf)

Format

# comment-line
attribute-name
attribute-name
attribute-name
   .
   .
   .
attribute-name

File

attr_list.conf (file that defines which items are displayed for event conditions)

attr_list.conf.model (model file for the file that defines which items are displayed for event conditions

Storage directory

In Windows

For a physical host:

Console-path\conf\action\attr_list

For a logical host:

shared-folder\jp1cons\conf\action\attr_list

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/action/attr_list

For a logical host:

shared-directory/jp1cons/conf/action/attr_list

Description

This file defines the items to be displayed in the Attribute name field in the Action Parameter Detailed Definitions window. The Action Parameter Detailed Definitions window displays the items in the Attribute name field in the order they are specified in this file.

When the definitions are applied

The file that defines which items are displayed for event conditions is loaded when Central Console is started or when the jco_spmd_reload command is executed. When JP1/IM - View displays the Action Parameter Definitions window, it acquires the contents of the file that defines the items and which was loaded by Central Console, and then applies the file's contents to the Action Parameter Detailed Definitions window.

Information that is specified

attribute-name

Specifies an item to be displayed in the Attribute name field of the Action Parameter Detailed Definitions window. Specify the attribute name of each item that is to be displayed with one item per line. You can specify from 0 to 256 items.

An attribute name is case sensitive. Any space or tab character immediately preceding or following the attribute name will be ignored.

The table below lists the attribute names that can be specified.

If you specify SEPARATOR, a horizontal line, such as --------------------, is displayed in the Attribute name field of the Action Parameter Detailed Definitions window. You can use SEPARATOR to separate the items that are used often from the items that are used infrequently.

If you specify only SEPARATOR, only a horizontal line is displayed in the Attribute name field. In such a case, no event condition can be set by selecting the separator line and then adding an event condition.

Table 2‒14: List of items that can be displayed

No.

Display item

Attribute name

1

Source host

B.SOURCESERVER

2

Event level

E.SEVERITY

3

Object type

E.OBJECT_TYPE

4

Object name

E.OBJECT_NAME

5

Root object type

E.ROOT_OBJECT_TYPE

6

Root object name

E.ROOT_OBJECT_NAME

7

Occurrence

E.OCCURRENCE

8

User name

E.USER_NAME

9

Message

B.MESSAGE

10

Product name

E.PRODUCT_NAME

11

Event ID

B.ID

12

Start time

E.START_TIME

13

End time

E.END_TIME

14

Registered time

B.TIME

15

Arrived time

B.ARRIVEDTIME

16

Program-specific extended attribute

OTHER_EXTENDED_ATTRIBUTE

17

Reason for registration

B.REASON

18

Source process ID

B.PROCESSID

19

Source user name

B.USERNAME

20

Source user ID

B.USERID

21

Source group name

B.GROUPNAME

22

Source group ID

B.GROUPID

23

Source IP address

B.SOURCEIPADDR

24

Object ID

E.OBJECT_ID

25

Result code

E.RESULT_CODE

26

Event source host name

E.JP1_SOURCEHOST

27

Basic event information

B.BASIC

28

Detailed event information

B.DETAIL

29

--------------------

SEPARATOR

Note:

If an attribute name has already been specified, subsequent specifications of the same name are ignored.

If the event display item definition file could not be read and the number of valid display items is zero, items 1 through 25 are displayed.

#comment-line

A line beginning with a hash mark (#) is treated as a comment.

Example definition

B.SOURCESERVER
E.SEVERITY
E.OBJECT_TYPE
E.OBJECT_NAME
E.ROOT_OBJECT_TYPE
E.ROOT_OBJECT_NAME
E.OCCURRENCE
E.USER_NAME
B.MESSAGE
E.PRODUCT_NAME
B.ID
E.START_TIME
E.END_TIME
B.TIME
B.ARRIVEDTIME
OTHER_EXTENDED_ATTRIBUTE
B.REASON
B.PROCESSID
B.USERNAME
B.USERID
B.GROUPNAME
B.GROUPID
B.SOURCEIPADDR
E.OBJECT_ID
E.RESULT_CODE
E.JP1_SOURCEHOST

Configuration file for converting information (event_info_replace.conf)

Format

character-before-conversion=character-string-after-conversion
character-before-conversion=character-string-after-conversion
      :
character-before-conversion=character-string-after-conversion

File

event_info_replace.conf

Storage directory

In Windows

For a physical host:

Console-path\conf\action

For a logical host:

shared-folder\jp1cons\conf\action

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/action

For a logical host:

shared-directory/jp1cons/conf/action

File permissions

The following permissions are needed to use the configuration file for converting information:

In Windows

The Administrators group and SYSTEM users must be able to reference the file.

In UNIX

Users with the root permissions must be able to reference the file.

Description

This file specifies the conversion rules for the functionality used to inherit events for automated actions and command execution. The automated action and command execution event inheritance function can convert specific ASCII characters contained in the inherited event information to another character string according to the conversion rules defined in the configuration file for converting information.

The configuration file for converting information is not created when JP1/IM - Manager is installed. To use this configuration file, use a text editor to create and edit event_info_replace.conf.

When the definitions are applied

For an automated action:

The contents of the configuration file for converting information take effect when JP1/IM - Manager starts, when the Apply button is clicked on the Action Parameter Definitions window of JP1/IM - View, and when the jcachange command is executed to reload the definition.

For command execution:

The contents of the configuration file for converting information take effect when the Execute Command window opens.

Information that is specified

character-before-conversion=character-string-after-conversion

Define in the configuration file for converting information conversion rules for the event inheritance information conversion function. Each rule consists of a character-before-conversion and a character-string-after-conversion. You can specify from 0 to 34 conversion rules.

Lines consisting of only spaces, tabs, or linefeed codes in the event inheritance information conversion settings file are ignored. Specify one conversion rule per line. Separate the character before conversion from the character string after conversion with an equal sign (=).

A defined line that is not in the format character-before-conversion=character-string-after-conversion is ignored and processing continues. If no character string after conversion is specified, the function assumes that the specified character before conversion is to be deleted from the event inheritance information.

There can be only one conversion rule for the same character before conversion. If more than one conversion rule is specified for the same character before conversion, the first conversion rule specified takes effect and the subsequent conversion rules for that character are ignored.

If the event inheritance information contains a control character (0x00 to 0x1F or 0x7F to 0x9F), the control character is converted to a space (0x20).

If either of the following applies, the conversion rules are ignored and processing continues:

A character that cannot be specified as a character before conversion is specified.

Two or more characters are specified as a character before conversion.

character-before-conversion

As a character before conversion, you can specify an ASCII character (0x00 to 0x7F) indicated by Y in the applicable character-before-conversion column of the table below.

The table below lists the ASCII characters that can be specified as the character before conversion.

Table 2‒15: Characters that can be specified as a character before conversion and a character string after conversion

Character

Hexadecimal value

character-before-conversion

character-string-after-conversion

Control character

0x00 to 0x08

N

N

Tab

0x09

Y

Y

Control character

0x0a to 0x1f

N

N

Space

0x20

Y

Y

!

0x21

Y

Y

"

0x22

Y

Y

#

0x23

Y

Y

$

0x24

Y

Y

%

0x25

Y

Y

&

0x26

Y

Y

'

0x27

Y

Y

(

0x28

Y

Y

)

0x29

Y

Y

*

0x2a

Y

Y

+

0x2b

Y

Y

-

0x2c

Y

Y

.

0x2d

Y

Y

/

0x2e

Y

Y

:

0x2f

Y

Y

;

0x3b

N

Y

<

0x3c

Y

Y

=

0x3d

Y

Y

>

0x3e

Y

Y

?

0x3f

Y

Y

@

0x40

Y

Y

[

0x5b

Y

Y

\

0x5c

Y

Y

]

0x5d

N

Y

^

0x5e

Y

Y

_

0x60

Y

Y

{

0x7b

Y

Y

|

0x7c

Y

Y

}

0x7d

Y

Y

~

0x7e

Y

Y

Legend:

Y: Can be specified

N: Cannot be specified

character-string-after-conversion

As a character string after conversion, you can specify 0 to 2 ASCII characters (0x00 to 0x7F) indicated by Y in the applicable character-string-after-conversion column of the above table.

Example definition

The following shows examples of converting ", ', and * to _:

"=_
'=_
*=_

When the value for a message (B.MESSAGE) receives a JP1 event, The Web server goes down. Details: "NetworkΔError", the value for the entire message text (variable: EVMSG) will be The Web server goes down. Details: _NetworkΔError_.

Extended startup process definition file (jp1co_service.conf)

Format

process-name|startup-options|whether-restartable|restart-count|retry-interval|restart-count-reset-time|

File

jp1co_service.conf (extended startup process definition file)

jp1co_service.conf.model (model file for the extended startup process definition file)

Storage directory

In Windows

For a physical host:

Console-path\conf\

For a logical host:

shared-folder\jp1cons\conf\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/

For a logical host:

shared-directory/jp1cons/conf/

Description

This file defines process information for the functions that constitute JP1/IM - Manager.

JP1/IM - Manager uses the process management function to control restart in the event of abnormal termination of a process. The process management function controls processes according to the definition in the extended startup process definition file.

Do not specify in this file any unneeded characters, such as spaces. Edit numeric values for only those parameters on which editing is permitted.

Customize only the applicable parameters as appropriate to your operations. Normally, there is no need to change the settings for other parameters because appropriate values have already been set in them as the default values for each process.

In the case of a cluster configuration, if the extended startup process definition file is not found in the conf folder for the logical host when the a process management process is started at the logical host, the extended startup process definition file for the physical host is copied.

When the definitions are applied

The contents of the definition file take effect when JP1/IM - Manager starts or when the jco_spmd_reload command is executed to reload the definition. A change in the startup-options parameter takes effect only when JP1/IM - Manager starts.

Information that is specified

process-name

Specifies the name of a process that is to be started and terminated by the process management function of JP1/IM - Manager.

JP1/IM - Manager's process name is already specified, and must not be edited.

The name specified here must be a process name displayed by the jco_spmd_status command.

startup-options

Specifies startup options for the process.

-Xmx

The -xmx parameter is a parameter that sets the maximum size of the Java heap space.

The size of the heap area used by the evtcon process and the jddmain process might exceed the initial value, depending on user settings. The evtcon process defaults to -Xmx 512m, with a default size of 512 megabytes. The jddmain process has no default specification, and the default size is 8,192 megabytes.

If the estimated heap area size that is required exceeds default value, you must change the -Xmx parameter's value to a value after a estimation.

For details about how to estimate the heap area size, see the Release Notes for JP1/IM - Manager.

Notes about startup options

• If you change the heap area size for the evtcon process of JP1/IM - Manager, check by performing appropriate tests that the change will not cause problems. Even if the value is within the permissible range for the heap area size, a memory shortage might occur and JP1/IM - Manager might terminate or information might not be updated in the Event Console window, resulting in unstable operation. If this occurs, revise as necessary the Event buffer and Num. of events to acquire in 1 search settings by referencing the formula for estimating the heap area size.

• The maximum memory size cited in the Release Notes for JP1/IM - Manager is a logical value. It might not be possible to allocate the set heap area depending on the OS, the environment in use, and the applications that run concurrently. If the heap area cannot be allocated or the set value is less than default value, problems might occur, such as a JP1/IM - Manager startup error.

The following example changes the heap area size of the evtcon process from 512 to 1,024 megabytes in Windows:

Example:

Before the heap area size is changed to 1,024 megabytes (from an initial size of 512 megabytes):

evtcon|-Xmx512m|0|3|3|3600|

After the heap area size has been changed to 1,024 megabytes:

evtcon|-Xmx1024m|0|3|3|3600|

whether-restartable

Specifies whether the process is to be restarted if it terminates abnormally.

Specify 0 to not restart the process and 1 to restart the process.

The default is 0.

restart-count

Specifies the number of times process restart is to be attempted.

The permitted value range is from 0 to 99. The default is 3.

Note that if 0 is specified in the whether-restartable field, this field is ignored even if a value is specified.

retry-interval

Specifies in seconds the interval between process restart attempts.

The permitted value range is from 0 to 3,600. The default is 3.

Note that if 0 is specified in the whether-restartable field, this field is ignored even if a value is specified.

restart-count-reset-time

Specifies in seconds the amount of time that is to elapse before the restart count will be reset after the process has restarted.

The permitted value range is from 3,600 to 2,147,483,647 (seconds). The default is 3,600.

The restart count is reset when the specified amount of time has elapsed after the process has restarted. If the process terminates abnormally again after this amount of time has elapsed, the restart count starts again from 1. If the process terminates abnormally again within the specified amount of time after it has restarted, the previous restart count is inherited.

Note that if 0 is specified in the whether-restartable field, this field is ignored even if a value is specified.

Example definition

The following shows an example of an extended startup process definition file:

evflow||0|3|3|3600|
jcamain||0|3|3|3600|
evtcon|-Xmx512m|0|3|3|3600|
evgen||0|3|3|3600|
jcsmain||0|3|3|3600|
jcfmain||0|3|3|3600|
jddmain||0|3|3|3600|

IM parameter definition file (jp1co_param_V7.conf)

Format

[logical-host-name\JP1CONSOLEMANAGER]
"SEND_PROCESS_TERMINATED_ABNORMALLY_EVENT"=dword:value
"SEND_PROCESS_RESTART_EVENT"=dword:value

File

jp1co_param_V7.conf (IM parameter definition file)

jp1co_param_V7.conf.model (model file for the IM parameter definition file)

Storage directory

In Windows

For a physical host:

Console-path\conf\

For a logical host:

shared-folder\jp1cons\conf\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/

For a logical host:

shared-directory/jp1cons/conf/

Description

This file defines whether a JP1 event is to be issued when JP1/IM - Manager processes fail or when JP1/IM - Manager processes are recovered automatically from abnormal termination. The following lists the JP1/IM - Manager processes and the JP1 events that can be issued.

JP1/IM - Manager processes

Event Console Service (evtcon)

Event Base Service (evflow)

Automatic Action Service (jcamain)

Central Scope Service (jcsmain)

Event Generation Service (evgen)

JP1 events that can be issued

JP1 event whose event ID is 3F90: This event can be issued when a process terminates abnormally.

JP1 event whose event ID is 3F91: This event can be issued when a timeout occurs during process startup.

JP1 event whose event ID is 3F92: This event can be issued when a process that terminated abnormally has successfully completed restart processing.

By issuing a JP1 event when a process recovers automatically from a process error or abnormal termination, you can manage the history of JP1/IM - Manager failures. For this reason, we recommend that you use this definition file to set issuance of such JP1 events.

The required definitions are provided as a model file. To change the settings, copy the model file and then edit the copy.

When the definitions are applied

The contents of the file take effect when JP1/IM - Manager is restarted by execution of the jbssetcnf command with this definition file specified in an argument.

Information that is specified

[logical-host-name\JP1CONSOLEMANAGER]

Specifies the key name for the JP1/IM - Manager environment settings.

For logical-host-name, specify JP1_DEFAULT for the physical host and logical-host-name for a logical host.

"SEND_PROCESS_TERMINATED_ABNORMALLY_EVENT"=dword:value

When 1 is set in value, a JP1 event is issued in the following cases:

A process terminates abnormally (JP1 event whose event ID is 3F90 is issued).

A timeout occurs during startup processing without a startup notification (JP1 event whose event ID is 3F91 is issued).

The default is 0, in which case no JP1 event is issued.

For details about the JP1 events, see 3.2.2 Details of JP1 events.

"SEND_PROCESS_RESTART_EVENT"=dword:value

When 1 is set in value, a JP1 event is issued in the following case:

Restart processing of a process that terminated abnormally is completed successfully (JP1 event whose event ID is 3F92 is issued).

The default is 0, in which case no JP1 event is issued.

For details about the JP1 events, see 3.2.2 Details of JP1 events.

Example definition

[JP1_DEFAULT\JP1CONSOLEMANAGER]
"SEND_PROCESS_TERMINATED_ABNORMALLY_EVENT"=dword:0
"SEND_PROCESS_RESTART_EVENT"=dword:0

Make sure that the end of the file is at the beginning of the last line.

System profile (.system)

Format

DESC_VERSION=15
     :
[ServerDefine]
InvalidateTime = 1440
EventCount = event-buffer-count
Debug = true
[End]
     :
[RetryInfo]
RetryCount = retry-count
RetryInterval = retry-interval
[End]

File

.system (system profile)

.system.model (model file for the system profile)

Storage directory

In Windows

For a physical host:

Console-path\conf\console\profile\

For a logical host:

shared-folder\jp1cons\conf\console\profile\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/profile/

For a logical host:

shared-directory/jp1cons/conf/console/profile/

Description

This file defines the basic operation of the event console.

There is a system profile for each manager (JP1/IM - Manager). The file defines information about the system environment for the event console (such as the number of event buffers and a retry count for connecting to the event service during event search). The information defined in this profile affects all instances of JP1/IM - View that are connected to the manager to which this profile is applicable.

When the definitions are applied

The definition takes effect when JP1/IM - Manager starts or when the Apply button is clicked in the System Environment Settings window.

Information that is specified

EventCount = event-buffer-count

Specifies the maximum number of events that can be buffered at the manager when events are extracted from the event service.

The permitted value range is from 10 to 2,000. The default is 2,000.

RetryCount = retry-count

Specifies the maximum number of times automatic connection establishment can be retried after connection with the event service has failed or the connection has been lost during event search.

The permitted value range is from 0 to 100. The default is 3.

RetryInterval = retry-interval

Specifies in milliseconds the retry interval between attempts to establish connection after connection with the event service has failed or the connection has been lost during event search.

The permitted value range is from 1 to 86,400,000. The default is 10,000.

Notes

Specify the settings in the System Environment Settings window, unless otherwise necessary.

Be attentive to the values that you set because the contents of the system profile affect all event console operations. Do not change any attribute or attribute value that is not explained here. If such an attribute or attribute value is changed, the event console might not function correctly.

You must terminate JP1/IM - View before you edit the system profile.

There is one system profile for each manager. Therefore, if you have changed the manager for logging in, you must change the system profile at the connection destinations.

When you intend to edit the contents of the .system file, we recommend that you make a backup before editing the file.

If the system profile contains an error, such as an attribute value that is outside the permitted range of values, the event console might not function correctly.

Example definition

DESC_VERSION=15
    :
[End]
[ServerDefine]
InvalidateTime = 1440
EventCount = 500
Debug = true
[End]
    :
[RetryInfo]
RetryCount = 3
RetryInterval = 10000
[End]
[LocaleInformation]
Language=English
[End]

User profile (defaultUser | profile_user-name)

Format

DESC_VERSION=file-version
[DisplayItemContainer]#
    :
[DisplayItemInformation]
ValidTab=All
Visible=whether-visible
AttrName=JP1-event-attribute-name
AttrOrder=sort-order
ColumnSize=column-width
[End]
[End]
    :

#: You can edit only placeholders in italic placed in a section that is enclosed with [DisplayItemInformation] and [End] and that includes ValidTab=All.

File

defaultUser (default user profile)

defaultUser.model (model file for the default user profile)

profile_user-name (user profile for an individual JP1 user)

Storage directory

In Windows

For a physical host:

Console-path\conf\console\profile\

For a logical host:

shared-folder\jp1cons\conf\console\profile\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/profile/

For a logical host:

shared-directory/jp1cons/conf/console/profile/

Description

This file defines environment information about how the Event Console window is displayed for each user.

At the manager, there is a user profile for each user. A user profile defines a user environment for the event console (principally, environment information about the window display). A user profile can be created for each user under the name profile_user-name (using the JP1 user's user name). There is also a default profile, defaultUser, that can be used as the default profile for any user. If you edit the defaultUser profile, the new contents become the default profile for user profiles that are created in the future.

You can define profile_user-name in the Preferences window. If there are any errors in the user profile, the Event Console window might not display correctly. For this reason, we recommend that you use the Preferences window of JP1/IM - View to define user profiles.

When the definitions are applied

The definition takes effect the next time you log in to JP1/IM - Manager (Central Console).

Information that is specified

DESC_VERSION=file-version

Specifies the version of the user profile being created. The items that can be specified in [DisplayItemInformation] to [End] depend on the value specified for the file version. For program version 11-00 or later, specify 15 as the file version. If the file version specified is 11 or earlier, do not attempt to change the file version.

The following operations update all instances of profile_user-name to the most recent file version:

Saving the Preferences window from JP1/IM - View

Saving the column width of the items that are displayed in the list of events on a page in the Event Console window during logout from JP1/IM - View

To set defaultUser (default user profile) to file version 12, overwrite defaultUser with defaultUser.model (model file for the default user profile), and then edit the file.

[DisplayItemInformation] to [End]

Specify the attributes of JP1 events that are to be displayed in the Event Console window.

[DisplayItemInformation] through [End] constitute a single definition block. The contents of this definition block take effect on all three pages of the Event Console window. To add a definition block, insert it between [DisplayItemContainer] and [End].

The parameters that can be specified in [DisplayItemInformation] through [End] are described below.

You must not edit the parameters in [DisplayItemInformation] through [End] for a definition block in which AttrOrder=0 is specified, because such definition blocks are used by the system.

ValidTab = All

This is a fixed character string that must not be changed.

Visible = whether-visible

Specifies whether the information for the attribute specified in AttrName is to be displayed. If true is specified in whether-visible, information about the attribute specified in AttrName is displayed. If false is specified, information about the attribute specified in AttrName is not displayed. When false is specified, the corresponding item is displayed in Available items in the Preferences window. If you specify false, you must specify -1 in AttrOrder.

AttrName = attribute-name-to-be-displayed

Specifies the attribute name of the JP1 event. Information about the attribute specified here is displayed in the Event Console window.

The following table lists the attributes that can be set.

Table 2‒16: List of attributes that can be set in attribute-name-to-be-displayed

No.

Specifiable attribute name

Attribute

DESC_VERSION

1-10#1

11

12-14

15

1

IM.EVENT_TYPE

Type

Y

Y

Y

Y

2

B.SEQNO

Serial number

Y

Y

Y

Y

3

B.IDBASE

Event ID

Y

Y

Y

Y

4

B.PROCESSID

Source process ID

Y

Y

Y

Y

5

B.TIME

Registered time

Y

Y

Y

Y

6

B.ARRIVEDTIME

Arrived time

Y

Y

Y

Y

7

B.USERID

Source user ID

Y

Y

Y

Y

8

B.GROUPID

Source group ID

Y

Y

Y

Y

9

B.USERNAME

Source user name

Y

Y

Y

Y

10

B.GROUPNAME

Source group name

Y

Y

Y

Y

11

B.SOURCESERVER

Source host

Y

Y

Y

Y

12

B.SOURCESEQNO

Source serial number

Y

Y

Y

Y

13

B.MESSAGE

Message

Y

Y

Y

Y

14

E.SEVERITY

Event level

Y

Y

Y

Y

15

E.USER_NAME

User name

Y

Y

Y

Y

16

E.PRODUCT_NAME

Product name

Y

Y

Y

Y

17

E.OBJECT_TYPE

Object type

Y

Y

Y

Y

18

E.OBJECT_NAME

Object name

Y

Y

Y

Y

19

E.OBJECT_ID

Object ID

Y

Y

Y

Y

20

E.ROOT_OBJECT_TYPE

Root object type

Y

Y

Y

Y

21

E.ROOT_OBJECT_NAME

Root object name

Y

Y

Y

Y

22

E.OCCURRENCE

Occurrence

Y

Y

Y

Y

23

E.START_TIME

Start time

Y

Y

Y

Y

24

E.END_TIME

End time

Y

Y

Y

Y

25

E.@JP1IM_ACTCONTROL

Action

N

Y

Y

Y

26

E.@JP1IM_ACTTYPE

Action type

N

Y

Y

Y

27

E.@JP1IM_ORIGINAL_SEVERITY

Original severity level

N

Y

Y

Y

28

E.@JP1IM_CHANGE_SEVERITY

New severity level

N

Y

Y

Y

29

E.@JP1IM_DISPLAY_MESSAGE

Changed display message

N

N

N

Y

30

E.@JP1IM_CHANGE_MESSAGE

New display message

N

N

N

Y

31

E.@JP1IM_CHANGE_MESSAGE_NAME

Display message change definition

N

N

N

Y

32

E.@JP1IM_MEMO

Memo

N

Y

Y

Y

33

E.JP1_SOURCEHOST

Event source host name

N

N

Y

Y

34

E.ACTION_TARGET#2

Action

Y

N

N

N

35

IM.ACTION_TYPE#2

Action type

Y

N

N

N

36

E.*

Program-specific extended attribute

N

N

N

Y

Legend:

Y: Can be specified

N: Cannot be specified

#1

There are no differences in the items that can be specified for file versions 1 through 10.

#2

These items are compatible with version 8. If DESC_VERSION is 10 or earlier (definition for version 8 or earlier), these attributes are converted as follows:

E.ACTION_TARGET E.@JP1IM_ACTCONTROL

IM.ACTION_TYPE E.@JP1IM_ACTTYPE

AttrOrder = sort-order

Specifies the display column location relative to the left margin. If you specify 1, the attribute is displayed as the first (leftmost) item in the list of events. Do not specify the same value for more than one item.

Do not specify 0 because it is used by the system.

If there are any errors in the user profile, the Event Console window might not display correctly. For this reason, we recommend that you use the Preferences window of JP1/IM - View to define user profiles.

ColumnSize = column-width

Specifies the column width. The permitted value range is from 1 to 1,000.

Notes

Specify each user profile carefully because the contents of this file affect overall event console operation. Do not change any attribute or attribute value that is not explained here. If such an attribute or attribute value is changed, the event console might not function correctly.

Because a user profile might be overwritten during JP1/IM - View operation or termination processing, make sure that you terminate JP1/IM - View before editing a user profile.

There is one user profile for each manager. Therefore, if you have changed the manager for logging in, you must change the profile at the connection destinations.

When you intend to edit the contents of the defaultUser file, you must make a backup before editing the file.

Using JP1/Base's user management to delete a user does not delete the user profile for that user.

If you use JP1/Base's user management to rename a user, the user's existing user profile is not inherited.

If a user profile contains an error, such as an attribute value outside the permitted range of values, the event console might not function correctly.

Communication environment definition file (console.conf.update)

Format

[logical-host-name\JP1CONSOLEMANAGER\EVCONS]
"COM_SO_TIMEOUT"=dword:hexadecimal-value

[JP1_DEFAULT\JP1CONSOLE_CMD]
"COM_SO_TIMEOUT"=dword:hexadecimal-value
"COM_RETRY_COUNT"=dword:hexadecimal-value
"COM_RETRY_INTERVAL"=dword:hexadecimal-value
"COM_RMI_TIMEOUT"=dword:hexadecimal-value

File

console.conf.update (model file for the communication environment definition file)

Storage directory

In Windows

Console-path\default\

In UNIX

/etc/opt/jp1cons/default/

Description

This file defines communication processing (timeout period) among JP1/IM - Manager, the viewer, and the jcochstat command.

When a low-speed line is used in the network for communication between the viewer and JP1/IM - Manager or when the viewer's workload is high, timeouts might occur during the viewer's communication processing, resulting in communication errors. You can prevent such communication errors by modifying the timeout period.

When the jcochstat command is used from another manager to change the action status of a JP1 event at the local host, a communication error might occur due to a timeout during communication processing. Modifying the timeout period and the connection retry count might resolve the problem, preventing a recurrence of the communication error.

If you are using JP1/IM - View (event console), you must also change the communication environment definition file for JP1/IM - View (event console) (view.conf.update).

The required definition is provided as a model file. To change the settings, copy the model file and then edit the copy.

When the definitions are applied

The definition takes effect after JP1/IM - Manager is restarted by executing the jbssetcnf command.

Information that is specified

[logical-host-name\JP1CONSOLEMANAGER\EVCONS]

Specifies the key name for Event Console Service environment settings.

For logical-host-name, specify JP1_DEFAULT for the physical host and logical-host-name for a logical host.

"COM_SO_TIMEOUT"=dword:hexadecimal-value

Specifies as a hexadecimal value the timeout period in milliseconds. The default value is dword:0000EA60 (60,000 milliseconds).

The range of values that can be specified is from 0x00000001 to 0x0036EE80 (3,600,000 milliseconds).

The specified value must not exceed the value specified for COM_RMI_TIMEOUT (default: 0000EA60) in the console.conf.update communication environment definition file and the view.conf.update communication environment definition file. Additionally, check the setting value (timeout period) on the connection source.

[JP1_DEFAULT\JP1CONSOLE_CMD]

Specifies the key name for the jcochstat command environment settings.

"COM_SO_TIMEOUT"=dword:hexadecimal-value

Specifies as a hexadecimal value the timeout period in milliseconds. The default value is dword:0000EA60 (60,000 milliseconds).

The range of values that can be specified is from 0x00000001 to 0x0036EE80 (3,600,000 milliseconds).

The specified value must not exceed the value specified for COM_RMI_TIMEOUT (default: 0000EA60) in the communication environment definition file (view.conf.update).

"COM_RETRY_COUNT"=dword:hexadecimal-value

Specifies as a hexadecimal value the retry count to be applied in the event of a communication error. The default is dword:00000003 (3 times).

The range of values that can be specified is from 0x00000001 to 0x7fffffff (2,147,483,647 times).

"COM_RETRY_INTERVAL"=dword:hexadecimal-value

Specifies as a hexadecimal value the wait time in milliseconds between retry attempts. The default is dword:00000BB8 (3,000 milliseconds).

The range of values that can be specified is from 0x00000001 to 0x7fffffff (2,147,483,647 milliseconds).

"COM_RMI_TIMEOUT"=dword:hexadecimal-value

Specifies as a hexadecimal value the timeout period in milliseconds for the event action status to change. The permitted value range is from 0000EA60 to 0036EE80 (from 60,000 to 3,600,000 milliseconds). The default is dword:0000EA60 (60,000 milliseconds).

If the KAVB1205-E message is displayed frequently, set a longer timeout period.

Example definition

[JP1_DEFAULT\JP1CONSOLEMANAGER\EVCONS]
"COM_SO_TIMEOUT"=dword:000009C4

[JP1_DEFAULT\JP1CONSOLE_CMD]
"COM_SO_TIMEOUT"=dword:0000EA60
"COM_RETRY_COUNT"=dword:00000003
"COM_RETRY_INTERVAL"=dword:00000BB8

Make sure that the end of the file is at the beginning of the last line.

Health check definition file (jcohc.conf)

Format

[HEALTHCHECK]
ENABLE={true | false}
FAILOVER={true | false}
EVENT={true | false}
COMMAND=command
NO_RESPONSE_TIME=no-response-time
ERROR_THRESHOLD=no-response-count-treated-as-error
BASE_NO_RESPONSE_TIME=no-response-time
BASE_ERROR_THRESHOLD=no-response-count-treated-as-error
[End]

File

jcohc.conf (health check definition file)

jcohc.conf.model(model file for the health check definition file)

Storage directory

In Windows

For a physical host:

Console-path\conf\health\

For a logical host:

shared-folder\jp1cons\conf\health\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/health/

For a logical host:

shared-directory/jp1cons/conf/health/

Description

This file defines whether the health check function is to be enabled. If you enable the health check function, you can also define whether errors are to be notified by issuing a JP1 event or by executing a notification command.

You must specify this definition file by using the character encoding supported by JP1/IM - Manager.

If you have deleted the health check definition file (jcohc.conf), copy the model file for the health check definition file (jcohc.conf.model) under the name jcohc.conf and then edit the definition in the copy, if necessary.

The health check function cannot monitor Central Scope Service (jcsmain).

When you enable the health check function by using this definition file, you gain the capability to check whether each process of JP1/IM - Manager and the event service of JP1/Base on the local host is running normally.

The health check function can detect errors in the following processes:

Event Console Service (evtcon)

Automatic Action Service (jcamain)

Event Base Service (evflow)

Event Generation Service (evgen)

Event service (jevservice)

If any of these processes hang up# or terminate abnormally, the health check function can issue a JP1 event or execute a specified notification command to prompt the operator to recover the process.

#

A process hang-up is a status in which a process can no longer accept processing requests due to deadlock or looping.

When the definitions are applied

The settings in the health check definition file take effect at the following times:

When JP1/IM - Manager is started.

When the file is reloaded by the jco_spmd_reload command.

Information that is specified

ENABLE={true | false}

Specifies whether the health check function is to be enabled.

Specify either true or false. To enable the health check function, specify true; to disable the function, specify false. The default is false.

When the health check function has been enabled and it detects an error, a message (KAVB8060-E or KAVB8062-E) is output to the integrated trace and the Windows event log (syslog) reporting whether the EVENT setting in the health check definition file is true or false.

FAILOVER={true | false}

Specifies whether a JP1/IM - Manager operation is to be performed when an error is detected by the health check function when you are operating in a cluster system. Specify true if the operation is to be performed, or specify false if the operation is not to be performed. The default is false. If you do not use a cluster system, do not change the default setting.

In Windows

When true is specified, JP1/IM - Manager is terminated when an error is detected. When the health check function detects an error, it notifies the cluster system of the error in JP1/IM - Manager by stopping JP1/IM - Manager. If you set the cluster system to fail over when a JP1/IM - Manager error occurs, failover can take place when an error is detected.

In UNIX

When true is specified, the JP1/IM - Manager process in which the error was detected is terminated. When the health check function detects an error, it notifies a cluster system of the error in JP1/IM - Manager by stopping JP1/IM - Manager. If you set the cluster system so that, on detection of an error, it is stopped forcibly by the jco_killall.cluster command and then failed over, failover can take place when an error is detected.

EVENT={true | false}

Specifies whether JP1 events (event ID: 2012 and 2013) are to be issued when an error is detected by the health check function.

Specify either true or false. If JP1 events are to be issued, specify true; otherwise, specify false.

The default is true. When true is specified, a JP1 event (event ID: 2014) is also issued in the following case:

The health check function detects abnormal recovery.

For details about JP1 events, see 3.2.2 Details of JP1 events.

COMMAND=command

Specifies the notification command that is to be executed when an error is detected by the health check function.

You can execute the following types of commands:

When the host executing the command is Windows:

Executable file (.com, .exe)

Batch file (.bat)

JP1/Script script file (.spt)

(An appropriate association must have been set so that an .spt file can be executed.)

When the host executing the command is UNIX:

Executable file (with execution permissions)

Shell script (with execution permissions)

The following notes apply to defining a notification command:

Everything from COMMAND= to the linefeed code is defined as a single command.

The maximum length of a command is 1,023 bytes. This length includes spaces, but does not include the linefeed code. If the length exceeds 1,023 bytes, the default value is assumed. If you specify variables and the character string obtained by expanding variables exceeds 1,023 bytes, the command will not execute. In such a case, the message KAVB8072-E is output to the integrated trace log.

If you specify a variable, specify it immediately after $. The following table lists and describes the variables that can be specified.

Table 2‒17: Variables that can be specified in notification commands

Variable name

Description

HCHOST

Name of host resulting in the error

HCFUNC

Name of function resulting in the error

(evflow, jcamain, evtcon, evgen, or jevservice)

HCPNAME

Name of process resulting in the error

(evflow, jcamain, evtcon, evgen, or jevservice)

HCPID

For evflow, jcamain, evtcon, or evgen

ID of process resulting in the error

For jevservice

-1

HCDATE

Date the error occurred (YYYY/MM/DD)

HCTIME

Time the error occurred (hh:mm:ss)

For the notification command, specify a command that will always terminate. If you set a batch file (Windows) or shell script (UNIX), make sure that it will terminate with exit 0. If the specified command does not terminate or uses the GUI, processes of the executed notification command will remain unresolved.

The notification command specified in COMMAND inherits the execution environment of JP1/IM - Manager.

The notification command is executed with the execution permissions of JP1/IM - Manager (Windows: SYSTEM user; UNIX: root).

Specify in COMMAND the full path of the notification command.

Use the jcohctest command to test thoroughly whether the set notification command functions successfully. For details about the jcohctest command, see jcohctest in 1. Commands.

The default is COMMAND=, in which case no notification command is executed.

To use $, specify $$.

In Windows, if you execute a command in the %WINDIR%\System32 folder, the WOW64 redirect functionality redirects execution to the same command in the %WINDIR%\SysWow64 folder. If there is no applicable command in the destination folder, command execution might fail. Make sure that the applicable command is in the %WINDIR%\System32 folder when you specify it for execution.

NO_RESPONSE_TIME=no-response-time

Specifies in seconds the amount of time to wait for a response to be sent from the JP1/IM - Manager process. The permitted value range is from 60 to 3,600 seconds. The default is 60 seconds.

If the value that is specified is outside the permitted value range or the definition is omitted, the default value (60 seconds) is assumed.

Note that this parameter is not included in the health check definition file (jcohc.conf) that is deployed when JP1/IM - Manager is installed. If you want to change the default value, you must add the parameter.

ERROR_THRESHOLD=no-response-count-treated-as-error

Specifies the number of times to wait for the set no-response time to elapse before assuming that an error has occurred in the JP1/IM - Manager process. The permitted value range is from 1 to 60 times. The default is 3 times.

If the value that is specified is outside the permitted value range or the definition is omitted, the default value (3 times) is assumed.

BASE_NO_RESPONSE_TIME=no-response-time

Specifies in seconds the interval for checking the JP1/Base event service for the set no-response time on Manager. The permitted value range is from 60 to 3,600 seconds. The default is 300 seconds.

If the value that is specified is outside the permitted value range or the definition is omitted, the default value (300 seconds) is assumed.

BASE_ERROR_THRESHOLD=no-response-count-treated-as-error

Specifies the number of times to wait for the set no-response time to elapse before assuming that an error has occurred in the JP1/Base event service on Manager. The permitted value range is from 1 to 60 times. The default is 2.

If the value that is specified is outside the permitted value range or the definition is omitted, the default value (2 times) is assumed.

Example definition

Issue a JP1 event and execute the jcohc01.exe notification command when an error is detected by the health check function:

[HEALTHCHECK]
ENABLE=true
FAILOVER=false
EVENT=true
COMMAND=C:\Command\jcohc01.exe
NO_RESPONSE_TIME=60
ERROR_THRESHOLD=3
BASE_NO_RESPONSE_TIME=300
BASE_ERROR_THRESHOLD=2
[End]

Event guide information file (jco_guide.txt)

Format

DESC_VERSION=file-version

[EV_GUIDE_event-guide-number]
EV_USER=JP1-user-name
EV_COMP=attribute-name:attribute-value
EV_GUIDE=event-guide-message
[END]
[EV_GUIDE_event-guide-number]
EV_COMP=attribute-name:attribute-value
EV_COMP=attribute-name:attribute-value
EV_FILE=event-guide-message-file-name
[END]
   :

File

sample_jco_guide_ja.txt (sample file of the event guide information file (Japanese))

sample_jco_guide_en.txt (sample file of the event guide information file (English))

sample_jco_guide_ja.txt.model (model file for the event guide information sample file (Japanese))

sample_jco_guide_en.txt.model (model file for the event guide information sample file (English))

Storage directory

In Windows

For a physical host:

Console-path\conf\guide\

For a logical host:

shared-folder\jp1cons\conf\guide\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/guide/

For a logical host:

shared-directory/jp1cons/conf/guide/

Description

This file defines event guide information for JP1 events. The information specified in this file is displayed in the Event Details window of JP1/IM - View or the Event Detail window of the integrated operation viewer.

The maximum size of an event guide information file is 1 megabyte. An event guide information file can contain up to 1,000 blocks.

Use the language encoding supported by JP1/IM - Manager to specify the event guide information file.

You must create an event guide information file under the name jco_guide.txt. Copy the sample_jco_guide_ja.txt or sample_jco_guide_en.txt, depending on the language code used by JP1/IM - Manager, and then rename the file jco_guide.txt before you use it. Store the event guide information file in the same directory that stores the sample file. Note that the event guide information file cannot have a user-selected name, unlike the file specified in the EV_FILE parameter (event guide message file).

If an issued JP1 event matches multiple event guide information items, the first item specified in the event guide information file is effective.

When # is specified, any text following # is treated as a comment. Note that a comment cannot be specified after the start tag, attribute information, or the end tag. An error results if a comment is specified following the start tag or the end tag. A comment that is specified following an attribute value is treated as part of the attribute value.

To use \, specify \\. If \ is used in a character combination other than \n or \$, a log is output and the line containing \ is ignored.

The event guide information file and event guide message file are not checked for HTML syntax errors.

When the definitions are applied

Once the event guide information file has been edited, the definitions in the file take effect when JP1/IM - Manager is restarted or when the jco_spmd_reload command is executed. If there is no display area for event guide information in the Event Details window when you log in to JP1/IM - View or the Event Detail window of the integrated operation viewer, apply the definitions and then re-log in to JP1/IM - View or the Event Detail window of the integrated operation viewer. The display area should appear.

After you have edited the event guide message file, you can display the new information by reloading the Event Details window.

Information that is specified

DESC_VERSION=file-version

Specifies the file version of the event guide information file. The specifiable values are 1 and 2. When 2 is specified, you can specify the EV_USER parameter.

[EV_GUIDE_event-guide-number]

This is the start tag for event guide information. The information from the [EV_GUIDE_event-guide-number] to the [END] tag constitutes a single definition block. Between this parameter and [END], specify a comparison condition for determining the JP1 events that are to be displayed in the Event Details window and the message to be displayed. For event-guide-number, specify a decimal number in the range from 1 to 9999.

When there are multiple definition blocks, the event guide numbers need not be in numerical order. However, an error results if the same event guide number is specified more than once, in which case the definition block with the duplicated event guide number is ignored. Note that [EV_GUIDE_1] and [EV_GUIDE_0001] are different.

Specify a unique character string in each EV_GUIDE_event-guide-number. If an invalid character string is specified, a log is output and the corresponding specification is ignored.

If an attribute specified for EV_GUIDE_event-guide-number is not permitted, the corresponding specification is ignored.

EV_USER=JP1-user-name

Specifies the JP1 user name to be displayed in the event guide message. You can specify 1 to 31 bytes of characters. Only one-byte alphanumeric characters can be used. Alphabetic characters are not case sensitive. If you specify this parameter, specify 2 for DESC_VERSION. You can specify this parameter only once. If the parameter is omitted, all JP1 users are assumed as applicable users.

This parameter can be specified only when the version of JP1/IM - Manager is 09-50 or later. You can specify a maximum of 100 JP1 user names by separating them with one or more spaces.

Example:

EV_USER=jp1user1 jp1user2 jp1user3

EV_COMP=attribute-name:attribute-value

Specify this parameter for each attribute that is to be used for comparison with JP1 events. When multiple attributes are specified, they are assumed to be connected by the AND condition. For example, if the EV_COMP parameter is specified twice, the event guide message is displayed in the Event Details window only when both of the conditions are satisfied.

If you specify an event ID for the attribute name in an EV_COMP parameter, you can specify either B.ID or B.IDBASE. In B.ID, specify the 16-digit attribute value in the format basic-part:extended-part. In B.IDBASE, specify the 8-digit basic part.

Example:

EV_COMP=B.ID:00004107:00000000

EV_COMP=B.IDBASE:00004107

You can specify a maximum of 100 EV_COMP conditions. For an example of using more than one EV_COMP condition, see the example definition below.

Note that a business group name cannot be used for the event-issuing server name (B.SOURCESERVER), the target event server name (B.DESTSERVER), and the event source host name (E.JP1_SOURCEHOST). If you specify a business group name, it is treated as a host name.

attribute-name

Specifies one of the following as the attribute:

• JP1 event basic attribute: If you specify this attribute, use the format B.attribute-name.

• JP1 event extended attribute: If you specify this attribute, use the format E.attribute-name.

Note that the reason for registration (B.REASON) and code set (B.CODESET) cannot be specified.

If you specify the registration time (B.TIME) or the arrival time (B.ARRIVEDTIME) for attribute-name, the total number of milliseconds after UTC January 1, 1970 at 00:00:00 is compared.

Example: Specify a JP1 event of which the arrival time is 10:20:00.000 (total number of milliseconds: 1371000000000) on June 12, 2013

EV_COMP=B.TIME:1371000000000

attribute-value

Specifies as a regular expression the value of the attribute specified in attribute-name. For the regular expression, use an extended regular expression. For details about regular expressions, see Appendix G. Regular Expressions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

By default, the specified regular expression is compared with the entire attribute value of the JP1 event. The condition is satisfied only if they match exactly.

To accept a partial match, execute the jbssetcnf command specifying a file that contains the common definition information shown below in an argument and then restart JP1/IM - Manager to apply the definition. When you create the definition file, make sure that the end of the file is at the beginning of the last line.

For a physical host

[JP1_DEFAULT\JP1CONSOLEMANAGER]

"GUIDE_EV_COMP"="find"

For a logical host

[logical-host-name\JP1CONSOLEMANAGER]

"GUIDE_EV_COMP"="find"

To reset the definition to a complete match (default), specify match for the value of the GUIDE_EV_COMP common definition information.

If the common definition information is missing or the specified value is invalid, the system assumes match for a complete match.

Note that the common definition information is not set at the time of installation.

When you specify an IPv6 address for a source IP address (B.SOURCEIPADDR) and the target IP address (B.DESTIPADDR), use lowercase alphabetic characters as in the following example:

0011:2233:4455:6677:8899:aabb:ccdd:eeff

Also note that abbreviated IP addresses such as the following cannot be specified:

2012:7:8::a:b

When you specify the registered time (B.TIME) or the arrived time (B.ARRIVEDTIME), specify the number of seconds in milliseconds starting from UTC 1970-01-01 00:00:00.

EV_GUIDE=event-guide-message

Specifies a character string that is to be displayed as the event guide information. The specified character string is displayed in the event guide information area in the Event Details window (in Guide under Message).

Note that you can specify this parameter only once between [EV_GUIDE_event-guide-number] and [END].

If you specify EV_GUIDE=event-guide-message and EV_FILE=event-guide-message-file-name together, the specification of EV_FILE=event-guide-message-file-name takes precedence.

To use \ in the message, specify \\. To use $, specify \$. To use a linefeed code in the message, specify \n.

You can use HTML tags and specify variables for JP1 event attributes in event-guide-message.

Specifying HTML tags

If you use HTML tags, you can display the event guide message in HTML format in the Event Details window (for details about the HTML tags that can be specified, see Table 2-21 HTML tags that can be used in the event guide message file, in the description of EV_FILE.

Specifying variables for JP1 event attributes

If you specify $B.attribute-nameΔ or $E.attribute-nameΔ in the message, the attribute value corresponding to the JP1 event attribute name is expanded in the message (Δ indicates a space). Note that the reason for registration (B.REASON) and code set (B.CODESET) cannot be specified. If there is no corresponding attribute, the attribute is replaced with blanks.

The table below lists the attribute names that can be specified in messages. For details about the attributes of JP1 events, see 3.1 Attributes of JP1 events.

Table 2‒18: List of attribute names that can be specified in messages

JP1 event attribute

Specification in message

Basic attributes

Serial number

B.SEQNO

Event ID

Specify either of the following:

B.ID

B.IDBASE

Source process ID

B.PROCESSID

Registered time

B.TIME

Arrived time

B.ARRIVEDTIME

Source user ID

B.USERID

Source group ID

B.GROUPID

Source user name

B.USERNAME

Source group name

B.GROUPNAME

Event-issuing server name

B.SOURCESERVER

Target event server name

B.DESTSERVER

Source serial number

B.SOURCESEQNO

Message

B.MESSAGE

Extended attributes

Event level

E.SEVERITY

User name

E.USER_NAME

Product name

E.PRODUCT_NAME

Object type

E.OBJECT_TYPE

Object name

E.OBJECT_NAME

Root object type

E.ROOT_OBJECT_TYPE

Root object name

E.ROOT_OBJECT_NAME

Object ID

E.OBJECT_ID

Occurrence

E.OCCURRENCE

Start time

E.START_TIME

End time

E.END_TIME

Result code

E.RESULT_CODE

Event source host name

E.JP1_SOURCEHOST

Other extended attribute

E.xxxxxx#

#:

You can also specify JP1 product-specific extended attributes. For example, the product-specific extended attribute for the JP1/AJS job execution host is E.C0. For details about the product-specific extended attributes, consult the documentation for the products that issue JP1 events.

You can specify for an event guide message a maximum of 196,608 characters. If more than 196,608 characters are specified, the portion in excess of 196,608 characters will not be displayed in the Event Details window.

The event guide message can display a Web page of related products without unreadable text by specifying replacement characters listed in the table below.

Table 2‒19: Replacement characters that can be specified

Specification format

Description

$B.attribute-nameΔ

$E.attribute-nameΔ

Expand the attribute value as is.

When guide information is in HTML format, use HTML encoding.

Specify the attribute value in this format to display the JP1 event attribute value as part of the text to be displayed in an event guide message.

Example: $B.MESSAGEΔ

$B.attribute-name$URLENCΔ

$E.attribute-name$URLENCΔ

Handle the attribute value as a UTF-8 string for URL encoding and expand it.

Use this format to pass the JP1 event attribute value as a UTF-8 string to be used as the argument (URL parameter) of the Web page application.

Example: <a href="http://host/page?msg=$B.MESSAGE$URLENCΔ">

$B.attribute-name$ENCΔ

$E.attribute-name$ENCΔ

Perform Base64 encoding for the attribute value as a UTF-8 string and expand it.

Use this format to display the Base64-encoded JP1 event attribute value as a UTF-8 string as part of the text to be displayed in an event guide message.

However, to pass the value as an argument (URL parameter) of a Web page application, use the variables $B.attribute-name$ENC$URLENCΔ, $E.attribute-name$ENC$URLENCΔ

Example: $B.MESSAGE$ENCΔ

$B.attribute-name$ENC$URLENCΔ

$E.attribute-name$ENC$URLENCΔ

Perform Base64 encoding for the attribute value as a UTF-8 string, and then perform URL-encoding to expand it.

Use this format to pass the Base64 value of the JP1 event attribute value as an argument (URL parameter) of the Web page application.

Example: <a href="http://host/page?msg=$B.MESSAGE$ENC$URLENCΔ">

Note:

When you specify $URLENC or $ENC, you must specify 2 as the value for DESC_VERSION.

EV_FILE=event-guide-message-file-name

Specifies the full path name of a file that contains the text for the event guide message that is to be displayed in the Event Details window. You can specify this parameter only once between [EV_GUIDE_event-guide-number] and [END]. If nothing is specified for event-guide-message-file-name, the file names in the following table are assumed.

Table 2‒20: Event guide message file name

OS

Event guide message file name

Windows

Console-path\conf\guide\EV_GUIDE_event-guide-number.txt

shared-folder\jp1cons\conf\guide\EV_GUIDE_event-guide-number.txt

UNIX

/etc/opt/jp1cons/conf/guide/EV_GUIDE_event-guide-number.txt

shared-directory/jp1cons/conf/guide/EV_GUIDE_event-guide-number.txt

Express the file name using from 1 to 1,024 characters, including the path. If the specified file name exceeds 1,024 characters, an error results when JP1/IM - Manager starts or when the event guide message file is called from JP1/IM - View or the integrated operation viewer.

You can specify any file name and extension for the event guide message file. We recommend that you select a file name that is easy to manage; for the extension, use .txt if the event guide message is in TXT format and .html or .htm if the event guide message is in HTML format.

Example: jco_guidemes001_AJS2.txt or jco_guidemes001_AJS2.htm

Event guide message file

Specify in the event guide message file in TXT or HTML format the information that you want to be displayed in the Event Details window. The information that you can specify in the event guide information file is the same as for EV_GUIDE. In other words, you can use HTML tags and variables for the attributes of JP1 events. To use a backslash sign (\) in a message, write it as\\. To use the dollar sign ($), write it as\$. To insert a linefeed in a message, write it as\n.

However, EV_GUIDE can be used only to specify a one-line message, whereas with the event guide message file you can use linefeed codes for a formatted message.

You can store the created event guide message file in any folder.

The maximum size of an event guide message file is 1 megabyte. If the file size exceeds 1 megabyte, an error occurs when the event guide message file is loaded into the Event Details window of JP1/IM - View or the integrated operation viewer.

The table below lists and describes the HTML tags and attributes that can be used when you create an event guide message file in HTML format. If any other HTML tags are used, the operational results cannot be guaranteed.

Table 2‒21: HTML tags that can be used in the event guide message file

Tag

Attribute

Description

HTML

--

Declares that this is an HTML text. This tag is mandatory.

HEAD

--

Declares the header for the HTML text.

This tag is mandatory.

BODY

--

Declares the body of the HTML text.

This tag is mandatory.

A#1

HREF="URL"

Specifies a linkage-target URL.#2, #3 You can specify URLs beginning with http:// or https://.

Operation with other URLs is unpredictable.

The link specified here is displayed in the Event Details window (HTML format). Clicking the link starts a Web browser and accesses the specified URL. You can encode a maximum of 2,083 characters.

H1, H2, H3, H4, H5, H6

--

Specifies headers.

FONT

SIZE="font-size"

Specifies the font size. The permitted values are from 1 to 7.

COLOR="font-color"

Specifies the font color. You can specify the following 16 colors:

black, silver, gray, white, maroon, red, purple, fuchsia, green, lime, olive, yellow, navy, blue, teal, aqua

If you specify any other font color, the operation is not guaranteed.

B

--

Specifies boldface type.

I#4

--

Specifies italics type.

HR

--

Specifies a horizontal rule.

BR

--

Specifies a forced linefeed.

Legend:

--: None

#1: The interpretation of the URL in the A tag and the screen to be displayed are dependent on the WWW browser and other aspects of the environment.

#2: The following is a coding example of a URL used to link with JP1/Navigation Platform.

Example:

http://hostA:8080/ucnpBase/portal/screen/Home/action/PLoginUser?contentId=f24077e7-0136-1000-8000-00000ad20b6f-0

For details about linking with JP1/Navigation Platform, see the descriptions of the URL for calling Navigation Platform from JP1 products in the JP1/Navigation Platform manuals.

#3: For details about the URL for linking with JP1/AJS, see the JP1/AJS manuals.

#4: In the integrated operation viewer, Japanese strings are not italicized even with the I tag.

[END]

Specifies the end tag for the event guide information. This item is not case sensitive.

Example definition

# JP1/IM-CC Guide Information File.

DESC_VERSION=1
[EV_GUIDE_001]
EV_COMP=B.ID:00004107:00000000
EV_COMP=E.SEVERITY:Error
EV_GUIDE=The job terminated abnormally.\nCheck whether an error has occurred on the $E.C0 host.
[END]

System color definition file (systemColor.conf)

Format

DESC_VERSION=file-version

#comment-line
[DEFAULT.BackgroundColor=color]
[DEFAULT.TextColor=color]

[SEVERITY.event-level.BackgroundColor=color]
[SEVERITY.event-level.TextColor=color]
:

File

systemColor.conf (system color definition file)

systemColor.conf.model (model file for the system color definition file)

Storage directory

In Windows

For a physical host:

Console-path\conf\console\profile

For a logical host:

shared-folder\jp1cons\conf\console\profile

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/profile

For a logical host:

shared-directory/jp1cons/conf/console/profile

Description

This file defines the color settings used on the Monitor Events page, Severe Events page, and Search Events page of the Event Console window.

Execution permission

In Windows

The Administrators group and SYSTEM users must be able to reference the file.

In UNIX

Users with the root permissions must be able to reference the file.

When the definitions are applied

When you select the Display check box in the Coloring section of the Preferences window, the events in an event list are colored according to the settings specified in the system color definition file.

JP1/IM - View colors the events according to the settings in the system color definition file specified when the user logs in.

If a user changes the settings in the system color definition file during the login process, the new settings take effect when the user restarts JP1/IM - View.

Information that is specified

DESC_VERSION=file-version

Indicates the system color definition file format version. The value to be specified is 1. If this value is omitted or another numeric value is specified, 1 is assumed.

#comment-line

A line beginning with a hash mark (#) is treated as a comment.

[DEFAULT.BackgroundColor=color]

Specifies the default background color. If the background color for the event level is not specified, or is specified for a JP1 event that does not match the specification of the background color, the background color specified for this parameter is applied. This parameter can be omitted. The background color is specified by the name of the color or by RGB values. The following table shows the correspondence between color name and RGB values.

Color name

RGB value

black

0,0,0

blue

0,0,255

cyan

0,255,255

darkGray

64,64,64

gray

128,128,128

green

0,255,0

lightGray

192,192,192

magenta

255,0,255

orange

255,200,0

pink

255,175,175

red

255,0,0

white

255,255,255

yellow

255,255,0

The color names are not case sensitive.

The range of RGB values that can be specified is from 0 to 255. The default value is white (255,255,255). RGB values are separated by a comma (,).

[DEFAULT.TextColor=color]

Specifies the text color of an event level if a color is not specified. This parameter can be omitted. The color name, the RGB values, and the range of RGB values are the same as DEFAULT.BackgroundColor=color. The color names are not case sensitive.

The default value is black (0,0,0).

[SEVERITY.event-level.BackgroundColor=color]

Specifies the background color of an event level. This parameter can be omitted. The color name, the RGB values, and the range of RGB values are the same as DEFAULT.BackgroundColor=color. The color names are not case sensitive.

The event levels that can be specified are Emergency, Alert, Critical, Error, Warning, Notice, Information, and Debug. The event levels are case sensitive.

[SEVERITY.event-level.TextColor=color]

Specifies the text color of the event level. This parameter can be omitted. The color name, the RGB values, and the range of RGB values are the same as DEFAULT.BackgroundColor=color. The color names are not case sensitive.

The event levels that can be specified are Emergency, Alert, Critical, Error, Warning, Notice, Information, and Debug. The event levels are case sensitive.

Example definition

DESC_VERSION=1

DEFAULT.TextColor=black
DEFAULT.BackgroundColor=white

SEVERITY.Emergency.TextColor=white
SEVERITY.Emergency.BackgroundColor=red

SEVERITY.Alert.TextColor=white
SEVERITY.Alert.BackgroundColor=red

SEVERITY.Critical.TextColor=white
SEVERITY.Critical.BackgroundColor=red

SEVERITY.Error.TextColor=white
SEVERITY.Error.BackgroundColor=255,128,0

SEVERITY.Warning.TextColor=black
SEVERITY.Warning.BackgroundColor=yellow

Definition file for extended event attributes

Format

@encode character-encoding
@file type="definition-file-type", version="definition-format-version";
@product name="product-name";
@define-block type="event-attr-def";
block lang = "language-type", platform="platform-type"
attr name="attribute-name", title="display-item-name"[, type="attribute-display-type"];
...
@define-block-end;
@define-block type="event-attr-group-def";
block platform="platform-type"
group name="group-name", attrs="list-of-attribute-names";
...
@define-block-end;
@define-block type="event-attr-order-def";
block platform="platform-type"
order id="event-ID-definition-character-string", attrs="list-of-attribute-names";
...
@define-block-end;

File

The extension of a definition file for extended event attributes must be .conf (in lowercase).

default.conf (default definition file for extended event attributes)

hitachi_xxxx.conf (definition file for extended event attributes for a linked product)

company-name_product-name_attr.conf (user-defined definition file for extended event attributes)

company-name can be changed to series-name_product-name. We recommend that you use the value specified for PRODUCT_NAME at the time of JP1 event issuance as the file name, with the forward slash (/) replaced by the underscore (_). Because, hitachi is used for the default file name, use a name other than hitachi for company-name.

Storage directory

In Windows

For a physical host:

Console-path\conf\console\attribute\

For a logical host:

shared-folder\JP1Cons\conf\console\attribute\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/attribute/

For a logical host:

shared-directory/jp1cons/conf/console/attribute/

Description

A definition file for extended event attributes defines the order for sorting the event attributes and the attribute names that are to be displayed in the Event Details window.

The following table describes the four types of definition files for extended event attributes.

Table 2‒22: Types of definition files for extended event attributes

No.

Type

Description

1

Default file

Definition of detailed event information about the basic attributes common to all events and the common information of extended attributes

2

Extended file

Definition of program-specific extended attributes

3

File provided by a linked product

Definition of program-specific information about the extended attributes of a linked product that issues JP1 events

4

User-defined file

User-specific information about user-defined extended attributes

The two file types listed under No. 1 and No. 3 above are stored in the definition file storage directory of JP1/IM. These two types of files are system standard definition files created when JP1/IM - Manager is installed, and they cannot be added to, changed, or deleted by the user.

To add new user- or program-specific information about extended attributes of JP1 events, you can create a definition file of type No. 2 or No. 4 above and store it in the storage directory.

For details about file type No. 2, see Definition file for extended event attributes (extended file) in Chapter 2. Definition Files.

Creation timing

The following shows when the different types of definition files for extended event attributes are created.

No.

File type

When created

1

default.conf

When JP1/IM - Manager is installed

2

hitachi_xxxx.conf

When JP1/IM - Manager is installed

3

company-name_product-name_attr.conf

When the user adds the file

When the definitions are applied

The definitions in the definition file for extended event attributes take effect after either of the following occurs:

JP1/IM - Manager is restarted.

The command jco_spmd_reload is executed.

Information that is specified

A definition file for extended event attributes defines the order for sorting event attributes and the attribute names that are to be displayed in the Event Details window of JP1/IM - View or the Event Detail window of the integrated operation viewer.

There are three types of definition files for extended event attributes:

File for definition of detailed event information about the basic attributes common to all events and the common information for extended attributes (file included with the product: default.conf)

File for definition of program-specific information about the extended attributes of a linked product that issues JP1 events (file included with the product: hitachi_xxxx.conf)

File for definition of user-specific information about user-defined extended attributes (created by the user)

The definition files for extended event attributes that are created when JP1/IM - Manager is installed are system standard definition files, and they cannot be added to, changed, or deleted by the user.

To add new user-specific information about extended attributes of JP1 events, you can create a definition file according to the naming rules described in Table 2-2 Naming rules for definition files and then store the file in the same definition file storage directory.

You should note the following about creating such a definition file:

In JP1/IM - Manager for Linux, use UTF-8 encoding. In JP1/IM - Manager for OSs other than Linux, use Shift-JIS or EUC encoding.

If you mistakenly define the basic attributes or common information for the extended attributes in the definition file, the following is displayed if attributes (attribute name, item name, and attribute display type) are duplicated.

If only the attribute name or item name is duplicated: The attribute names and item names defined in each definition file are displayed.

If all attributes are duplicated: Specifications of the default file (default.conf) for the definition files for extended event attributes are ignored.

JP1/IM provides the jcoattrfcheck command for checking the contents of a definition file for extended event attributes. For details about this command, see jcoattrfcheck in Chapter 1. Commands.

You can specify the statements and blocks described in the table below in a definition file for extended event attributes.

Table 2‒23: Statements and blocks that can be specified in a definition file for extended event attributes

Statement or block

Description

@encode statement

Specifies the character encoding used in the definition file

@file statement

Declares the definition file type and version

@product statement

Declares product information in the definition

Definition block for extended event attributes

Defines the display of event attributes

Definition block for attribute groups

Defines event attribute groups

Definition block for the attribute display order

Defines ID the order in which attributes are displayed in the Event Details window

Information that is specified (specification of character encoding)

@encode

Specifies the character encoding that is to be used in the definition file for extended event attributes. The @encode statement can be omitted.

To create an additional file for definition file for extended event attributes, use an @encode statement to specify the character set for the definition file.

Item names are expressed in characters that can be represented in the character encoding specified in the @encode statement. In addition, the definition file for extended event attributes is stored in the character encoding specified in the @encode statement.

In the following circumstances, item names displayed in JP1/IM - View or the integrated operation viewer might be garbled:

If the item name uses characters that cannot be represented in the character encoding specified in the @encode statement

If the character encoding specified in the @encode statement does not match the character encoding in which the file was saved

If no @encode statement exists or if there is an error in the specified character set name that follows the @encode statement, the character set is determined automatically. However, depending on the content of the definition file, the character encoding might not be determined correctly.

The following character encodings can be specified:

C

EUCJIS

SJIS

UTF-8

GB18030

Note

If you use UTF-8 as the encoding to save a definition file, save the file without attaching a BOM (byte order mark).

An error is output in the following cases:

A character encoding other than C, EUCJIS, SJIS, UTF-8 or GB18030 is specified

The definition file does not begin with @encode.

@encode is not followed by a character encoding value.

Note

If you use a definition file for extended event attributes provided by another product, make sure that the character encoding specified in the @encode statement matches the character encoding used in the definition file. In addition, if you plan to transfer definition files, do not convert their character encoding.

Information that is specified (rules for generating in-file statements)

@filestatement

Declares that this is a definition file for extended event attributes and that the version of the definition specification format is 0300. This statement is mandatory.

This statement must be on the first line of the file, or on the line following the @encode statement. If the statement is not specified on the first line, the integrity of operations cannot be guaranteed.

Syntax

@file type="extended-attributes-definition", version="0300";

@productstatement

Defines product information for the statements defined in the file.

When you specify this statement, note the following:

The specified value must match the PRODUCT_NAME JP1 event extended attribute. If this specification is omitted, the integrity of operations cannot be guaranteed.

Prohibited characters and formatting irregularities are not checked during parsing; instead, the specified character string is used as is.

Syntax

@product name="product-name";

name="product-name"

The product name is a string of alphanumeric characters separated by a forward slash. It must be specified in one of the following formats:

/company-name/series-name/product-name

/company-name/product-name

Example definition

The following shows an example of definition information header statements:

@file type="extended-attributes-definition", version="0300";
@product name="/HITACHI/JP1/CentralConsole";
@define-block type="event-attr-def";
block lang="English", platform="NT";
attr name="E.SAMPLE_TIME", title="Sample time";
attr name="E.SAMPLE_HOST", title="Sample host";
attr name="E.SAMPLE_USER", title="Sample user";
@define-block-end;

Information that is specified (rules for generating blocks in the definition file for extended event attributes)

This subsection describes the blocks that can be specified in a definition file for extended event attributes. If an invalid statement is specified in a block, an error is output but only the statement with the error is ignored.

Definition block for extended event attributes

In the Event Details window, associate the event attribute name with its display item name (for all Japanese, English, and Chinese names). You can specify this block more than once in the definition file unless the blocks have the same key attribute (the value specified in the block statement discussed below).

When specifying multiple languages, if you specify an attribute name in an attr statement (described below) for any one language, you must specify that attribute name in an attr statement for every specified language.

Types of statements that can be specified

You can specify the following statements in this block:

• block statement

• attr statement

Definition block for attribute groups

This block groups event attributes that are defined in the definition blocks for extended event attributes. If you group multiple event attributes, you can avoid defining order statements repeatedly in the definition blocks for the attribute display order.

This block is optional.

Types of statements that can be specified

You can specify the following statements in this block:

• block statement

• group statement

Definition block for the attribute display order

Defines the order in which event attributes and attribute names are to be displayed when the details of each event are displayed.

Types of statements that can be specified

You can specify the following statements in this block:

• block statement

• order statement

Information that is specified (rules for generating statements in a definition block for extended event attributes)

block statement

Defines block attributes. You can specify this statement only once at the beginning of a block.

Syntax

block lang=language-type, platform=platform-type;

lang=language-type

Declares the language used for the definition block for extended event attributes. You can specify one of the following languages:

• Japanese

Indicates that this is a definition for a Japanese language environment.

• English

Indicates that this is a definition for an English language environment.

• Chinese

Indicates that this is a definition for a Chinese language environment.

platform=platform-type

Specifies the platform to which the definition in the block is to be applied. You can specify the following values:

• base

The definition is applicable to all platforms.

If base is specified for the platform parameter, you must specify a comma (,) followed by extended="false".

• user-defined

The definition is applicable to a user-defined platform. You must specify for user-defined a character string of alphanumeric characters. Note that this character string is not checked for errors.

The platform name specified in the platform parameter is compared with the PLATFORM JP1 event extended attribute; if they match, the specified information is subject to detailed information processing. If the platform name specified here is not found in the PLATFORM JP1 event extended attribute, the specified information is not processed. Note that if the PLATFORM extended attribute is not set at the time of JP1 event issuance, the system assumes that base is specified and executes file parsing.

Example definition

See the example definition for the attr statement below.

attr statement

Specifies an item name that is to be displayed in the attribute name column in the Event Details window and the type of the attribute value. You can specify this statement more than once in a block.

Note that this statement can be used to define only user-specific extended attribute information; the basic attributes and the common information of extended attributes are excluded. If the specified information is not user-specific extended attribute information, processing continues without outputting an error, but the specified information is displayed together with the provided standard definition information. For details about the standard definitions included with the product, see Example definition below.

Syntax

attr name=attribute-name, title=display-item-name[,type="elapsed_time/

date_format:CLIENT"];

name=attribute-name

Specifies the name of an attribute.

The following table lists the attributes that can be displayed.

No.

Specification format

Meaning of attribute

1

"B.SEQNO"

Serial number

2

"B.IDBASE"

Event ID

3

"B.PROCESSID"

Source process ID

4

"B.TIME"

Registered time

5

"B.ARRIVEDTIME"

Arrived time

6

"B.USERID"

Source user ID

7

"B.GROUPID"

Source group ID

8

"B.USERNAME"

Source user name

9

"B.GROUPNAME"

Source group name

10

"B.SOURCESERVER"

Source host

11

"B.DESTSERVER"

Target event server name

12

"B.SOURCESEQNO"

Source serial number

13

"B.MESSAGE"

Message

14

"B.SOURCEIPADDR"

Source IP address

15

"E.extended-attribute-name"

Extended attribute

title=display-item-name

Specifies the character string that is to be displayed in the attribute name column in the Event Details window; the language specified in the block statement will be used.

type="elapsed_time/date_format:CLIENT"

Specifies the type and display format of the attribute value. The attribute value elapsed_time is a decimal character string indicating the elapsed time in seconds since UTC 1970-01-01 00:00:00. The display format date_format:CLIENT means that the value is to be displayed in the time format by using the time specified in the local time zone of the target viewer.

Example definition

This subsection presents an example of user-specific extended attribute information for JP1 events. This is an example of a definition block for extended event attributes that displays four extended attributes (user-specific information) listed in the following table for the platform W2K.

Table 2‒24: Example definition of a definition block for extended event attributes

Name displayed in the window

Extended attribute name (user-specific information)

SAMPLE common attribute 1

COMMON_ATTR1

SAMPLE common attribute 2

COMMON_ATTR2

SAMPLE start attribute 1

START_ATTR1

SAMPLE start attribute 2

START_ATTR2

@define-block type="event-attr-def";
block lang="English", platform="w2k";
attr name="E.COMMON_ATTR1",    title="SAMPLE common attribute 1";
attr name="E.COMMON_ATTR2",    title="SAMPLE common attribute 2";
attr name="E.START_ATTR1",     title="SAMPLE start attribute 1";
attr name="E.START_ATTR2",     title="SAMPLE start attribute 2";
@define-block-end;

Information that is specified (rules for generating statements in a definition block for attribute groups)

block statement

Defines block attributes. You can specify this statement only once at the beginning of a block.

When you define this statement, note the following:

This block cannot contain the lang parameter.

Syntax

block platform=platform-type;

platform=platform-type

Specifies the platform to which the definition in the block is to be applied. You can specify the following values:

Specifiable value

Description

"base"

Use the value to enable the definition for all platforms.

If base is specified for the platform parameter, you must specify a comma (,) followed by extended="false".

"user-defined"

The definition is enabled for a user-defined platform. You must specify for user-defined a one-byte alphanumeric character string. Note that this character string is not checked for errors.

The platform name specified in the platform parameter is compared with the PLATFORM JP1 event extended attribute; if they match, the specified information is subject to detailed information processing. If the platform name specified here is not found in the PLATFORM JP1 event extended attribute, the specified information is not processed. Note that if the PLATFORM extended attribute is not set at the time of JP1 event issuance, the system assumes that base is specified and executes file parsing.

Example definition

See the example definition for the group statement below.

group statement

Groups attributes by assigning a name to a list of attributes that are to be displayed in the Event Details window. You can specify this statement more than once in a block.

Syntax

group name=group-name, attrs=list-of-attribute-names;

name=group-name

Specifies a name for the list of attribute names. Express the name using from 1 to 32 alphanumeric characters. This name is not case sensitive. You can use this name in the order block in the definition file.

attrs=list-of-attribute-names

Specifies a list of one or more attributes that are to be grouped. When multiple attributes are listed in this parameter, they are displayed in the Event Details window in the order specified here. The specification format is as follows:

• To specify only one attribute: attrs="E.A0"

• To specify multiple attributes: attrs="E.A0|E.A1"

Note that you can specify only user-specific extended attribute information. If you have specified a basic attribute or a common information item for an extended attribute, the specified attribute value is displayed more than once in the Event Details window.

Example definition

This example shows the definitions of basic attributes and user-specific information for JP1 event extended attributes. These definitions are provided as standard in the definition file for extended event attributes.

@define-block type="event-attr-group-def";
block platform="base", extended="false";
group name="BASE", attrs="B.GROUPID|B.GROUPNAME|B.IDBASE|B.PROCESSID|B.SEQNO|B.SOURCEIPADDR|
B.SOURCESEQNO|B.SOURCESERVER|B.TIME|B.USERID|B.USERNAME|B.ARRIVEDTIME";
group name="COMMON", attrs="E.SEVERITY|E.USER_NAME|E.PRODUCT_NAME|E.OBJECT_TYPE|E.OBJECT_NAME|
E.ROOT_OBJECT_TYPE|E.ROOT_OBJECT_NAME|E.OBJECT_ID|E.OCCURRENCE|
E.START_TIME|E.END_TIME|E.RESULT_CODE";
@define-block-end;

Information that is specified (rules for generating statements in a definition block for the attributes display order)

block statement

Defines the block attribute that depends on the definition block for the attribute display order. You can specify this statement only once at the beginning of a block.

When you define this statement, note the following:

This block cannot contain the lang parameter.

Syntax

block platform=platform-type;

platform=platform-type

Specifies the platform to which the definition in the block is to be applied. You can specify the following values:

Table 2‒25: Specifiable platforms

Specifiable value

Description

"base"

Use the value to enable the definition for all platforms.

If base is specified for the platform parameter, you must specify a comma (,) followed by extended="false".

"user-defined"

The definition is enabled for a user-defined platform. You must specify for user-defined a one-byte alphanumeric character string. Note that this character string is not checked for errors.

The platform name specified in the platform parameter is compared with the PLATFORM JP1 event extended attribute; if they match, the specified information is subject to detailed information processing. If the platform name specified here is not found in the PLATFORM JP1 event extended attribute, the specified information is not processed. Note that if the PLATFORM extended attribute is not set at the time of JP1 event issuance, the system assumes that base is specified and executes file parsing.

Example definition

See the example definition for the order statement below.

order statement

Defines by ID the attributes to be displayed in the Event Details window and their sort order. You can specify this statement more than once in a block.

Syntax

order id=event-ID-definition-character-string, attrs=list-of-attribute-names;

id=event-ID-definition-character-string

Specifies one event ID for which attributes are to be displayed in the order specified in the attrs parameter.

The specification format is as follows:

id="200"

Express an event ID using from 1 to 8 hexadecimal characters. If a specified event ID consists of fewer than 8 characters, there is no need to add leading zeros to pad it out to 8 characters. The alphabetic characters in the hexadecimal character string (a to f) are not case sensitive.

A range of IDs cannot be specified.

attrs=list-of-attribute-names

Specifies a list of the attributes, the groups, or both that are to be displayed. When multiple items are specified in this parameter, they are displayed in the Event Details window in the order specified here.

The specification format is as follows:

• To specify only one item: attrs="E.A0"

• To specify multiple items: attrs="E.A0|E.A1|GROUP1"

As is the case with the group statement, you can specify only user-specific extended attributes. If you have specified a basic attribute or common extended attribute, the specified attribute value will be displayed more than once in the Event Details window.

Example definition

This example definition displays the BASE and COMMON groups for event ID 00001000:

@define-block type="event-attr-order-def";
block platform="base", extended="false";
order id="00001000", attrs="BASE|COMMON"
@define-block-end;

Example definition of a definition file for extended event attributes

@encode UTF-8
@file type="extended-attributes-definition", version="0300";
@product name="/HITACHI/JP1/SAMPLE";
@define-block type="event-attr-def";
block platform="base", lang="English", extended="false";
attr name="E.SAMPLE_CLUSTER_NAME", title="Cluster name";
attr name="E.SAMPLE_PRINT_SERVER_NAME", title="Print server name";
attr name="E.SAMPLE_PRINTER_NAME", title="Printer name";
attr name="E.SAMPLE_PORT_NAME", title="Port name";
@define-block-end;
@define-block type="event-attr-group-def";
block platform="base", extended="false";
group name="_PRINTER_INFO",
attrs="E.SAMPLE_PRINT_SERVER_NAME|E.SAMPLE_PRINTER_NAME";
group name="_CLUSTER_INFO", attrs="E.SAMPLE_CLUSTER_NAME|E.SAMPLE_PORT_NAME";
@define-block-end;
@define-block type="event-attr-order-def";
block platform="base", extended="false";
order id="00003100",attrs="_PRINTER_INFO";
order id="00003101",attrs="_CLUSTER_INFO";
order id="00003102", attrs="_PRINTER_INFO|_CLUSTER_INFO";

@define-block-end;

Definition file for extended event attributes that is included with the product

Shown below are the definitions of the basic attributes and the common information for extended attributes for JP1 events. These definitions are included with the product as the definition file for extended event attributes.

@define-block type="event-attr-def";
block lang="English", platform="base", extended="false";
attr name="B.SEQNO",            title="Serial number";
attr name="B.IDBASE",           title="Event ID";
attr name="B.PROCESSID",        title="Source process ID";
attr name="B.TIME",             title="Registered time", type="elapsed_time_in_milli/date_format:CLIENT";
attr name="B.ARRIVEDTIME",      title="Arrival time", type="elapsed_time/date_format:CLIENT";
attr name="B.USERID",           title="Source user ID";
attr name="B.GROUPID",          title="Source group ID";
attr name="B.USERNAME",         title="Source user name";
attr name="B.GROUPNAME",        title="Source group name";
attr name="E.JP1_SOURCEHOST",   title="Event source host name";
attr name="B.SOURCESERVER",     title="Event-issuing server name";
attr name="B.SOURCEIPADDR",     title="Source IP address";
attr name="B.SOURCESEQNO",      title="Source serial number";
attr name="E.SEVERITY",         title="Event level";
attr name="E.USER_NAME",        title="User name";
attr name="E.PRODUCT_NAME",     title="Product name";
attr name="E.OBJECT_TYPE",      title="Object type";
attr name="E.OBJECT_NAME",      title="Object name";
attr name="E.ROOT_OBJECT_TYPE", title="Root object type";
attr name="E.ROOT_OBJECT_NAME", title="Root object name";
attr name="E.OBJECT_ID",        title="Object ID";
attr name="E.OCCURRENCE",       title="Occurrence";
attr name="E.START_TIME",       title="Start time", type="elapsed_time/date_format:CLIENT";
attr name="E.END_TIME",         title="End time",type="elapsed_time/date_format:CLIENT";
attr name="E.RESULT_CODE",      title="Result code";
attr name="E.JP1_GENERATE_SOURCE_SEQNO", title="Relation Event serial number";
attr name="E.JP1_GENERATE_NAME",         title="Correlation event generation condition name";
attr name="E.@JP1IM_ORIGINAL_SEVERITY",  title="Original severity level";
attr name="E.JP1_IMSUPPRESS_ID",   title="Suppressed event ID";
attr name="E.JP1_IMSUPPRESS_NAME", title="Repeated event condition name";
attr name="E.JP1_TRAP_ID",      title="Monitoring ID";
attr name="E.JP1_TRAP_NAME",    title="Log file trap name";
attr name="E.@JP1IM_CHANGE_MESSAGE_NAME",    title="Display message change definition";
attr name="E.JP1_IMCOMEXCLUDE_ID",   title="Common exclude conditions group ID";
attr name="E.JP1_IMCOMEXCLUDE_NAME", title="Common exclude conditions group name";
attr name="E.JP1_IMCOMEXCLUDE_TARGET", title="Common exclude conditions group target-for-exclusion";
@define-block-end;

Definition file for extended event attributes (extended file)

Format

[@encode character-encoding]
@file type="extended-attributes-definition", version="0300";
@define-block type="event-attr-def";
attr name="attribute-name", title="item-name";
...
@define-block-end;

File

template_extend_attr_ja.conf (Japanese extended file)

template_extend_attr_ja.conf.model (model file for the Japanese extended file)

template_extend_attr_en.conf (English extended file)

template_extend_attr_en.conf.model (model file for the English extended file)

template_extend_attr_zh.conf (Chinese extended file)

template_extend_attr_zh.conf.model (model file for the Chinese extended file)

Storage directory

In Windows

For a physical host:

Console-path\conf\console\attribute\extend

For a logical host:

shared-folder\JP1Cons\conf\console\attribute\extend

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/attribute/extend

For a logical host:

shared-directory/jp1cons/conf/console/attribute/extend

Description

The definition file for extended event attributes (extended file) defines program-specific extended attributes to be displayed as item names on the screen of JP1/IM - View or the integrated operation viewer or output as item names in event reports.

Note that the definition file included with JP1/IM-Manager is prefixed with template_. Rename the file to extend_attr_ja.conf before you use it.

For details about a definition file for extended event attributes that is not an extended file, see Definition file for extended event attributes in Chapter 2. Definition Files.

Creation timing

The files are created when JP1/IM - Manager is installed.

When the definitions are applied

The definitions in the definition file for extended event attributes (extended file) take effect after either of the following occurs:

JP1/IM - Manager is restarted.

The command jco_spmd_reload is executed.

Note that you must restart JP1/IM - View or the integrated operation viewer if the definition is applied while JP1/IM - View or the integrated operation viewer are connected.

Information that is specified

The definition file for extended event attributes (extended file) defines program-specific extended attributes to be displayed as item names on the screen or output as item names in event reports. The extended files are JP1/IM - Manager definition files that are defined for each language used by JP1/IM - Manager.

If you use extended files for multiple languages in JP1/IM - Manager, the same attribute names must be specified in all the extended files. Because the attributes to be displayed in JP1/IM - View or the integrated operation viewer are uniquely determined for the entire system, it is not possible to display different attributes for different JP1/IM - Viewsor the integrated operation viewerin each language.

If there is a mismatch in the attribute names specified in the extended files, the warning message KAVB5820-W will be output when you check the extended files using the jcoattrfcheck command. In addition, attributes not specified in the extended files might appear in JP1/IM - View or the integrated operation viewer. For example, if the attribute E.SYSTEM is specified only in the English extended file, E.SYSTEM will also appear in the Japanese and Chinese JP1/IM - Views. In this case, the item name of E.SYSTEM displayed in the Japanese and Chinese JP1/IM - Views will be identical to the attribute name, namely E.SYSTEM.

JP1/IM provides the jcoattrfcheck command for checking the contents of a definition file for extended event attributes (extended file). For details about this command, see jcoattrfcheck in Chapter 1. Commands.

You can specify the statements and blocks described in the table below in a definition file for extended event attributes (extended file).

Table 2‒26: Statements and blocks that can be specified in a definition file for extended event attributes (extended file)

Statement or block

Description

@encode statement

Specifies the character encoding used in the definition file

@file statement

Declares the definition file type and version

Definition block for extended event attributes

Defines the display of event attributes

Any statement or block that is not listed in the table above is ignored. If a definition file for extended event attributes (extended file) includes an invalid element, the invalid line is ignored while other valid lines work successfully. However, an error is issued if an invalid element is found in a statement that can be read from a definition file for extended event attributes (non-extended file) but cannot be read from a definition file for extended event attributes (extended file), for example, the block statement (block lang="";). For details about definition files for extended event attributes (non-extended files), see Definition file for extended event attributes in Chapter 2. Definition Files.

Information that is specified (specification of character encoding)

@encode

Specifies the character encoding that is to be used in the definition file for extended event attributes (extended file).

Item names will be expressed in characters that can be represented in the character encoding specified in the @encode statement. In addition, the definition file for extended event attributes (extended file) will be saved in the character encoding specified in the @encode statement.

In the following circumstances, item names displayed in JP1/IM - View or the integrated operation viewer might be garbled:

If the item name uses characters that cannot be represented in the character encoding specified in the @encode statement

If the character encoding specified in the @encode statement does not match the character encoding in which the file was saved

If no @encode statement exists or if there is an error in the specified character set name that follows the @encode statement, the character set is determined automatically. However, depending on the content of the definition file, the character encoding might not be determined correctly.

The following character encodings can be specified.

Table 2‒27: Definition file character encodings that can be specified

No.

Character encoding of file

Can be specified?

OS other than Linux

Linux

1

C

Y

Y

2

EUCJIS

Y

N

3

SJIS

Y

Y#

4

UTF-8

Y

Y

5

GB18030

Y

Y

Legend:

Y: Can be specified

N: Cannot be specified

#

Can be specified only in SUSE Linux.

Note:

If you use UTF-8 as the encoding to save a definition file, save the file without attaching a BOM (byte order mark).

An error is output in the following cases:

A character encoding other than C, EUCJIS, SJIS, UTF-8, or GB18030 is specified

The definition file does not begin with @encode

@encode is not followed by a character encoding value

Information that is specified (rules for generating in-file statements)

@file statement

Declares that this is a definition file for extended event attributes (extended file) and that the version of the definition specification format is 0300. This statement is required.

This statement must be on the first line of the file. If the statement is not specified on the first line, the integrity of operations cannot be guaranteed.

Syntax

@file type="extended-attributes-definition", version="0300";

Information that is specified (rules for generating blocks in the definition file for extended event attributes)

This subsection describes the blocks that can be specified in a definition file for extended event attributes (extended file). If an invalid statement is specified in a block, an error is output but only the statement with the error is ignored.

Definition block for extended event attributes

This block associates the event attribute name with its display item name. You can specify this block only once within the definition file. If you specify more than one definition block for extended event attributes, no error or warning is output, but the second and subsequent blocks are ignored.

Types of statements that can be specified

You can specify the following statements in this block:

attr statement

Information that is specified (rules for generating statements in a definition block for extended event attributes)

attr statement

Specifies the name of a program-specific extended attribute and the item name corresponding to that attribute, which is to be displayed on the screen or in event reports. You can specify this statement up to 100 times in a block. If you specify more than 100 attr statements, message KAVB5803-W will be output when you check the definition file with the jcoattrfcheck command.

Syntax

attr name=attribute-name, title=item-name;

name=attribute-name

Specifies the name of the extended attribute. The format is as follows:

"E.extended-attribute-name"

For the attribute name, you can specify a name with a maximum length of 32 bytes that begins with an uppercase letter and consists of uppercase letters, numeric characters, and the underscore (_).

If you specify an extended attribute name that exceeds 32 bytes, message KAVB5803-W will be output when you check the definition file with the jcoattrfcheck command or execute the jcoevtreport command. In addition, message KAVB5822-W will be output when the definition file for extended event attributes (extended file) is loaded when JP1/IM - Manager starts or the jco_spmd_reload command is executed.

Only a program-specific extended attribute can be specified. However, you cannot specify attributes that overlap with the extended attributes specified in the standard definition file for extended event attributes (default.conf), such as the event source host name (E.JP1_SOURCEHOST) or the log file trap name (E.JP1_TRAP_NAME). If you specify extended attributes that overlap with the standard definition file for extended event attributes (default.conf), the item names specified in the standard file will be applied.

If you specify extended attributes that overlap with the standard definition file for extended event attributes (default.conf), message KAVB5802-W# will be output after the definition file for extended event attributes (extended file) is loaded when you execute the jcoevtreport or jcoattrfcheck command. The jcoevtreport command proceeds by ignoring overlapping attributes specified in the definition file for extended event attributes (extended file). In addition, message KAVB5822-W will be output after the definition file for extended event attributes (extended file) is loaded when you restart JP1/IM - Manager or execute the jco_spmd_reload command. JP1/IM - Manager proceeds by ignoring overlapping attributes specified in the definition file for extended event attributes (extended file).

If you specify a basic attribute (B.attribute-name) or an IM attribute (E.@attribute-name), or some other attribute that is not an extended attribute (E.attribute-name), message KAVB5821-W# will be output after the definition file for extended event attributes (extended file) is loaded when you execute the jcoevtreport or jcoattrfcheck command. In addition, message KAVB5822-W will be output after the definition file for extended event attributes (extended file) is loaded when you restart JP1/IM - Manager or execute the jco_spmd_reload command.

#: When the jcoevtreport command generates reports successfully or when the jcoattrfcheck command checks the definition file completely, the return value of the commands is 0 (normal end), regardless of whether message KAVB5802-W or KAVB5821-W was output.

If you use extended files for multiple languages in JP1/IM - Manager, all the attribute names specified in the definition files for extended event attributes (extended files) must match. Otherwise, message KAVB5820-W will be output after the definition file for extended event attributes (extended file) is loaded when you execute the jcoevtreport or jcoattrfcheck command. In addition, message KAVB5822-W will be output after the definition file for extended event attributes (extended file) is loaded when you restart JP1/IM - Manager or execute the jco_spmd_reload command.

title=item-name

Defines the item name of the program-specific extended attribute. item-name is expressed in characters that can be represented in the character encoding specified in the @encode statement. item-name might appear garbled in JP1/IM - View if it uses characters that cannot be represented in the character encoding specified in the @encode statement.

In addition, item-name might appear garbled in CSV files if it uses characters that cannot be represented in the character encoding of the report output by the jcoevtreport command.

Specify a character string that will serve as the program-specific extended attribute's item name for display on the screen and output in event reports. Half-width kana characters and the comma (,) cannot be used in this parameter. If half-width kana characters and the comma (,) are specified in the character string, they will not be output correctly.

The maximum length of item-name is 255 bytes. If you specify more than 255 bytes for item-name, message KAVB5803-W will be output when you check the definition file with the jcoattrfcheck command or execute the jcoevtreport command. In addition, message KAVB5822-W will be output after the definition file for extended event attributes (extended file) is loaded when you restart JP1/IM - Manager or execute the jco_spmd_reload command.

Note:

If you specify program-specific extended attributes in the definition file for extended event attributes (extended file) that overlap with the attributes in the standard definition file for extended event attributes (default.conf), the program-specific extended attribute item names specified in the standard definition file for extended event attributes (default.conf) will be displayed in the list of events in the Event Console window and will be output in the CSV header that is output with event reports.

Example definition

The following shows an example of a definition file for extended event attributes (extended file):

@encode UTF-8
@file type="extended-attributes-definition", version="0300";
@define-block type="event-attr-def";
attr name="E.SYSTEM",    title="System name";
attr name="E.ROLE",     title="Server role";
@define-block-end;

Common-exclusion-conditions extended definition file

Format

DESC_VERSION=file-version
# comment-line
def conditions-group-name
    [cmt comment]
    id conditions-group-ID
    [valid {true | false}]
    [ex-target Exclusion target]
    [date start-date-end-date]
    [rtime start-time-end-time]
    [week day-of-week]
    cnd
        event-condition
    end-cnd
end-def

def conditions-group-name-2
...
end-def
   :

File

Use any file.

Storage directory

In Windows

Any folder

In UNIX

Any directory

Description

This file defines the event conditions or the applicable period of the extended-mode common exclusion-conditions.

Use the language encoding that is used by JP1/IM - Manager to specify this file.

In the following cases, the backup file for the common-exclusion-conditions extended definition file is output as common_exclude_filter_backup.conf.

An error is still found in a regular expression after the operation mode of common exclusion-conditions is switched from the basic mode to the extended mode by the jcochcefmode command.

When the operation mode is changed from the extended mode to the basic mode.

For details about the jcochcefmode command and the backup file for the common-exclusion-conditions extended definition file, see jcochcefmode in Chapter 1. Commands.

Note that if the event acquisition filter (for compatibility) is used, common exclusion-conditions cannot be used. If the event acquisition filter (for compatibility) is used, use the jcochafmode command to switch to event acquisition filters. For details about the jcochafmode command, see jcochafmode (UNIX only) in Chapter 1. Commands.

The maximum size of the common-exclusion-conditions extended definition file is 15 megabytes in Shift JIS code.

Note that the maximum size is the total of the common-exclusion-conditions extended definition file and the additional common exclusion conditions. Therefore, if you write definitions so that the common-exclusion-conditions extended definition file is 15 megabytes in JIS code, you cannot add the additional common exclusion definition conditions.

When the definitions are applied

The definitions take effect when the -ef option of the jcochfilter command is specified. For details about the jcochfilter command, see jcochfilter in Chapter 1. Commands.

Information that is specified

DESC_VERSION=file-version

Indicates the version of the extended definition file for the common exclusion-conditions. 1 or 2 can be specified. If this parameter is omitted, 1 is assumed.

# comment-line

A line beginning with a hash mark (#) is treated as a comment.

def to end-def (definition block)

These are the start and end parameters of the definition for the extended-mode common exclusion-conditions. The block from def to end-def can be omitted. After def, specify the name of the extended-mode common exclusion-conditions group. If you specify "defΔconditions-group-name-1Δconditions-group-name-2Δ", "Δconditions-group-name-1Δconditions-group-name-2Δ" will be the definition name (Δ indicates a space).

Specify conditions-group-name so that it is unique within the common-exclusion-conditions extended definition file. You can specify a character string of 1 to 50 bytes in Shift JIS. The characters you can specify are characters other than control characters (0x00 to 0x1F, 0x7F to 0x9F).

A maximum of 2,500 definition blocks can be written.

Note that the maximum number is the total of the number of definition blocks written in the common-exclusion-conditions extended definition file and the number of additional common exclusion condition groups. Therefore, if you write 2,500 definition blocks in the common-exclusion-conditions extended definition file, you cannot create an additional common exclusion condition group.

cmt comment

Provides an explanation of the extended-mode common exclusion-conditions. This parameter can be omitted. Specify a character string of 1 to 1,024 bytes in Shift JIS code for the comment. Specifiable characters are other than control characters (0x00 to 0x1F, 0x7F to 0x9F).

id conditions-group-ID

Specifies the conditions group ID of the extended-mode common exclusion-conditions. You can specify a value from 0 to the maximum number of definitions minus 1. This parameter cannot be omitted.

The IDs you can specify for the id parameter is from 0 to 2,499.

valid {true | false}

Specifies whether to enable the extended-mode common exclusion-conditions.

This parameter is not case sensitive. If this parameter is omitted, true is assumed.

ex-target Exclusion target

Specifies the target of the exclusion. Specify the character string action in the exclusion-target to exclude JP1 events that satisfy a common exclusion-condition from automated-action execution. The character string is not case sensitive. If this parameter is omitted, JP1 events that satisfy a common exclusion-condition are excluded from the target to be collected. Only one occurrence of this parameter is allowed for each definition block. Note that this parameter is available only when the version of the common exclusion-conditions extended definition file is 2.

date start-date-end-date

Specifies the period during which the extended-mode common exclusion-conditions apply. This parameter can be omitted. Specify this parameter in the following format:

dateΔYYYYMMDD-YYYYMMDD

Legend: Δ: A space

The specifiable period is from 1970/01/01 to 2038/01/19.

If this parameter is omitted, the extended-mode common exclusion-conditions always apply.

If the start date is omitted, the extended-mode common exclusion-conditions apply from the time they are defined until the end date. To omit the start date, specify only the end date in the following format:

dateΔ-YYYYMMDD

Legend: Δ: A space

If the end date is omitted, the conditions apply continuously from the start date. To omit the end date, specify only the start date using one of the following formats:

dateΔYYYYMMDD

dateΔYYYYMMDD-

Legend: Δ: A space

For details about the applicable period, see 4.2.7 Common exclusion-conditions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

rtime start-time-end-time

Specifies the time during which the extended-mode common exclusion-conditions apply. This parameter can be omitted. Specify this parameter in the following format:

rtimeΔHHMM-HHMM

Legend: Δ: A space

If this parameter is omitted, 9:00 is assumed as the start time, and the end time will be 24 hours after that time. The start time cannot be omitted. If the end time is omitted, the conditions apply for 24 hours from the start time.

To omit the end time, specify only the start time using one of the following formats:

rtimeΔHHMM

rtimeΔHHMM-

Legend: Δ: A space

The time you can specify for the start time and the end time is from 00:00 to 23:59.

If you specify an end time earlier than the start time, the end time is treated as the time of the following day. Alternatively, if the same time is specified for the start time and the end time, the end time is treated as the time of the following day.

The following table lists the omission patterns of the parameter end time.

Table 2‒28: Omission patterns of the end time for the rtime parameter

No.

Omission pattern

Description

1

rtimeΔstart-time

Applied within 24 hours from the start time

2

rtimeΔstart-time-

3

rtimeΔstart-time-end-time

Applied from the start date to the end date.

Legend:

Δ: Single-byte space

Specify the start time and the end time in the HHMM format. Specify the hour for HH, and the minute for MM.

The application period includes the start time but not the end time. For example, if you specify Monday, and set the start time to 21:00 and the end time to 03:00, the application period is from 21:00:00 on Monday through 02:59:59 on Tuesday (the following day).

For details about the applicable period, see 4.2.7 Common exclusion-conditions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

week day-of-week

Specifies a day of the week on which the extended-mode common exclusion-conditions apply. This parameter can be omitted. To specify two or more days of the week, separate the days by a comma (,). Use the following format:

weekΔ0,1,2,3,4,5,6

Legend: Δ: A space

Days of the week correspond to the following numeric values:

Sunday: 0

Monday: 1

Tuesday: 2

Wednesday: 3

Thursday: 4

Friday: 5

Saturday: 6

If the day of the week is omitted, all days of the week are assumed.

For details about the applicable period, see 4.2.7 Common exclusion-conditions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

cnd to end-cnd (event condition block)

These parameters mark the start and end of the block that specifies the event conditions of the extended-mode common exclusion-conditions. An event condition block must be specified in a definition block. It cannot be omitted. A tab or a space before or after the cnd and end-cnd parameters is ignored.

You cannot specify multiple event condition blocks for one definition block.

event-condition

Specifies the conditions for excluding JP1 events by means of the extended-mode common exclusion-conditions. You can specify from 0 to 256 event conditions for the event condition block. The event conditions are connected with the AND condition. The following shows how JP1 event conditions are specified:

attribute-nameΔcomparison-keywordΔoperand

Legend: Δ: A space

Note that a line that contains only spaces and tabs is ignored, and processing continues.

attribute-name

Specifies the name of the attribute you want to compare. To specify a basic attribute, prefix the name with B.. To specify an extended attribute (common information) or an extended attribute (program-specific information), prefix the name with E.. The attribute name is case sensitive.

The following table lists and describes the combinations of attribute names and comparison keywords and the operands that can be specified.

Table 2‒29: Combinations of attribute names and comparison keywords and the operands that can be specified

No.

Item

Attribute name

Comparison keyword

Operand

1

Event ID

B.ID

Match

Do not match

Specifies the event ID of a JP1 event.

A maximum of 100 event IDs can be specified.

Specify the event IDs in hexadecimal notation.

Event IDs are not case sensitive.

The permitted range is from 0 to 7FFFFFFF.

2

Reason for registration

B.REASON

Match

Do not match

Specifies the reason for registration of a JP1 event.

A maximum of 100 reasons can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

3

Source process ID

B.PROCESSID

Match

Do not match

Specifies the source process ID of the JP1 event source application.

A maximum of 100 source process IDs can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

4

Registered time

B.TIME

Time range

Specifies the time that a JP1 event was registered in the event database on the source host.

Specify the time of an environment in which JP1/IM - Manager is running.

Specify the start date and time and the end date and time of the range or the period.

Comparison is possible when start-date-and-time-of-the range≤time≤end-date-and-time-of-the range is true.

5

Arrived time

B.ARRIVEDTIME

Time range

Specifies the time that the JP1 event was registered in the event database on the manager host.

Specify the time of an environment in which JP1/IM - Manager is running.

Specify the start date and time and the end date and time of the range or the period.

6

Source user ID

B.USERID

Match

Do not match

Specifies the user ID of the JP1 event source process.

A maximum of 100 source user IDs can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

7

Source group ID

B.GROUPID

Match

Do not match

Specifies the group ID of the JP1 event source process.

A maximum of 100 source group IDs can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

8

Source user name

B.USERNAME

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the user name of the JP1 event source process.

A maximum of 100 source user names can be specified. However, if a regular expression is specified, only one source user name is allowed.

The source user name is case sensitive

9

Source group name

B.GROUPNAME

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the group name of the JP1 event source process.

A maximum of 100 source group names can be specified. However, if a regular expression is specified, only one source group name is allowed.

The source group name is case sensitive.

10

Source IP address

B.SOURCEIPADDR

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the IP address of the event-issuing server for a JP1 event.

A maximum of 100 source IP addresses can be specified. However, if a regular expression is specified, only one source IP address is allowed.

Specify four-digit values in hexadecimal for an IPv6 address as shown below by using 0 to 9 and a to f. a to f must be lowercase.

Example: 0011:2233:4455:6677:8899:aabb:ccdd:eeff

Uppercase letters, an IPv4-mapped address, an IPv4 compatible address, and an abbreviated IPv6 address cannot be specified.

11

Event-issuing server name (source host)#

B.SOURCESERVER

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the source host (event server name) of a JP1 event.

A maximum of 100 event-issuing server names can be specified. However, if a regular expression is specified, only one event-issuing server name is allowed.

The event-issuing server name is case sensitive.

12

Message

B.MESSAGE

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Sets the message of a JP1 event.

A maximum of 100 messages can be specified. However, if a regular expression is specified, only one message can be specified.

The message is case sensitive.

13

Event level

(if the severity changing function is enabled, specifies the event level before the change)

E.SEVERITY

defined

notdefined

Match

Specifies whether an event level exists and the JP1 event type.

When the comparison keyword is Match, two or more of the following event levels can be specified: Emergency, Alert, Critical, Error", Warning, Notice, Information, and Debug.

14

User name

E.USER_NAME

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the name of the user who issued a JP1 event.

A maximum of 100 user names can be specified. However, if a regular expression is used, only one user name is allowed.

The user name is case sensitive.

15

Product name

E.PRODUCT_NAME

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the name of the program that issued a JP1 event.

A maximum of 100 product names can be specified. However, if a regular expression is used, only one product name is allowed.

The produce name is case sensitive.

16

Object type

E.OBJECT_TYPE

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the type of a JP1 event object.

A maximum of 100 object types can be specified. However, if a regular expression is used, only one object type is allowed.

The object type is case sensitive.

17

Object name

E.OBJECT_NAME

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the name of a JP1 event object.

A maximum of 100 object names can be specified. However, if a regular expression is used, only one object name is allowed.

The object name is case sensitive.

18

Root object type

E.ROOT_OBJECT_TYPE

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the root object type of a JP1 event.

A maximum of 100 root object types can be specified. However, if a regular expression is used, only one root object type is allowed.

The root object type is case sensitive.

19

Root object name

E.ROOT_OBJECT_NAME

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the root object name of a JP1 event.

A maximum of 100 root object names can be specified. However, if a regular expression is used, only one root object name is allowed.

The root object name is case sensitive.

20

Object ID

E.OBJECT_ID

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the object type of a JP1 event.

A maximum of 100 object IDs can be specified. However, if a regular expression is used, only one object ID is allowed.

The object ID is case sensitive.

21

Occurrence

E.OCCURRENCE

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the occurrence of a JP1 event.

A maximum of 100 occurrences can be specified. However, if a regular expression is used, only one occurrence is allowed.

The occurrence is case sensitive.

22

Start time

E.START_TIME

Time range

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the time to start or restart execution of a JP1 event.

When the comparison keyword is Time range:

- Specify the start date and time and the end date and time of the range or the period.

- Comparison is possible when start-date-and-time-of-the range≤time≤end-date-and-time-of-the range is true.

- When the attribute to be compared is a decimal value, the attribute is compared as the total number of seconds.

When the comparison keyword is not Time range:

- A maximum of 100 start times can be specified. However, if a regular expression is specified, only one start time name is allowed.

- Compare using a comparison keyword for which an operand is specified as a character string.

23

End time

E.END_TIME

Time range

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the time for ending execution of a JP1 event.

When the comparison keyword is Time range:

- Specify the start date and time and the end date and time of the range or the period.

- Comparison is possible when start-date-and-time-of-the range≤time≤end-date-and-time-of-the range is true.

- When the attribute to be compared is a decimal value, the attribute is compared as the total number of seconds.

When the comparison keyword is not Time range:

- A maximum of 100 end times can be specified. However, if a regular expression is specified, only one end time is allowed.

- Compare using a comparison keyword for which an operand is specified as a character string.

24

Return code

E.RESULT_CODE

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the return code of a JP1 event.

A maximum of 100 return codes can be specified. However, if a regular expression is used, only one return code is allowed.

The return code is case sensitive.

25

Event source host name#

E.JP1_SOURCEHOST

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the host name of the event source host for a JP1 event.

A maximum of 100 event source host names can be specified. However, if a regular expression is specified, only one event source host name is allowed.

The event source host name is case sensitive.

26

Extended attribute

E.xxxxxxx

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

Specifies the attribute name of the extended attribute for a JP1 event.

For the attribute name, you can specify a name with a maximum length of 32 bytes that begins with an uppercase letter and consists of uppercase letters, numeric characters, and the underscore (_).

A maximum of 100 extended attributes can be specified. However, if a regular expression is specified, only one extended attribute is allowed.

The extended attribute is case sensitive.

#

If the integrated monitoring database and the IM Configuration Management database are enabled, and the comparison keyword is Match or Do not match, you can specify a business group name in a path format.

If the integrated monitoring database and the IM Configuration Management database are disabled, and a comparison keyword other than Match and Do not match is selected, a business group name specified in a path format is treated as a host name.

If the -ignorecasehost option of the jcoimdef command is set to ON, and a comparison keyword other than Regular expression is selected, the character string is no longer case sensitive.

comparison-keyword

Specifies BEGIN (begins with), IN (matches), NOTIN (does not match), SUBSTR (includes), NOTSUBSTR (does not include), or REGEX (regular expression), TRANGE (time range), DEFINED (defined), or NOTDEFINED (not defined) as the comparison keyword. The comparison keyword is case sensitive.

To use the TRANGE (time range) comparison keyword, specify it as shown in the following table.

Table 2‒30: Format for specifying TRANGE

Comparison method

Format

Specifiable range

Specification example

Specifying date and time

start-date-and-timeΔend-date-and-time

start-date-and-time≤ attribute-value≤end-date-and-time

When May 1, 2018, 00:00:00 to May 31, 2018, 23:59:59 is

specified:

20180501000000 20180531235959

Specifying a period

xx minutes ago

base-timeΔ - period (minutes) MIN

base-time - period (minutes)≤attribute-value≤base-time

To specify the period from 330 minutes earlier than May 1, 2018, 00:00:00 to the base time:

20180501000000 -330MIN

xx minutes later

base-timeΔ + period (minutes) MIN

base-time≤attribute-value≤base-time + period (minutes)

To specify the period from May 1, 2018, 00:00:00 to 330 minutes later than the base time:

20180501000000 +330MIN

xx hours ago

base-timeΔ - period (hours) HOUR

base-time - period (hours)≤attribute-value≤base-time

To specify the period from 120 hours earlier than May 1, 2018, 00:00:00 to the base time:

20180501000000 -120HOUR

xx hours later

base-timeΔ + period (hours) HOUR

base-time≤attribute-value≤base-time + period (hours)

To specify the period from May 1, 2018, 00:00:00 to 120 hours later than the base time:

20180501000000 +120HOUR

xx days ago

base-timeΔ - period (days) DAY

base-time - period (days)≤attribute-value≤base-time

To specify the period from 180 days earlier than May 1, 2018, 00:00:00 to the base time:

20180501000000 -180DAY

xx days later

base-timeΔ + period (days) DAY

base-time≤attribute-value≤base-time + period (days)

To specify the period from May 1, 2018, 00:00:00 to 180 days later than the base time:

20180501000000 +180DAY

Legend:

Δ: A space

Specify the start date and time, the end date and time, and the base time in YYYYMMDDhhmmss format. The period (minutes, hours, and days) must be specified as a numeric value from 1 to 9,999. MIN, HOUR, and DAY are case sensitive.

An error results if you specify a period and the calculated date and time from the base time does not fall in an acceptable time range (from UTC 1970-01-01

00:00:00 to UTC 2038-01-19 03:14:07).

Operand

Specifies a character string as the value to be compared with the attribute value specified by the comparison keyword. The operand is case sensitive.

If you specify two or more operands, separate them by one or more consecutive spaces or tabs. The OR condition is applied to the specified operands. Note that if a regular expression is specified, only one operand is allowed.

If you want to specify a space, a tab, an end-of-line code (CR or LF), or % as part of an operand, use the format shown in the table below. Note also that during maximum value checking for the definition format, each of these values is treated as a single character.

There is no limit on the maximum length of the operand. However, for Shift-JIS, the maximum number of event conditions (attribute name, comparison keyword, and operand) in cnd to end-cnd (event condition block) is 65,536 bytes.

No.

Value to be specified

How to specify

1

Tab (0x09)

%09

2

Space (0x20)

%20

3

% (0x25)

%25

4

Linefeed LF (0x0a)

%0a

5

Linefeed CR (0x0d)

%0d

Note:

Relationship between the values of date, rtime, and week

When date, rtime, and week are set, the common exclusion-condition is enabled on every week day of week during a period of days specified in date from the start time to the end time specified in rtime.

When the end time of rtime indicates a time on the next day, the common exclusion-condition remains enabled until the end time on the next day.

For details about the applicable period, see 4.2.7(4) Applicable period of a common exclusion-condition in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

Example definition

When the following conditions exist, the example definition excludes events during the period from 2010/10/01 to 2010/10/31 on Mondays through Saturdays from 10:00 to 12:00:

The event ID matches 1.

The event level is Emergency or Alert.

The registered host is specified with a regular expression as follows:

host[0-9][0-9]

DESC_VERSION=1
# comment
def common-exclusion-conditions-group-1
    cmt expiration: 2010/10/31
    id 1
    valid true
    date 20101001-20101031
    week 1,2,3,4,5,6
    rtime 1000-1200
    cnd
        B.ID IN 00000001
        E.SEVERITY IN Emergency Alert
        B.SOURCESERVER REGEX host[0-9][0-9]
    end-cnd
end-def

The definition example below excludes events from automated-action execution from 23:00 to next day 02:00 on every Monday through Saturday during the period between April 1, 2017 and May 1, 2017 when the following conditions are true:

The event ID is 2.

The severity is Emergency or Alert.

The source host matches the following regular expression:

host[0-9][0-9]

DESC_VERSION=2
# comment
def common-exclusion-conditions-group-1
    cmt expiration: 2017/05/01
    id 1
    valid true
    ex-target action
    date 20170401-20170501
    week 1,2,3,4,5,6
    rtime 2300-0200
    cnd
        B.ID IN 00000002
        E.SEVERITY IN Emergency Alert
        B.SOURCESERVER REGEX host[0-9][0-9]
    end-cnd
end-def

Common-exclusion-conditions display item definition file (common_exclude_filter_attr_list.conf)

Format

# comment-line
attribute-name
attribute-name
attribute-name
  .
  .
  .
attribute-name

File

common_exclude_filter_attr_list.conf (common-exclusion-conditions display item definition file)

common_exclude_filter_attr_list.conf.model (model file for the common-exclusion-conditions display item definition file)

Storage directory

In Windows

For a physical host:

Console-path\conf\console\filter\attr_list

For a logical host:

shared-folder\jp1cons\conf\console\filter\attr_list

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/filter/attr_list

For a logical host:

shared-directory/jp1cons/conf/console/filter/attr_list

Description

This definition file specifies the items that are to be displayed in the Attribute name display area of the Common Exclusion-Conditions Settings (Extended) window. The display items specified in the common-exclusion-conditions display item definition file are displayed in the Attribute name display area of the Common Exclusion-Conditions Settings (Extended) window in the order they are specified.

When the definitions are applied

The definitions take effect when Central Console is started or when the definitions are reloaded by executing the jco_spmd_reload command.

Information that is specified

#comment-line

A line beginning with a hash mark (#) is treated as a comment.

attribute-name

The items to be displayed in the Attribute name display area of the Common Exclusion-Conditions Settings (Extended) window are specified in the common-exclusion-conditions display item definition file. Write one attribute name corresponding to a display item on each line. A maximum of 0 to 256 display items can be specified.

The attribute name is case sensitive. Space and tab characters specified at the beginning or the end of the attribute name are ignored.

If you specify SEPARATOR, a horizontal line, such as --------------------, is displayed in the Attribute name display area of the Common Exclusion-Conditions Settings (Extended) window. You can use SEPARATOR to separate frequently used items from those used less frequently.

However, if you specify only SEPARATOR, only -------------------- is displayed in the Attribute name display area. If you then select --------------------, you will be unable to set the attribute name.

The following table lists the specifiable attribute names.

Table 2‒31: List of display items

No.

Display item

Attribute name

1

Event source host name#

E.JP1_SOURCEHOST

2

Registered host name

B.SOURCESERVER

3

Event level

E.SEVERITY

4

Object type

E.OBJECT_TYPE

5

Object name

E.OBJECT_NAME

6

Root object type

E.ROOT_OBJECT_TYPE

7

Root object name

E.ROOT_OBJECT_NAME

8

Occurrence

E.OCCURRENCE

9

User name

E.USER_NAME

10

Message

B.MESSAGE

11

Product name

E.PRODUCT_NAME

12

Event ID

B.ID

13

Start time

E.START_TIME

14

End time

E.END_TIME

15

Registered time

B.TIME

16

Arrived time

B.ARRIVEDTIME

17

Extended attribute

OTHER_EXTENDED_ATTRIBUTE

18

Reason for registration

B.REASON

19

Source process ID

B.PROCESSID

20

Source user name

B.USERNAME

21

Source user ID

B.USERID

22

Source group name

B.GROUPNAME

23

Source group ID

B.GROUPID

24

Source IP address

B.SOURCEIPADDR

25

Object ID

E.OBJECT_ID

26

Return code

E.RESULT_CODE

27

--------------------

SEPARATOR

Note:

If the same attribute name is specified twice, both specifications are ignored.

Also, if the common-exclusion-conditions display item definition file cannot be read, and the number of valid display items is 0, items 1 to 26 are displayed.

#

If the event source host mapping function is not enabled, the item is not displayed in the Common Exclusion Condition Settings (Extended) window.

Common-exclusion-conditions auto-input definition file (common_exclude_filter_auto_list.conf)

Format

# comment
[DEFAULT_NAME common-exclusion-conditions-group-name]
attribute-name
attribute-name
  .
  .
attribute-name
attribute-name

File

common_exclude_filter_auto_list.conf

common_exclude_filter_auto_list.conf.model (model file for the common-exclusion-conditions auto-input definition file)

Storage directory

In Windows

For a physical host:

Console-path\conf\console\filter\auto_list

For a logical host:

shared-folder\jp1cons\conf\console\filter\auto_list

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/filter/auto_list

For a logical host:

shared-directory/jp1cons/conf/console/filter/auto_list

Description

This file defines the JP1 event attributes that are set automatically when the Common Exclusion-Conditions Settings (Extended) window opens. The window opens when a JP1 event is selected from the list of events in the Event Console window, and then View - Exclude by Common Exclusion-Conditions is chosen. You can also define a default name for the additional common exclusion conditions group.

When the definitions are applied

The definitions take effect when Central Console is started or when the definitions are re-read by executing the jco_spmd_reload command.

Information that is specified

DEFAULT_NAME common-exclusion-conditions-group-name

Specifies the identifier that defines the common exclusion conditions group name. The identifier must be on the first line in the file (the first line in the file that is not a null line or a comment line).

The common exclusion conditions group name specified for this parameter is displayed as the initial value when the Common Exclusion-Conditions Settings (Extended) window opens. The window opens when a JP1 event from the list of event in the Event Console window, and then View - Exclude by Common Exclusion-Conditions is chosen.

For the name, specify a character string with a maximum of 40 bytes. You can specify any character that is not a control character (0x00 to 0x1F, 0x7F to 0x9F). If a name with more than 40 bytes is specified, characters from the 41st are dropped, and the first 40 bytes of the character string are used as the common exclusion-conditions group name. If this parameter is omitted, Add common exclusion conditions group is assumed as the common exclusion-conditions group name.

#comment-line

A line beginning with a hash mark (#) is treated as a comment.

attribute-name

For the common-exclusion-conditions auto-input definition file, specify the attribute of a JP1 event that is to be set as an event condition when the Common Exclusion-Conditions Settings (Extended) window opens. The Common Exclusion-Conditions Settings (Extended) window opens when a JP1 event from the list of JP1 events in the Event Console window is selected, and then View - Exclude by Common Exclusion-Conditions is chosen. The condition for the attribute name specified for this parameter is displayed as the initial value when the Common Exclusion-Conditions Settings (Extended) window opens. The window opens when a JP1 event from the list of JP1 events in the Event Console window is selected, and then View - Exclude by Common Exclusion-Conditions is chosen.

For the definition items, write on each line one attribute name of a JP1 event that will be set.

The attribute name is case sensitive. Any space or tab character at the beginning or at the end of the attribute name is ignored.

If the same attribute name is specified twice, it is ignored, and the KAVB1160-W message is output to the integrated trace log file.

The order of JP1 events to be displayed automatically in the Event conditions section of the Common Exclusion-Conditions Settings (Extended) window is determined by the order in which the attributes are written in the common-exclusion-conditions display item definition file (common_exclude_filter_attr_list.conf).

The following table lists the attribute names that can be specified.

Table 2‒32: List of display items

No.

Display item

Attribute name

1

Event source host name

E.JP1_SOURCEHOST

2

Registered host name

B.SOURCESERVER

3

Event level

E.SEVERITY

4

Object type

E.OBJECT_TYPE

5

Object name

E.OBJECT_NAME

6

Root object type

E.ROOT_OBJECT_TYPE

7

Root object name

E.ROOT_OBJECT_NAME

8

Occurrence

E.OCCURRENCE

9

User name

E.USER_NAME

10

Message

B.MESSAGE

11

Product name

E.PRODUCT_NAME

12

Event ID

B.ID

13

Reason for registration

B.REASON

14

Source process ID

B.PROCESSID

15

Source user name

B.USERNAME

16

Source user ID

B.USERID

17

Source group name

B.GROUPNAME

18

Source group ID

B.GROUPID

19

Source IP address

B.SOURCEIPADDR

20

Object ID

E.OBJECT_ID

21

Return code

E.RESULT_CODE

Note:

If the same attribute name is specified twice, both specifications are ignored.

Also, if the common-exclusion-conditions auto-input definition file cannot be read, and the number of valid display items is 0, items 1 to 3 and items 10 to 12 are displayed.

Display item definition file for the repeated event condition (event_storm_attr_list.conf)

Format

# comment
attribute-name
attribute-name
  .
attribute-name

File

event_storm_attr_list.conf (Display item definition file for the repeated event condition)

event_storm_attr_list.conf.model (model file for the display item definition file for the repeated event condition)

Storage directory

In Windows

For a physical host:

Console-path\conf\console\event_storm\attr_list

For a logical host:

shared-folder\jp1cons\conf\console\event_storm\attr_list

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/event_storm/attr_list

For a logical host:

shared-directory/jp1cons/conf/console/event_storm/attr_list

Description

Specifies the items to be displayed in the Attribute name display area of the Repeated Event Condition Settings window. The items are displayed in this area in the order in which they are specified in the file.

When the definitions are applied

The contents of the definition file take effect when Central Console is started and when the definitions are read again by executing the jco_spmd_reload command.

Information that is specified

#comment-line

A line beginning with a hash mark (#) is treated as a comment.

attribute-name

In the display item definition file for the repeated event condition, specify an item to be displayed in the Attribute name display area of the Repeated Event Condition Settings window. Specify the attribute names of the items you want to be displayed by specifying one item per line. You can specify from 0 to 256 items.

An attribute name is case sensitive. Any space or tab characters immediately preceding or following the attribute name will be ignored.

If you specify SEPARATOR, a horizontal line like -------------------- is displayed in the Attribute name display area of the Repeated Event Condition Settings window. You can use SEPARATOR to separate items used frequently from those used infrequently.

However, if you specify only SEPARATOR, only -------------------- is displayed in the Attribute name display area. If you then select --------------------, you will be unable to set the attribute name.

The following table lists the attribute names that can be specified.

Table 2‒33: List of display items

No.

Display item

Attribute name

1

Event source host name#

E.JP1_SOURCEHOST

2

Registered host name

B.SOURCESERVER

3

Event level

E.SEVERITY

4

Object type

E.OBJECT_TYPE

5

Object name

E.OBJECT_NAME

6

Root object type

E.ROOT_OBJECT_TYPE

7

Root object name

E.ROOT_OBJECT_NAME

8

Occurrence

E.OCCURRENCE

9

User name

E.USER_NAME

10

Message

B.MESSAGE

11

Product name

E.PRODUCT_NAME

12

Event ID

B.ID

13

Start time

E.START_TIME

14

End time

E.END_TIME

15

Registered time

B.TIME

16

Arrived time

B.ARRIVEDTIME

17

Program-specific extended attribute

OTHER_EXTENDED_ATTRIBUTE

18

Reason for registration

B.REASON

19

Source process ID

B.PROCESSID

20

Source user name

B.USERNAME

21

Source user ID

B.USERID

22

Source group name

B.GROUPNAME

23

Source group ID

B.GROUPID

24

Source IP address

B.SOURCEIPADDR

25

Object ID

E.OBJECT_ID

26

Result code

E.RESULT_CODE

27

--------------------

SEPARATOR

Note:

If an attribute name is specified twice, both specifications are ignored.

Also, if the display item definition file for the repeated event condition cannot be read, and the number of valid display items is 0, items 1 to 26 are displayed.

#

If the user mapping function of the event source host is not enabled, this item is not displayed in the Repeated Event Condition Settings window.

Auto-input definition file for the repeated event condition (event_storm_auto_list.conf)

Format

# comment
[DEFAULT_NAME repeated-event-condition-name]
attribute-name
attribute-name
  .
  .
attribute-name
attribute-name

File

event_storm_auto_list.conf

event_storm_auto_list.conf.model (model file for the auto-input definition file for the repeated event condition)

Storage directory

In Windows

For a physical host:

Console-path\conf\console\event_storm\auto_list

For a logical host:

shared-folder\jp1cons\conf\console\event_storm\auto_list

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/event_storm/auto_list

For a logical host:

shared-directory/jp1cons/conf/console/event_storm/auto_list

Description

This file defines the JP1 event attributes that are set automatically when the Repeated Event Condition Settings window opens. The window opens when the user selects a JP1 event from the list of events in the Event Console window and then chooses Display - Suppress by Repeated Event Conditions. You can also define a default name for the repeated event condition.

When the definitions are applied

The contents of the definition file take effect when Central Console is started and when the definitions are re-loaded by executing the jco_spmd_reload command.

Information that is specified

DEFAULT_NAME repeated-event-condition-name

Indicates the identifier that defines the repeated event condition name. The identifier must be on the first line in the file (more specifically, the first line in the file that is not a null line or a comment line).

The common exclusion conditions group name specified for this parameter is displayed as the initial value when the Repeated Event Condition Settings window opens. The window opens when the user selects a JP1 event from the list of events in the Event Console window and then chooses Display - Suppress by Repeated Event Conditions.

For the name, you can specify a character string that does not exceed 40 bytes. You can specify any character that is not a control character (0x00 to 0x1F, 0x7F to 0x9F). If a name with more than 40 bytes is specified, characters from the 41st are dropped, and the first 40 bytes of the character string are used as the repeated event condition name. If this parameter is omitted, additional-repetition-event-condition is assumed as the repeated event condition name.

#comment-line

A line beginning with a hash mark (#) is treated as a comment.

attribute-name

In the auto-input definition file for the repeated event condition, specify a JP1 event attribute to be set as an event condition when the Repeated Event Condition Settings window opens. The window opens when the user selects a JP1 event from the list of events in the Event Console window, and then chooses Display - Suppress by Repeated Event Conditions. The condition of the attribute name specified for this parameter is displayed as the initial value when the Repeated Event Condition Settings window opens. The window opens when the user selects a JP1 event from the list of events in the Event Console window, and then chooses Display - Suppress by Repeated Event Conditions.

Specify the attribute names of items that are to be set as definition items by specifying one item per line.

An attribute name is case sensitive. Any space or tab characters immediately preceding or following the attribute name will be ignored.

If the same attribute is specified twice, both specifications are ignored, and the KAVB1896-W message is output to the integrated trace log file.

The order of JP1 events that are displayed automatically in the Event conditions section of the Repeated Event Condition Settings window is determined by the order in which the attribute names are written in the display item definition file for the repeated event condition (event_storm_attr_list.conf).

The following table lists the attribute names that can be specified.

Table 2‒34: List of display items

No.

Display item

Attribute name

1

Event source host name

E.JP1_SOURCEHOST

2

Registered host name

B.SOURCESERVER

3

Event level

E.SEVERITY

4

Object type

E.OBJECT_TYPE

5

Object name

E.OBJECT_NAME

6

Root object type

E.ROOT_OBJECT_TYPE

7

Root object name

E.ROOT_OBJECT_NAME

8

Occurrence

E.OCCURRENCE

9

User name

E.USER_NAME

10

Message

B.MESSAGE

11

Product name

E.PRODUCT_NAME

12

Event ID

B.ID

13

Reason for registration

B.REASON

14

Source process ID

B.PROCESSID

15

Source user name

B.USERNAME

16

Source user ID

B.USERID

17

Source group name

B.GROUPNAME

18

Source group ID

B.GROUPID

19

Source IP address

B.SOURCEIPADDR

20

Object ID

E.OBJECT_ID

21

Result code

E.RESULT_CODE

Note:

If the same attribute name is specified twice, both specifications are ignored.

Also, if the auto-input definition file for the repeated event condition cannot be read, and the number of valid display items is 0, items 1 to 3 and items 10 to 12 are displayed.

Status event definition file (processupdate.conf)

Format

[PROCESSUPDATE]
PROCESS_UPDATE_EVENT_OPTION={true | false}
[End]

File

processupdate.conf (status event definition file)

processupdate.conf.model (model file for the status event definition file)

Storage directory

In Windows

For a physical host:

Console-path\conf\processupdate\

For a logical host:

shared-folder\jp1cons\conf\processupdate\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/processupdate/

For a logical host:

shared-directory/jp1cons/conf/processupdate/

Description

This file defines whether a JP1 event is to be issued when the action status changes.

When the definitions are applied

The setting specified in the status event definition file takes effect at the following time:

When JP1/IM - Manager starts

Information that is specified

PROCESS_UPDATE_EVENT_OPTION={true | false}

Specifies whether a JP1 event (event ID: 3F11) is to be issued when the action status changes. The value is not case sensitive.

Specify true if a JP1 event is to be issued when the action status changes.

Specify false if a JP1 event is not to be issued when the action status changes. The default is false.

If this parameter is omitted or an invalid value is specified, false is assumed.

For details about JP1 events, see 3.2.2 Details of JP1 events.

Note

If you specify that a JP1 event is to be issued, one instance of the JP1 event with ID 3F11 will be issued for each JP1 event for which an action is taken. For example, if you select multiple JP1 events on the Severe Events page on the Event Console window and their action status changes, as many JP1 events with ID 3F11 will be issued as there are JP1 events whose action status has changed.

You should not enable this function when the action status of a large number of JP1 events will be changed by processing in the batch mode.

Correlation event generation system profile (egs_system.conf)

Format

VERSION=1

START_OPTION={cold | warm}

File

egs_system.conf (correlation event generation system profile)

egs_system.conf.model (model file for the correlation event generation system profile)

Storage directory

In Windows

For a physical host:

Console-path\conf\evgen\profile\

For a logical host:

shared-folder\jp1cons\conf\evgen\profile\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/evgen/profile/

For a logical host:

shared-directory/jp1cons/conf/evgen/profile/

Description

This file defines the start and stop operations for the Event Generation Service.

When the definitions are applied

The settings in the correlation event generation system profile take effect at the following times:

When JP1/IM - Manager starts

When the file is reloaded by the jco_spmd_reload command

Information that is specified

VERSION=1

Specifies the file version. There is no need to edit this parameter. If this parameter is omitted or a numeric value other than 1 is specified, VERSION=1 is assumed.

START_OPTION={cold | warm}

Specifies the startup option for the Event Generation Service.

Specify the value that corresponds to the operation to be performed during start and stop processing. The permitted values are cold and warm. The default is warm. This value is not case sensitive. If the parameter is omitted or an invalid value is specified, warm is assumed.

The operations are different depending on whether or not the integrated monitoring database is used.

The table below describes the operation of the Event Generation Service during start and stop processing depending on whether cold or warm is specified when the integrated monitoring database is not used. Change the value as appropriate to your operations.

Table 2‒35: Operation of the Event Generation Service during start and stop processing depending on the start option (when the integrated monitoring database is not used)

Start option

Operation of Event Generation Service

Operation during startup processing#1

Operation during stop processing

cold

When the start option was set to cold during the previous stop processing:

JP1 events registered after the Event Generation Service started are subject to generation processing.

All correlation events under generation processing fail and are output to the correlation event generation history file.

When the start option was set to warm during the previous stop processing:

All correlation events under generation processing fail and the JP1 events acquired since the Event Generation Service started are subject to generation processing.

warm

When the start option was set to cold during the previous stop processing:

JP1 events are subject to generation processing beginning with the one that immediately follows the last JP1 event acquired by the Event Generation Service during the previous stop processing.

Information about the last JP1 event acquired before the service stopped, details of the generation processing, and the correlation event generation definition information are output to internal logs and saved.

When the start option was set to warm during the previous stop processing:

The correlation event generation processing performed during the previous stop processing is inherited, and JP1 events are subject to generation processing beginning with the one that immediately follows the last JP1 event acquired by the Event Generation Service during the previous stop processing.#2

#1

When the Event Generation Service starts for the first time, it functions as follows, regardless of the start option value:

• The Event Generation Service acquires JP1 events that are registered after the Event Generation Service starts.

• The Event Generation Service loads the correlation event generation definition and starts processing according to the definition.

Note that the default is that correlation events are not generated because the correlation event generation definition has not been set.

#2

If the correlation event generation definition used when JP1/IM - Manager stopped differs from the definition used the next time JP1/IM - Manager starts, all correlation events under generation processing fail. After the contents are cleared, JP1 events are subject to generation processing again starting with the one that immediately follows the JP1 event acquired during the previous stop processing.

When the integrated monitoring database is used, the correlation event generation function associates the correlation event generation definition with the event acquired by the Event Base Service and then generates the correlation event.

It is possible to choose the position at which the Event Base Service is to start acquiring JP1 events from the JP1/Base event database after startup. Use the -b option to the jcoimdef command to choose where to start JP1 event acquisition.

The correlation event generation processing varies depending on the combination of the start option and the JP1 event acquisition start position, as shown in the following table.

Table 2‒36: Operation of the Event Generation Service during start and stop processing depending on the start option (when the integrated monitoring database is used)

Start option

Value of -b option

Processing

warm

-1 (default value)

The status of the JP1 events under correlation event generation processing is inherited.

JP1 event acquisition starts from the next JP1 event after the last JP1 event acquired when the service stopped. If there is no such JP1 event, acquisition starts from the oldest JP1 event among the events registered in the event database.

0 to 144

Message KAJV2316-W is output, and the status of the JP1 events under correlation event generation processing is not inherited.

cold

-1 to 144

All correlation event generation processing stops and the service terminates. The status of the JP1 events under correlation event generation processing is not inherited.

Note that when the integrated monitoring database is used, JP1 events that were once subject to correlation event generation processing are not subject to correlation event generation processing again.

If you run JP1/IM - Manager in a cluster system, change the setting to warm.

In the event of failover, products are stopped and started in the following order: stopping JP1/IM - Manager stopping JP1/Base starting JP1/Base starting JP1/IM - Manager. If failover occurs while the parameter is set to cold, the system cannot acquire JP1 events that occur during the period of stopping JP1/IM - Manager stopping JP1/Base and during the period of starting JP1/Base starting JP1/IM - Manager. Therefore, if you leave the parameter set to cold, some JP1 events that are subject to generation processing might be missed.

Correlation event generation definition file

Format

VERSION={1 | 2}

#comment-line
[generation-condition-name]
TARGET=filtering-condition-for-the-correlation-target-range
CON=event-condition
TIMEOUT=timeout-period
TYPE=event-correlation-type
SAME_ATTRIBUTE=duplicate-attribute-value-condition
CORRELATION_NUM=maximum-correlation-number
SUCCESS_EVENT=correlation-approval-event
FAIL_EVENT=correlation-failure-event

[generation-condition-name]
TARGET=filtering-condition-for-the-correlation-target-range
CON=event-condition
TIMEOUT=timeout-period
TYPE=event-correlation-type
SAME_ATTRIBUTE=duplicate-attribute-value-condition
CORRELATION_NUM=maximum-correlation-number
SUCCESS_EVENT=correlation-approval-event
FAIL_EVENT=correlation-failure-event
          :

File

Use any file. However, the following limitations apply:

The extension must be .conf.

The file name can consist of only alphanumeric characters and the underscore (_).

Storage directory

In Windows

Any folder

In UNIX

Any directory

Description

This file defines JP1 event conditions that result in generation of correlation events and the correlation events that are generated when the JP1 event conditions are satisfied. Use the language encoding that is used by JP1/IM - Manager to specify this file.

When the definitions are applied

The definitions take effect after the correlation event generation definitions are applied by the jcoegschange command.

Information that is specified

VERSION={1 | 2}

Specifies the version of the correlation event generation definition file.

Specify either 1 or 2.

If you specify 1, none of the parameters listed below can be specified. To specify all the parameters described here, specify 2 in the VERSION parameter.

Table 2‒37: Parameters that cannot be specified

Version

Parameter

1

TARGET

SAME_ATTRIBUTE

CORRELATION_NUM

2

None

Any zeros that are specified preceding the value are ignored. For example, VERSION=0001 is the same as VERSION=1. If this parameter is omitted, VERSION=1 is assumed.

If the specified value is neither 1 nor 2, a definition error results. Specifying VERSION more than once also results in a definition error.

#comment-line

A line beginning with a hash mark (#) is treated as a comment.

[generation-condition-name]

This is the start tag for a definition block that defines a correlation event generation condition. The information from the[generation-condition-name] tag to the information immediately before the next [generation-condition-name] tag constitutes one definition block. This tag cannot be omitted. You can define a maximum of 1,000 correlation event generation conditions. If more than 1,000 correlation event generation conditions are defined, a definition error occurs.

You must enclose the generation condition name in square brackets ([ ]). The generation condition name can consist of from 1 to 32 alphanumeric characters, the hyphen (-). underscore (_), and forward slash (/).

This name is case sensitive. For example, [JP1_HAKKOUZYOUKEN]is treated as being different from [jp1_hakkouzyouken].

Each generation condition name specified in the correlation event generation definition file must be unique. If the same generation condition name is specified more than once, the first name specified in the file is effective. A generation condition name cannot begin with IM_ (whether upper- or lowercase letters are used). If such a name is specified, a definition error occurs.

If you wish to specify a comment immediately following [generation-condition-name], use the format [generation-condition-name]#comment-on-generation-condition.

TARGET=filtering-condition-for-the-correlation-target-range

Specifies a filtering condition to narrow the range of JP1 events that are to be subject to generation of correlation events. If this parameter is omitted, all JP1 events that are acquired are subject to correlation event generation processing.

You can specify only one filtering condition for the correlation target range for each correlation event generation condition. If multiple filtering conditions are specified, a definition error results.

The following is the format:

- TARGET=event-attribute-condition-1[,event-attribute-condition-2...]

Separate multiple event attribute conditions with the comma (,). When multiple event attribute conditions are specified, it is assumed that they are connected with the AND condition, in which case the condition is satisfied only when a JP1 event that satisfies all the specified event attribute conditions is issued.

Specify an event attribute condition in the following format:

attribute-name comparison-condition attribute-value

The following table lists and describes the items that can be set for an event attribute condition.

Table 2‒38: Items to be set for an event attribute condition

No.

Item

Description

1

attribute-name

Specifies a JP1 event basic or extended attribute. Prefix a basic attribute with B. and an extended attribute with E.. For example, to specify a message, specify B.MESSAGE.

If you specify an extended attribute, express the character string that follows E. using from 1 to 32 bytes of characters. The following rules apply:

The character string must begin with an uppercase letter.

The character string beginning with byte 2 must be expressed using uppercase alphanumeric characters and the underscore (_).

For details about the specifiable attribute names, see Table 2-39 List of attribute names that can be specified in the filtering condition for the correlation target range.

2

comparison-condition

Specifies a comparison condition. The supported comparison conditions and their meanings are listed below. If any other comparison condition is used, a definition error results.

==: Match

!=: Does not match

^=: First characters

>=: Is contained

<=: Is not contained

*=: Regular expression

Note: For details about regular expressions, see Appendix G. Regular Expressions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

3

attribute-value

Specifies the value to be compared. You can specify a character string with a maximum of 2,048 bytes (1,023 bytes for JP1/IM - Manager version 09-10 or earlier) for an attribute value. If the value exceeds 2,048 bytes (1,023 bytes for JP1/IM - Manager version 09-10 or earlier), the definition is not valid.

When specifying multiple event attribute conditions, you can specify a maximum of 2,305 bytes (1,280 bytes for JP1/IM - Manager version 09-10 or earlier) for the total of the attribute values for all conditions. If the value exceeds 2,305 bytes (1,280 bytes for JP1/IM - Manager version 09-10 or earlier), the definition is not valid.

For example, if five event attribute conditions are specified, the total of these attributes must be equal to or smaller than 2,305 bytes (1,280 bytes for JP1/IM - Manager version 09-10 or earlier).

Separate multiple attribute values with the semicolon (;). Any number of consecutive semicolons between attribute values is treated as a single semicolon (;). For example, B.ID==A;;;;;B is treated as B.ID==A;B.

Example: If E.xxx==A;B is specified, the condition is satisfied when E.xxx matches A or B.

To use a comma (,) or semicolon (;) as an attribute value, or use a space on each end of an attribute value, enclose the part you want to use as an attribute value in double quotation marks (").

To specify a double-quotation mark (") or a backslash sign (\) in an attribute value, prefix it with a backslash sign (\).

If you specify multiple attribute values for a single attribute name, the condition is satisfied as shown in the following examples:

Example 1: If E.xxx==A;B is specified, the condition is satisfied when E.xxx matches A or B.

Example 2: If E.xxx!=A;B is specified, the condition is satisfied when E.xxx matches neither A nor B.

Example 3: If E.xxx^=A;B is specified, the condition is satisfied when E.xxx begins with A or B.

Example 4: If E.xxx>=A;B is specified, the condition is satisfied when E.xxx contains either A or B.

Example 5: If E.xxx<=A;B is specified, the condition is satisfied when E.xxx contains neither A nor B.

Example 6: If E.xxx*=A;B is specified, the condition is satisfied when E.xxx matches the regular expression of either A or B.

Be careful about specifying the same attribute name more than once in the same attribute condition. The following combinations result in a definition error:

• A combination that never matches

- The message (B.MESSAGE) begins with KAVB and does not include KAVB.

• Redundant combinations

- The message (B.MESSAGE) begins with KAVB and contains KAVB.

The system ignores any space (space and ASCII codes from 0x01 to 0x1F) between an attribute name, a comparison condition, and an attribute value, at both ends of an attribute value separated by a semicolon, and at both ends of an event attribute condition.

Example: The message matches KAJVxxxx-IΔExecuted or Error.

A space is ignored if it is specified at the location of Δ below:

ΔB.MESSAGEΔ==Δ"KAJVxxxx-IΔExecuted";ΔErrorΔ

The following specifications are the same as the above example:

B.MESSAGE==KAJVxxxx-IΔExecuted;Error

B.MESSAGE=="KAJVxxxx-IΔExecuted";Error

If you specify the event ID (B.ID) as the attribute name, the comparison condition must be a complete match (==).

The following table lists the attribute names that can be specified in the filtering condition for the correlation target range.

Table 2‒39: List of attribute names that can be specified in the filtering condition for the correlation target range

No.

Attribute name

Item

1

B.SOURCESERVER#1

Event-issuing server name

2

B.DESTSERVER#1

Target event server name

3

B.MESSAGE

Message

4

B.ID

Event ID

5

B.REASON

Reason for registration

6

B.USERID

Source user ID

7

B.GROUPID

Source group ID

8

B.USERNAME

Source user name

9

B.GROUPNAME

Source group name

10

E.JP1_SOURCEHOST#1

Event source host name

11

E.xxxxxxx#2

Extended attribute (common information, user-specific information)

#1

If the integrated monitoring database and the IM Configuration Management database are enabled, the business group name can be specified in a path format.

If the integrated monitoring database and the IM Configuration Management database are disabled, a business group name specified in a path format is treated as a host name.

If the -ignorecasehost option of the jcoimdef command is set to ON, and a comparison keyword other than Regular expression is selected, the character string is no longer case sensitive.

#2

You can also specify a JP1 product-specific extended attribute. For example, the program-specific extended attribute for the JP1/AJS job execution host is E.C0. For details about the product-specific extended attributes, consult the documentation for the products that issue JP1 events.

CON=event-condition

Defines the targets of correlation event generation processing or a condition for JP1 events that are to be excluded as targets. You can specify multiple event conditions. There must be at least one definition in each correlation event generation condition. You can define a maximum of 10 event conditions. If no event condition is defined or the specified definition is invalid, a definition error results.

The following is the specification format:

CON={NOT|[CID:n]},event-attribute-condition-1 [, event-attribute-condition-2[, event-attribute-condition-3 ...] ]

If you specify multiple event attribute conditions, separate them with the comma (,). When multiple event attribute conditions are specified, they are assumed to be connected with the AND condition, in which case the condition is satisfied only when a JP1 event that satisfies all the specified event attribute conditions is issued.

The following table lists and describes the items to be set for the event condition.

Table 2‒40: Items to be set for the event condition

No.

Item

Description

1

NOT

Specifies that JP1 events are to be excluded as targets of correlation event generation processing.

When you specify NOT as an event condition, that condition is applied first, regardless of the sequence in which the event conditions (CON statements) are defined.

2

CID:n

Specifies an ID for the condition. Specify this item to use a variable to pass the correlation source event information to another parameter (SAME_ATTRIBUTE, SUCCESS_EVENT). The permitted values are the integers in the range from 1 to 999.

For example, if the correlation source event consists of multiple JP1 events and the $EVn_B.MESSAGE variable is specified in the SUCCESS_EVENT parameter, message information for the correlation source event can be passed to the correlation event.

If this parameter is omitted, information cannot be passed to another parameter. If the specified value is preceded by zeros or the same CID is specified more than once, a definition error results.

3

event -attribute-condition

Specifies the event attribute condition in the following format:

Format:

attribute-name comparison-condition attribute-value

attribute-name

Specifies a JP1 event basic or extended attribute.

Prefix a basic attribute with B. and an extended attribute with E..

For example, to specify the message, specify B.MESSAGE.

If you specify an extended attribute, express the character string that follows E. using from 1 to 32 bytes of characters. The following rules apply:

The character string must begin with an uppercase letter.

The character string beginning in byte 2 must be expressed using uppercase alphanumeric characters and the underscore (_).

For details about basic and extended attributes, see 3.1 Attributes of JP1 events. To specify a product-specific extended attribute, consult the documentation for that product.

If you specify product-specific extended attributes, consult the documentation for the products that issue the JP1 events.

Note that you cannot specify the source IP address (SOURCEIPADDR).

comparison-condition and attribute value

The rules for specifying the comparison condition and attribute value are the same as for specifying the event attribute condition in TARGET.

See Table 2-38 Items to be set for an event attribute condition and the information following the table.

TIMEOUT=timeout-period

Specifies the timeout period for the correlation event generation condition. The permitted value range is from 1 to 86,400 (seconds). If this parameter is omitted, 60 seconds is assumed.

TYPE=event-correlation-type

Specifies the event correlation type.

The three event correlation types that can be specified are sequence, combination, and threshold, which are explained below:

sequence

The correlation event generation condition is satisfied if the JP1 events that satisfy the defined event condition are issued in the order defined.

combination

The correlation event generation condition is satisfied if a JP1 event that satisfies the combination of defined event conditions is issued regardless of the sequence.

threshold:n

The correlation event generation condition is satisfied if the number of JP1 events that satisfy the defined event condition reaches the threshold. If multiple event conditions are defined, the correlation event generation condition is satisfied if the total number of JP1 events that satisfy any of the defined conditions reaches the threshold.

The value permitted for the threshold is from 1 to 100 (count). For example, if the threshold is 10, specify as follows:

threshold:10

This parameter is not case sensitive. If the event correlation type is omitted, combination is assumed.

SAME_ATTRIBUTE=duplicate-attribute-value-condition

Specifies the duplicate attribute value condition.

Define this parameter to group the JP1 events (correlation source events) that satisfy the event condition for an attribute value and to generate a correlation event for the group.

You can define a maximum of 3 duplicate attribute value conditions per correlation event generation condition. This parameter is optional.

The following shows the format:

- SAME_ATTRIBUTE=attribute-name | {$EVn_attribute-name | $EVn_ENVo} [, {$EVn_attribute-name | $EVn_ENVo} ...]

The following table lists and describes the items to be set for the duplicate attribute value condition.

Table 2‒41: Items to be set for the duplicate attribute value condition

No.

Item

Description

1

attribute-name

Specifies a JP1 event basic or extended attribute.

The attribute value of the correlation source event that corresponds to the attribute name specified here becomes the grouping key.

You can specify only one attribute-name per duplicate-attribute-value-condition.

Prefix a basic attribute with B. and an extended attribute with E. If you specify an extended attribute, express the character string that follows E. using from 1 to 32 bytes of characters. The following rules apply:

The character string must begin with an uppercase letter.

The character string beginning in byte 2 must be expressed as uppercase alphanumeric characters and the underscore (_).

For details about the specifiable attribute names, see Table 2-42 List of attribute names that can be specified in the duplicate attribute value condition.

2

Variable

$EVn_attribute-name

Specify this parameter if the attribute value to be used as the grouping key belongs to an attribute that varies for each correlation source event.

For example, specify this parameter to use attribute A' of correlation source event A and attribute B' of correlation source event B as the grouping key.

You can specify a maximum total of 10 $EVn_attribute-name and $EVn_ENVo parameters per duplicate attribute value condition.

For details, see (1)(a) Using an attribute value of the correlation source event as the duplicate attribute value condition.

3

Variable

$EVn_ENVo

Specify this parameter to use part of the attribute value of a correlation source event as the duplicate attribute value condition.

For example, specify this parameter to use part of the message (B.MESSAGE) as the grouping key.

You can specify a maximum total of 10 $EVn_ENVo and $EVn_attribute-name parameters per duplicate attribute value condition.

For details, see (1)(b) Using part of an attribute value of the correlation source event as the duplicate attribute value condition.

The attribute name and the value that is replaced with a variable (an attribute value or part of an attribute value) are case sensitive. Only values that perfect matches are able to be a duplicate attribute value condition.

If the attribute name and the value that is replaced with a variable (attribute value or part of an attribute value) are not in the correlation source event, they are replaced with the null character (0 byte). This means that the null character is used as the grouping key. If this occurs, the following character string is output to the correlation event generation history file:

A JP1 event that matches the correlation event generation condition occurred and correlation event generation processing started, but the event attribute defined in that attribute value condition was not found in the JP1 event. (generation-condition-name(generation-processing-number) serial-number attribute-name)

If you specify SAME_ATTRIBUTE=duplicate-attribute-value-condition more than once, a correlation event is generated for each duplicate attribute value condition.

For example, to issue a correlation event for each host name (B.SOURCESERVER) and user name (B.USERNAME), define as follows:

:

SAME_ATTRIBUTE=B.SOURCESERVER

SAME_ATTRIBUTE=B.USERNAME

:

If you specify multiple variables in the duplicate attribute value condition, separate them with the comma (,). A correlation event is generated for each attribute value that is replaced with a variable.

The system ignores any space (space and ASCII codes from 0x01 to 0x1F) between an attribute name and a variable ($EVn_attribute-name, $EVn_ENVo) and at both ends of a duplicate attribute value condition (Δ in the following example):

Example:

ΔSAME_ATTRIBUTEΔ=Δ$EV1_ENV1Δ,Δ$EV2_ENV2Δ

The following table lists the attribute names that can be specified in the duplicate attribute value condition

Table 2‒42: List of attribute names that can be specified in the duplicate attribute value condition

No.

Attribute name

Item

1

B.SOURCESERVER

Event-issuing server name

2

B.DESTSERVER

Target event server name

3

B.MESSAGE

Message

4

B.ID

Event ID

5

B.REASON

Reason for registration

6

B.USERID

Source user ID

7

B.GROUPID

Source group ID

8

B.USERNAME

Source user name

9

B.GROUPNAME

Source group name

10

E.xxxxxxx#

Extended attribute (common information, user-specific information)

#

You can also specify a JP1 product-specific extended attribute. For example, the product-specific extended attribute for the JP1/AJS job execution host is E.C0. For details about the product-specific extended attributes, consult the documentation for the products that issue JP1 events.

CORRELATION_NUM=maximum-correlation-number

Specifies the maximum number of JP1 event sets that can be held by the correlation event generation condition. Only one maximum correlation number can be defined for a single correlation event generation condition.

The permitted value range is from 1 to 1,024 (sets). If this parameter is omitted, 10 sets is assumed.

Note:

It is not recommended to specify CORRELATION_NUM for many correlation event generation conditions and a large value for the maximum correlation number.

Doing so will increase the number of JP1 event sets that need to be processed concurrently by the Event Generation Service, and result in an increase in the amount of memory required and a reduction in processing speed.

The maximum number of JP1 event sets that can be issued concurrently by all correlation event generation conditions is 20,000 sets. When 20,000 sets have been issued concurrently, a JP1 event (event ID: 00003F28) is output; until the number of sets drops below 20,000, no more processing is performed even if new JP1 events that satisfy the event conditions are issued.

SUCCESS_EVENT=correlation-approval-event

Defines the JP1 event (correlation event) that is to be issued when the correlation event generation condition results in correlation approval. Only one correlation approval event can be defined for a correlation event generation condition. For details about the conditions that result in correlation approval, see 4.3.6(1) Generation condition satisfied in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

If you have defined FAIL_EVENT=correlation-failure-event in the correlation event generation condition, you can omit this parameter. When this parameter is omitted, no correlation approval event is issued, even when the correlation event generation condition results in correlation approval.

Specify the correlation approval event in the following format:

attribute-name:attribute-value

The following describes each item.

attribute-name

Specifies a JP1 event basic or extended attribute (correlation source event). Prefix a basic attribute with B. and an extended attribute with E. If you specify an extended attribute, express the character string that follows E. using from 1 to 32 bytes of characters. The following rules apply:

• The character string must begin with an uppercase letter.

• The character string beginning in byte 2 must be expressed as uppercase alphanumeric characters and the underscore (_).

You can specify any value for the following attributes:

• Event ID (B.ID)

• Message (B.MESSAGE)

• Extended attributes, except for those listed in the table below.

Table 2‒43: Extended attributes for which a value cannot be specified

Attribute type

Item

Attribute name

Description

Common information

Product name

E.PRODUCT_NAME

/HITACHI/JP1/IM/GENERATE_EVENT

Object type

E.OBJECT_TYPE

SERVICE

Object name

E.OBJECT_NAME

EGS

Occurrence

E.OCCURRENCE

SUCCESS

User-specific information

Relation Event serial number

E.JP1_GENERATE_SOURCE_SEQNO

Stores the serial numbers of the correlation source events separated by the space:

serial-number-1Δserial-number-2Δserial-number-3...serial-number-n

The maximum value of n is 100.

Correlation event generation condition name

E.JP1_GENERATE_NAME

Name of correlation event generation condition that is satisfied

Reserved word

Extended attribute beginning with E.JP1_

Extended attribute reserved by JP1/IM - Manager (other than the event source host name (E.JP1_SOURCEHOST))

If you want to pass the attribute value of a correlation source event to the correlation event, specify a variable. Specify correlation-approval-event in the following format:

attribute-name:$EVn_attribute-name

In this case, specify the correlation source event to be inherited by CID of the event condition and then specify the value of CID in n. Specify a variable to the right of the colon.

For details, see (2)(a) Passing an attribute value of the correlation source event to an attribute value of the correlation event.

If you want to specify a threshold (threshold) as the event correlation type and pass an attribute value of the correlation source event to the correlation event, specify correlation-approval-event in the following format:

attribute-name:$EVn_m_attribute-name

In this case, specify the correlation source event to be inherited by CID and then specify in n the value of CID. Specify a variable to the right of the colon. Also, specify in m the location of the correlation source event whose attribute value is to be passed.

For details, see (2)(b) Passing an attribute value of the correlation source event to an attribute value of the correlation event (when the event correlation type is threshold).

If you wish to pass a portion of an attribute value of the correlation source event to the correlation event, specify the $EVn_ENVo variable. Use a regular expression to specify the event condition and enclose the portion of the attribute value to be acquired in parentheses.

Specify correlation-approval-event in the following format:

attribute-name:$EVn_ENVo

In this case, specify the correlation source event to be passed to CID and specify the value of CID in n. In o of ENVo, specify the acquisition order.

For details, see (2)(c) Passing part of an attribute value of the correlation source event to the correlation event.

For details about basic and extended attributes, see 3.1 Attributes of JP1 events. If you specify product-specific extended attributes, consult the documentation for the products that issue JP1 events.

You can specify multiple items in correlation source event by separating them with the comma (,).

Make sure that you specify the event ID of a basic attribute (B.ID). The permitted range of event IDs is from 0 to 1FFF and from 7FFF8000 to 7FFFFFFF. If the event ID is not specified, 0 is set as the event ID.

The maximum length of a single correlation approval event is 8,192 bytes. The maximum length of B.MESSAGE is 1,023 bytes. These maximum lengths include spaces but do not include linefeed codes.

The system ignores any space (space and ASCII codes from 0x01 to 0x1F) between an attribute name and an attribute value and at both ends of SUCCESS_EVENT=correlation-approval-event (the space is represented by Δ in the following example).

Example:

ΔSUCCESS_EVENTΔ=ΔB.IDΔ:Δ1Δ

To use a comma (,) or a space in an attribute value, enclose it in double-quotation marks (").

To specify a double-quotation mark (") or a backslash (\), prefix it with a backslash (\) so that the value becomes \" or \\.

To restore a special character (^ $ . * + ? | ( ) { } [ ] \) to its original meaning, prefix it with two backslash signs so that the value becomes \\special-character.

For example, to treat $ as a normal character, specify it as \\$. Also, to give \ its original meaning, specify \\\\.

If you omit an attribute value, nothing is set when a correlation event is generated. If you omit the attribute value of an attribute name (B.ID), 0 is set.

To specify a setting following the $EVn_attribute-name variable, specify a space (indicated by Δ in the example below) after the variable.

Example:

SUCCESS_EVENT=B.MESSAGE:"$EVn_B.IDΔ$EVn_B.TIMEΔ..."

If you use a variable and there is no matching attribute name, the variable is replaced with a space. If the variable would be replaced when the correlation event is generated with an attribute value that exceeds the permitted maximum value, the correlation event is not generated.

Up to 94 extended attributes can be specified.

FAIL_EVENT=correlation-failure-event

Defines a JP1 event (correlation event) that is to be issued when the correlation event generation condition results in a correlation failure. You can define only one correlation failure event per correlation event generation condition. For details about the conditions that result in a correlation failure, see 4.3.6(2) Generation condition fails in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

If you have specified SUCCESS_EVENT=correlation-approval-event in the correlation event generation conditions, you can omit this parameter. When this parameter is omitted, no correlation failure event is issued even if a correlation event generation condition results in a failure.

Specify correlation-failure-event in the same format as used for a correlation approval event. For details, see SUCCESS_EVENT=correlation-approval-event.

(1) Using a variable in the duplicate attribute value condition (SAME_ATTRIBUTE)

This subsection describes how to use a variable ($EVn or $EVn_ENVo) in the duplicate attribute value condition (SAME_ATTRIBUTE).

(a) Using an attribute value of the correlation source event as the duplicate attribute value condition

To use an attribute value of the correlation source event as the duplicate attribute value condition, use the $EVn_attribute-name variable. The format is as follows:

- SAME_ATTRIBUTE=$EVn_attribute-name

For n, specify the value that corresponds to the condition ID (CID) of the event condition. A value from 1 to 999 can be specified for the condition ID.

For attribute-name, specify the attribute name that is to be used as the grouping key. For details about the specifiable attributes names, see Table 2-42 List of attribute names that can be specified in the duplicate attribute value condition.

For example, the following definition associates JP1 events that have attribute values whose host information is different, such as a JP1 event of Windows log trapping (event ID: 00003A71) and a JP1 event issued by JP1/AJS (event ID: 00004107), and generates a correlation event for each host:

CON=CID:1,B.ID==3A71,E.A0==host1;host2
CON=CID:2,B.ID==4107,E.C0==host1;host2
          :
SAME_ATTRIBUTE=$EV1_E.A0,$EV2_E.C0
          :

(b) Using part of an attribute value of the correlation source event as the duplicate attribute value condition

To use part of the attribute value of a correlation source event as the duplicate attribute value condition, use the $EVn_ENVo variable. The format is as follows:

- SAME_ATTRIBUTE=$EVn_ENVo

When you specify $EVn_ENVo, use a regular expression (*=) to specify the event condition and enclose the part of the attribute value that is to be acquired in parentheses. For n, specify the value that corresponds to the condition ID (CID) of the event condition. A value from 1 to 999 can be specified for the condition ID.

In o of ENVo, specify the acquisition order. The acquisition order is based on the order of the parentheses in the right-hand term of the event condition, counting the pairs of parentheses from left to right. A value from 1 to 9 can be specified for the acquisition order.

The following figure shows the correspondence between the event condition (CON) and the part that is acquired by $EVn_ENVo.

Figure 2‒2: Correspondence between the event condition (CON) and the part that is acquired by $EVn_ENVo

If there are multiple event attribute conditions that specify regular expressions in a single event condition (CON), count the pairs of parentheses from left to right and set in o the order of the pair enclosing the attribute value that is to be acquired.

For example, if you want to issue correlation events for each event that has the same host name in the message in the correlation source event, define as follows:

CON=CID:1, B.ID==1001, B.MESSAGE*=.*HOST=(.*\\))
TYPE=threshold:5
SAME_ATTRIBUTE=$EV1_ENV1
          :

(2) Using a variable in the correlation approval event (SUCCESS_EVENT)

To pass an attribute value of the correlation source event to the correlation event, use a variable in the correlation approval event (SUCCESS_EVENT).

(a) Passing an attribute value of the correlation source event to an attribute value of the correlation event

To pass an attribute value of the correlation source event to an attribute value of the correlation event, use the $EVn_attribute-name variable. The format is as follows:

- SUCCESS_EVENT=attribute-name:$EVn_attribute-name

For n, specify the condition ID (CID) that was specified in the event condition. For the right-hand attribute-name, specify the attribute that is to be passed from the correlation source event. Note that if the event ID (B.ID) is specified in the left-hand attribute-name, an attribute value of the correlation source event cannot be passed.

The following table lists the attribute names that can be specified in the variable.

Table 2‒44: List of attribute names that can be specified in the variable

No.

Attribute name

Item

Format

1

B.SEQNO

Serial number

Numeric value

2

B.ID

Event ID

basic-part:extended-part in hexadecimal notation

3

B.PROCESSID

Source process ID

Numeric value

4

B.TIME

Registered time

YYYY/MM/DD hh:mm:ss#1

5

B.ARRIVEDTIME

Arrived time

YYYY/MM/DD hh:mm:ss#1

6

B.REASON

Reason for registration

Character string

7

B.USERID

Source user ID

Numeric value

8

B.GROUPID

Source group ID

Numeric value

9

B.USERNAME

Source user name

Character string

10

B.GROUPNAME

Source group name

Character string

11

B.SOURCESERVER

Event-issuing server name

Character string

12

B.DESTSERVER

Target event server name

Character string

13

B.SOURCESEQNO

Source serial number

Numeric value

14

B.MESSAGE

Message

Character string

15

E.SEVERITY

Event level

Character string

16

E.USER_NAME

User name

Character string

17

E.PRODUCT_NAME

Product name

Character string

18

E.OBJECT_TYPE

Object type

Character string

19

E.OBJECT_NAME

Object name

Character string

20

E.ROOT_OBJECT_TYPE

Root object type

Character string

21

E.ROOT_OBJECT_NAME

Root object name

Character string

22

E.OBJECT_ID

Object ID

Character string

23

E.OCCURRENCE

Occurrence

Character string

24

E.START_TIME

Start time

YYYY/MM/DD hh:mm:ss#1

25

E.END_TIME

End time

YYYY/MM/DD hh:mm:ss#1

26

E.xxxxxx#2

Other extended attribute

Character string

#1

This value is obtained by converting the JP1 event's time in GMT to the time zone of JP1/IM - Manager.

#2

You can also specify a JP1 product-specific extended attribute. For example, the program-specific extended attribute for the JP1/AJS job execution host is E.C0. For details about the product-specific extended attributes, consult the documentation for the products that issue JP1 events.

The following figure shows an example of passing an attribute value from the correlation source event.

Figure 2‒3: Example of using a variable to pass an attribute value to the correlation approval event

In this example, the event levels issued by JP1/AJS and JP1/Base associate the JP1 event for an error, resulting in generation of a correlation event.

This example defines correlation-approval-event as follows:

For the event level, the correlation event passes the event level of the JP1 event issued by JP1/AJS.

For the message, the correlation event passes the messages for the JP1 events issued by JP1/AJS and JP1/Base.

(b) Passing an attribute value of the correlation source event to an attribute value of the correlation event (when the event correlation type is threshold)

This subsection describes how to define a correlation approval event using a variable when the event correlation type is threshold.

When the event correlation type is threshold, multiple JP1 events can satisfy a single event condition (CON). The following figure shows an example.

Figure 2‒4: When the event correlation type is threshold

As shown in this figure, three JP1 events (Event 1, Event 2, and Event 3) match $EV1_B.MESSAGE. Therefore, the message to be passed must be specified.

In this case, specify the correlation approval event in the following format:

- SUCCESS_EVENT=attribute-name:$EVn_m_attribute-name

For n, specify the condition ID (CID) that was specified in the event condition as described above. For the right-hand attribute-name, specify the attribute that is to be passed from the correlation source event. Note that if the event ID (B.ID) is specified in the left-hand attribute-name, an attribute value of the correlation source event cannot be passed.

In m, specify the order in which the JP1 events (correlation source events) are processed. To pass the attribute value of the third JP1 event that was processed, specify 3 in m. If the value of m is greater than the value specified in the threshold (threshold:n), a definition error results.

The following figure shows an example of passing attribute values when the event correlation type is threshold.

Figure 2‒5: Example of passing attribute values when the event correlation type is threshold

You can omit both n and m in attribute-name:$EVn_m_attribute-name. The following examples describe how attribute values are passed when n and m are omitted.

Example 1:

If a JP1 event containing Login error in the message is issued three times, generate a correlation event that receives the message in the correlation source event.

Definition in the correlation event generation definition file

[ex.1]

CON=CID:1,B.MESSAGE*="Login error"

TYPE=threshold:3

SUCCESS_EVENT=B.ID:A00,E.SEVERITY:Error,B.MESSAGE:setting

Table 2‒45: Conditions to be satisfied and settings (in Example 1)

No.

Condition to be satisfied

Setting

1

Pass to the correlation event the message in the first JP1 event that satisfies the event condition

$EV1_1_B.MESSAGE

or $EV_1_B.MESSAGE

2

Pass the message in the second JP1 event that satisfies the event condition

$EV1_2_B.MESSAGE

or $EV_2_B.MESSAGE

3

Pass the message in the third (last) JP1 event that satisfies the event condition

$EV1_3_B.MESSAGE,

$EV1_B.MESSAGE,

$EV_3_B.MESSAGE,

or $EV_B.MESSAGE

Example 2:

If a JP1 event that satisfies either of the conditions listed below is issued 10 times, generate a correlation event that receives the message in the correlation source event.

Event ID is 100 and the message contains Warning.

Event ID is 200 and the message contains Warning or Error.

Definition in the correlation event generation definition file:

[ex.2]

CON=CID:100,B.ID==100,B.MESSAGE*="Warning"

CON=CID:200,B.ID==200,B.MESSAGE*="Warning";"Error"

TYPE=threshold:10

SUCCESS_EVENT=B.ID:B00,E.SEVERITY:Error,B.MESSAGE:setting

Table 2‒46: Conditions to be satisfied and settings (in Example 2)

No.

Condition

Setting

1

Pass to the correlation event the message in the first JP1 event that satisfies the event condition (condition ID: 100)

$EV100_1_B.MESSAGE

2

Pass to the correlation event the message in the fifth JP1 event that satisfies the event condition (condition ID: 100)

$EV100_5_B.MESSAGE

3

Pass to the correlation event the message in the 10th JP1 event that satisfies the event condition (condition ID: 100)

$EV100_10_B.MESSAGE

4

Pass to the correlation event the message in the first JP1 event processed, regardless of the event conditions

$EV_1_B.MESSAGE

5

Pass to the correlation event the message in the fifth JP1 event processed, regardless of the event conditions

$EV_5_B.MESSAGE

6

Pass to the correlation event the message in the 10th (last) JP1 event processed, regardless of the event conditions

$EV_10_B.MESSAGE

or $EV_B.MESSAGE

The following summarizes the processing:

When n is omitted:

If n is omitted, only the correlation source event with the order specified in m is used for checking the conditions. For example, if 3 is specified in m, the attribute value of the third correlation source event processed is passed to the correlation event.

When m is omitted:

If m is omitted, the last correlation source event processed is the target, regardless of the order. For example, if the threshold is 10, the attribute value of the 10th correlation source event processed is passed.

If n is specified, the attribute value of the last correlation source event processed by the event condition is passed.

When n and m are both omitted:

If n and m are both omitted, the last correlation source event processed is the target, regardless of the event conditions or the order of processing.

Note that regardless of whether n or m is specified, if no (source) JP1 event satisfies the conditions, the variable is replaced with the null character (0 bytes).

(c) Passing part of an attribute value of the correlation source event to the correlation event

To pass part of an attribute value of the correlation source event to the correlation event, use the $EVn_ENVo variable. In this case, use a regular expression (*=) to specify the event condition and enclose the part of the attribute value that is to be acquired in parentheses.

Specify correlation-approval-event in the following format:

SUCCESS_EVENT=attribute-name:$EVn_ENVo

Specify the correlation source event to be received by CID and specify the value of CID in n. In o of ENVo, specify the acquisition order. The following figure shows an example of receiving part of an attribute value.

Figure 2‒6: Example of receipt by the correlation approval event when the $EVn_ENVo variable is used

This example uses parentheses to acquire the right-hand term of ErrorCode= from the correlation source event that is specified by the conditions of condition ID (CID) =1 and condition ID (CID) =2.

If you use the $EVn_ENVo variable, when a correlation source event that has an attribute value containing a specific character string is issued, you can generate a correlation event, and then pass the portion of the character string contained in the attribute value to the correlation event.

In this case, specify in o of ENVo the numeric value that determines the parentheses pair that follows the regular expression (*=) specified in the event conditions. In other words, count parentheses pairs from left to right for the attribute value in the correlation source event that follows the regular expression (*=) in the event conditions, and then specify in o the location that is to be passed.

The part acquired by $EVn_ENVo is the same as when $EVn_ENVo is specified in the duplicate attribute value condition. For details, see Figure 2-2 Correspondence between the event condition (CON) and the part that is acquired by $EVn_ENVo.

The example shown below generates a correlation event if a correlation source event with an attribute value that contains a specific character string is issued, and passes part of the character string contained in that attribute value to the correlation event.

Figure 2‒7: Example of passing part of a character string contained in an attribute value to the correlation event

This example specifies the definition in such a manner that whenever a correlation source event that satisfies the conditions listed below is generated, an attribute value is passed from it to the correlation event:

host= is followed by MANAGER_A, AGENT_A, AGENT_B, or AGENT_C.

ErrorCode= is followed by a character string of at least 4 characters.#

#

If the character string consists of more than four characters, only the first four characters are passed.

For example, in the case of ErrorCode=12345678, 1234 is passed.

If the character string consists of fewer than four characters, the necessary number of characters that follow ErrorCode= character-string are included so that four characters are passed.

For example, in the case of ErrorCode=1 2006/11/11, 1 20 is passed.

If the character string that follows ErrorCode= consists of fewer than 4 characters, no correlation event is generated.

Example definition

Example 1: Generate a correlation event for any JP1 event whose event level is Error or higher:

VERSION=2

#Generate a correlation event for any a JP1 event
#whose event level is Error or higher
[filter_over_error]
CON=CID:1,B.ID==1,E.SEVERITY==Error;Critical;Alert;Emergency
SUCCESS_EVENT=E.SEVERITY:Emergency,B.MESSAGE:$EV1_B.MESSAGE

Example 2: Generate a correlation event for any JP1 event whose event level is Error or higher and for any JP1 event issued by JP1/AJS whose event level is Error:

If the following definition is specified and JP1/AJS issues a JP1 event whose event level is Error, two correlation events will be generated because the JP1 event satisfies the two correlation event generation conditions over_error and ajs2_over_error:

VERSION=2

#Generate a correlation event for any JP1 event whose
#event level is Error or higher.
[over_error]
CON=CID:1,E.SEVERITY==Error;Critical;Alert;Emergency
SUCCESS_EVENT=E.SEVERITY:Emergency,B.MESSAGE:$EV1_B.MESSAGE

#Generate a correlation event for any JP1 event issued by
#JP1/AJS@ whose event level is Error.
[ajs2_over_error]
CON=CID:1,E.SEVERITY==Error,E.PRODUCT_NAME==/HITACHI/JP1/AJS2
SUCCESS_EVENT=E.SEVERITY:Emergency,B.MESSAGE:$EV1_B.MESSAGE

To generate only one correlation event when JP1/AJS issues a JP1 event whose event level is Error, specify the first correlation event generation condition as follows:

VERSION=2

#Generate a correlation event for any JP1 event whose
#event level is Error or higher.
#Exclude events issued by JP1/AJS2.
[over_error_and_not_ajs2]
CON=NOT,E.SEVERITY==Error,E.PRODUCT_NAME==/HITACHI/JP1/AJS2
CON=CID:1,E.SEVERITY==Error;Critical;Alert;Emergency
SUCCESS_EVENT=E.SEVERITY:Emergency,B.MESSAGE:$EV1_B.MESSAGE

#Generate a correlation event for any JP1 event issued by
#JP1/AJS2 whose event level is Error.
[ajs2_over_error]
CON=CID:1,E.SEVERITY==Error,E.PRODUCT_NAME==/HITACHI/JP1/AJS2
SUCCESS_EVENT=E.SEVERITY:Emergency,B.MESSAGE:$EV1_B.MESSAGE

Example 3: Define a timeout period:

VERSION=2

[condition]
CON=NOT,E.SEVERITY==Error,E.PRODUCT_NAME==/HITACHI/JP1/AJS2

CON=CID:1,B.ID==1,B.MESSAGE==TEST,E.SEVERITY==Warning
CON=CID:2,B.ID==1,B.MESSAGE==TEST,E.SEVERITY==Error
CON=CID:3,B.ID==1,B.MESSAGE==TEST,E.SEVERITY==Critical

TIMEOUT=10
SUCCESS_EVENT=E.SEVERITY:Emergency,B.MESSAGE:$EV1_B.MESSAGE

Example 4: Generate a single correlation event that combines the messages in JP1 events issued by JP1/AJS2 and JP1/Base and whose event level is Error:

VERSION=2

[cond1]

CON=CID:1,E.SEVERITY==Error,E.PRODUCT_NAME>=HITACHI/JP1/AJS2
CON=CID:5,E.SEVERITY==Error,E.PRODUCT_NAME>=HITACHI/JP1/Base

SUCCESS_EVENT=E.SEVERITY:$EV1_E.SEVERITY,B.MESSAGE:"$EV1_B.MESSAGE $EV5_B.MESSAGE"

Example 5: Acquire a value by using the $EVn_ENVo variable:

This example acquires the detail code errorΔcodeΔ=ΔnΔ that is included in the message and then places it in the message in the correlation event (n: any character string; Δ: Space).

VERSION=2

[SAMPLE]

CON=CID:100, B.MESSAGE*=(errorΔcodeΔ=.*Δ)
SUCCESS_EVENT=B.ID:100,E.SEVERITY:Emergency,B.MESSAGE: error-information[$EV100_ENV1Δ]

Example 6: Narrow down the target range for correlation by the host and generate a correlation event for each user with the maximum correlation number set to 20:

VERSION=2

[condition2]
TARGET=B.SOURCESERVER==host1;host2;host3
CON=NOT, E.SEVERITY==Error, E.PRODUCT_NAME==/HITACHI/JP1/AJS2

CON=CID:1, B.ID==1, B.MESSAGE==TEST, E.SEVERITY==Warning
CON=CID:2, B.ID==1, B.MESSAGE==TEST, E.SEVERITY==Error
CON=CID:3, B.ID==1, B.MESSAGE==TEST, E.SEVERITY==Critical

SAME_ATTRIBUTE=E.USERNAME
CORRELATION_NUM=20
TIMEOUT=10
SUCCESS_EVENT=B.MESSAGE:$EV1_B.MESSAGE

Correlation event generation environment definition file

Format

[logical-host-name\JP1CONSOLEMANAGER\EVGEN]
"OPERATION_LOG_SIZE"=dword:hexadecimal-value
"OPERATION_LOG_NUM"=dword:hexadecimal-value

File

Use any file.

Storage directory

In Windows

Any folder

In UNIX

Any directory

Description

This file defines the size and number of correlation event generation history files.

When this file is updated, the definition information is updated for all processes managed by JP1/IM - Manager.

When the definitions are applied

The definition takes effect when JP1/IM - Manager is restarted or the jco_spmd_reload command is executed after the jbssetcnf command has been executed to apply the definition to the common definition information.

Information that is specified

[logical-host-name\JP1CONSOLEMANAGER\EVGEN]

Specifies the key name for the JP1/IM - Manager environment settings.

For logical-host-name, specify JP1_DEFAULT for the physical host and logical-host-name for a logical host.

"OPERATION_LOG_SIZE"=dword:hexadecimal-value

Specifies in hexadecimal notation the size of one correlation event generation history file. The permitted value range is from 00010000 to 06400000 (from 64 kilobytes to 100 megabytes). The default is 00A00000.

"OPERATION_LOG_NUM"=dword:hexadecimal-value

Specifies in hexadecimal notation the number of correlation event generation history files. The permitted value range is from 00000003 to 00000064 (from 3 to 100 files). The default is 00000003 (3 files).

How to determine the size and number of correlation event generation history files

If it is necessary to adjust the size and number of correlation event generation history files, estimate the size of the correlation event generation history file required for one day and multiply that value by the number of days the files are to be retained. Set a value that is larger than the estimated value.

For details about the estimation, see the Release Notes for JP1/IM - Manager.

Definition file for manually registering incidents (incident.conf)

Format

VERSION=version-information
SS_MODE={1|2|3}

#comment-line
[SS_URL=http://JP1/Service Support host:port-number]

File

incident.conf (definition file for manually registering incidents)

incident.conf.model (model file for the definition file for manually registering incidents)

Storage directory

In Windows

For a physical host:

Console-path\conf\console\incident\

For a logical host:

shared-folder\jp1cons\conf\console\incident\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/incident/

For a logical host:

shared-directory/jp1cons/conf/console/incident/

Description

This definition file is used to register a JP1 event in JP1/IM - View as an incident in another product.

When the definitions are applied

The settings in the definition file for manually registering incidents take effect when the jco_spmd_reload command is executed, or when a user logs in to JP1/IM - Manager (Central Console) after restarting JP1/IM - Manager.

Information that is specified

VERSION=version-information

Specify the version of the definition file for manually registering incidents. Specify 2, or 3 for version-information. If you omit this parameter, or did not specify the value correctly, the SS_URL and SS_MODE parameters are ignored. Note that if you specify this parameter more than once, the parameter on the last line is valid.

Table 2‒47: List of parameters that can be specified for the version information and definition file for manually registering incidents

Version information

Parameter name

2

SS_URL#

3

SS_URL

SS_MODE

#

This works with SS_MODE=1.

SS_MODE={1|2|3}

Specify the registration mode of an incident. If you want to specify this parameter, specify 3 for the VERSION parameter. If not, this parameter is ignored. You can specify 1, 2, or 3. The following table describes available incident registration modes and when each mode should be used.

Table 2‒48: Incident registration modes and when to use each of them

Incident registration mode

Description

When to use

Supported version of JP1/IM - Manager, JP1/IM - View, and JP1/Service Support

SS_MODE=1

Source attributes and their target fields are fixed.

The specification of JP1/IM - Manager 10-00 or earlier must be used for linkage with JP1/Service Support.

09-50 or later

SS_MODE=2

Source attributes and their target fields are fixed.

The event ID (B.IDBASE) is inherited in addition to the attributes that are inherited when SS_MODE=1.

The event ID is required to be registered.

Linkage with JP1/IM - Manager, JP1/Service Support, and JP1/Navigation Platform is required.

10-10 or later

SS_MODE=3

The mapping between source attributes and target fields is configurable.

Multiple attributes can be mapped to one target field.

Any character string you want can be inherited.

Any attribute or character string you want is required to be registered.

This mode also allows linkage with JP1/IM - Manager, JP1/Service Support, and JP1/Navigation Platform.

11-50 or later

If you omit this parameter, or do not specify the value correctly, 1 is assumed. Note that if you specify this parameter more than once, the parameter on the last line is valid.

If you specify the registration mode of an incident, information to be registered as an incident is changed. For details about registration modes of incidents and information to be registered as incidents, see 9.1.1 Attributes of a JP1 event registered as an incident in JP1/Service Support during linkage in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

#comment-line

A line beginning with a hash mark (#) is treated as a comment.

[SS_URL=http://JP1/Service Support-host:port-number]

Specifies the URL of a Web page for JP1/Service Support on which you can register an incident by using one-byte numeric values and symbols. The default is SS_URL=, and no value is set.

The maximum length of a URL that calls JP1/Service Support is 2,046 characters. If 2 is set for the registration mode of an incident, event IDs are inherited. Therefore, the length of a message that can be inherited when 2 is set is less than the length of a message when 1 is set. If a message is truncated before the end, the user must copy the rest of the message displayed in the Event Details window, and paste it into JP1/Service Support.

When you code the port numbers of JP1/Service Support in this parameter, you must set them to ensure passage through the firewall between the JP1/IM - View machine and the JP1/Service Support machine.

To link with JP1/Service Support after upgrading JP1/IM - Manager, add this line, and then do the following:

Change version-information to 2 or 3.

Add SS_MODE on a new line to specify the registration mode when you want to register an event ID (SS_MODE=2) or you want a desired attribute or character string of a JP1 event to be inherited as an incident (SS_MODE=3).

Change the line beginning with IDM_URL as the comment statement (add #).

Restart JP1/IM - Manager or execute the jco_spmd_reload command to apply the definitions. If you already logged in to JP1/IM - View, restart JP1/IM - View.

Configuration file for incident inheritance information (incident_info.conf)

Format

[@encode UTF-8]
#item-field-ID=value-to-be-set-for-the-item
JP1/Service-Support-item-element-ID=value-passed-to-item-element[end-of-line-character]

File

incident_info.conf (Configuration file for incident inheritance information)

incident_info.conf.model (Model file for the configuration file for incident inheritance information)

Storage directory

In Windows:

Physical hosts:

Console-path\conf\console\incident\

Logical hosts:

shared-folder\jp1cons\conf\console\incident\

In UNIX:

Physical hosts:

/etc/opt/jp1cons/conf/console/incident/

Logical hosts:

shared-directory/jp1cons/conf/console/incident/

Description

Attributes or character strings of a JP1 event can be inherited as an incident in JP1/Service Support. This file defines which attributes or character strings of a JP event are mapped to which item elements of the New item window in JP1/Service Support.

When the definitions are applied

The settings edited in the configuration file for incident inheritance information take effect when you log in to JP1/IM - Manager (Central Console) with JP1/IM - View after setting the incident registration mode to 3 and then executing the jco_spmd_reload command or restarting JP1/IM - Manager.

Information that is specified

[@encode UTF-8]

Specifies the character encoding of the configuration file for incident inheritance information. The @encode statement must be on the first line. When the @encode statement does not exist, the character encoding of the manager is used. The acceptable character encoding is UTF-8. When the specified character encoding is UTF-8, the character encoding of the configuration file is set to UTF-8.

The error message KAVB1115-W is issued and the character encoding of the manager is used when any of the following conditions is true:

The configuration file does not begin with @encode.

@encode is not followed by a character encoding value.

The error message KAVB1119-W is issued and the character encoding of the manager is used when the following condition is true:

The specified character encoding is not UTF-8.

The managers use the following character encodings:

In Windows:

One of the following character encodings is used depending on the system locale:

Japanese: MS932 (Note that available characters are limited to SJIS characters.)

English: C

Chinese: GB18030

Any encoding other than Japanese or Chinese: C

In UNIX:

The character encoding depends on the value of the LANG environment variable specified in the /etc/opt/jp1cons/conf/jp1co_env.conf file.

#comment-line

A line beginning with a hash mark (#) is treated as a comment.

JP1/Service-Support-item-element-ID=value-passed-to-item-element[end-of-line-character]

Specifies which attributes or character strings of a JP1 event that are inherited as incidents are mapped to which item elements of the New item window in JP1/Service Support.

JP1/Service-Support-item-element-specification-ID

Specifies an item element specification ID in JP1/Service Support. If there are multiple occurrences of the same ID, the first occurrence takes precedence. For details about item element specification IDs, see the manual JP1/Service Support Configuration and Administration Guide.

value-passed-to-item-element[end-of-line-character]

Specifies any character strings or variables. You can specify as many multiple variables as you need.

A character string can consist of any characters other than control characters. When you include a control character (0x00 to 0x0F, 0x14 to 0x1F, or 0x7F), the character is replaced with a space (0x20). To use a dollar sign ($) as a literal character, place an escape character \ immediately before the dollar sign ($). To break a line, specify \n on the point where you want to break the line. To use \n as literal characters, specify \\n.

The following table describes how to specify a variable.

Table 2‒49: How to specify a variable

Format

Description

$variable-name

A variable must be specified in the following format: $variable-name. For details about specific variable names of JP1 event attributes, see Table 2-51 Variables that can be specified for JP1/Service Support item elements.

${variable-name}

A variable name must be enclosed in curly brackets ({}) when the variable name is directly followed by an alphanumeric character or an underscore (_).

$variable-name$URLENC

${variable-name$URLENC}

The attribute value is URL-encoded with UTF-8 character encoding.

$variable-name$ENC

${variable-name$ENC}

The attribute value is Base64-encoded.

$variable-name$ENC$URLENC

${variable-name$ENC$URLENC}

The attribute value is Base64-encoded and then URL-encoded.

The following table lists the examples of specified variables. These examples assume that the value of the event ID ($EVID) is 100:0 and the value of the EX extended attribute ($EV"EX") is ABC.

Table 2‒50: Examples of specified variables

Specified variable

Converted value

$EVID abc

100:0 abc

$EVIDabc

In Windows

$EVIDabc

In UNIX

Converted to an empty string.

${EVID}abc

100:0abc

$EVID_abc

In Window

$EVID_abc

In UNIX

Converted to an empty string.

${EVID}_abc

100:0_abc

$EV"EX" abc

ABC abc

$EV"EX"abc

ABCabc

The table below lists variables that can be used to pass the attribute values. You can map any source attribute to any target element but you must ensure that the value of the source attribute matches the display format of the target element.

Table 2‒51: Variables that can be specified for JP1/Service Support item elements

Item

Information to be inherited

Variable name

Entire basic event information

Entire basic event information

EVBASE

Event ID (basic-code:extended-code)

Value of the event ID in the format basic-code:extended-code.

basic-code is the value of the event ID (B.ID). extended-code is the value of the event code (extended code) (B.IDEXT). Both basic-code and extended-code are an 8-digit hexadecimal number (where A-F are uppercase). Zeros preceding the ID are omitted. When the extended code is 00000000, the value of the variable is basic-code:0.

EVID

Event ID (basic-code)

8-digit hexadecimal number representing the event ID (basic code) (where A-F are uppercase). Zeros preceding the ID are omitted.

EVIDBASE

Event registration date

Character value of the registration time (B.TIME) in the following format: yyyy/mm/dd

EVDATE

Event registration time (hh:mm:ss)

Character value of the registration time (B.TIME) in the following format: hh:mm:ss

EVTIME

Event source process ID

Value of B.PROCESSID

EVPID

User ID of the event source process

Value of B.USERID

EVUSRID

Group ID of the event source process

Value of B.GROUPID

EVGRPID

Event source user name

Value of B.USERNAME

EVUSR

Event source group name

Value of B.GROUPNAME

EVGRP

Event source server name

Value of B.SOURCESERVER

Only when the event source host mapping is disenabled

EVHOST

Event source IP address

Value of B.SOURCEIPADDR

EVIPADDR

Event database serial number

Value of B.SEQNO

EVSEQNO

Event arrival date

Character value of the arrival time (B.ARRIVEDTIME) in the following format: yyyy/mm/dd

EVARVDATE

Event arrival time

Character value of the arrival time (B.ARRIVEDTIME) in the following format: hh:mm:ss

EVARVTIME

Event database serial number at the event source

Value of B.SOURCESEQNO

EVSRCNO

Message

Value of B.MESSAGE

EVMSG

Detailed information

Character value of the detailed information (B.DETAIL) in the following format: informaion-1Δinformaion-2Δinformaion-3Δ...informaion-nΔ (where Δ indicates a space)

EVDETAIL

Severity level

Value of E.SEVERITY

EVSEV

User name

Value of E.USER_NAME

EVUSNAM

Object type

Value of E.OBJECT_TYPE

EVOBTYP

Object name

Value of E.OBJECT_NAME

EVOBNAM

Root object type

Value of E.ROOT_OBJECT_TYPE

EVROBTYP

Root object name

Value of E.ROOT_OBJECT_NAME

EVROBNAM

Product name

Value of E.PRODUCT_NAME

EV"PRODUCT_NAME"

Object ID

Value of E.OBJECT_ID

EV"OBJECT_ID"

Occurrence

Value of E.OCCURRENCE

EV"OCCURRENCE"

Start time

Value of E.START_TIME

EV"START_TIME"

End time

Value of E.END_TIME

EV"END_TIME"

Return code

Value of E.RESULT_CODE

EV"RESULT_CODE"

Event source host name

Value of E.JP1_SOURCEHOST

Only when the event source host mapping is enabled

EV"JP1_SOURCEHOST"

Any extended attribute

Value of a named extended attribute

EV"extended-attribute-name"

Correlation event flag

Value of E.@JP1IM_CORRELATE

Not a correlation event: 0

Correlation approval event: 1

Correlation failure event: 2

Only when the correlation event generation function is enabled and the integrated monitoring database is enabled

EV"@JP1IM_CORRELATE"

Original severity level

Value of E.@JP1IM_ORIGINAL_SEVERITY

Only when the severity changing function is enabled

EV"@JP1IM_ORIGINAL_SEVERITY"

New severity level flag

Value of E.@JP1IM_CHANGE_SEVERITY

Severity is not changed: 0

Severity is changed: 1

Only when the severity changing function is enabled

EV"@JP1IM_CHANGE_SEVERITY"

Changed display message

Value of E.@JP1IM_DISPLAY_MESSAGE

Only when the display message change function is enabled

EV"@JP1IM_DISPLAY_MESSAGE"

New display message flag

Value of E.@JP1IM_CHANGE_MESSAGE

Message is not changed: 0

Message is changed: 1

Only when the display message change function is enabled

EV"@JP1IM_CHANGE_MESSAGE"

Memo

Value of E.@JP1IM_MEMO

An attribute that is set after memo is set

EV"@JP1IM_MEMO"

Common exclude conditions group ID

Value of E.JP1_IMCOMEXCLUDE_ID

Only when the extended mode of common exclusion is enabled and the integrated monitoring database is enabled

EV"JP1_IMCOMEXCLUDE_ID"

Common exclude conditions group name

Value of E.JP1_IMCOMEXCLUDE_NAME

Only when the extended mode of common exclusion is enabled and the integrated monitoring database is enabled

EV"JP1_IMCOMEXCLUDE_NAME"

Common exclude conditions group target-for-exclusion

Value of E.JP1_IMCOMEXCLUDE_TARGET

Only when the extended mode of common exclusion is enabled and the integrated monitoring database is enabled

EV"JP1_IMCOMEXCLUDE_TARGET"

When a variable name other than those listed above is specified, the statement including the variable is not replaced with event information. For example, when you use the variable AAA to compose the statement $AAA, the literal characters $AAA are passed to the New item window in JP1/Service Support.

When the value of an attribute that is specified in EV"extended-attribute-name" is not available, the statement including the variable is not replaced with event information. For example, when you specify the statement $EV"BBB" but the JP1 event does not have the extended attribute BBB, the literal characters $EV"BBB" are passed to the New item window in JP1/Service Support.

When the value of an attribute that is specified in a statement other than EV"extended-attribute-name" is not available, the statement including the variable is replaced with an empty string. For example, when you specify the statement $EVSEV but the JP1 event does not have the extended attribute SEVERITY, "" (an empty string) is passed to the New item window in JP1/Service Support.

Example definition

To show "Event that occurred on event-source-host name (IP-address): event-ID" in the Title element of the New item window in JP1/Service Support (only when the event source host mapping is enabled):

TITLE=Event that occurred on $EV"JP1_SOURCEHOST" ($EVIPADDR): $EVIDBASE

To show a URL link (by URL-encoding the attribute value with UTF-8 character encoding) in the Related information element of the New item window in JP1/Service Support:

LINKURL=http://host/page?msg=$EVMSG$URLENC

Host information file (jcs_hosts)

Format

IP-address host-name-1 host-name-2 host-name-3 ... host-name-8
IP-address host-name-1 host-name-2 host-name-3 ... host-name-8
              :

File

jcs_hosts (host information file)

jcs_hosts.model (model file for the host information file)

Storage directory

In Windows

For a physical host:

Scope-path\conf\

For a logical host:

shared-folder\jp1scope\conf\

In UNIX

For a physical host:

/etc/opt/jp1scope/conf/

For a logical host:

shared-directory/jp1scope/conf/

Description

This file defines the host information that is managed by JP1/IM - Manager (Central Scope).

The host information file is used to specify the host information that is used for automatic generation of a monitoring tree and for Host name Comparison during JP1 event collation processing for changing the status of monitoring objects. The format of the host information file is the same as for the hosts file.

If # is specified, any text following # is treated as a comment.

When the definitions are applied

The contents of the host information file take effect when JP1/IM - Manager is restarted or the jco_spmd_reload command is executed after the jcshostsimport command has been executed.

If you use the jcshostsimport command to store the contents of the host information file in the host information database, the host names become all lowercase. Therefore, the host names output by jcshostsexport are also in lowercase.

The jcshostsimport command does not store comments in the host information file.

Information that is specified

IP-address host-name-1 host-name-2 host-name-3 ... host-name-8

Specifies an IP address from the beginning of the line (other than spaces), and then specifies host names or alias names after one or more spaces or tabs.

The maximum length of the IP address is 63 bytes. IP addresses of IP V6 are not supported.

The maximum length of a host name or alias name is 255 bytes.

You can specify a maximum of 8 host names for one IP address and a maximum of 8 IP addresses for one host name.

If the same IP address is specified more than once, the first IP address defined is effective.

If there is a line that contains only an IP address, an error occurs during jcshostsimport command execution.

A host name is not case sensitive. Japanese characters cannot be used for a host name. An IP address can also be expressed in hexadecimal notation.

Example definition

#
# jcs_hosts
#
# Internet Address Hostname
100.100.10.10     samplehost1  samplehost2

Guide information file (jcs_guide.txt)

Format 1

DESC_VERSION=1

[EV_GUIDE_number]
NUM=number
EV_COMP_number=attribute-specification:regular-expression
EV_TITLE=character-string
EV_GUIDE=message
[END]
[EV_GUIDE_number]
NUM=number
EV_COMP_number=attribute-specification:regular-expression
EV_TITLE=character-string
EV_GUIDE=message
[END]
   :

Format 2

DESC_VERSION=2

[EV_GUIDE_number]
NUM=number
EV_COMP_number=attribute-specification:regular-expression
EV_TITLE=character-string
EV_FILE=guide-message-file
[END]
[EV_GUIDE_number]
NUM=number
EV_COMP_number=attribute-specification:regular-expression
EV_TITLE=character-string=character-string
EV_FILE=guide-message-file
[END]
   :

File

The guide information file (jcs_guide.txt) to be edited depends on the language encoding supported by JP1/IM. The following table shows the correspondence between the language encodings supported by JP1/IM and the guide information files to be edited.

Table 2‒52: Correspondence between language encodings supported by JP1/IM and the guide information files

OS

Language type

Language encoding supported by JP1/IM

File to be edited

Windows

Japanese

jcs_guide_sjis.txt (guide information file)

jcs_guide_sjis.txt.model

(model file for the guide information file)

English

jcs_guide.txt (guide information file)

jcs_guide.txt.model (model file for the guide information file)

Chinese

jcs_guide_GB18030.txt (guide information file)

UNIX#

Japanese

Shift-JIS encoding

jcs_guide_sjis.txt (guide information file)

jcs_guide_sjis.txt.model

(model file for the guide information file)

EUC encoding

jcs_guide_euc.txt (guide information file)

jcs_guide_euc.txt.model

(model file for the guide information file)

UTF-8 encoding

/etc/opt/jp1scope/conf/jcs_guide_UTF-8.txt

shared-directory/jp1scope/conf/jcs_guide_UTF-8.txt

English

jcs_guide.txt (guide information file)

jcs_guide.txt.model

(model file for the guide information file)

Chinese

GB18030 encoding

jcs_guide_GB18030.txt (guide information file)

#: Only files corresponding to the languages supported by the OS exist.

Storage directory

In Windows

For a physical host:

Scope-path\conf\

For a logical host:

shared-folder\jp1scope\conf\

In UNIX

For a physical host:

/etc/opt/jp1scope/conf/

For a logical host:

shared-directory/jp1scope/conf/

Description

This file defines guide information about the JP1 events that trigger a change in monitoring object status.

The information specified in this file is displayed in the Guide window of JP1/IM - View.

The maximum size of the guide information file is 1 megabyte.

Format 2 is used to import a user-created TXT or HTML file as the guide-message file and then display it in the Guide window.

If there are multiple matching guide information items, the first item specified in the guide information file is effective.

In Windows, guide information files from version 07-00 of JP1/IM - Manager (Central Scope) can also be read in JP1/IM - Manager version 08-00 and later.

In Windows, guide information files from version 08-00 or later of JP1/IM - Manager can also be read in version 07-00 of JP1/IM - Manager (Central Scope), but the specification EV_FILE=guide-message-file under DESC_VERSION=2 is ignored, and the specification EV_GUIDE=message takes precedence. An error results if the file includes neither specification.

If # is specified, any text following # is treated as a comment. Note that a comment cannot be specified after the start tag, attribute information, or end tag. An error results if a comment is specified following the start and end tags. If a comment is specified following an attribute value, that comment is treated as part of the attribute value.

To use \, specify \\. If \ is used in other than \n or \$, a log is output and the line containing \ is ignored.

When the definitions are applied

After the guide information file is edited, the definitions in the file take effect when JP1/IM - Manager is restarted or when the jco_spmd_reload command is executed.

Information that is specified

DESC_VERSION=1 | 2

Specifies the version of the guide information file. The permitted values are 1 and 2.

If you specify the EV_FILE parameter to call a guide-message file, you must specify 2 in this parameter.

If you specify DESC_VERSION=1, EV_GUIDE=message, and EV_FILE=guide-message-file together, the specification of EV_FILE=guide-message-file will be ignored.

If you specify DESC_VERSION=2 and also specify both EV_GUIDE=message and EV_FILE=guide-message-file, the specification of EV_FILE=guide-message-file will take precedence.

[EV_GUIDE_number]

This is the start tag for the guide information. The information from the [EV_GUIDE_number] tag to the [END] tag constitutes a single definition block. Between this parameter and [END], specify a condition for JP1 events that are to be displayed in the Guide window and the message that is to be displayed. The number begins with 1 and increments by 1 up to the number of guides.

The specification in each instance of the EV_GUIDE_number tag must be unique. If an invalid character string is specified, a log is output and the corresponding specification is ignored.

If an attribute specified in the EV_GUIDE_number tag is not permitted, the corresponding specification is ignored.

NUM=number

Specifies the total number of EV_COMP_number entries.

EV_COMP_number=attribute-specification:regular-expression

Specifies an attribute to be compared. Specify this parameter for each attribute that is to be compared. The specification in number begins with 1 and increments by 1. When multiple parameters have been specified and the AND condition among them is completely satisfied, the message specified in the EV_GUIDE parameter is displayed in the Guide window.

The value specified in EV_COMP_number is ignored if it is less than 1 or greater than the value specified in NUM=number.

Express the event ID as 8 digits. If you specify B.ID as an attribute specification for EV_COMP_number and you set only the base part of the event ID in the matching condition, you can omit specification of the extended part.

Example:

EV_COMP_1=B.ID:00004107:00000000 or EV_COMP_1=B.ID:00004107

attribute-specification

Specifies an attribute of one the following types:

JP1 event basic attribute: If you specify this type of attribute, use the format B.attribute-name.

JP1 event extended attribute: If you specify this type of attribute, use the format E.attribute-name.

Monitoring node attribute: If you specify this type of attribute, you can use the format T.MONNODEID (monitoring node ID), with the monitoring node ID expressed as 8 hexadecimal characters.

regular-expression

Specifies a value of the attribute specified in attribute-specification using a regular expression. For the regular expression, use an extended regular expression. For details about regular expressions, see Appendix G. Regular Expressions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

EV_TITLE=character-string

Specifies the character string that is to be displayed as the title of the Guide window. You can specify this parameter only once between [EV_GUIDE_number] and [END].

EV_GUIDE=message

Specifies the character string that is to be displayed as a guide message in the Guide window. If you use HTML tags, you can display the guide message in HTML format in the Guide window (for details about the supported HTML tags, see Table 2-53 HTML tags that can be used in guide messages in the description of EV_FILE). Note that you can specify this parameter only once between [EV_GUIDE_number] and [END].

Express the message as a maximum of 10,240 bytes of characters. If the specified message consists of more than 10,240 bytes, the portion of the message in excess of 10,240 bytes is not displayed in the Guide window.

To use \ in the message, specify \\. To use $, specify \$. If $B.attribute-nameΔ or $E.attribute-nameΔ is specified in the message, the attribute value corresponding to the JP1 event attribute name is expanded (Δ indicates a space). The monitoring node ID replaces $T.MONNODEIDΔ (Δ indicates a single-byte space). If there is no corresponding attribute, the attribute is replaced with blanks.

To use a linefeed code in the message, specify \n.

EV_FILE=guide-message-file

Specifies the full path or relative path (from Scope-path\conf\guide\ or /etc/opt/jp1scope/conf/guide/) of the file that contains the guide message to be displayed in the Guide window. Note that you can specify this parameter only once between [EV_GUIDE_number] and [END].

Express the file name using a maximum of 1,024 bytes of characters. If the specified file name exceeds 1,024 bytes, an error occurs when JP1/IM - Manager starts or the guide message file is called from JP1/IM - View.

When you specify this parameter, you must specify 2 as the value of DESC_VERSION.

The file specified as guide-message-file can have any file name and extension. We recommend that you use a file name that is easy to manage, and that you use the extension .txt if the guide messages are in TXT format and the extension .html or .htm if the guide messages are in HTML format.

Examples: guide001_AJS2.txt, guide001_AJS2.htm

Guide-message file

Specify in the guide-message file in TXT or HTML format the information that you want to display in the Guide window. The information that you can specify is the same as for EV_GUIDE in the guide information file. In the case of a guide-message file, you can edit the formatting by inserting linefeed codes.

The contents and syntax of the guide-message file are not checked.

You can store the created guide-message file in any folder. However, when you are operating in a cluster configuration, you should store it in the following folder for purposes of system failover:

• In Windows

shared-folder\jp1scope\conf\guide\

• In UNIX

shared-directory/jp1scope/conf/guide/

The maximum size of a guide-message file is 1 megabyte. If the file size exceeds 1 megabyte, an error occurs when the guide-message file is loaded from the Guide window of JP1/IM - View.

The table below lists and describes the HTML tags and attributes that can be used to create a guide-message file in HTML format.

Table 2‒53: HTML tags that can be used in guide messages

Tag

Attribute

Description

HTML

--

Declares that this is an HTML text. This tag is mandatory.

HEAD

--

Declares the header of the HTML text.

This tag is mandatory.

BODY

--

Declares the body of the HTML text.

This tag is mandatory.

A

HREF="URL"

Specifies a link-target URL. If a relative path or a URL beginning with mailto: is specified, the integrity of the operation is not guaranteed.

The link specified here is displayed in the Guide window (HTML format). Clicking the link starts a Web browser and accesses the specified URL.

H1, H2, H3, H4, H5, H6

--

Specifies headers.

FONT

SIZE="font-size"

Specifies the font size. The permitted values are from 1 to 7.

COLOR="font-color"

Specifies the font color. You can specify the following 16 colors:

black, silver, gray, white, maroon, red, purple, fuchsia, green, lime, olive, yellow, navy, blue, teal, aqua

If you specify any other font color, the operation is not guaranteed.

B

--

Specifies boldface type.

I

--

Specifies italics type.

HR

--

Specifies an underscore.

BR

--

Specifies a forced linefeed.

Legend:

--: None

If any other HTML tags are used, the integrity of operations is not guaranteed.

[END]

Specifies the end tag for the guide information.

Example definition

# JP1/IM-CS Guide Information File.

DESC_VERSION=1
[EV_GUIDE_1]
NUM=2
EV_TITLE=JP1/AJS2  Abnormal termination of job A
EV_COMP_1=T.MONNODEID:0000000A
EV_COMP_2=B.ID:00000111
EV_GUIDE=The job terminated abnormally. \nCheck whether an error has occurred on the $E.C0 host.
[END]
[EV_GUIDE_2]
NUM=1
EV_COMP_1=B.ID:00004107
EV_GUIDE=The job terminated abnormally. \nCheck whether an error has occurred on the $E.C0 host.\nAs an example of failure, a job failed at host A due to a memory shortage in the past. Use the vmstat command to check the available memory capacity.
[END]

Settings file for the maximum number of status change events (evhist_warn_event_xxx.conf)

Format

[logical-host-name\JP1SCOPE\BMS\EVHISTORY]
"EVHIST_WARN_EVENT"=dword:value

File

evhist_warn_event_on.conf (used to enable monitoring of the maximum number of status change events)

evhist_warn_event_off.conf (used to disable monitoring of the maximum number of status change events)

Storage directory

In Windows

For a physical host:

Scope-path\conf\

For a logical host:

shared-folder\jp1scope\conf\

In UNIX

For a physical host:

/etc/opt/jp1scope/conf/

For a logical host:

shared-directory/jp1scope/conf/

Description

This file defines whether a JP1 event is to be issued when the number of status change events exceeds the maximum value (100 events).

When you have enabled this function, a JP1 event is issued when the number of status change events for a monitoring object exceeds 100. The JP1 event that is issued is a warning event whose event ID is 3FB1.

In JP1/IM - Manager that has been installed as a new installation, this function (issuance of a warning JP1 event) is enabled. In JP1/IM - Manager that has been installed as an upgrade installation, the same setting that was specified in the previous version is initially retained.

When the definitions are applied

The definition takes effect after JP1/IM - Manager is restarted by executing the jbssetcnf command.

Information that is specified

[logical-host-name\JP1SCOPE\BMS\EVHISTORY]

Specifies the key name for the JP1/IM environment settings.

For logical-host-name, specify JP1_DEFAULT for the physical host and logical-host-name for a logical host.

"EVHIST_WARN_EVENT"=dword:value

The value of evhist_warn_event_on.conf is 00000001 (JP1 event with event ID 3FB1 is issued).

The value of evhist_warn_event_off.conf is 00000000 (JP1 event with event ID 3FB1 is not issued).

Do not edit this parameter.

For details about the JP1 events, see 3.2.2 Details of JP1 events.

Settings file for the completed-action linkage function (action_complete_xxx.conf)

Format

[logical-host-name\JP1SCOPE\BMS]
"ACTION_COMPLETE_MODE"=dword:value

File

action_complete_on.conf (used to enable the completed-action linkage function)

action_complete_off.conf (used to disable the completed-action linkage function)

Storage directory

In Windows

For a physical host:

Scope-path\conf\

For a logical host:

shared-folder\jp1scope\conf\

In UNIX

For a physical host:

/etc/opt/jp1scope/conf/

For a logical host:

shared-directory/jp1scope/conf/

Description

This file defines whether the completed-action linkage function is to be enabled.

When the function is enabled, the status of a monitoring object changes on Central Scope according to the JP1 event action status at Central Console.

In JP1/IM - Manager that has been installed as a new installation, this function is enabled. In JP1/IM - Manager that has been installed as an upgrade installation, the same setting that was specified in the previous version is initially retained.

When the definitions are applied

The definition takes effect after JP1/IM - Manager is restarted by executing the jbssetcnf command.

Information that is specified

[logical-host-name\JP1SCOPE\BMS]

Specifies the key name for the JP1/IM environment settings.

For logical-host-name, specify JP1_DEFAULT for the physical host and logical-host-name for a logical host.

"ACTION_COMPLETE_MODE"=dword:value

The value of action_complete_on.conf is 00000001.

The value of action_complete_off.conf is 00000000.

Do not edit this parameter.

Definition file for automatic delete mode of status change event

Format

[logical-host-name\JP1SCOPE\BMS\EVHISTORY]
"EVPROCESSED_MODE"=dword:value

File

Use any file.

Storage directory

In Windows

Any folder

In UNIX

Any directory

Description

This definition file is used to enable the function that automatically deletes the status change events when a JP1 event's action status becomes Processed.

In JP1/IM - Manager that has been installed as a new installation, this function is disabled. In JP1/IM - Manager that has been installed as an upgrade installation, the same setting that was specified in the previous version is initially retained.

When the definitions are applied

The definition takes effect after JP1/IM - Manager is restarted by executing the jbssetcnf command.

Information that is specified

[logical-host-name\JP1SCOPE\BMS\EVHISTORY]

Specifies the key name for the JP1/IM environment settings.

For logical-host-name, specify JP1_DEFAULT for the physical host and logical-host-name for a logical host.

"EVPROCESSED_MODE"=dword:value

Specifies 1 to enable the function that automatically deletes status change events and 0 to disable the function.

Definition file for monitoring object initialization mode

Format

[logical-host-name\JP1SCOPE\BMS]
"AUTO_INITIALIZE_MODE"=dword:value

File

Use any file.

Storage directory

In Windows

Any folder

In UNIX

Any directory

Description

This definition file is used to enable the function that automatically initializes monitoring objects when a specific JP1 event is received.

In JP1/IM - Manager that has been installed as a new installation, this function is disabled. In JP1/IM - Manager that has been installed as an upgrade installation, the same setting that was specified in the previous version is initially retained.

When the definitions are applied

The definition takes effect after JP1/IM - Manager is restarted by executing the jbssetcnf command.

Information that is specified

[logical-host-name\JP1SCOPE\BMS]

Specifies the key name for the JP1/IM environment settings.

For logical-host-name, specify JP1_DEFAULT for the physical host and logical-host-name for a logical host.

"AUTO_INITIALIZE_MODE"=dword:value

Specifies 1 to enable the function that automatically initializes monitoring objects and 0 to disable the function.

Automatic backup and recovery settings file for the monitoring object database (auto_dbbackup_xxx.conf)

Format

[logical-host-name\JP1SCOPE\BMS]
"AUTO_DB_BACKUP_RECOVERY"=dword:value

File

auto_dbbackup_on.conf (used to enable the backup and recovery functions for the monitoring object database)

auto_dbbackup_off.conf (used to disable the backup and recovery functions for the monitoring object database)

Storage directory

In Windows

For a physical host:

Scope-path\conf\

For a logical host:

shared-folder\jp1scope\conf\

In UNIX

For a physical host:

/etc/opt/jp1scope/conf/

For a logical host:

shared-directory/jp1scope/conf/

Description

This file defines whether to enable the function that protects the monitoring object database from corruption that may be caused by OS shutdown or cluster system switching during monitoring tree update processing (automatic backup and recovery functions for the monitoring object database).

If enabled, this function backs up the existing monitoring object database when the monitoring tree is updated, and performs recovery from the backup of the monitoring object database in the event of a failure (if update processing finishes without a failure occurring, the backup data is automatically deleted).

When JP1/IM - Manager is newly installed, this function is enabled by default, but when JP1/IM - Manager is upgraded, the legacy settings are inherited.

When you are operating in a cluster operation system, you must enable this function.

When the definitions are applied

The definition takes effect after JP1/IM - Manager is restarted by executing the jbssetcnf command.

Information that is specified

[logical-host-name\JP1SCOPE\BMS]

Specifies the key name for the JP1/IM environment settings.

For logical-host-name, specify JP1_DEFAULT for the physical host and logical-host-name for a logical host.

"AUTO_DB_BACKUP_RECOVERY"=dword:value

The value of auto_dbbackup_on.conf is 00000001.

The value of auto_dbbackup_off.conf is 00000000.

Do not edit this parameter.

Coding example

This example enables the automatic backup and recovery functions for the monitoring object database of JP1/IM - Manager on the HostA logical host:

[HostA\JP1SCOPE\BMS\JCSDB]"AUTO_DB_BACKUP_RECOVERY"=dword:00000001

Definition file for object types

Format

@encode character-encoding
[comment]
[ObjectType]
definition-block [comment]
[End]
[comment]

File

company-name_product-name_company-name_product-name_obj.en (definition file for object types)

company-name can be changed to series-name_product-name. We recommend that you use the value specified for PRODUCT_NAME at the time of JP1 event issuance as the file name, with the forward slash (/) replaced by the underscore (_). Because hitachi is used for the default file name, use a name other than hitachi for company-name.

Storage directory

In Windows

For a physical host:

Console-path\conf\console\object_type\

For a logical host:

shared-folder\jp1cons\conf\console\object_type\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/object_type/

For a logical host:

shared-directory/jp1cons/conf/console/object_type/

Description

The definition file for object types defines the object types and root object types that are displayed in Object type and Root object type in the following JP1/IM-View windows:

Severe Event Definitions window

Event Acquisition Settings window

Common Exclusion-Conditions Settings window

Common Exclusion-Condition Settings (Extended) window

Repeated Event Condition Settings window

Event Search Conditions window

Settings for View Filter window

Detailed Settings for Event Receiver Filter window

Action Parameter Detailed Definitions window

Severity Change Definition Settings window (Add Severity Change Definition Settings window)

Display Message Change Definition Settings window (Add Display Message Change Definition Settings window)

For JP1/IM - Manager for Linux, the file must use UTF-8 encoding, and for JP1/IM - Manager for an OS other than Linux, the file must use Shift-JIS or EUC encoding.

If multiple files contain the same object type, the integrity of operations is not guaranteed.

When the definitions are applied

The definition takes effect after JP1/IM - View is restarted.

Information that is specified

@encode character-encoding

Specifies the character encoding that is to be used in the definition file for object types.

To create an additional file for definition file for object types, use an @encode statement to specify the character set for the definition file.

Item names will be expressed in characters that can be represented in the character encoding specified in the @encode statement. In addition, the definition file for object types will be saved in the character encoding specified in the @encode statement.

In the following circumstances, item names displayed in JP1/IM - View might be garbled:

If the item name uses characters that cannot be represented in the character encoding specified in the @encode statement

If the character encoding specified in the @encode statement does not match the character encoding in which the file was saved

If no @encode statement exists or if there is an error in the specified character set name that follows the @encode statement, the character set is determined automatically. However, depending on the content of the definition file, the character encoding might not be determined correctly.

The specifiable character encodings are as follows:

C

EUCJIS

SJIS

UTF-8

GB18030

Note

If you use UTF-8 as the encoding to save a definition file, save the file without attaching a BOM (byte order mark).

An error is output in the following cases:

A character encoding other than C, EUCJIS, SJIS UTF-8 or GB18030 is specified

The definition file does not begin with @encode.

@encode is not followed by a character encoding specification.

[comment]

Specifies a comment as a character string that begins with a hash mark (#) and does not contain a linefeed code.

[ObjectType]

Specify [ObjectType] and [End] as is, including the square brackets.

definition-block [comment]

A definition block consists of an extended attribute value and a list display character string. The extended attribute value is a character string that is stored in the object type or root object type. The list display character string is a character string that is displayed in a list drop-down list.

[End]

Specify [End] as is, including the square brackets.

When you define this information, note the following:

The object type (extended attribute value) cannot contains spaces.

For list display character strings, specify the extended attribute value itself instead of characters.

Example definition

The following shows an example of a definition file for object types:

@encode UTF-8
[ObjectType]
# Extended attribute value,  List display character string   Comment
ACTION,        ACTION          // action
ACTIONFLOW,    ACTIONFLOW      // action flow
BATCHQUEUE,    BATCHQUEUE      // batch queue
JOB,           JOB             // job
JOBNET,        JOBNET          // jobnet
MEDIA,         MEDIA           // media
PRINTER,       PRINTER         // printer
PRINTJOB,      PRINTJOB        // print job
PRINTQUEUE,    PRINTQUEUE      // pipe queue
PROCESS,       PROCESS         // process
RESTORE,       RESTORE         // restore
[End]

Definition file for executing applications

Format

@file type="definition-file-type", version="definition-format-version";
# comment-line
@define-block type="application-execution-def";
id="application-execution-definition-identifier";
path="command-path";
description="description-of-application-execution";
@define-block-end;

File

!JP1_CC_APP0.conf (definition file for executing applications)

!JP1_CC_APP0.conf.model (model file for the definition file for executing applications)

Storage directory

View-path\conf\appexecute\en\

Description

This file defines the IDs and paths of executable files, such as applications that are started from the Event Console window.

JP1/IM provides the jcoappexecfcheck command, which checks the contents of the definition file for executing applications. For details about this command, see jcoappexecfcheck (Windows only) in Chapter 1. Commands.

When the definitions are applied

The definition takes effect after JP1/IM - View is restarted.

Information that is specified

@file type="application-execution-definition";

Declares that this is the definition file for executing applications. This statement is mandatory.

This statement must be specified on the first line of the file.

# comment-line

A line beginning with a hash mark (#) is treated as a comment.

Application execution definition block

Defines the path of an executable file, such as an application that is started from the Event Console window, and assigns an ID for purposes of linkage from other definition files.

You can specify the following statements in this block:

id statement

path statement

description statement

If any other statement is written, an error is output, and only the applicable statement is ignored.

The following describes the statements.

id="application-execution-definition-identifier";

Specifies an identifier that is to be assigned to the command path that is specified in this block. This statement is mandatory. You can specify this statement only once in a block.

If the file to be analyzed contains multiple blocks with the same id, their priority is determined as follows and only the block that has the highest priority is effective:

1. Last block when the file names are sorted in ascending order

2. Last block in the file

All the other blocks are ignored.

The application execution definition identifier is a character string consisting of no more than 32 alphanumeric characters. This character string must be unique within the definition. To achieve uniqueness, observe the following naming convention:

company-name_product-name[_function-name-(or-window-name)]

This cannot be a character string that begins with jco_ or the character string default_browser because they are reserved as application execution definition identifiers.

path="command-path";

Defines the path of the executable file that is to be associated with the application execution definition identifier specified in the id statement. This statement is mandatory. You can specify the path statement more than once in the same block. Express the executable file that is to be started as a full path. You can also use a substitute keyword discussed below to assemble a path from data such as the registry.

If you specify this statement more than once, the paths are searched in the order specified and the first path found is used.

In the path statement, you can specify an .exe or .bat file as the executable file.

The current directory is undefined during command execution. A command that uses a relative path from the current directory cannot be specified. Execute such a command after you have executed the cd command by using a file such as a .bat file.

The search processing executes only when JP1/IM - View starts. Therefore, if you have installed an application to be started while JP1/IM - View is running, you must restart JP1/IM - View.

Note that if you attempt to execute a command located under the %WINDIR%\System32 folder in the 64-bit edition of Windows, the WOW64 redirection function executes the corresponding command under the %WINDIR%\SysWow64 folder. If the corresponding command does not exist, command execution might fail. Keep this in mind if you specify a path of an executable file under the %WINDIR%\System32 folder.

Alternate string

In the path statement, you can specify an alternate string that can be replaced during execution.

(1) Alternate keyword string

If the specified definition contains an alternate keyword string, the character string is replaced according to the specified keyword. The format is as follows:

%alternate-keyword%

The following table lists the alternate keywords.

Table 2‒54: List of alternate keywords

Keyword

Substitute data

JCO_JP1USER

JP1 user who logged in to JP1/IM - Manager

JCO_INSTALL_PATH

Name of the JP1/IM - View installation folder

(2) Alternate registry string

If the specified definition contains an alternate registry string, the value is acquired from the specified registry to replace the character string. The format of an alternate registry string is as follows:

[\registry-key\registry-key\...\registry-value]

In an alternate registry string, you can specify the registry-only substitute keyword %UPPER%. If you use %UPPER%, the character string for the key name is compared within the same hierarchy in the registry key. The purpose of this keyword is to always acquire the most recent version when the key is classified by the version in the registry key.

You can specify %UPPER% only once in a registry string. The following example specifies the registry of JP1/SAMPLE using %UPPER%:

[\HKEY_LOCAL_MACHINE\SOFTWARE\HITACHI\SAMPLE\%UPPER%\PATHNAME\PATH00]

In this example, %UPPER% is replaced with the most recent version, so that the most recent executable file is always obtained.

For example, if there are the following two registry keys, the value is acquired from the registry 0700 because 0700 is greater than 0671:

[\HKEY_LOCAL_MACHINE\SOFTWARE\HITACHI\SAMPLE\0671\PATHNAME\PATH00]

[\HKEY_LOCAL_MACHINE\SOFTWARE\HITACHI\SAMPLE\0700\PATHNAME\PATH00]

description="description-of-application-execution";

Adds a description to the application execution definition in the block. You can specify this statement only once in a block.

There is no limit to the number of characters, but we recommend that you specify no more than 50 characters.

The following shows an example of an application execution definition block:

@define-block type="application-execution-def";

id="HITACHI_JP1_SAMPLE";

path="C:\Program Files\Hitachi\JP1\bin\sample.exe";

description="Hitachi Sample Program";

@define-block-end;

Example definition

The following shows an example of a definition file for executing applications:

@file type="application-execution-definition", version="0300";
#-----------------------------------------
@define-block type="application-execution-def";
id="jco_notepad";
path="C:\winnt40\system32\notepad.exe";
@define-block-end;
#-----------------------------------------
@define-block type="application-execution-def";
id="jco_dmp";
path="[\HKEY_LOCAL_MACHINE\SOFTWARE\HITACHI\NETM/DM/P\0521/
    A\PathName\Path00]\bin\DMPSTS.exe";
@define-block-end;

Definition file for on memory mode of status change condition

Format

[logical-host-name\JP1SCOPE\BMS]
"EVENT_MATCH_MODE"=dword:value

File

Use any file.

Storage directory

In Windows

Any folder

In UNIX

Any directory

Description

This definition file is used to enable the memory-resident status change condition function.

In JP1/IM - Manager that has been installed as a new installation, this function is enabled. In JP1/IM - Manager that has been installed as an upgrade installation, the same setting that was specified in the previous version is initially retained.

When the definitions are applied

The definition takes effect after JP1/IM - Manager is restarted by executing the jbssetcnf command.

Information that is specified

[logical-host-name\JP1SCOPE\BMS]

Specifies the key name for the JP1/IM environment settings.

For logical-host-name, specify JP1_DEFAULT for the physical host and logical-host-name for a logical host.

"EVENT_MATCH_MODE"=dword:value

To enable the memory-resident status change condition function, specify 1; to disable the function, specify 0.

Severity changing definition file (jcochsev.conf)

Format

DESC_VERSION=version-information

def definition-name-1
    [cmt comment]
    [define {enable | disable}]
    [addflag {true | false}]
    cnd
        event-condition
    end-cnd
    sev event-level
end-def

def definition-name-2
    [cmt comment]
    [define {enable | disable}]
    [addflag {true | false}]
    cnd
        event-condition
    end-cnd
    sev event-level
end-def

File

jcochsev.conf (severity changing definition file)

jcochsev.conf.model (model file for the severity changing definition file)

Storage directory

In Windows

For a physical host:

Console-path\conf\chsev\

For a logical host:

shared-folder\jp1cons\conf\chsev\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/chsev/

For a logical host:

shared-directory/jp1cons/conf/chsev/

Description

This file defines conditions for changing the event level of JP1 events and the new event level. The event severity changing function changes the event level of a JP1 event if it satisfies an event condition defined in this file. Specify this file using the language encoding that is used by JP1/IM - Manager.

The maximum size of this file is 17 megabytes (17,825,792 bytes). There is no upper limit on the number of definitions.

There are two types of parameters in the severity changing definition file:

Severity changing definition file version

Defines the format version of the severity changing definition file.

Severity changing definition parameter

Defines a condition for JP1 events whose event level is to be changed and the new event level. The higher a severity changing definition is listed in the severity changing definition file, the higher its priority.

When the definitions are applied

The definition takes effect when the event severity changing function is enabled, and one of the following operations is performed:

JP1/IM - Manager is started.

The jco_spmd_reload command is executed.

The OK button is clicked in the Add Severity Change Definition Settings window.

The Apply button is clicked in the View Severity Change Definitions window.

Information that is specified (severity changing definition file version)

DESC_VERSION

Specifies the file version that determines the format of this severity changing definition file as version information. Specify 2. If DESC_VERSION is omitted, 2 is assumed as the file version.

Specify DESC_VERSION on the first line of the definition file (the first line in the file excluding any null lines and comment lines). If there is no file version in the first line, 2 is assumed.

Table 2‒55: Version information of the severity changing definition file format

Version information

Description

1

Indicates version 10-10 or earlier as the version of the severity changing definition file.

2

Indicates version 10-50 as the version of the severity changing definition file.

Table 2‒56: List of parameters that can be specified in the severity changing definition file according to the version information

Version information

Parameter name

1

def to end-def (definition block)

cnd to end-cnd (event condition block)

sev

2

def to end-def (definition block)

cmt comment

define {enable | disable}

addflag {true | false}

cnd to end-cnd (event condition block)

sev

Information that is specified (severity changing definition parameter)

As shown in the following figure, the definition parameter for changing severity consists of a definition block and an event condition block.

Figure 2‒8: Parameter for changing severity

def to end-def (definition block)

These are the start and end parameters for a severity changing definition. The block from def to end-def can be omitted, in which case the system assumes that the event level is not to be changed for any JP1 events. After def, specify the names of severity changing definitions. If you specify defΔdefinition-1Δdefinition-2Δ, then Δdefinition-1Δdefinition-2Δ are treated as the definition names (Δ indicates a single-byte space).

For a definition name, specify a character string of from 1 to 50 bytes. Each definition name must be unique within the severity changing definition file. The permitted characters are all characters other than the control characters (from 0x00 to 0x1F and 0x7F to 0x9F).

cmt comment

Describes the comment for the severity changing definition. The comment specified for cmt is displayed in the comment section of the Severity Change Definition Settings window. Only one cmt parameter can be specified in the definition block. This parameter can be omitted. Specify the comment within 1,024 bytes. The permitted characters are all characters other than the control characters (0x00 to 0x1F, and 0x7F to 0x9F).

If you specify this parameter when version-information is 1, an error occurs.

define {enable | disable}

Specifies whether to enable the severity changing definition. Only one define parameter can be specified in the definition block. To enable the severity changing definition, specify enable, to disable it, specify disable. The define parameter can be omitted. By default, enable is set. The values are not case sensitive.

If you specify this parameter when version-information is 1, an error occurs.

addflag {true | false}

Indicates an additional severity changing definition has been added from a window, and specifies whether the severity changing definition is an additional severity changing definition. Therefore, to edit the severity changing definition file, you do not need to specify the addflag parameter. Only one addflag parameter can be specified in the definition block. Specify true for the additional severity changing definition, and false for the severity changing definition. When true is specified, the icon () is displayed in Type of the View Severity Change Definitions window. The addflag parameter can be omitted. By default, false is specified. The value is not case sensitive.

If you specify this parameter when version-information is 1, an error occurs.

cnd to end-cnd (event condition block)

These are the start and end parameters for the block that specifies a condition for the JP1 events whose event level is to be changed. You must specify one event condition block in a definition block. The event condition block cannot be omitted. If a received JP1 event satisfies multiple event conditions, the definition block closest to the beginning of the severity changing definition file is effective. Tabs and spaces before and after the cnd and end-cnd parameters are ignored.

event-condition

Specifies a condition for the JP1 events whose event level is to be changed. You can specify from 0 to 256 event conditions in an event condition block. You can specify from 1 to 256 event conditions per event condition block. When multiple event conditions are specified, it is assumed that they are connected with the AND condition. Specify the event conditions in the following format (Δ indicates a single-byte space):

attribute-nameΔcomparison-keywordΔoperand[Δoperand]...

Note that a line consisting of only spaces or tabs is ignored during processing.

attribute-name

Specifies the name of the attribute that you want to compare. To specify a basic attribute, place B. immediately before the name. To specify an extended attribute (common information or user-specific information), place E. immediately before the name. The attribute names are case sensitive.

The following table lists and describes the combinations of attribute names and comparison keywords and the operands that can be specified.

Table 2‒57: Combinations of attribute names and comparison keywords and the operands that can be specified

No.

Item

Attribute name

Comparison keyword

Operand

1

Event ID

B.ID

Match

Does not match

A maximum of 100 event IDs can be specified.

Specify event IDs in hexadecimal notation. Event IDs are not case sensitive.

The permitted range is from 0 to 7FFFFFFF.

2

Reason for registration

B.REASON

Match

Does not match

A maximum of 100 reasons for registration can be specified.

3

Source process ID

B.PROCESSID

Match

Does not match

A maximum of 100 source process IDs can be specified.

The permitted value range is from -2,147,483,648 to 2,147,483,647.

4

Source user ID

B.USERID

Match

Does not match

A maximum of 100 source user IDs can be specified.

The permitted value range is from -2,147,483,648 to 2,147,483,647.

5

Source group ID

B.GROUPID

Match

Does not match

A maximum of 100 source group IDs can be specified.

The permitted value range is from -2,147,483,648 to 2,147,483,647.

6

Source user name

B.USERNAME

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 source user names can be specified. However, if a regular expression is used, only one source user name is allowed.

7

Source group name

B.GROUPNAME

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 source group names can be specified. However, if a regular expression is used, only one source group name is allowed.

8

Event-issuing server name (source host)#1

B.SOURCESERVER

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 event-issuing server names can be specified. However, if a regular expression is used, only one event-issuing server name is allowed.

9

Target event server name#1

B.DESTSERVER

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 target event server names can be specified. However, if a regular expression is used, only one target event server name is allowed.

10

Message

B.MESSAGE

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 messages can be specified. However, if a regular expression is used, only one message is allowed.

11

Severity

E.SEVERITY

Match

Multiple severity values can be specified. However, if a regular expression is used, only one severity value is allowed. The following are the specifiable values: Emergency, Alert, Critical, Error, Warning, Notice, Information, or Debug.

12

User name

E.USER_NAME

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 user names can be specified. However, if a regular expression is used, only one user name is allowed.

13

Product name

E.PRODUCT_NAME

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 product names can be specified. However, if a regular expression is used, only one product name is allowed.

14

Object type

E.OBJECT_TYPE

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 object types can be specified. However, if a regular expression is used, only one object type is allowed.

15

Object name

E.OBJECT_NAME

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 object names can be specified. However, if a regular expression is used, only one object name is allowed.

16

Root object type

E.ROOT_OBJECT_TYPE

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 root object types can be specified. However, if a regular expression is used, only one root object type is allowed.

17

Root object name

E.ROOT_OBJECT_NAME

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 root object names can be specified. However, if a regular expression is used, only one root object name is allowed.

18

Object ID

E.OBJECT_ID

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 object IDs can be specified. However, if a regular expression is used, only one object ID is allowed.

19

Occurrence

E.OCCURRENCE

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 occurrences can be specified. However, if a regular expression is used, only one occurrence is allowed.

20

Result code

E.RESULT_CODE

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 termination codes can be specified. However, if a regular expression is used, only one termination code is allowed.

21

Event source host name#1

E.JP1_SOURCEHOST

First characters

Match

Do not match

Is contained

Is not contained

Regular expression

A maximum of 100 event source host names can be specified. However, if a regular expression is used, only one event source host name is allowed.

22

Program-specific extended attribute#2

E.xxxxxxx

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

For the attribute name, you can specify a name with a maximum length of 32 bytes that begins with an uppercase letter and consists of uppercase letters, numeric characters, and the underscore (_).

A maximum of 100 extended attributes can be specified. However, if a regular expression is used, only one extended attribute is allowed.

#1

If the integrated monitoring database and the IM Configuration Management database are enabled, and the comparison keyword is Match or Do not match, the business group name can be specified in a path format.

If the integrated monitoring database and the IM Configuration Management database are disabled, and a comparison keyword other than Match and Do not match is selected, a business group name specified in a path format is treated as a host name.

If the -ignorecasehost option of the jcoimdef command is set to ON, and a comparison keyword other than Regular expression is selected, the character string is no longer case sensitive.

#2

You can also specify a JP1 product-specific extended attribute. For example, the program-specific extended attribute for the JP1/AJS job execution host is E.C0. For details about the product-specific extended attributes, consult the documentation for the products that issue JP1 events.

•comparison-keyword

Specifies one of BEGIN (begins with), IN (matches), NOTIN (does not match), SUBSTR (includes), NOTSUBSTR (does not include), or REGEX (regular expression) as the comparison keyword. The comparison keyword is case sensitive.

•operand

Specifies a character string as the value that is to be compared with the attribute value by the specified comparison keyword. Operands are case sensitive.

Separate multiple operands with one or more consecutive spaces or a tab. The OR condition is applied to the specified operands. Note that if a regular expression is specified, only one operand can be specified.

To specify a space, a tab, end-of-line code (CR or LF), or % as part of an operand, specify as follows:

No.

Value to be set

How to specify

1

Tab (0x09)

%09

2

Space (0x20)

%20

3

% (0x25)

%25

4

Linefeed code LF (0x0a)

%0a

5

Carriage return code CR (0x0d)

%0d

During maximum value checking for the definition format, %20 and %25 are each treated as a single character. The character code specified after the % is not case sensitive. The following shows an example of defining ID matches 100 and 200, which selects multiple operands:

B.IDΔINΔ100Δ200

Legend:

Δ: Space (0x20)

You can specify a maximum of 4,096 bytes of operands per event condition and per event condition block (total length in bytes of all operands that are specified in the event condition block).

sev

Specifies the new event level after the change.

You must specify one sev parameter in a definition block. This parameter cannot be omitted.

You can specify in the sev parameter Emergency, Alert, Critical, Error, Warning, Notice, Information, or Debug.

#comment-line

A line beginning with a hash mark (#) is treated as a comment. Note that if you set the severity changing definition from JP1/IM - View, the comment line beginning with # is deleted.

Example definition

Change the event level to Emergency when the event ID is 100 or 200, the existing event level is Warning, and the source host is hostA, hostB, or hostC:

DESC_VERSION=2
def Event level change 1
    cmt comment1
    define enable
    cnd
        B.ID IN 100 200
        E.SEVERITY IN Warning
        B.SOURCESERVER IN hostA hostB hostC
    end-cnd
    sev Emergency
end-def

Display item definition file for the severity change definition (chsev_attr_list.conf)

Format

# comment-line
attribute-name
attribute-name
  .
  .
attribute-name

File

chsev_attr_list.conf (display item definition file for the severity change definition)

chsev_attr_list.conf.model (model file of the display item definition file for the severity change definition)

Storage directory

In Windows

For a physical host:

Console-path\conf\chsev\attr_list

For a logical host:

shared-folder\jp1cons\conf\chsev\attr_list

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/chsev/attr_list

For a logical host:

shared-directory/jp1cons/conf/chsev/attr_list

Description

This definition file specifies the items to display in the Attribute name display area of the Severity Change Definition Settings window. The display items specified in the display item definition file for the severity change definition are displayed in the Attribute name display area of the Severity Change Definition Settings window in the specified order.

When the definitions are applied

The contents of the definition file take effect when Central Console is started, and the definition is reloaded by executing the jco_spmd_reload command.

Information that is specified

#comment-line

A line beginning with a hash mark (#) is treated as a comment.

attribute-name

For the display item definition file for the severity change definition, specify the display items to display in the Attribute name display area of the Severity Change Definition Settings window. Write an attribute name corresponding to the display item per line. You can specify 0 to 256 display items.

The attribute name is case sensitive. Single-byte spaces and tabs before or after the attribute name are ignored.

If you specify SEPARATOR, -------------------- is displayed in the Attribute name display area of the Severity Change Definition Settings window. You can set SEPARATOR to separate frequently used items from those used less frequently.

However, if you specify only SEPARATOR, only -------------------- is displayed in the Attribute name display area. In this case, if you select --------------------, you cannot set the attribute name.

The following table lists the specifiable attribute names.

Table 2‒58: List of display items

No.

Display item

Attribute name

1

Event source host name#

E.JP1_SOURCEHOST

2

Registered host name

B.SOURCESERVER

3

Event level

E.SEVERITY

4

Object type

E.OBJECT_TYPE

5

Object name

E.OBJECT_NAME

6

Root object type

E.ROOT_OBJECT_TYPE

7

Root object name

E.ROOT_OBJECT_NAME

8

Occurrence

E.OCCURRENCE

9

User name

E.USER_NAME

10

Message

B.MESSAGE

11

Product name

E.PRODUCT_NAME

12

Event ID

B.ID

13

Destination event server name

B.DESTSERVER

14

Program-specific extended attribute

OTHER_EXTENDED_ATTRIBUTE

15

Reason for registration

B.REASON

16

Source process ID

B.PROCESSID

17

Source user name

B.USERNAME

18

Source user ID

B.USERID

19

Source group name

B.GROUPNAME

20

Source group ID

B.GROUPID

21

Object ID

E.OBJECT_ID

22

Result code

E.RESULT_CODE

23

--------------------

SEPARATOR

Note:

If the same attribute name is specified twice, both specifications are ignored.

Also, if the display item definition file for the severity change definition cannot be read, and the number of valid display items is 0, items 1 to 22 are displayed.

#

If the mapping function of the source host is not enabled, the event source host name is not displayed in the Severity Change Definition Settings window.

Auto-input definition file for the severity change definition (chsev_auto_list.conf)

Format

# comment-line
[DEFAULT_NAME severity-changing-definition-name]
attribute-name
attribute-name
  .
  .
attribute-name
attribute-name

File

chsev_auto_list.conf

chsev_auto_list.conf.model (model file of the auto-input definition file for the severity change definition)

Storage directory

In Windows

For a physical host:

Console-path\conf\chsev\auto_list

For a logical host:

shared-folder\jp1cons\conf\chsev\auto_list

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/chsev/auto_list

For a logical host:

shared-directory/jp1cons/conf/chsev/auto_list

Description

This file defines the JP1 event attribute that is set automatically when you select a JP1 event in the event list of the Event Console window, select View, and then Add Severity Change Definition Settings to open the Add Severity Change Definition Settings window. Also, the default severity changing definition name can be defined.

When the definitions are applied

The contents of the definition file take effect when Central Console starts, and when the definition is reloaded by executing the jco_spmd_reload command.

Information that is specified

# comment-line

A line beginning with a hash mark (#) is treated as a comment.

DEFAULT_NAME severity-changing-definition-name

Indicates the identifier that defines the severity changing definition name. The identifier must be written at the beginning of the file excluding the comment and blank lines.

The severity changing definition name specified for this parameter is displayed as the initial value when you select a JP1 event from the event list in the Event Console window, select View, and then Add Severity Change Definition Settings to open the Add Severity Change Definition Settings window.

Specify a character string of maximum of 40 bytes. Any characters, other than control characters (0x00 to 0x1F, and 0x7F to 0x9F), are permitted. If you specify over 40 bytes of characters, the characters from the 41st byte are dropped, and the first 40 bytes are treated as the severity changing definition name. If you omit this parameter, additional-severity-changing-definition is used as the severity-changing-definition-name.

attribute-name

For the auto-input definition file for the severity change definition, specify the JP1 event attribute which is set as an event condition when you select a JP1 event from the event list in the Event Console window, select View, and then Add Severity Change Definition Settings to open the Add Severity Change Definition Settings window. The attribute name condition specified for this parameter is displayed as the initial value when you select a JP1 event from the event list in the Event Console window, select View, and then Add Severity Change Definition Settings to open the Add Severity Change Definition Settings window.

For the definition item, specify one attribute name of the JP1 event to be set for each line.

The attribute name is case sensitive. Single-byte spaces or tabs before or after the attribute name are ignored.

Note that if you specify the same attribute name more than once, both values are ignored, and the KAVB1935-W message is output to the integrated trace log file.

JP1 event attributes are displayed automatically in the Event conditions section of the Severity Change Definition Settings window in the order they were written in the display item definition file for the severity change definition (chsev_attr_list.conf).

The following table lists the specifiable attribute names.

Table 2‒59: List of display items

No.

Display item

Attribute name

1

Event source host name#

E.JP1_SOURCEHOST

2

Registered host name

B.SOURCESERVER

3

Event level

E.SEVERITY

4

Object type

E.OBJECT_TYPE

5

Object name

E.OBJECT_NAME

6

Root object type

E.ROOT_OBJECT_TYPE

7

Root object name

E.ROOT_OBJECT_NAME

8

Occurrence

E.OCCURRENCE

9

User name

E.USER_NAME

10

Message

B.MESSAGE

11

Product name

E.PRODUCT_NAME

12

Event ID

B.ID

13

Destination event server name

B.DESTSERVER

14

Reason for registration

B.REASON

15

Source process ID

B.PROCESSID

16

Source user name

B.USERNAME

17

Source user ID

B.USERID

18

Source group name

B.GROUPNAME

19

Source group ID

B.GROUPID

20

Object ID

E.OBJECT_ID

21

Result code

E.RESULT_CODE

Note:

If the same attribute name is specified twice, both specifications are ignored.

Also, if the auto-input definition file for the severity change definition cannot be read, and the number of valid display items is 0, items 1 to 3, and items 10 to 12 are displayed.

#

If the mapping function of the source host is not enabled, the event source host name is not displayed in the Add Severity Change Definition Settings window.

Communication environment definition file (view.conf.update)

Format

[JP1_DEFAULT\JP1CONSOLEVIEW]
"COM_SO_TIMEOUT"=dword:hexadecimal-value
"COM_RMI_TIMEOUT"=dword:hexadecimal-value

File

view.conf.update (model file for the communication environment definition file)

Storage directory

View-path\default\

Description

This file defines timeout periods for communication between JP1/IM - View and JP1/IM - Manager (Central Console).

When a low-speed line is used in the network or when the viewer's workload is high, timeouts might occur during the viewer's communication processing, resulting in communication errors. You can prevent such communication errors by modifying timeout periods. If you set a timeout period, you must also specify the same setting at the JP1/IM - Manager (Central Console) that is connected.

If you change any value in this definition file, you must also change the value in the communication environment definition file for JP1/IM - Manager (Central Console).

The required definition is provided as a model file. To change the settings, copy the model file and then edit the copy.

When the definitions are applied

The definitions take effect after the jbssetcnf command is executed and JP1/IM - View is restarted.

Information that is specified

[JP1_DEFAULT\JP1CONSOLEVIEW]

Specifies the key name for the JP1/IM - View environment settings.

In JP1/IM - View, this parameter is fixed.

"COM_SO_TIMEOUT"=dword:hexadecimal-value

Specify in milliseconds as a hexadecimal value the amount of time to wait for the arrival of reception data (socket timeout value). The default value is dword:0000EA60 (60,000 milliseconds).

In an environment in which a low-speed line is used or event traffic is heavy, specify a larger value.

The range of values that can be specified is 0x00000001 to 0x0036EE80 (3,600,000 milliseconds).

The specified value must not exceed the value specified for COM_RMI_TIMEOUT (default: 0000EA60) in the view.conf.update communication environment definition file.

"COM_RMI_TIMEOUT"=dword:hexadecimal-value

Specifies in milliseconds as a hexadecimal value the timeout period for communication processing during the following operations or settings:

Login

Logout

Manual and automatic refreshing of the Event Console window

Changing the event action status

Deletion of server events

Event search

User environment setting

Severe event setting

Automated action setting

Filter setting

Command execution

Function status notification recovery operation

Response to a response-waiting event and release from the hold-and-accumulate state

The permitted value range is from 0000EA60 to 0036EE80 (from 60,000 to 3,600,000 milliseconds), and the default is dword:0000EA60 (60,000 milliseconds).

Example

[JP1_DEFAULT\JP1CONSOLEVIEW]
"COM_SO_TIMEOUT"=dword:000009C4
"COM_RMI_TIMEOUT"=dword:0000EA60

Communication environment definition file (tree_view.conf.update)

Format

[JP1_DEFAULT\JP1CONSOLEVIEW]
"SOV_LOGIN_TIMEOUT"=dword:hexadecimal-value
"SOV_GETTREE_TIMEOUT"=dword:hexadecimal-value
"SOV_SETTREE_TIMEOUT"=dword:hexadecimal-value
"SOV_MAKETREE_TIMEOUT"=dword:hexadecimal-value
"SOV_GETMAP_TIMEOUT"=dword:hexadecimal-value
"SOV_SETMAP_TIMEOUT"=dword:hexadecimal-value
"SOV_GETPROFILE_TIMEOUT"=dword:hexadecimal-value
"SOV_SETPROFILE_TIMEOUT"=dword:hexadecimal-value
"SOV_DEF_TIMEOUT"=dword:hexadecimal-value

File

tree_view.conf.update (model file for the communication environment definition file)

Storage directory

View-path\default\

Description

This file defines timeout periods for communication between JP1/IM - View and JP1/IM - Manager (Central Scope).

When a low-speed line is used in the network or when the viewer's workload is high, timeouts might occur during the viewer's communication processing, resulting in communication errors. You can prevent such communication errors by modifying timeout periods.

The required definition is provided as a model file. To change the settings, copy the model file and then edit the copy.

When the definitions are applied

The definition takes effect after the jbssetcnf command is executed and JP1/IM - View is restarted.

Information that is specified

[JP1_DEFAULT\JP1CONSOLEVIEW]

Specifies the key name for the JP1/IM - View environment settings.

In JP1/IM - View, this parameter is fixed.

"SOV_LOGIN_TIMEOUT"=dword:hexadecimal-value

Specifies in milliseconds as a hexadecimal value the server response wait time for login and logout processing. The permitted value range is from 0000EA60 to 0036EE80 (from 60,000 to 3,600,000 milliseconds), and the default is dword:0002BF20 (180,000 milliseconds).

"SOV_GETTREE_TIMEOUT"=dword:hexadecimal-value

Specifies in milliseconds as a hexadecimal value the server response wait time for acquisition of the status of monitoring objects, updating of the monitoring tree, and performance of display processing for the Monitoring Tree (Editing) window. The permitted value range is from 0000EA60 to 0036EE80 (from 60,000 to 3,600,000 milliseconds), and the default is dword:0036EE80 (3,600,000 milliseconds).

"SOV_SETTREE_TIMEOUT"=dword:hexadecimal-value

Specifies in milliseconds as a hexadecimal value the server response wait time for changing of the status of monitoring objects, setting of monitoring targets, and performance of tree update processing. The permitted value range is from 0000EA60 to 0036EE80 (from 60,000 to 3,600,000 milliseconds), and the default is dword:0036EE80 (3,600,000 milliseconds).

"SOV_MAKETREE_TIMEOUT"=dword:hexadecimal-value

Specifies in milliseconds as a hexadecimal value the server response wait time for performance of automatic generation of the monitoring tree. The permitted value range is from 0000EA60 to 0036EE80 (from 60,000 to 3,600,000 milliseconds), and the default is dword:0036EE80 (3,600,000 milliseconds).

"SOV_GETMAP_TIMEOUT"=dword:hexadecimal-value

Specifies in milliseconds as a hexadecimal value the server response wait time for performance of display processing for the visual monitoring list and for the Visual Monitoring window. The permitted value range is from 0000EA60 to 0036EE80 (from 60,000 to 3,600,000 milliseconds), and the default is dword:0002BF20 (180,000 milliseconds).

"SOV_SETMAP_TIMEOUT"=dword:hexadecimal-value

Specifies in milliseconds as a hexadecimal value the server response wait time for creation, deletion, and copying of visual monitoring maps, and for performance of visual monitoring update processing. The permitted value range is from 0000EA60 to 0036EE80 (from 60,000 to 3,600,000 milliseconds), and the default is dword:0002BF20 (180,000 milliseconds).

"SOV_GETPROFILE_TIMEOUT"=dword:hexadecimal-value

Specifies in milliseconds as a hexadecimal value the server response wait time for acquisition of user environment settings and system environment settings for the Monitoring Tree window. The permitted value range is from 0000EA60 to 0036EE80 (from 60,000 to 3,600,000 milliseconds), and the default is dword:0002BF20 (180,000 milliseconds).

"SOV_SETPROFILE_TIMEOUT"=dword:hexadecimal-value

Specifies in milliseconds as a hexadecimal value the server response wait time for performance of reflection processing of user environment settings and system environment settings for the Monitoring Tree window. The permitted value range is from 0000EA60 to 0036EE80 (from 60,000 to 3,600,000 milliseconds), and the default is dword:0002BF20 (180,000 milliseconds).

"SOV_DEF_TIMEOUT"=dword:hexadecimal-value

Specifies in milliseconds as a hexadecimal value the server response wait time for acquisition and setting of monitoring object properties, acquisition of a list of login users, and acquisition of automatically generated configuration selections. The permitted value range is from 0000EA60 to 0036EE80 (from 60,000 to 3,600,000 milliseconds), and the default is dword:001B7740 (1,800,000 milliseconds).

Example definition

[JP1_DEFAULT\JP1CONSOLEVIEW]
"SOV_LOGIN_TIMEOUT"=dword:0002BF20
"SOV_GETTREE_TIMEOUT"=dword:0002BF20
"SOV_SETTREE_TIMEOUT"=dword:0002BF20
"SOV_MAKETREE_TIMEOUT"=dword:0036EE80
"SOV_GETMAP_TIMEOUT"=dword:0002BF20
"SOV_SETMAP_TIMEOUT"=dword:0002BF20
"SOV_GETPROFILE_TIMEOUT"=dword:0002BF20
"SOV_SETPROFILE_TIMEOUT"=dword:0002BF20
"SOV_DEF_TIMEOUT"=dword:0002BF20

Non-encryption communication host configuration file (nosslhost.conf)

Format

[NO_SSL_HOST]
manager-host-name
manager-host-name
    :
manager-host-name

File

nosslhost.conf (non-encryption communication host configuration file)

nosslhost.conf.model (model file for the non-encryption communication host configuration file)

Storage directory

View-path\conf\ssl

Description

This file is for configuring which hosts are to use non-encrypted communication. By default, this file specifies non-encrypted communication for all hosts, so if you want to use encrypted communication, you must configure this file. If you want JP1/IM - View to use non-encrypted communications upon login to a manager host, you must define the host in this file. Communication with manager hosts that are not defined in this file will be encrypted.

JP1/IM - View compares the destination host name in the Login window and the connection target host name specified in the -h option of the jcoview or jcfview command against the manager host names listed in the definition file, and if there is a match, uses non-encrypted communication with the host. The host names are not case sensitive.

When the definitions are applied

The settings for the non-encryption communication host configuration file take effect at the following times:

When you log in to Central Console from the Central Console viewer, log in to Central Scope from the Central Scope viewer, or log in to IM Configuration Management from the IM Configuration Management viewer (when you display the Login window and click the OK button to log in)

When you display the Central Console viewer or Central Scope viewer from the IM Configuration Management viewer

When you display the site manager's IM Configuration Management viewer from the IM Configuration Management viewer (Launch Base View)

The following table shows whether the non-encryption communication host configuration file is read when different viewers are launched

Table 2‒60: Whether the non-encryption communication host configuration file is read when different viewers are launched

Calling window (operation in calling window)

Check box

Viewer to be launched

Definition file is read

Central Console

Central Scope

Login window of the Central Console viewer or Central Scope viewer (click OK button)

C

U

Central Console

Y

U

C

Central Scope

Y

C

C

Central Console and Central Scope

Y#

Login window of the IM Configuration Management viewer (click OK button)

IM Configuration Management

Y

Login window of the Central Scope viewer (click OK button)

Launch from Monitoring Tree (Editing) window

Central Scope

Y

Central Console viewer (Main menu or toolbar)

Central Scope

N

Central Scope viewer (Main menu or toolbar)

Central Console

N

IM Configuration Management viewer (Main menu or toolbar)

Central Console

Y

Central Scope

Y

IM Configuration Management viewer (Launch Base View)

Site manager's IM Configuration Management

Y

Legend:

Y: The definition file is read.

N: The definition file is not read.

C: The check box is selected.

U: The check box is not selected.

#

Although two viewers (the Central Console viewer and Central Scope viewer) are launched, the definition file is only read once.

Information that is specified

[NO_SSL_HOST]

This block is mandatory. Uppercase and lowercase are distinguished. Any space or tab character immediately preceding or following [NO_SSL_HOST] will be ignored.

manager-host-name

Specify the host name or IPv4 address of a destination manager host for which non-encrypted communication is to be used. You can also specify manager-host-name in FQDN format. By default, an asterisk (*) is set. The wildcard asterisk (*) indicates that non-encrypted communication is to be used for connections to all manager hosts. A maximum of 1,024 hosts can be listed. You cannot list the same manager host name more than once. Letter case is ignored. Specify between 0 and 255 characters. Any space or tab character immediately preceding or following manager-host-name will be ignored.

Example definition

Example definition 1: Use non-encrypted communication to communicate with all manager hosts

[NO_SSL_HOST]
*

Specifying an asterisk (*) indicates that non-encrypted communication to is to be used with all manager hosts. When an asterisk (*) is specified, an error results if anything other than the above is specified.

Example definition 2: Use encrypted communication to communicate with all manager hosts

[NO_SSL_HOST]

To use encrypted communication to communicate with all manager hosts, delete the asterisk (*).

Example definition 3: Use a mixture of non-encrypted and encrypted communication to communicate with manager hosts

[NO_SSL_HOST]
hostA
hostB

Communication with the manager hosts hostA and hostB will be non-encrypted, while communication with other manager hosts will be encrypted.

IM-View settings file (tuning.conf)

Format

LOGIN_HISTORY_MAX=number-of-connected-host-log-entries
MENU_AUTO_START={ON | OFF}
ACTIONLIST_AUTO_START={ON | OFF}
WWW_BROWSER_PATH=start-path-of-browser
CLIPBOARD_OUTPUT={ON | OFF}
LOGIN_USER_HISTORY_MAX={0|1}
SCREEN_TITLE_LOGININFO={ON | OFF}

File

tuning.conf (IM-View settings file)

tuning.conf.model (model file for the IM-View settings file)

Storage directory

View-path\conf\

Description

This file defines the operation of JP1/IM - View, such as the number of connected-host log entries in the Login window, the operation when the Event Console window is displayed, and whether data can be copied to the clipboard.

Specify each item in the tuning.conf file in the format parameter-name=value. The following lines are ignored in the definition file:

A line consisting only of spaces

A line beginning with a hash mark (#) or a hash mark preceded by any number of spaces (comment line)

When the definitions are applied

The definition takes effect after JP1/IM - View is restarted.

Information that is specified

LOGIN_HISTORY_MAX=number-of-connected-host-log-entries

Specifies the number of entries (hosts to which connection has been made) that are to be displayed in the Host to connect list box in the login window.

The permitted value range is from 0 to 20. If 0 is specified, no history of connected hosts is displayed. If this parameter is omitted, 5 is assumed. The default is 5.

MENU_AUTO_START={ON | OFF}

Specifies whether the Tool Launcher is to be started when the Event Console window is displayed. If you specify ON, the Tool Launcher window is opened when the Event Console window is displayed. If you specify OFF, the Tool Launcher window is not opened when the Event Console window is displayed. If this parameter is omitted, OFF is assumed. The default is OFF.

ACTIONLIST_AUTO_START={ON | OFF}

Specifies whether the List of Action Results window is to be displayed when the Event Console window is displayed. If you specify ON, the List of Action Results window is opened when the Event Console window is displayed. If you specify OFF, the List of Action Results window is not opened when the Event Console window is displayed. If this parameter is omitted, OFF is assumed. The default is OFF.

WWW_BROWSER_PATH=start-path-of-browser

Specifies the start path of the Web browser that is to be used to open the Tool Launcher and monitor windows. The default is that this parameter is not specified. If you specify this parameter, you must add a parameter in the definition file.

When you specify a path, express \ as \\. Do not enclose the start path name in double-quotation marks ("). Make sure that the specified Web browser is supported by the Tool Launcher and the application that is started when monitor windows are opened.

If this parameter is omitted, the Web browser associated with files of the .html file type on the host is used. Specify this parameter in order to use a Web browser that is not associated with files of the .html file type (including a different version of the same Web browser).

CLIPBOARD_OUTPUT={ON | OFF}

Specifies whether the function for copying JP1 event information, action results, and command execution results to the clipboard is to be enabled.

Specifying ON enables the function for copying to the clipboard. When it is enabled, you use this function by selecting the information in the JP1/IM - View window that you want to copy, and then pressing the Ctrl and C keys to copy it in CSV format to the clipboard. In the Event Console window, Copy is displayed in the Edit menu.

Specifying OFF disables the function for copying to the clipboard.

If this parameter is omitted, ON is assumed.

LOGIN_USER_HISTORY_MAX={0|1}

Specifies whether to display the names of JP1 users who have logged in previously in the User name text box of the Login window. When 1 is specified, the names of users who logged in previously are displayed. When 0 is specified, the names are hidden. If you omit this parameter, or if you specify a value other than 0 or 1, 1 is assumed. The default is 1.

SCREEN_TITLE_LOGININFO={ON | OFF}

You can prevent the name of the logged-in JP1 user from being displayed in the title of the Monitoring Tree window, the Monitoring Tree (Editing) window, the Visual Monitoring (Editing) window, the Event Console window, the Execute Command window, and the List of Action Results window. The ON specification displays the name of the logged-in JP1 user. The OFF specification hides name of the logged-in JP1 user. The default is ON. If you omit this parameter, or if you specify a value other than ON or OFF, ON is assumed. The value is case sensitive.

Example definition

# *************************************************************
# * JP1/Integrated Management - View   Tuning definition file *
# *************************************************************

# Input history maximum number in connected hostname input field on log in screen
LOGIN_HISTORY_MAX=5
# Tool Launcher is automatically started at log in whether (ON) (OFF).
MENU_AUTO_START=OFF
# List of Action Result is automatically started at log in whether (ON) (OFF).
  ACTIONLIST_AUTO_START=OFFCLIPBOARD_OUTPUT=ON
# Copies JP1 event information, action results, and command execution results to the clipboard (ON) (OFF).
CLIPBOARD_OUTPUT=ON
# Displays the names of previously logged-in users in the Login window (1) (0).
LOGIN_USER_HISTORY_MAX=1
# Displays the user name in the window title bar (ON) (OFF).
SCREEN_TITLE_LOGININFO=ON

Definition file for opening monitor windows

Format

[@encode character-encoding]
DESC_VERSION=0300
{key-definition(SUBKEY parameter is used)
subkey-definition
association-definition
|key-definition(INTERFACE parameter is used)}
call-interface-definition

File

hitachi_xxxx_mon.conf

(definition file for opening monitor windows for a linked product)

company-name_product-name_mon.conf

(user-defined definition file for opening monitor windows)

company-name_series-name_product-name_mon.conf

(user-defined definition file for opening monitor windows)

Storage directory

In Windows

For a physical host:

Console-path\conf\console\monitor\

For a logical host:

shared-folder\jp1cons\conf\console\monitor\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/monitor/

For a logical host:

shared-directory/jp1cons/conf/console/monitor/

Description

This definition file is used to define settings for calling monitor windows (such as a monitor window at an event source) from the Integrated Operation Viewer window of Intelligent Integrated Management Base, or the Event Console window of Central Console. Use this file to create a key from information such as the event ID and attributes, and a command line parameter from the event attributes.

The encoding defined in the definition file for calling monitor windows must be UTF-8 for JP1/IM - Manager for Linux and Shift-JIS or EUCJIS for JP1/IM - Manager for an OS other than Linux. Because, hitachi is used for the default file name, use a name other than hitachi for company-name.

If hitachi is specified for the company name in a definition file for opening monitor windows, this definition file contains system standard definition information, and therefore a user cannot create, change, or delete the file.

JP1/IM provides the jcomonitorfcheck command for checking the contents of the definition file for opening monitor windows.For details about this command, see jcomonitorfcheck in Chapter 1. Commands.

When the definitions are applied

The definition takes effect after JP1/IM - Manager is restarted or when the jco_spmd_reload command is executed. Note that the changes made to the definition while the user is logged in to JP1/IM - View or the Intelligent Integrated Management Base, are not applied. You need to restart JP1/IM - View or the Intelligent Integrated Management Base to apply the change.

Information that is specified

@encode

Specifies the character encoding that is to be used in the definition file for opening monitor windows. This item is optional.

To create an additional file for definition file for opening monitor windows, use an @encode statement to specify the character set for the definition file.

Item names will be expressed in characters that can be represented in the character encoding specified in the @encode statement. In addition, the definition file for opening monitor windows will be saved in the character encoding specified in the @encode statement.

In the following circumstances, item names displayed in JP1/IM - View or the Integrated Operation Viewer window, might be garbled:

If the item name uses characters that cannot be represented in the character encoding specified in the @encode statement

If the character encoding specified in the @encode statement does not match the character encoding in which the file was saved

If no @encode statement exists or if there is an error in the specified character set name that follows the @encode statement, the character set is determined automatically. However, depending on the contents of the definition file, the character encoding might not be determined correctly.

The specifiable character encodings are as follows:

C

EUCJIS

SJIS

UTF-8

GB18030

Note

If you use UTF-8 as the encoding to save a definition file, save the file without attaching a BOM (byte order mark).

An error is output in the following cases:

A character encoding other than C, EUCJIS, SJIS UTF-8 or GB18030 is specified

The definition file does not begin with @encode.

@encode is not followed by a character encoding specification.

Note

If you use a definition file for extended event attributes provided by another product, make sure the character encoding specified in the @encode statement matches the character encoding used in the definition file. In addition, if you will be transferring definition files, do not convert the character encoding of the definition files.

DESC_VERSION=0300

This is the table version record.

key-definition

Defines a fixed key in the event attributes that is to be used when a monitor window is opened. The key consists of three items:

Event ID

Product name

Version

The combination of these attributes defines a link to operations and subkeys.

Format

DEF_KEY PRODUCT_NAME="product-name"

EVENT_ID=event-ID

[VERSION=version|ALL]

{SUBKEY=subkey

|INTERFACE=interface-name}

Arguments

• PRODUCT_NAME="product-name"

Specifies a product name as a character string, such as /HITACHI/JP1/AJS. This value must be the same as a value that is set in a PRODUCT_NAME extended attribute.

• EVENT_ID=event-ID

Specifies only the base part of an event identifier, expressed as eight hexadecimal characters. The extended part is ignored. If you need to include the extended part set for a JP1/SES event, use a subkey.

• VERSION=version

Specifies a version. The version specified in this argument is compared with the ACTION_VERSION JP1 event extended attribute. The version can be expressed in numeric characters (from 0 to 9), alphabetic characters (A to Z), the forward slash (/), and the hyphen (-). The alphabetic characters are not case sensitive.

Specify a single version as a string of no more than 8 bytes. To specify a range of versions, separate the start version from the end version with a hyphen (-). In this case, there must be at least one space preceding and following the hyphen.

The version specified here cannot duplicate any version specified in any other key definition.

• SUBKEY=subkey

Specifies the name of a subkey. This parameter and the INTERFACE parameter are mutually exclusive.

If you specify the SUBKEY parameter, you need the subkey definition corresponding to the subkey name specified for SUBKEY, and the association definition.

• INTERFACE=interface-name

Specifies an interface name. For the key to define, specify only one interface that is to be used when the monitor window opens. This parameter and the SUBKEY parameter are mutually exclusive.

If you specify the INTERFACE parameter, you cannot use the subkey definition and association definition.

Notes:

The versions are compared in ascending order. If the start version is greater than the end version, that key definition is ignored even though no error is issued.

The value specified in PRODUCT_NAME must be the same as the value specified in a PRODUCT_NAME JP1 event extended attribute.

subkey-definition

When the monitor window is opened, the subkey definition is linked from the fixed key and registers the event attributes as the key.

Format

DEF_SUBKEY

NAME=subkey-name

KEYS=attribute-name-1 [, attribute-name-2[,attribute-name-3[,attribute-name-4]]]

Arguments

• NAME=subkey-name

Specifies a name for the subkey, expressed using from 1 to 16 alphanumeric characters; no spaces or control characters can be used. This name is not case sensitive.

• KEYS=attribute-name-1 [,attribute-name-2 [,attribute-name-3 [,attribute-name-4]]]

Specifies attribute names. The following table shows the specification formats of the attribute names.

Table 2‒61: Specification formats of the attribute names

Specification format

Value format

Description

B.ARRIVEDTIME

13-digit decimal character string

Arrived time (time in milliseconds since UTC 1970-01-01 at 00:00:00)

B.DESTSERVER

Character string

Target event server name

B.GROUPNAME

Character string

Source group name

B.IDBASE

8 hexadecimal characters

Base part of the event ID

B.IDEXT

8 hexadecimal characters

Extended part of the event ID

B.PROCESSID

Decimal character string

Source process ID

B.SEQNO

Decimal character string

Sequence number in the database

B.SOURCESEQNO

Decimal character string

Sequence number by source

B.SOURCESERVER

Character string

Event-issuing server name

B.TIME

13-digit decimal character string

Registered time (time in milliseconds since UTC 1970-01-01 at 00:00:00)

B.USERNAME

Character string

Source user name

B.MESSAGE

Character string

Message

E.JP1_SOURCEHOST#

Character string

Event source host name

E.xxxxxxx

Character string

Extended attribute

#

A business group name cannot be used for the event-issuing server name (B.SOURCESERVER) and the event source host name (E.JP1_SOURCEHOST). If a business group name is specified, it is treated as a host name.

association-definition

Defines the association between subkey values and the interface.

Format

DEF_IF_RELATION

SUBKEY_NAME=subkey-name

{ VALUE1="attribute-value-1"[[ VALUE2="attribute-value-2"]...]

|KEY_DEFAULT }

IF_NAME=interface-name

Arguments

• SUBKEY_NAME=subkey-name

Specifies the name of the subkey. Express the name using from 1 to 16 alphanumeric characters; no spaces or control characters can be used. This name is not case sensitive.

• VALUEn="attribute-value"

Specifies an attribute value and its sort order. Specify for n an integer in the range from 1 to 4 representing the sort order among the attributes specified in the KEYS parameter in the subkey definition. The key values must match exactly. A regular expression cannot be used for the value. For a list of the specifiable attributes and their specification formats, see the explanation of subkey-definition.

If any of the attributes, such as VALUE1, VALUE2, ..., does not match, the interface specified in KEY_DEFAULT is used for the corresponding JP1 event.

• KEY_DEFAULT

Specify this argument instead of VALUE1, VALUE2, ..., in order to create an association with the interface when there is not an exact match with the values specified in VALUE1, VALUE2, ....

• IF_NAME=interface-name

Specifies the name of the interface that is to be called when the subkey values match. Express the interface name using from 1 to 16 alphanumeric characters; no spaces or control characters can be used. This name is not case sensitive.

call-interface-definition

Defines the interface to be used when a monitor window is opened.

Format

DEF_MTR_CALL

NAME=interface-name

EXEC_ID=application-execution-definition-identifier

PATH="command-arguments"

[PARAM=attribute-name-1[,attribute-name-2...]]

Arguments

• NAME=interface-name

Specifies a name for the interface. Express the name using from 1 to 16 alphanumeric characters; no spaces or control characters can be used. This name is not case sensitive.

• EXEC_ID=application-execution-definition-identifier

Specifies the identifier for an application execution definition. You must specify an identifier defined in the definition file for executing applications on the viewer.

You can launch the default browser by specifying "default_browser" for the EXEC_ID parameter. If you specify "default_browser" for the EXEC_ID parameter, specify a URL for the PATH parameter.

Note that a character string beginning with jco_ cannot be used because it is reserved as the application execution definition identifier.

• PATH="command-arguments"

Specifies command arguments that are to be passed to the executable file specified in EXEC_ID. The command line is formed by the name of the executable file specified in EXEC_ID and the arguments specified here. For example, you would specify arg1 and arg2 in the PATH parameter to form the following command line:

"app.exe arg1 arg2"

You can also specify in the PATH parameter reserved keywords that will be replaced with values from the viewer's operating environment attributes and event attributes. The following lists and describes the specifiable substitute keywords.

Table 2‒62: Specifiable substitute keywords

Keyword

Substituted value

%JCO_JP1USER%

Central Console or the Intelligent Integrated Management Base are login user name

%JCO_INSTALL_PATH%#

Name of the viewer installation folder

%IM_EVC_PARAMETER_n%

Event attribute value specified in PARAM

(n: integer of 1 or greater)

%IM_EVC_LANGUAGE%

Depending on the language environment, the language switches between Japanese and English.

#: In the Intelligent Integrated Management Base, the string is not substituted.

• PARAM=attribute-name-1 [,attribute-name-2...]

Specifies the names of event attributes whose values are to be set. Sequential numbers that begin with 1 are assigned to the attribute names. This sequence corresponds to n in the substitute keywords.

Separate multiple event attributes with the comma, as shown in the example below:

B.EXTID,E.A0

You can specify some of the basic attributes and extended attributes. For details about the specifiable attributes and their specification formats, see the explanation of subkey-definition.

Example definition

This example opens a monitor window from the JP1 event that traps the Windows event log:

Note:

In this example, a line number is assigned at the beginning of each line for explanatory purposes.

Line 1

Indicates the character encoding used for the definition file. In this example, the character encoding is UTF-8.

Line 2

DESC_VERSION=0300 means that the description format version of this file is 0300.

Lines 3 to 5

These are comment lines. We recommend that you include the scope of the operating version.

Line 6

This is a key definition record. It means that if the product name is /HITACHI/JP1/NTEVENT_LOGTRAP and the event ID is 00003A71, then the subkey SAMPLE is used to determine which monitor window is opened.

Line 7

This is a subkey definition record. It declares that the extended attributes PRODUCT_NAME and A5 (Windows event log ID) are used with the subkey name SAMPLE.

Line 8

This is an association definition record. It means that if the value of subkey E.A5 matches 8010, the interface NETM_DM is used to display the monitor window.

Line 9

This is a call interface definition record. It means that the interface name is NETM_DM and the argument netmdm_argument is passed to the command whose application execution definition identifier is HITACHI_NETM_DM, which is then executed.

Email environment definition file (jimmail.conf)

Format

Charset=email-character-encoding
From=sender-email-address
DefaultTo=default-destination-email-address[,default-destination-email-address...]
SmtpServer=SMTP-server-name
SmtpPort=SMTP-port-number
AuthMethod=authentication-method-when-sending-email
SmtpAuthPort=SMTP-AUTH-authentication-submission-port-number
Pop3Server=POP3-server-name
Pop3Port=POP3-port-number
AuthUser=authentication-account-name
AuthPassword=authentication-password
ConnectTimeout=network-connection-timeout-period
SoTimeout=communication-timeout-period
MailSubjectCutting=email-subject-drop-setting
MailNewLine=email-linefeed-code

File

jimmail.conf (email environment definition file)

jimmail.conf.model (model file of the email environment definition file)

Storage directory

In Windows

For a physical host:

Console-path\conf\mail

For a logical host:

shared-folder\JP1Cons\conf\mail

Description

The email environment definition file is a definition file that sets information required to send an email, including email server host names, authentication methods, authentication account names, and passwords.

When the definitions are applied

The definition takes effect when the jimmail command is executed.

Information that is specified

The following rules are applied to the email environment definition file:

Each entry must be specified on a line in parameter-name=setting-value format. On each line, parameter-name and setting-value are separated by the first equal sign (0x3d).

Only CR (0x0d) + LF (0x0a) is treated as a line break. If line break codes other than CRLF are contained, the line break codes are converted to CRLF before output when a password is set by using the jimmailpasswd command.

The parameter name is case sensitive.

A line beginning with # (0x23) or Δ# is a comment statement. However, if there is a character other than a single-byte space (0x20) or a tab (0x09) before #, the line is not treated as a comment statement (Δ indicates a single-byte space or a tab).

Single-byte spaces or tabs are treated as follows (Δ indicates a single-byte space or a tab):

Single-byte spaces or tabs immediately before or after a parameter name are ignored.

Example: Δparameter-nameΔ=setting-value

Single-byte spaces or tabs immediately before or after the setting value are ignored. However, they are treated as characters and not ignored for the AuthPassword parameter.

Example: parameter-name=Δsetting-valueΔ

If an invalid parameter is written, an error occurs. Also, if there is no equal sign (=) after a parameter name, an error occurs.

Charset=email-character-encoding

Defines the character encoding for the subject and text of an email to send.

The character encoding is not case sensitive.

The following table lists the initial values for the Charset parameter, and a value to be set if the value for the Charset parameter is not obtained.

Table 2‒63: Initial values for the Charset parameter and setting values when the value could not be obtained

Environment

Initial value

Setting value when the value could not be obtained

Japanese environment

iso-2022-jp

iso-8859-1

Non-Japanese environment

iso-8859-1

iso-8859-1

The following table lists the character encoding that can be specified for Charset.

If you specify character encoding that cannot be specified, the setting value in the above table is assumed.

Table 2‒64: Character encoding that can be specified for Charset

Character encoding

Description

iso-2022-jp

JIS encoding

shift_jis

Shift-JIS encoding

euc-jp

EUC encoding

utf-8

UTF-8 encoding

iso-8859-1

Latin1 encoding

us-ascii

ANSI encoding

GB18030

GB18030 encoding (GBK range only)

Others

Cannot be specified

If there is no parameter, the parameter does not have a value, or character encoding that cannot be specified for the parameter is defined, the KAVB8715-W message is output, and the initial value is set.

From=source-email-address

Defines the source email address of an email notification.

The initial value is the null character ("").

Only one source email address can be defined.

This item cannot be omitted.

Specify the source email address from 1 to 256 bytes.

The following table lists the permitted characters.

Table 2‒65: Character encoding that can be used for From

Characters that can be used

Description

One-byte alphanumeric characters

0 to 9, and a to z

@

At mark (0x40)

.

Period (0x2e)

-

Hyphen (0x2d)

_

Underscore (0x5f)

If there is no essential parameter, the parameter does not have a value, a character that cannot be specified for a parameter is defined, a parameter is not in the RFC822 format, or a parameter is exceeding the maximum length, the KAVB8714-E message is output and the operation terminates abnormally.

DefaultTo=default-destination-email-address[,default-destination-email-address...]

Defines the default destination email address.

The initial value is the null character ("").

You can define 20 destination email addresses. To specify multiple email addresses, separate them by a comma (,).

A single-byte space or tab between an email address and a comma (,) is ignored.

Consecutive commas (,) are treated as a comma, and commas at the beginning and at the end are ignored. If the same email address is specified more than once, the email message is sent to the specified address only once.

This parameter can be omitted. If omitted, the -to option of the jimmail command must be specified.

If both the DefaultTo parameter and the -to option of the jimmail command are specified, the -to option is prioritized.

Specify the destination email address from 1 to 256 bytes.

The characters that can be used for the source email address can be used.

If unusable characters are specified, the parameter is not in the RFC822 format, or the parameter exceeds the maximum length, the KAVB8714-E message is output, and the operation terminates abnormally.

Also, if neither the DefaultTo parameter nor the -to option of the jimmail command is specified, the KAVB8712-E message is output, and the operation terminates abnormally.

SmtpServer=SMTP-server-name

Defines the host name or the IP address of the SMTP server to connect when sending an email. Configure one of the following files to enable successful host name resolution of SMTP-server-name:

The jp1hosts file in JP1/Base on the manager host

The jp1hosts2 file in JP1/Base on the manager host

The hosts file or DNS

For the IP address, only IPv4 addresses can be specified. IPv6 addresses cannot be specified.

The initial value of the SmtpServer parameter is the null character ("").

Specify only one SMTP server name across the system.

This parameter cannot be omitted.

Specify 1 to 255 of one-byte characters for the host name.

If there is no essential parameter, the parameter does not have a value, a character that cannot be used for a parameter is defined, or the parameter exceeds the maximum length, the KAVB8714-E message is output, and the operation terminates abnormally.

SmtpPort=SMTP-port-number

Defines the port number of the communication port for the SMTP server.

The initial value for the SmtpPort parameter is 25. If you could not obtain the value, 25 is assumed. Specify the port number from 1 to 65535.

If you define NONE or POP for AuthMethod, this item takes effect.

If there is no parameter, the parameter does not have a value, a character other than a numeric value is specified for the parameter, or a value outside the range is specified for the parameter, the KAVB8715-W message is output. The command continues processing, assuming the initial value.

AuthMethod=authentication-method-for-sending-email

Defines the authentication method for sending an email.

This parameter cannot be omitted.

Use the value listed in the table below for the authentication method. The initial value is NONE.

Table 2‒66: Authentication method for AuthMethod

Value of AuthMethod

Authentication method

NONE

No authentication

POP

POP before SMTP authentication

SMTP

SMTP-AUTH authentication

Depending on the authentication method for sending an email, the items that must be set for the email environment definition file vary.

If there is no essential parameter, the parameter does not have a value, or a value outside the range is specified for the parameter, the KAVB8714-E message is output, and the operation terminates abnormally.

The following table lists the setting items for each AuthMethod value.

Table 2‒67: Setting items when AuthMethod is NONE

Parameter name

Setting

Omission

Value assumed when omitted

Charset

Y

Possible

iso-8859-1

From

Y

Impossible

--

DefaultTo

Y

Possible

""

AuthMethod

Y

Impossible

--

SmtpServer

Y

Impossible

--

SmtpPort

Y

Possible

25

SmtpAuthPort

N

--

--

Pop3Server

N

--

--

Pop3Port

N

--

--

AuthUser

N

--

--

AuthPassword

N

--

--

ConnectTimeout

Y

Possible

10,000

SoTimeout

Y

Possible

10,000

MailSubjectCutting

Y

Possible

OFF

MailNewLine

Y

Possible

CRLF

Legend:

Y: Must be set.

N: Not necessary to be set.

Table 2‒68: Setting items when AuthMethod is POP

Parameter name

Setting

Omission

Value assumed when omitted

Charset

Y

Possible

iso-8859-1

From

Y

Impossible

--

DefaultTo

Y

Possible

""

AuthMethod

Y

Impossible

--

SmtpServer

Y

Impossible

--

SmtpPort

Y

Possible

25

SmtpAuthPort

N

--

--

Pop3Server

Y

Impossible

--

Pop3Port

Y

Possible

110

AuthUser

Y

Impossible

--

AuthPassword

Y

Impossible

--

ConnectTimeout

Y

Possible

10,000

SoTimeout

Y

Possible

10,000

MailSubjectCutting

Y

Possible

OFF

MailNewLine

Y

Possible

CRLF

Legend:

Y: Must be set.

N: Not necessary to be set.

Table 2‒69: Setting items when AuthMethod is SMTP

Parameter name

Setting

Omission

Value assumed when omitted

Charset

Y

Possible

iso-8859-1

From

Y

Impossible

--

DefaultTo

Y

Possible

""

AuthMethod

Y

Impossible

--

SmtpServer

Y

Impossible

--

SmtpPort

N

--

--

SmtpAuthPort

Y

Impossible

587

Pop3Server

N

--

--

Pop3Port

N

--

--

AuthUser

Y

Impossible

--

AuthPassword

Y

Impossible

--

ConnectTimeout

Y

Possible

10,000

SoTimeout

Y

Possible

10,000

MailSubjectCutting

Y

Possible

OFF

MailNewLine

Y

Possible

CRLF

Legend:

Y: Must be set.

N: Not necessary to be set.

SmtpAuthPort=SMTP-AUTH-authentication-submission-port-number

Defines the submission port number of the communication port for the SMTP-AUTH authentication. The initial value is 587. If you cannot obtain the value, 587 is assumed. Specify a value from 1 to 65535.

When using the SMTP-AUTH authentication, specify the number of the destination port used by the SMTP server to connect for the SmtpAuthPort parameter if the connection email server does not use the submission port.

When you define SMTP for AuthMethod, this item takes effect.

If this parameter does not exist, the parameter does not have a value, characters other than numeric values are specified for the parameter, or a value outside the range is specified for the parameter, the KAVB8715-W message is output. The command continues processing, assuming the initial value.

Pop3Server=POP3-server-name

Defines the host name or the IP address of the POP3 server to be used for POP before SMTP authentication. Configure one of the following files to enable successful host name resolution of POP3-server-name:

The jp1hosts file in JP1/Base on the manager host

The jp1hosts2 file in JP1/Base on the manager host

The hosts file or DNS

For the IP address, IPv4 addresses can be specified. IPv6 addresses cannot be specified.

If the email server serves as both the SMTP server and the POP3 server, specify the SMTP server name specified for SmtpServer.

Specify only one POP3 server name across the system.

Specify 1 to 255 one-byte characters as the host name of the POP3 server. The initial value is the null character (""). Characters you can use as the host name of the POP3 server are the characters that can be used for the host name of the SMTP server.

If you define POP for AuthMethod, this item takes effect. When it takes effect, you must specify this parameter.

If there is no essential parameter, the parameter does not have a value, characters that cannot be specified for the parameter are specified, or the parameter exceeds the maximum length, the KAVB8714-E message is output, and the operation terminates abnormally.

Pop3Port=POP3-port-number

Defines the port number of the communication port for the POP3 server to use for the POP before SMTP authentication.

The initial value for the parameter is 110. If you cannot obtain the value, 110 is assumed. Specify a value from 1 to 65535 for the port number.

If you define POP for AuthMethod, this item takes effect.

If there is no parameter, the parameter does not have a value, characters other than numeric values are specified for the parameter, or a value outside the range is specified for the parameter, the KAVB8715-W is output, and the initial value is assumed.

AuthUser=authentication-account-name

The AuthUser parameter defines the authentication account name to use for the POP before SMTP or SMTP-AUTH authentication.

Specify 1 to 255 one-byte characters for the authentication account name.

The initial value is the null character ("").

If you specify POP or SMTP for the AuthMethod parameter, this item takes effect.

If there is no essential parameter, the parameter does not have a value, characters (multi-byte) that cannot be used for the parameter are defined, or the parameter exceeds the maximum length, the KAVB8714-E message is output, and the operation terminates abnormally.

AuthPassword=authentication-password

For the AuthPassword parameter, the authentication password for the POP before SMTP or SMTP-AUTH authentication is set.

The authentication password for the AuthPassword parameter is set by using the jimmailpasswd command.

If you edit the email environment definition file, and set a password in plain text for the AuthPassword parameter, you cannot log in to the email server because the authentication password does not match when connecting to the email server.

If you specify POP or SMTP for the AuthMethod parameter, this item takes effect.

If there is no essential parameter, the parameter does not have a value, characters (multi-byte) that cannot be used for the parameter are specified, or the parameter exceeds the maximum length, the KAVB8714-E message is output, and the operation terminates abnormally.

ConnectTimeout=network-connection-timeout-period

For the ConnectTimeout parameter, define the timeout period in milliseconds for waiting until connection between the SMTP and POP3 servers is established. The initial value is 10,000 milliseconds (10 seconds).

Specify 1,000 to 3,600,000 (1 to 3,600 seconds) for the timeout period.

Change this value only when a timeout occurs with the initial value according to the operating environment.

If there is no parameter, the parameter does not have a value, a character string other than numeric characters is specified for the parameter, or a value outside the range is specified for the parameter, the KAVB8715-W message is output, and the initial value is assumed.

SoTimeout=communication-timeout-period

Define the timeout period in milliseconds until a response is received from the SMTP and POP3 servers for the SoTimeout parameter. The initial value is 10,000 milliseconds (10 seconds).

Specify a value from 1,000 to 3,600,000 (1 to 3,600 seconds) as the timeout period.

Only when a communication timeout error occurs with the initial value, change the value according to the operating environment.

If there is no parameter, the parameter does not have a value, a character string other than numeric characters is specified for the parameter, or a value outside the range is specified for the parameter, the KAVB8715-W message is output, and the initial value is assumed.

MailSubjectCutting=email-subject-drop-setting

For the MailSubjectCutting parameter, define whether to drop the email subject, and forcibly send the email if the email subject exceeds the maximum length when sending the email.

When OFF is set, the email subject is not dropped, and the jimmail command terminates abnormally.

When ON is set, drops the email subject according to the character encoding specified for the Charset parameter within 512 bytes, and continues sending the email.

The initial value is OFF. The setting value is not case sensitive.

If there is no parameter, the parameter does not have a value, or a value other than ON and OFF is specified, the KAVB8715-W message is output, and the initial value is assumed.

MailNewLine=email-linefeed-code

For the MailNewLine parameter, define the linefeed code to be used in the text of an email. The jimmail command replaces the linefeed code (\n) specified for the optional argument of the command with the linefeed code specified for this parameter before sending the email. The initial value is CRLF.

The setting value is not case sensitive.

The linefeed code is regulated as CRLF in RFC. Do not change the initial value if you do not have specific reasons. On some email servers, if linefeed codes other than CRLF are used, email messages might not be sent, or a line in email contents might not be broken.

The linefeed codes are defined by using the values listed in the following table.

Table 2‒70: Setting value for MailNewLine

Setting value

Description

CRLF

CR (0x0d) + LF (0x0a)

LF

LF (0x0a)

CR

CR (0x0d)

If there is no parameter, the parameter does not have a value, or a value outside the range is defined for the parameter, the KAVB8715-W message is output, and the initial value is assumed.

Example

The following is the email environment definition file for a Japanese environment immediately after installation:

Charset=iso-2022-jp
From=
DefaultTo=
SmtpServer=
SmtpPort=25
AuthMethod=NONE
SmtpAuthPort=587
Pop3Server=
Pop3Port=110
AuthUser=
AuthPassword=
ConnectTimeout=10000
SoTimeout=10000
MailSubjectCutting=OFF
MailNewLine=CRLF

The following is the email environment definition file for a non-Japanese environment immediately after installation:

Charset=iso-8859-1
From=
DefaultTo=
SmtpServer=
SmtpPort=25
AuthMethod=NONE
SmtpAuthPort=587
Pop3Server=
Pop3Port=110
AuthUser=
AuthPassword=
ConnectTimeout=10000
SoTimeout=10000
MailSubjectCutting=OFF
MailNewLine=CRLF

Display message change definition file (jcochmsg.conf)

Format

DESC_VERSION=1
# Display-message-change-definition-comment
def definition-name-1
    [cmt comment]
    [define {enable | disable}]
    [addflag {true | false}]
    cnd
        event-condition
    end-cnd
    msg message
end-def

def definition-name-2
    [cmt comment]
    [define {enable | disable}]
    [addflag {true | false}]
    cnd
        event-condition
    end-cnd
    msg message
end-def

File

jcochmsg.conf (display message change definition file)

jcochmsg.conf.model (model file for the display message change definition file)

Storage directory

In Windows

For a physical host:

Console-path\conf\chattr\jcochmsg.conf

For a logical host:

shared-folder\jp1cons\conf\chattr\jcochmsg.conf

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/chattr/jcochmsg.conf

For a logical host:

shared-directory/jp1cons/conf/chattr/jcochmsg.conf

Description

This file defines the JP1 event conditions that change the display of a message using the display message change function and defines the message after the change. JP1 event attributes that match event conditions are changed in accordance with the definitions in this file. Specify this file using the language encoding that is used by JP1/IM - Manager.

The maximum size of this file is 22 megabytes (23,068,672 bytes).

There are two types of parameters in the display message change definition file:

Display message change definition file version

Defines the format version of the display message change definition file.

Display message change definition parameter

Defines a condition for the JP1 events whose display message is to be changed and the display message after the change. The higher a display message change definition appears in the display message change definition file, the higher its priority.

When the definitions are applied

The definition takes effect when the event display message change function is enabled, and one of the following operations is performed:

JP1/IM - Manager is restarted

The jco_spmd_reload command is executed

The OK button is clicked in the Add Display Message Change Definition Settings window opened from the Display Message Change Definition Settings menu

The Apply button is clicked in the View Display Message Change Definition window

Information that is specified (display message change definition file version)

DESC_VERSION

Specifies the file version that determines the format of this display message change definition file. Specify a value of 1. If DESC_VERSION is omitted, 1 is assumed as the file version.

Specify DESC_VERSION on the first line of the definition file (the first line in the file excluding any null lines and comment lines). If there is no file version in the first line, 1 is assumed.

Information that is specified (display message change definition parameter)

As shown in the following figure, the definition parameter for changing the display message consists of a definition block and an event condition block.

Figure 2‒9: Definition parameter for changing the display message

Multiple definition blocks can be specified. The number of definition blocks that can be specified is from 0 to 3,000. If the number of definition blocks exceeds the maximum, message KAVB4640-W is output, and processing continues, ignoring the definition blocks after number 3,000.

def to end-def (definition block)

These are the start and end parameters for a display message change definition. The block from def to end-def can be omitted, in which case the system assumes that messages are not to be changed for any JP1 events.

After def, specify the names of display message change definitions. If you specify defΔdefinition-1Δdefinition-2Δ, then Δdefinition-1Δdefinition-2Δ are treated as the definition names (Δ indicates a single-byte space).

For a definition name, specify a character string of from 1 to 50 bytes. Each definition name must be unique within the display message change definition file. The permitted characters are all characters other than the control characters (from 0x00 to 0x1F and 0x7F to 0x9F).

cmt comment

Describes the comment for the display message change definition. The comment specified for cmt is displayed in the comment section of the Display Message Change Definition Settings window. Only one cmt parameter can be specified in the definition block. This parameter can be omitted. Specify the comment using up to 1,024 bytes. The permitted characters are all characters other than the control characters (from 0x00 to 0x1F and 0x7F to 0x9F).

define {enable | disable}

Specifies whether to enable the display message change definition. Only one define parameter can be specified in the definition block. To enable the display message change definition, specify enable, to disable it, specify disable. The define parameter can be omitted. By default, enable is set. The values are not case sensitive.

addflag {true | false}

Indicates an additional display message change definition has been added from a window, and specifies whether the display message change definition is an additional display message change definition. Therefore, to edit the additional display message change definition file, you do not need to specify the addflag parameter. Only one addflag parameter can be specified in the definition block. Specify true for the additional display message change definition, and false for the display message change definition. When true is specified, the icon () is displayed in Type of the View Display Message Change Definition window. The addflag parameter can be omitted. By default, false is set. The values are not case sensitive.

cnd to end-cnd (event condition block)

These are the start and end parameters for the block that specifies a condition for the JP1 events whose display message is to be changed. You must specify at least one event condition block in a definition block. The event condition block cannot be omitted. If a received JP1 event satisfies multiple event conditions, the definition block closest to the beginning of the display message change definition file is used. Tabs and spaces before and after the cnd and end-cnd parameters are ignored.

event-condition

Specifies a condition for the JP1 events whose display message is to be changed. You can specify from 1 to 256 event conditions per event condition block. When multiple event conditions are specified, it is assumed that they are connected with the AND condition. Specify an event condition in the following format (Δ indicates a single-byte space):

attribute-nameΔcomparison-keywordΔoperand[Δoperand]...

Note that a line consisting of only spaces or tabs is ignored during processing.

attribute-name

Specifies the name of the attribute that you want to compare. To specify a basic attribute, place B. immediately before the name. To specify an extended attribute (common information or user-specific information), place E. immediately before the name. Uppercase and lowercase are distinguished.

The following table lists and describes the combinations of attribute names and comparison keywords and the operands that can be specified.

Table 2‒71: Combinations of attribute names and comparison keywords and the operands that can be specified

No.

Item

Attribute name

Comparison keyword

Operand

1

Event ID

B.ID

Match

Does not match

A maximum of 100 of these items can be specified.

Specify the event ID in hexadecimal notation. Letter case is ignored.

The permitted range is from 0 to 7FFFFFFF.

2

Reason for registration

B.REASON

Match

Does not match

A maximum of 100 of these items can be specified.

3

Source process ID

B.PROCESSID

Match

Does not match

A maximum of 100 of these items can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

4

Source user ID

B.USERID

Match

Does not match

A maximum of 100 of these items can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

5

Source group ID

B.GROUPID

Match

Does not match

A maximum of 100 of these items can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

6

Source user name

B.USERNAME

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

7

Source group name

B.GROUPNAME

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

8

Event-issuing server name (source host)#1

B.SOURCESERVER

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

9

Destination event server name#1

B.DESTSERVER

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

10

Message

B.MESSAGE

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

11

Severity

E.SEVERITY

Match

Multiple items can be specified, unless a regular expression is used, in which case only one item is allowed. Only the following values can be specified: Emergency, Alert, Critical, Error, Warning, Notice, Information, or Debug.

12

User name

E.USER_NAME

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

13

Product name

E.PRODUCT_NAME

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

14

Object type

E.OBJECT_TYPE

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

15

Object name

E.OBJECT_NAME

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

16

Root object type

E.ROOT_OBJECT_TYPE

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

17

Root object name

E.ROOT_OBJECT_NAME

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

18

Object ID

E.OBJECT_ID

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

19

Occurrence

E.OCCURRENCE

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

20

Result code

E.RESULT_CODE

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

21

Event source host name#1

E.JP1_SOURCEHOST

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

22

Program-specific extended attribute#2

E.xxxxxxx

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

For the attribute name, you can specify a name with a maximum length of 32 bytes that begins with an uppercase letter and consists of uppercase letters, numeric characters, and the underscore (_).

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

#1

If the integrated monitoring database and the IM Configuration Management database are enabled, and the comparison keyword is Match or Do not match, the business group name can be specified in a path format.

If the integrated monitoring database and the IM Configuration Management database are disabled, and a comparison keyword other than Match and Do not match is selected, a business group name specified in a path format is treated as a host name.

If the -ignorecasehost option of the jcoimdef command is set to ON, and a comparison keyword other than Regular expression is selected, the character string is no longer case sensitive.

#2

You can also specify a JP1 product-specific extended attribute. For example, the program-specific extended attribute for the JP1/AJS job execution host is E.C0. For details about the product-specific extended attributes, consult the documentation for the products that issue JP1 events.

comparison-keyword

Specifies one of BEGIN (begins with), IN (matches), NOTIN (does not match), SUBSTR (includes), NOTSUBSTR (does not include), or REGEX (regular expression) as the comparison keyword. The comparison keyword is case sensitive.

operand

Specifies a character string as the value that is to be compared with the attribute value as specified by the comparison keyword. Operands are case sensitive.

Separate multiple operands with one or more consecutive spaces or a tab. The OR condition is applied to the specified operands. Note that if a regular expression is specified, only one operand can be specified.

To specify a single-byte space, a tab, end-of-line code (CR or LF), or % as part of an operand, specify as follows:

No.

Value to be set

How to specify

1

Tab (0x09)

%09

2

Space (0x20)

%20

3

% (0x25)

%25

4

Linefeed code LF (0x0a)

%0a

5

Carriage return code CR (0x0d)

%0d

During maximum value checking for the definition format, %20 and %25 are each treated as a single character. The character code specified after the % is not case sensitive. The following shows an example of defining ID matches 100 and 200, which selects multiple operands:

B.IDΔINΔ100Δ200

Legend: Δ indicates a single-byte space (0x20)

You can specify a maximum of 4,096 bytes of operands per event condition and per event condition block (total length of operands in bytes that are specified in the event condition block).

msg

This parameter describes the message to be displayed.

You must specify one msg parameter in a definition block. The parameter cannot be omitted.

The msg parameter cannot exceed 1,023 bytes. The permitted characters are all characters other than the control characters (from 0x00 to 0x1F and 0x7F to 0x9F).

If a msg parameter is specified outside of the definition block, message KAVB4629-W is output, the msg parameter specification is ignored, and processing continues.

In the circumstances listed below, message KAVB4631-W is output, and processing continues, ignoring the definition block that produced the error.

The msg parameter is omitted

The msg parameter is specified more than once

The message specified in the msg parameter exceeds 1,023 bytes

The message specified in the msg parameter includes control characters

To specify a variable in the message after the change, use a format such as $EVSEV. The variable will be replaced with the actual value of the attribute value in the event.

The following table describes the available variables.

Type of information

Variable name

Description

Information contained in the basic attributes of JP1 events

EVBASE

Entire basic event information#1

EVID

Event ID (basic-code:extended-code)

EVIDBASE

Event ID (basic code)

EVDATE

Event registration date (YYYY/MM/DD)#2

EVTIME

Event registration time (hh:mm:ss)#2

EVPID

Event source process ID

EVUSRID

User ID of the event source process

EVGRPID

Group ID of the event source process

EVUSR

Event source user name

EVGRP

Event source group name

EVHOST

Event source host name

EVIPADDR

Event source IP address

EVSEQNO

Serial number

EVARVDATE

Event arrival date (YYYY/MM/DD)#2

EVARVTIME

Event arrival time (hh:mm:ss)#2

EVSRCNO

Serial number at the event source

EVMSG

Entire message text#3

EVDETAIL

Entire detailed event information#3, #4

Information contained in the extended attributes of JP1 events

EVSEV

Severity levels in extended event information (Emergency, Alert, Critical, Error, Warning, Notice, Information, Debug)#3

EVUSNAM

User name#3

EVOBTYP

Object type#3

EVOBNAM

Object name#3

EVROBTYP

Registration type#3

EVROBNAM

Root object name#3

EV"PRODUCT_NAME"

Product name#5

EV"OBJECT_ID"

Object ID#5

EV"OCCURRENCE"

Occurrence#5

EV"START_TIME"

Start time#5

EV"END_TIME"

End time#5

EV"RESULT_CODE"

Return code#5

EV"JP1_SOURCEHOST"

Issuing host name#5

EV"extended-attribute-name"

Any extended attribute#5

Other

EV"@JP1IM_CORRELATE"

Correlation event flag

Not a correlation event: 0

Correlation approval event: 1

Correlation failure event: 2

EV"@JP1IM_ORIGINAL_SEVERITY"

Severity levels in extended event information (before change)

(Emergency, Alert, Critical, Error, Warning, Notice, Information, Debug)#3

EV"@JP1IM_CHANGE_SEVERITY"

New severity level flag

Severity is not changed: 0

Severity is changed: 1

ACTHOST

Value of the manager host name#3

EVENV1 to EVENV20

Data obtained by specifying parantheses (()) in a regular expression in the specification of an event condition#5

(applicable only when an extended regular expression is used at the manager host)

#1

The basic information of a JP1 event is converted to the following format and passed to the message after the change (Δ indicates a single-byte space):

event-ID Δ event-source-user-name Δ event-source-user-ID Δ event-source-group-name Δ event-source-group-ID Δ event-source-event-server-name Δ event-source-process-ID Δ event-registration-date Δ event-registration-time Δ event-source-host-IP-address

An item that is not set is replaced with the null character.

#2

This attribute value is converted using the time zone set for JP1/IM - Manager and is passed to the message after the change.

#3

When the message is changed, if the applicable attribute does not exist, the variable is converted to a null character and passed to the message after the change.

#4

When detailed attribute information for a JP1 event is in binary format, the variable is converted to a null character and passed to the message after the change.

#5

If the applicable attribute does not exist, the character string of the variable is passed as-is to the message after the change.

Notes about specifying variables

If you want to specify $ as a character, specify the escape character \ before the $.

If you specify a character, such as an alphanumeric character or an underscore (_), immediately after the variable name, the variable will not be converted correctly. In such a case, enclose the variable name in curly brackets ({ }), as shown in the examples below. These examples assume that 100:0 is specified as the event ID ($EVID) and ABC is specified as the extended attribute EX ($EV"EX").

Examples:

display-message-change-definition -> information-after-conversion

$EVID abc -> 100:0 abc

$EVIDabc -> $EVIDabc

${EVID}abc -> 100:0abc

$EVID_abc -> $EVID_abc

${EVID}_abc -> 100:0_abc

$EV"EX" abc -> ABC abc

$EV"EX"abc -> ABCabc

If a non-variable name is specified, no information will be converted at that location. For example, if you specify $AAA but there is no variable AAA, $AAA will be set in the message after the change.

If the value of the attribute specified in EV"extended-attribute-name" or EVENV1 to EVENV20 cannot be acquired, no information will be converted at that location. For example, if $EV"BBB" is specified but the JP1 event has no extended attribute BBB, $EV"BBB" will be set in the message after the change.

If the value of the attribute specified in a variable other than EV"extended-attribute-name" or EVENV1 to EVENV20 cannot be acquired, the variable will be converted to the null character at that location. For example, if $EVSEV is specified but the JP1 event has no extended attribute SEVERITY, the null character will be set in the message after the change.

When there is more than one event condition that uses a regular expression, and when there is more than one set of parentheses (()) in a regular expression, the data captured in parentheses is associated with variables EVENV1 to EVENV20 in a nested sequential manner, proceeding from left to right within each regular expression, and then through each event condition in series.

Conversion functions for inherited event information

Inherited event information can be converted into character strings of a user-specified length. This makes it possible to display lists of message IDs, dates, and so on in an easy-to-read format where the data is aligned in a fixed-length field.

If the length of the inherited event information is less than the length specified by the user, single-byte spaces are added to make it the specified length.

If the length of the inherited event information is greater than the length specified by the user, the information is truncated to make it fit the length specified by the user.

When multi-byte characters are truncated, the truncation is performed in such a way that characters are not broken. If the length after truncation is less than the length specified by the user, a single-byte space is added.

Specification format:

$variable-name$FIXLEN=number-of-bytes

Specify a numeric value from 1 to 1,023 for number-of-bytes. If the specification format is incorrect, $FIXLEN=number-of-bytes will be treated as a character string.

By enclosing variable-name in curly brackets ({}), you can explicitly specify the material to be treated as part of the parameter.

No.

Specification format

Character string in $variable-name

Character string set in message

Remarks

1

$variable-name$FIXLEN=6

ABC

ABCΔ

Because the character string is shorter than the specified length, single-byte spaces are added to compensate.

2

ABCDEFG

ABCDEF

Because the character string exceeds the specified length, it is truncated.

3

$variable-name$FIXLEN=1024

ABC

ABC$FIXLEN=1024

Because the specified value exceeds the maximum value of 1023, it is treated as a character string.

4

$variable-name$FIXLEN=10225

ABC

ABCΔ ... Δ 5, where

Δ ... Δ represents 1,019 Δ characters

Only the first four characters in the character string after $FIXLEN= are considered part of the parameter, so the fifth and subsequent characters are treated as a character string.

5

${variable-name$FIXLEN=10}235

ABC

ABCΔ235

The material in the curly brackets ({}) through 10 is treated as the parameter, and 235 is treated as a character string.

Legend: Δ indicates a single-byte space

It is possible to align the number of digits of numerical values to be displayed in the message by padding the value with zeros. This can be used when you want to convert the numeric value representing seconds to a format such as ss, ss.sss, or ss.ssssss.

Specification format:

$variable-name$FIXNUM=00.000000

You can specify 0 to 2 digits for the integer portion and 0 to 6 digits for the decimal portion.

This conversion is also possible when the value stored in the variable is a character string representation of a numeric value.

When a character string representing a non-numeric value is set, no conversion is performed if the integer portion exceeds the specified number of digits, or the value stored in the variable is greater than or equal to 100.

When the decimal portion exceeds the specified number of digits, the excess decimal places are truncated. Truncation is also performed whenever 7 or more decimal places are set in the value stored in the variable.

No.

Specification format

Character string in $variable-name

Character string set in message

Remarks

1

$variable-name$FIXNUM=00.000

1

01.000

The integer and decimal portions are padded with zeros.

2

123.123456

123.123456

No conversion is performed because the value is greater than or equal to 100.

3

$variable-name$FIXNUM=0.00

15

15.00

The integer portion is not converted because it exceeds the specified number of digits (1).

4

$variable-name$FIXNUM=00

1

01

The integer portion is padded with zeros.

5

1.5

01

The decimal portion exceeds the specified number of digits, so the excess decimal places are truncated.

6

$variable-name$FIXNUM=00.000000

0.1234567

00.123456

The 7th and subsequent decimal places are truncated.

7

$variable-name$FIXNUM=.00

1

1.00

The decimal portion is padded with zeros.

8

$variable-name$FIXNUM=00.

1

01

The integer portion is padded with zeros.

9

$variable-name$FIXNUM=ABC

1

1$FIXNUM=ABC

The invalid $FIXNUM specification is treated as a character string.

10

$variable-name$FIXNUM=0.00

ABC

ABC

No conversion is performed because the value in $variable-name is non-numeric.

11

0.0000000A

0.0000000A

The number of seconds elapsed since 1970/01/01 is converted to character strings representing the year, month, day, hour, minute, and seconds.

The conversion uses the time zone of the manager host.

No conversion is performed unless the value stored in the variable is a character string representing a numeric value from 0 to 2,147,483,647.

No.

Specification format

Conversion

1

$variable-name$YEAR

Converts the number of seconds elapsed since 1970/01/01 to a year.

After conversion, the value is output in the format YYYY. The year to be output is padded with zeros as necessary to make it 4 digits.

2

$variable-name$MONTH

Converts the number of seconds elapsed since 1970/01/01 to a month

After conversion, the value is output in the format MM. The month to be output is padded with zeros as necessary to make it 2 digits.

3

$variable-name$DAY

Converts the number of seconds elapsed since 1970/01/01 to a day.

After conversion, the value is output in the format DD. The day to be output is padded with zeros as necessary to make it 2 digits.

4

$variable-name$HOUR

Converts the number of seconds elapsed since 1970/01/01 to an hour.

After conversion, the value is output in the format hh. The hour to be output is padded with zeros as necessary to make it 2 digits.

The hour value is output in 24-hour format.

5

$variable-name$MIN

Converts the number of seconds elapsed since 1970/01/01 to a minute.

After conversion, the value is output in the format mm. The minutes value to be output is padded with zeros as necessary to make it 2 digits.

6

$variable-name$SEC

Converts the number of seconds elapsed since 1970/01/01 to seconds.

After conversion, the value is output in the format ss. The seconds value to be output is padded with zeros as necessary to make it 2 digits.

Successive format conversion functions can be specified.

If you specify a succession of format conversion functions, the format conversions will be performed from left to right in the order specified.

Even if the previous format conversion fails, subsequent conversion processing is performed.

Figure 2‒10: Successive format conversions

# comment-line

A line beginning with a hash mark (#) is treated as a comment. Note that the comment will be deleted if the display message change definition is set from JP1/IM - View.

Example definition

If the event ID matches 100 or 200, the severity is Warning, and the source host matches hostA, hostB, or hostC, change the message to A failure occurred in the database server, with the date and time prepended to the beginning of the message.

DESC_VERSION=1
def display-message-change-1
    cmt comment1
    define enable
    addflag false
    cnd
        B.ID IN 100 200
        E.SEVERITY IN Warning
        B.SOURCESERVER IN hostA hostB hostC
    end-cnd
    msg $EVDATE $EVTIME A failure occurred in the database server
end-def

The following example extracts the message ID and message text portions from the Hntr log.

DESC_VERSION=1
def display-message-change-1
    cmt comment1
    define enable
    addflag false
    cnd
        E.OBJECT_TYPE IN LOGFILE
        E.OBJECT_NAME SUBSTR HNTRLib2
        E.ROOT_OBJECT_TYPE IN LOGFILE
        E.PRODUCT_NAME IN /HITACHI/JP1/NT_LOGTRAP
        B.MESSAGE REGEX [0-9]{4}%20[0-9]{4}/[0-9]{2}/[0-9]{2}%20[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}[%20]+.*[%20]+[0-9A-Z]+%20[0-9A-Z]+[%20]+([^%20]+)[%20]+(.*)
    end-cnd
    msg $EVENV1 $EVENV2
end-def

The following example prepends a character string to the beginning of all messages for a particular product.

DESC_VERSION=1
    def display-message-change-1
    cmt comment1
    define enable
    addflag false
    cnd
        E.PRODUCT_NAME IN PRODUCT_A
    end-cnd
    msg [Product A]$EVMSG
end-def

Display item definition file for a display message change definition (chmsg_attr_list.conf)

Format

# comment-line
attribute-name
attribute-name
   :
   :
attribute-name

File

chmsg_attr_list.conf (display item definition file for a display message change definition)

chmsg_attr_list.conf.model (model file for the display item definition file for a display message change definition)

Storage directory

In Windows

For a physical host:

Console-path\conf\chattr\attr_list

For a logical host:

shared-folder\jp1cons\conf\chattr\attr_list

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/chattr/attr_list

For a logical host:

shared-directory/jp1cons/conf/chattr/attr_list

Description

This definition file specifies the items to be displayed in the Attribute name display area of the Display Message Change Definition Settings window. The display items specified in the display item definition file for a display message change definition are displayed in the Attribute name display area of the Display Message Change Definition Settings window in the order they are specified.

When the definitions are applied

The definitions take effect when Central Console is started and when the definitions are re-read by executing the jco_spmd_reload command.

Information that is specified

# comment-line

A line beginning with a hash mark (#) is treated as a comment.

attribute-name

The items to be displayed in the Attribute name display area of the Display Message Change Definition Settings window are specified in the display item definition file for a display message change definition.Write one attribute name corresponding to a display item on each line. You can specify from 0 to 256 display items.

Uppercase and lowercase are distinguished. Space and tab characters specified at the beginning or the end of the attribute name are ignored.

When SEPARATOR is specified, a horizontal line such as -------------------- is displayed in the Attribute name display area of the Display Message Change Definition Settings window. SEPARATOR can be used to separate frequently used items from those used less frequently.

However, if only SEPARATOR is specified, only -------------------- will appear in the Attribute name display area. If you then select --------------------, you will be unable to set the attribute name.

The following table lists the attribute names that can be specified.

Table 2‒72: List of display items

No.

Display item

Attribute name

1

Event source host name#

E.JP1_SOURCEHOST

2

Registered host name

B.SOURCESERVER

3

Event level

E.SEVERITY

4

Object type

E.OBJECT_TYPE

5

Object name

E.OBJECT_NAME

6

Root object type

E.ROOT_OBJECT_TYPE

7

Root object name

E.ROOT_OBJECT_NAME

8

Occurrence

E.OCCURRENCE

9

User name

E.USER_NAME

10

message

B.MESSAGE

11

Product name

E.PRODUCT_NAME

12

Event ID

B.ID

13

Destination event server name

B.DESTSERVER

14

Program-specific extended attribute

OTHER_EXTENDED_ATTRIBUTE

15

Reason for registration

B.REASON

16

Source process ID

B.PROCESSID

17

Source user name

B.USERNAME

18

Source user ID

B.USERID

19

Source group name

B.GROUPNAME

20

Source group ID

B.GROUPID

21

Object ID

E.OBJECT_ID

22

Return code

E.RESULT_CODE

23

--------------------

SEPARATOR

Note:

If an attribute name is specified twice, both specifications are ignored.

If the display item definition file for a display message change definition cannot be read, or the number of valid display items is 0, items 1 to 22 are displayed.

#

If the user mapping function of the event source host is not enabled, this item is cannot be displayed in the Display Message Change Definition Settings window.

Example definition

E.JP1_SOURCEHOST
B.SOURCESERVER
E.SEVERITY
E.OBJECT_TYPE
E.OBJECT_NAME
E.ROOT_OBJECT_TYPE
E.ROOT_OBJECT_NAME
E.OCCURRENCE
E.USER_NAME
B.MESSAGE
E.PRODUCT_NAME
B.ID
B.DESTSERVER
OTHER_EXTENDED_ATTRIBUTE
B.REASON
B.PROCESSID
B.USERNAME
B.USERID
B.GROUPNAME
B.GROUPID
E.OBJECT_ID
E.RESULT_CODE

Automatic input definition file for a display message change definition (chmsg_auto_list.conf)

Format

# comment-line
[DEFAULT_NAME display-message-change-definition]
attribute-name
attribute-name
   :
   :
attribute-name
attribute-name

File

chmsg_auto_list.conf (automatic input definition file for a display message change definition)

chmsg_auto_list.conf.model (model file for the automatic input definition file for a display message change definition)

Storage directory

In Windows

For a physical host:

Console-path\conf\chattr\auto_list

For a logical host:

shared-folder\jp1cons\conf\chattr\auto_list

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/chattr/auto_list

For a logical host:

shared-directory/jp1cons/conf/chattr/auto_list

Description

This file defines the JP1 event attributes that are set automatically when the Add Display Message Change Definition Settings window opens. The window opens when the user selects it from the Display Message Change Definition Settings menu after selecting a JP1 event from the list of events in the Event Console window and selecting View. You can also define a default name for the display message change definition.

When the definitions are applied

The contents of the definition file take effect when Central Console is started and when the definitions are re-read by executing the jco_spmd_reload command.

Information that is specified

# comment-line

A line beginning with a hash mark (#) is treated as a comment.

DEFAULT_NAME display-message-change-definition

Specifies the identifier that defines the display message change definition. The identifier must be on the first line in the file (the first line in the file that is not a null line or a comment line).

The display message change definition specified for this parameter is displayed as the initial value when the Add Display Message Change Definition Settings window opens. The window opens when the user selects it from the Display Message Change Definition Settings menu after selecting a JP1 event from the list of events in the Event Console window and selecting View.

For the name, specify a character string of up to 40 bytes. The permitted characters are all characters other than the control characters (from 0x00 to 0x1F and 0x7F to 0x9F). If a name with more than 40 bytes is specified, characters after the 40th are dropped, and the first 40 bytes of the character string are used as the display message change definition. If this parameter is omitted, Add display message change definition is assumed as the display message change definition.

attribute-name

For the automatic input definition file for a display message change definition,specify the attribute of a JP1 event that is to be set as an event condition when the Add Display Message Change Definition Settings window opens. The window opens when the user selects it from the Display Message Change Definition Settings menu after selecting a JP1 event from the list of events in the Event Console window and selecting View. At this time, the condition for the attribute name specified for this parameter will be displayed as the initial value.

For the definition items, write one attribute name of a JP1 event that will be set on each line.

Uppercase and lowercase are distinguished. Space and tab characters specified at the beginning or the end of the attribute name are ignored.

If there are no valid attribute names, the KAVB1952-W message is output to the integrated trace log file, and the default items are used.

If the same attribute name is specified twice, both are ignored, and the KAVB1954-W message is output to the integrated trace log file.

The order in which the attributes are written in this definition file determines the order in which JP1 event attributes are displayed automatically in the Event conditions section of the Display Message Change Definition Settings window.

If attribute-name is specified incorrectly, the KAVB1953-W message is output to the integrated trace log file, and the attribute name is ignored.

The following table lists the attribute names that can be specified.

Table 2‒73: List of display items

No.

Display item

Attribute name

1

Event source host name#

E.JP1_SOURCEHOST

2

Registered host name

B.SOURCESERVER

3

Event level

E.SEVERITY

4

Object type

E.OBJECT_TYPE

5

Object name

E.OBJECT_NAME

6

Root object type

E.ROOT_OBJECT_TYPE

7

Root object name

E.ROOT_OBJECT_NAME

8

Occurrence

E.OCCURRENCE

9

User name

E.USER_NAME

10

Message

B.MESSAGE

11

Product name

E.PRODUCT_NAME

12

Event ID

B.ID

13

Destination event server name

B.DESTSERVER

14

Reason for registration

B.REASON

15

Source process ID

B.PROCESSID

16

Source user name

B.USERNAME

17

Source user ID

B.USERID

18

Source group name

B.GROUPNAME

19

Source group ID

B.GROUPID

20

Object ID

E.OBJECT_ID

21

Return code

E.RESULT_CODE

Note:

If an attribute name is specified twice, both specifications are ignored.

If the definition file cannot be read, or the number of valid display items is 0, items 1 to 12 are displayed.

#

If the user mapping function of the event source host is not enabled, this item is cannot be displayed in the Add Display Message Change Definition Settings window.

Example definition

DEFAULT_NAME display-message-change-definition
E.JP1_SOURCEHOST
B.SOURCESERVER
E.SEVERITY
B.MESSAGE
E.PRODUCT_NAME
B.ID

Environment definition file for events after the display message is changed (chmsgevent.conf)

Format

[logical-host-name\JP1CONSOLEMANAGER]
"SEND_CHANGE_MESSAGE_EVENT"=dword:hexadecimal-value

File

chmsgevent.conf (environment definition file for events after the display message is changed)

chmsgevent.conf.update (model file for the environment definition file for events after the display message is changed)

Storage directory

In Windows

Console-path\default\

In UNIX

/etc/opt/jp1cons/default/

Description

This file defines the execution environment of the function for issuing an event after a display message has been changed. It specifies whether to enable the function.

When the definitions are applied

The definitions take effect when JP1/IM - Manager is restarted after the jbssetcnf command has been executed in JP1/Base to apply the definitions to the JP1 common definition information.

Information that is specified

[logical-host-name\JP1CONSOLEMANAGER]

Indicates the key name of the JP1/IM - Manager environment settings.

For logical-host-name, specify JP1_DEFAULT for a physical host and logical-host-name for a logical host.

"SEND_CHANGE_MESSAGE_EVENT"=dword:hexadecimal-value

Specifies whether to enable the function to issue an event after a display message is changed.

00000001: Enabled (issue an event after a display message is changed)

00000000: Disabled (do not issue an event after a display message is changed)

The default value is 00000000 (disabled).

Example definition

[JP1_DEFAULT\JP1CONSOLEMANAGER]
"SEND_CHANGE_MESSAGE_EVENT"=dword:00000000

Web page call definition file (hitachi_jp1_product-name.html)

Format

<HTML>
<HEAD>
<META HTTP-EQUIV="refresh" CONTENT="0;URL=URL-of-other-product's-web-page">
</HEAD>
</HTML>

File

hitachi_jp1_product-name.html (Web page call definition file)

hitachi_jp1_product-name.html.model (model file for the Web page call definition file)

Storage directory

View-path\conf\webdata\en\

Description

This file is used for calling another product's Web page from the Tool Launcher.

When another product's Web page is to be called from the Tool Launcher, the Web page call definition file is referenced first and then its URL defined in this file is accessed. If you plan to call some other product's web page from the Tool Launcher, you must set its URL by editing this file as appropriate to your environment.

If you attempt to display a Web page from the Tool Launcher without having set its URL, a page describing the setting method is displayed.

List of Web page call definition files

JP1/IM provides the definition files listed in the table below. See the individual linked product documentation for details about the versions and operating systems that support the linked product.

Table 2‒74: List of Web page call definition files that correspond to item names in the Tool Launcher window

Item in the Tool Launcher window

Web page call definition file name

Product name

Folder name

Subfolder name

Function name

Network Management

--

Network Node Manager

hitachi_jp1_cm2.html

HP NNM Version 7.5 or earlier

HP NNM

Inventory/Software Distribution

--

Integrated Asset Management

hitachi_jp1_assetinfomationmanager.html

JP1/Asset Information Manager

--

Inventory/Software Distribution#

hitachi_jp1_netmdm.html

JP1/Software Distribution Manager

Storage Management

Storage Area Management

Storage System Usage Management

hitachi_jp1_hicommand_tuning_manager.html

JP1/HiCommand Tuning Manager

Storage Hardware Management

hitachi_jp1_hicommand_device_manager.html

JP1/HiCommand Device Manager

Storage Resource Allocation Management

hitachi_jp1_hicommand_provisioning_manager.html

JP1/HiCommand Provisioning Manager

Storage Replication Management

hitachi_jp1_hicommand_replication_manager.html

Hitachi Replication Manager

Tiered Storage Resource Management

hitachi_jp1_hicommand_tiered_storage_manager.html

JP1/HiCommand Tiered Storage Manager

Global Input/output Path Availability Management

hitachi_jp1_hicommandGLAM.html

JP1/HiCommand Global Link Availability Manager

Server Management

--

Web Console

hitachi_jp1_systemmanager.html

JP1/Server Conductor

Legend:

--: None

#

JP1/IM - View for Windows cannot link with the Web page versions of JP1/Software Distribution Manager.

By changing the URLs specified in these HTML files to the URLs of individual product Web pages, you can access those products' Web pages from the Tool Launcher window.

When the definitions are applied

The definition takes effect when JP1/IM - View is restarted.

Information that is specified

<META HTTP-EQUIV="refresh" CONTENT="0;URL=URL-of-other-product's-web-page">

Specifies the URL of another product's Web page.

If you attempt to display another product's Web page from the Tool Launcher without setting its URL, a page describing the setting method is displayed (View-path\conf\webdata\en\webconfig_hitachi_jp1_product-name.html). You can specify the URL by following the instructions provided on the displayed page.#

#

• The URL set on this page is the default value. With some products, the user can customize the URL. Check the URLs used by other products beforehand.

Sometimes, the URL of a product will have changed, for a reason such as upgrading. If no window opens at the specified URL, check the applicable product's documentation.

• In host name, specify the host name or IP address of the machine where the product corresponding to the Web page is installed.

Example definition

<HTML>
<HEAD>
<META HTTP-EQUIV="refresh" CONTENT="0;URL=http://hostA/OvCgi/ovlaunch.exe">
</HEAD>
</HTML>

Definition file for the Tool Launcher window

Format

@file type="definition-file-type", version="definition-format-version";
# comment-line
@define-block type="function-tree-def";
folder-definition
function-definition
@define-block-end;

File

!JP1_CC_FTREE0.conf (definition file for the Tool Launcher window)

!JP1_CC_FTREE0.conf.model (model file for the definition file for the Tool Launcher window)

Storage directory

View-path\conf\function\en\

Description

This file defines tree and item information to be displayed in the Tool Launcher window of JP1/IM - View.

JP1/IM provides the jcofuncfcheck command for checking the contents of the definition file for the Tool Launcher window. For details about this command, see jcofuncfcheck (Windows only) in Chapter 1. Commands.

When the definitions are applied

The definition takes effect after JP1/IM - View is restarted.

Information that is specified

@file type="function-definition"

Declares that this is a definition file for the Tool Launcher window. This statement is mandatory.

You must always specify function-definition.

This statement must be on the first line of the file.

version="0300";

Specify 0300 for the version.

# comment-line

A line beginning with a hash mark (#) is treated as a comment.

@define-block type="function-tree-def"; to @define-block-end;(Tool Launcher definition block)

Tool Launcher definition block

Creates folders or functions that are to be displayed in the Tool Launcher window and specifies application execution definition identifiers to associate the application that is to be executed when a function is chosen.

The functions are displayed in the Tool Launcher window in the order of their file names. Within the same file, the functions are displayed in the order of their definition blocks. You can change the display order of menu items by changing the order of the file names or definition blocks.

The statements that can be specified in this block depend on whether folders or functions are being defined:

Table 2‒75: Statements

When folders are defined

When functions are defined

id statement

parent_id statement

name statement

id statement

parent_id statement

name statement

execute_id statement

icon statement

arguments statement

If any other statement is specified, an error is output but only the extraneous statement is ignored.

The following describes these statements.

id="menu-identifier";

Defines a menu identifier for the menu tree definition block. This statement is mandatory. This statement can be specified only once in a block.

If the file to be analyzed contains multiple blocks with the same id, their priority is determined as follows and only the block that has the highest priority is effective:

1. Last block when the file names are sorted in ascending order

2. Last block in the file

All other blocks are ignored.

Express a menu identifier using from 1 to 32 alphanumeric characters. This character string must be unique within the definition file for the Tool Launcher window. To achieve uniqueness, observe the following naming rules:

• When defining folders

company-name[_product-name]

• When defining functions

company-name_product-name[_function-name-(or-window-name)]

If an appropriately named folder name already exists, do not add a new folder; use the definition file storage location folder already specified in the other definition file.

"root" cannot be used because it is reserved for the highest menu identifier.

A character string beginning with jco_ cannot be used because it is reserved as an application execution identifier.

parent_id="parent-menu-identifier";

Specifies root or the menu identifier that is located above the local menu identifier in the tree configuration. You can specify a maximum of 3 hierarchical levels, including root. This statement is mandatory. This statement can be specified only once in a block.

You cannot specify multiple parent menu identifiers to create multiple higher folders.

name="display-name";

Defines the name that is to be displayed in the Tool Launcher window. This statement is mandatory. This statement can be specified only once in a block.

Specify in display-name the character string that is to be displayed in the Tool Launcher window; we recommend that you use a simple but readily understood name. The character string can contain Japanese characters.

We recommend that you use a noun phrase, such as the character string Command Execution Function, because the specified value is displayed in the menu.

Although this value need not be unique in the definition, we recommend that you assign a unique name to eliminate possibilities for confusion.

execute_id="application-execution-definition-identifier";

Specifies the identifier for the application execution definition that is to be executed when the function displayed in the Tool Launcher window is double-clicked. If you specify a function, this statement is mandatory. You can specify this statement only once in a block.

You can launch the default browser by specifying "default_browser" for the execute_id parameter. If you specify "default_browser" for the execute_id parameter, specify a URL in the arguments parameter.

If you are creating a folder, this statement is ignored if specified.

If the specified application execution definition identifier does not exist, the menu is not displayed.

Note that a character string beginning with jco_ cannot be used, because it is reserved as the application execution definition identifier.

icon="display-icon-file-name";

Specifies the file that contains the icon that is to be displayed in the Tool Launcher window. Specify the full path name of a GIF file. The recommended size for the GIF image is 16 × 16 pixels. If the specified icon image is not this size, it will be resized when the icon is displayed.

You can specify this statement only when you are specifying a function.

If you are creating a folder, this statement is ignored if specified.

If this statement is omitted, the common icon is used.

arguments="command-arguments";

Specifies arguments for the application specified in execute_id. You can use this statement only when you are specifying a function. You can specify this statement only once in a block.

You can also set in arguments reserved keywords that will be replaced with the viewer's operating environment attributes or alternate strings for substitution from registry values. For details about alternate strings, see Alternate string in Definition file for executing applications in Chapter 2. Definition Files.

If you are creating a folder, this statement is ignored if specified.

The full path of the executable file specified in execute_id is linked with the value of arguments obtained from the alternate string with a single space added. In this case, the command cannot be executed if its length exceeds 1,024 characters.

The following shows an example definition of a menu tree definition block:

@define-block type="function-tree-def";

id="hitachi_jp1";

parent_id="root";

name="Sample management";

@define-block-end;

@define-block type="function-tree-def";

id="hitachi_jp1_seihin_sample";

parent_id="hitachi_jp1";

name="Sample window";

icon="sample.gif";

execute_id="hitachi_jp1_seihin_sample_execute";

arguments="node_map";

@define-block-end;

Example definition

The following shows an example of the definition file for the Tool Launcher window:

#
# All Rights Reserved, Copyright (C) 2000, Hitachi, Ltd.
#
@file type="function-definition", version="0300";
#----------------------------------------------------------
@define-block type="function-tree-def";
id="jco_folder_Network";
parent_id="root";
name="Network Management";
@define-block-end;
#----------------------------------------------------------
@define-block type="function-tree-def";
id="jco_JP1_Cm2";
parent_id="jco_folder_Network";
name="Network Management";
icon="%JCO_INSTALL_PATH%\image\menu\cm2_manager.gif";
execute_id="default_browser";
arguments="%JCO_INSTALL_PATH%\conf\webdata\en\hitachi_jp1_cm2.html";
@define-block-end;
#----------------------------------------------------------
@define-block type="function-tree-def";
id="jco_folder_JobSystemOperation";
parent_id="root";
name="Job System Management";
@define-block-end;
#----------------------------------------------------------
@define-block type="function-tree-def";
id="jco_JP1_AJS2";
parent_id="jco_folder_JobSystemOperation";
name="Job System Management";
icon="%JCO_INSTALL_PATH%\image\menu\ajs2_manager.gif";
execute_id="jco_JP1_AJS2";
arguments="-t "%JCO_JP1TOKEN%"";
@define-block-end;
#----------------------------------------------------------

Command button definition file (cmdbtn.conf)

Format

DESC_VERSION=file-version

#comment-line
def
  [usr target-user-name target-user-name ...]

  btn command-button-name
    [cmt comment-about-command-button]
    [cmdtype {agent|client}]
    [inev {true|false}]
    [hst target-host]
    cmd command-line
    [var environment-variable-file-name]
    [qui {true|false}]
    [preview {true|false}]
  end-btn
  :
  :
end-def
:
:

File

cmdbtn.conf

Storage directory

In Windows

For a physical host:

Console-path\conf\console\rmtcmd\

For a logical host:

shared-folder\jp1cons\conf\console\rmtcmd\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/rmtcmd/

For a logical host:

shared-directory/jp1cons/conf/console/rmtcmd/

Execution permission

In Windows

Administrators group and SYSTEM users

In UNIX

Users with the root permissions

Description

This file defines the command buttons to be displayed in the Execute Command window. The maximum size of the command button definition file is 10 megabytes. If there are multiple command button definitions that can be used, the definition listed first in the command button definition file is displayed.

When the definitions are applied

If the jcoimdef command has been executed to enable the command button, the command button definitions are applied when the Execute Command window opens.

Note that if you change the definition of the command button while JP1/IM - View is running, you must restart JP1/IM - View.

Information that is specified

DESC_VERSION=file-version

Specifies the version of the format of the command button definition file. The specifiable values are 1 and 2. To use the functionality that inherits the client application or event information, specify 2. When 2 is specified, the following parameters can be specified:

cmdtype

inev

preview

When the file version is omitted or a numeric value other than 1 or 2 is specified, 1 is assumed.

#comment-line

A line beginning with a hash mark (#) is treated as a comment.

def to end-def (definition block)

These are the start and end parameters of the command button definition. You can specify a maximum of 64 parameters.

[usr target-user-name target-user-name ...]

Specifies the names of JP1 users who use the command button. The number of characters you can specify for each target user name is from 1 to 31 bytes. Only one-byte alphanumeric characters can be used. Alphabets are not case sensitive. To specify multiple names, separate the names by one or more consecutive spaces or tabs. You can specify a maximum of 100 target user names. Target user names from the 101st are ignored. If this parameter is omitted, all JP1 users become target users. One target user name can be specified between def and end-def. No target user names can be specified between btn and end-btn.

btn command-button-name to end-btn

Specify the start and the end of a command button. command-button-name is displayed as the name of a command button in the Execute Command window. You can specify a maximum of eight characters for command-button-name. Specifiable characters are characters other than control characters (0x00 to 0x1F, 0x7F to 0x9F). The command button name is case sensitive. A maximum of 16 command buttons can be specified in a definition block. The same command button name cannot be specified twice. If command-button-name exceeds the limit for number of characters or the same command button name is specified twice, the command button name cannot be loaded.

[cmt comment-about-command-button]

Provides a description of the command button. The comment is displayed as a tool tip. This parameter can be omitted. You can specify a maximum of 40 characters for the comment. Characters from the 41st are ignored. You can specify any characters.

[cmdtype {agent|client}]

Specifies the type of command executed by a command button. Select whether the button will be used for managed-host commands or by client applications. Client applications are executed by the client application execution functionality. If you specify this parameter, specify 2 for DESC_VERSION.

For command execution on an agent or a manager host, specify the agent parameter. For command execution by a client application, specify the client parameter.

If you specify client for cmdtype, you cannot specify the hst and var parameters.

agent and client are not case sensitive.

[inev {true|false}]

Specifies whether to inherit event information by using the command button. If you specify this parameter, specify 2 for DESC_VERSION.

Specify true to execute the command by inheriting event information specified when you click the command button, or specify false not to execute the command. If this parameter is omitted, false is assumed.

true and false are not case sensitive.

[hst target-host]

Specifies the name of the host on which the command is executed. For target-host, you can specify a host name, host group name, business group name, or monitoring group name.

For a host name or a host group name, you can specify a character string with a maximum of 255 bytes. For a business group name or a monitoring group name, you can specify a character string with a maximum of 2,048 bytes. This parameter can be omitted.

If the integrated monitoring database and the IM Configuration Management database are enabled, the business group name can be specified in a path format.

If the integrated monitoring database and the IM Configuration Management database are disabled, and you specify the business group name in a path format, the name is treated as a host name or a host group name.

Specify a variable to hold the inherited event information. For details about the inherited event information that can be specified, see 4.19.5(1) Specifiable event inheritance information in the JP1/Integrated Management 2 - Manager Overview and System Design Guide. To specify inheritance of event information, specify true for the inev parameter. If you make this specification, make sure that the length of the character string following replacement of the variable with JP1 event information is equal to or less than the maximum number of bytes permitted for target-host. If the length of the character string exceeds the limit, a truncated character string is specified as the target host name in the environment variable file.

cmd command-line

Specifies the command to be executed. You can specify a maximum of 4,096 bytes for the command line. This parameter cannot be omitted.

Specify a variable to hold the inherited event information. To specify inheritance of event information, specify true for the inev parameter. If you make this specification, make sure that the length of the character string following replacement of the variable with JP1 event information is equal to or less than the maximum number of bytes permitted for target-host. If the length of the character string exceeds the limit, a truncated character string is specified as the target host name in the environment variable file.

[var environment-variable-file-name]

Specifies the name of the environment variable file in which the environment variable of the command to be executed is specified. This parameter can be omitted. For details about the environment variable file format, see the JP1/Base User's Guide. You can specify a character string with a maximum of 255 bytes for the environment variable file name. If the environment variable file name exceeds the limit, the command button is not loaded.

Specify a variable for the inherited event information. To specify inherited event information, specify true for the inev parameter. When you specify inherited event information, make sure that the length of a character string following replacement of the variable with JP1 event information is equal to or less than the maximum number of bytes permitted for the environment variable file. If the length of the character string exceeds the limit, a truncated character string is specified as the target host name in the environment variable file.

[qui {true|false}]

Specifies whether to display a message confirming that the command can be executed before executing a command with a command button. If the confirmation message is not displayed, the command is executed at the same time the command button is clicked.

Specify true if you want the confirmation message to be displayed. Specify false if you do want the message to be displayed. If this parameter is omitted, false is assumed. However, if true is specified for the preview parameter, the Preview Command Execution Content window opens.

true and false are not case sensitive.

[preview {true|false}]

If you inherit event information by using a command button, this parameter specifies whether to check the action definition of the command with the preview function after event information is inherited. To specify this parameter, specify 2 for DESC_VERSION.

Specify true to display the preview window. Specify false if you do not want to display the preview window. If this parameter is omitted, true is assumed.

true and false are not case sensitive.

This parameter is ignored if false is specified for the inev parameter.

If false is specified for the preview parameter and true is specified for the qui parameter, the command is executed at the same time the command button is clicked. The Preview Command Execution Content window and a message to confirm command execution are not displayed.

Example definition

DESC_VERSION=2

def
# Execute the command on the viewer host.
# Specify inherited event information for the command to be executed.
# Before executing the command, display the preview window.
  btn App1
    cmt Execute App1.
    cmdtype client
    inev true
    cmd C:\kansi\app1.exe $EVIDBASE $EVSEQNO "$EVMSG"
  end-btn

# Execute the command on the viewer host.
# Specify inherited event information for the command to be executed.
# Before executing the command, display the confirmation dialog box. The preview window is not displayed.
  btn App2
    cmt Execute App2.
    cmdtype client
    inev true
    cmd C:\kansi\app2.exe $EVIDBASE $EVSEQNO "$EVMSG"
    preview false
  end-btn

# Execute the command on the viewer host.
# Specify inherited event information for the command to be executed.
# Do not display the dialog box and the preview window before executing the command.
  btn App3
    cmt Execute App3.
    cmdtype client
    inev true
    cmd C:\kansi\app3.exe $EVIDBASE $EVSEQNO "$EVMSG"
    qui true
    preview false
  end-btn

# Execute the command on the agent or the manager host.
# Specify inherited event information for the command to be executed.
# Display the preview window before executing the command.
  btn Cmd1
    cmt Execute cmd1.
    cmdtype agent
    inev true
    hst $EVHOST
    cmd /kansi/cmd1 $EVIDBASE $EVSEQNO '$EVMSG'
  end-btn

# Execute the command on the agent or the manager host.
# Do not specify inherited event information for the command to be executed.
# Display the confirmation dialog box before executing the command.
  btn Cmd2
    cmt Execute cmd2.
    hst agent2
    cmd /kansi/cmd2
  end-btn

end-def

Start program definition file (!JP1_CS_APP0.conf)

Format

@define-block type="application-execution-def";
id="program-identifier";
path="start-program-path";
@define-block-end;

File

!JP1_CS_APP0.conf (start program definition file)

!JP1_CS_APP0.conf.model (model file for the start program definition file)

Storage directory

View-path\conf\sovtoolexec\en\

Description

This file defines the start path for a program that is added to the toolbar in the Monitoring Tree window.

To add a program to the toolbar in the Monitoring Tree window, and then start the program from the toolbar, you must also edit the following definition files:

Toolbar definition file

Icon operation definition file

When the definitions are applied

The definition takes effect when the Monitoring Tree window is re-opened.

Information that is specified

From @define-block type to @define-block-end;

The information from @define-block type to @define-block-end; constitutes a single definition block. To add multiple programs to the toolbar in the Monitoring Tree window, specify this definition block as many times as there are programs to be added. You can specify the following parameters in this definition block:

id="program-identifier"

Specifies the identifier that indicates the program to be started. You can specify from 1 to 32 alphanumeric characters. This character string must be unique within the definition file. The program identifier specified in this parameter must be the same as a program identifier that is specified in the icon operation definition file (!JP1_CS_FTREE0.conf). For details about the icon operation definition file (!JP1_CS_FTREE0.conf), see Icon operation definition file (!JP1_CS_FTREE0.conf) in Chapter 2. Definition Files.

path="start-program-path"

Specifies the path of the program to be started. An executable file that can be specified must be an .exe or .bat file.

Example definition

#
# All Rights Reserved. Copyright (C) 2003, Hitachi, Ltd.
#
@file type="application-execution-definition", version="0300";
#----------------------------------------------------------
@define-block type="application-execution-def";
id="app_notepad";
path="C:\WINNT\NOTEPAD.EXE";
@define-block-end;
#----------------------------------------------------------

Toolbar definition file (!JP1_CS_FTOOL0.conf)

Format

@define-block type="function-toolbar-def";
toolbar="sov_JP1_IM_Central_Console|sov_JP1_IM_Function_Tree|sov_JP1_IM_Visual_View|sov_JP1_IM_Bmv_Help|icon-identifier...";
@define-block-end;

File

!JP1_CS_FTOOL0.conf (toolbar definition file)

!JP1_CS_FTOOL0.conf.model (model file for the toolbar definition file)

Storage directory

View-path\conf\sovtoolitem\en\

Description

This file defines the order of programs that are added to the toolbar in the Monitoring Tree window.

To add a program to the toolbar in the Monitoring Tree window, and then start the program from the toolbar, you must also edit the following definition files:

Start program definition file

Icon operation definition file

When the definitions are applied

The definition takes effect when the Monitoring Tree window is re-opened.

Information that is specified

From @define-block type to @define-block-end;

The information from @define-block type to @define-block-end; constitutes a single definition block. This block can be specified only once in the definition file.

toolbar="sov_JP1_IM_Central_Console|sov_JP1_IM_Function_Tree|sov_JP1_IM_Visual_View|sov_JP1_IM_Bmv_Help|icon-identifier";

Specifies the icon identifiers in the order they are to be displayed. The icon identifiers are separated by the vertical bar (|) and the icons are displayed from left to right in the Monitoring Tree window in the order they are specified here. An icon identifier is a character string consisting of no more than 32 alphanumeric characters. Each icon identifier character string must be unique within the definition file. The icon identifiers specified in this parameter must be the same as icon identifiers specified in the icon operation definition file (!JP1_CS_FTREE0.conf). For details about the icon operation definition file (!JP1_CS_FTREE0.conf), see Icon operation definition file (!JP1_CS_FTREE0.conf) in Chapter 2. Definition Files.

Example definition

#
# All Rights Reserved. Copyright (C) 2003, Hitachi, Ltd.
#
@file type="function-definition", version="0300";
#----------------------------------------------------------
@define-block type="function-toolbar-def";
toolbar="sov_JP1_IM_New_Info|sov_JP1_IM_Visual_View|sov_JP1_IM_Function_Tree|sov_JP1_IM_Central_Console|sov_JP1_IM_Bmv_Help|tool_notepad";
@define-block-end;
#----------------------------------------------------------

Icon operation definition file (!JP1_CS_FTREE0.conf)

Format

@define-block type="function-tree-def";
id="icon-identifier";
name="tooltip";
iconstandard="icon-storage-path";
icondown="icon-storage-path";
iconrollover="icon-storage-path";
icondisable="icon-storage-path";
execute_id="program-identifier";
arguments="argument";
@define-block-end;

File

!JP1_CS_FTREE0.conf (icon operation definition file)

!JP1_CS_FTREE0.conf.model (model file for the icon operation definition file)

Storage directory

View-path\conf\sovtoolitem\en\

Description

This file defines the operation of icons that are displayed on the toolbar in the Monitoring Tree window.

To add a program to the toolbar in the Monitoring Tree window, and then start the program from the toolbar, you must also edit the following definition files:

Start program definition file

Toolbar definition file

When the definitions are applied

The definition takes effect when the Monitoring Tree window is re-opened.

Information that is specified

From @define-block type to @define-block-end;

Information from @define-block type to @define-block-end; constitutes a single definition block.

To add multiple programs to the toolbar in the Monitoring Tree window, specify this definition block as many times as there are programs to be added. In this definition block, you can specify the following parameters:

id="icon-identifier";

Specifies the identifier that indicates the appropriate icon. You can specify from 1 to 32 alphanumeric characters. This character string must be unique within the definition file. Also, the icon identifier specified for this parameter must be the same as the icon identifier specified for the toolbar definition file (!JP1_CS_FTOOL0.conf). For details about the toolbar definition file (!JP1_CS_FTOOL0.conf), see Toolbar definition file (!JP1_CS_FTOOL0.conf) in Chapter 2. Definition Files.

name="tooltip";

Specifies the tooltip that is to be displayed when the cursor is placed on the icon.

iconstandard="icon-storage-path";

Specifies the full path of the icon that is to be displayed during normal operation.

icondown="icon-storage-path";

Specifies the full path of the icon that is to be displayed when the icon is clicked.

iconrollover="icon-storage-path";

Specifies the full path of the icon that is to be displayed when the cursor is moved onto the icon.

icondisable="icon-storage-path";

Specifies the full path of the icon that is to be displayed when the corresponding program cannot be started.

execute_id="program-identifier";

Specifies an identifier for the program that is to be started. You can specify from 1 to 32 alphanumeric characters. This character string must be unique within the definition file. The program identifier specified in this parameter must be the same as a program identifier that is specified in the start program definition file (!JP1_CS_APP0.conf). For details about the start program definition file (!JP1_CS_APP0.conf), see Start program definition file (!JP1_CS_APP0.conf) in Chapter 2. Definition Files.

arguments="arguments";

Specifies arguments for the program to be started (start path) that is defined in the start program definition file (!JP1_CS_APP0.conf). For details about the start program definition file (!JP1_CS_APP0.conf), see Start program definition file (!JP1_CS_APP0.conf) in Chapter 2. Definition Files.

Example definition

#----------------------------------------------------------
# Definition changed by 07-00.
@define-block type="function-tree-def";
id="tool_notepad";
name="Notepad";
iconstandard="%SOV_INSTALL_PATH%\image\sovtool\blank_standard.gif";
icondown="%SOV_INSTALL_PATH%\image\sovtool\blank_down.gif";
iconrollover="%SOV_INSTALL_PATH%\image\sovtool\blank_over.gif";
icondisable="%SOV_INSTALL_PATH%\image\sovtool\blank_disable.gif";
execute_id="app_notepad";
arguments="C:\test.txt";
@define-block-end;
#----------------------------------------------------------

Configuration file for monitoring tree

Format

TREE:BUILD=value;ID=value;[DATE=generation-date-and-time;]CSV_VER=09000000;MSCOPE=ON (linefeed)
OBJ:monitoring-node-name#, NID:monitoring-node-ID#, ICO:icon-name, TYPE:monitoring-node-type, CLASS:monitoring-object-type, STA:status-ID, CHDT:status-update-time, OBS:monitoring-status, STD:basic-information (attribute-name-1=attribute-name-1#), BKIMG=background-image-file-name, POT:X=X-coordinate;Y=Y-coordinate;Z=Z-coordinate, CON:NAME=status-change-condition-name#, STA=change-status-ID, CID=common-condition-ID;common-condition-information, GCON:NAME=status-change-condition-name#, STA=change-status-ID, CSTA=child-node-status-ID, NUM>=child-node-count, RATIO>=child-node-ratio, (individual-condition-name==individual-condition-value#), EVE:STA=status-ID, RES:JP1-resource-group-name, OWN:monitoring-node-owner's-name, OPE:list-of-operation-items (linefeed)
          :

Legend:

(linefeed): Location of a linefeed

#: Item that can be edited (all other items cannot be edited)

File

Any file (configuration file for monitoring tree)

Storage directory

Any folder

Description

This file defines the configuration of the monitoring tree that is displayed in the Monitoring Tree window.

By editing the configuration file for the monitoring tree, you can change the information that is displayed in the monitoring tree, such as the names of monitoring nodes and attribute values of basic information. To create a configuration file for monitoring tree, save the tree configuration locally from the Monitoring Tree window or Monitoring Tree (Editing) window. Do not create a configuration file for monitoring tree by any other method. When you edit the configuration file for monitoring tree, make sure that you do not edit any values other than those described below.

If you have updated an uneditable value by mistake and a backup of the configuration file for monitoring tree is available, use the backup file to update the configuration file for monitoring tree again. If no backup file is available, use the jcsdbsetup or jcsdbimport command to set up the monitoring object database again.

It is preferable that you use the Monitoring Tree (Editing) window to edit the monitoring tree, unless otherwise necessary.

To use two-byte characters, standardize the character encoding as MS932. No custom characters can be used. Do not enter an escape character.

When the definitions are applied

The definition takes effect when it is applied to JP1/IM - Manager after this definition file has been opened in the Monitoring Tree (Editing) window.

Information that is specified

TREE

The following parameters contained in TREE cannot be changed.

BUILD=value

value displays the tree generation number. This parameter value is changed by updating at the server.

ID=value

value displays the tree ID.

DATE=generation-date-and-time

generation-date-and-time displays the date and time the tree was generated. This parameter's value is updated when a server update is performed and when the status of a monitoring node changes.

CSV_VER=09000000

This is the CSV file format version. The value might be different depending on the version of JP1/IM - Manager.

MSCOPE={ON | OFF}

Displays whether the monitoring range settings are enabled or disabled. ON means that the monitoring range settings are enabled.

OBJ:monitoring-node-name

Displays the name of a monitoring node that is to be displayed in the monitoring tree. The user can change this information. You can specify a character string with a maximum of 255 bytes. Specifiable characters are one-byte alphanumeric characters and two-byte characters (except custom characters). If you use a semicolon (;) in the monitoring node name, enter two consecutive semicolons.

If the monitoring node name contains a comma (,), enclose the entire OBJ item in double-quotation marks (").

Example:

To specify "monitoring,node" as the name of a monitoring node, specify as follows:

"OBJ:monitoring,node"

If you enclose the monitoring node name in double-quotation marks ("), you must enclose the monitoring node name in another set of double-quotation marks and then also enclose the entire OBJ item in double-quotation marks.

Example:

To specify "monitoring node" as the monitoring node name, specify as follows:

"OBJ:""monitoring node"""

NID:monitoring-node-ID

Displays the ID (8 hexadecimal characters) of the monitoring node that is to be displayed in the monitoring tree. The user can change this information.

Make sure that each monitoring node ID is unique. Specify a value in the range from 00000001 to 7FFFFFFF.

ICO:icon-name

Displays a maximum of three icon names for the monitoring node, separated by the semicolon (;).

This parameter cannot be changed.

TYPE:monitoring-node-type

Displays the ID that identifies the monitoring group, monitoring object, and virtual root node. This parameter cannot be changed.

CLASS:monitoring-object-type

Displays the type of monitoring node. This parameter cannot be changed.

STA:status-ID

Displays the ID that indicates the status of the monitoring node. This parameter cannot be changed.

CHDT:status-update-time

Displays the time the status of the monitoring node was updated. This parameter cannot be changed.

OBS:monitoring-status

Displays the monitoring status of the monitoring node. This parameter cannot be changed.

STD:attribute-name=attribute-value

Displays the attribute name and attribute value when basic information has been defined for the monitoring node. If multiple basic information items are specified, the items are separated by the semicolon (;).

You can change only attribute-value. You can specify a maximum of 1,023 bytes# of characters for the attribute value. If you use a semicolon (;) in the attribute value, enter two consecutive semicolons.

#: The total length of the field is a maximum of 1,280 bytes (for example, if five basic information items are set, the total length of all five attribute values must be no greater than 1,280 bytes).

If the attribute value contains a comma (,), enclose the entire STD item in double-quotation marks (").

Example:

To specify attribute,value as the attribute value, specify as follows:

"STD:attribute-name=attribute,value"

If you enclose the attribute value in double-quotation marks ("), you must enclose the attribute value in another set of double-quotation marks and then also enclose the entire STD item in double-quotation marks.

Example:

To specify "attribute value" as the attribute value, specify as follows:

"STD:attribute-name=""attribute value"""

BKIMG=background-image-file-name

Displays the name of the background image file that is set in the Visual Monitoring (Editing) window or that is set when the map is displayed in the Monitoring Tree (Editing) window. This parameter cannot be changed.

POT:X=X-coordinate;Y=Y-coordinate;Z=Z-coordinate

Displays the icon location information (coordinates) that is set in the Visual Monitoring (Editing) window or that is set when the map is displayed in the Monitoring Tree (Editing) window. This parameter cannot be changed.

CON

CON includes the parameters shown below. Note that if the value of TYPE is 1 (monitoring group), the CON parameter is not displayed.

NAME=status-change-condition-name

Displays the status change condition name. The user can change this information. Specifiable characters are one-byte alphanumeric characters and two-byte characters (except custom characters). None of the following characters can be used: * " ' \ : ; | = + ? < . >. If the line contains more than one NAME parameter, the same status change condition name cannot be used more than once on that line.

If the status change condition name contains a comma (,), enclose the entire CON item in double-quotation marks (").

Example:

To specify "status change,condition name" as the status change condition name, specify as follows:

"CON:NAME=status change,condition name;

STA=700;

individual condition name==individual condition value"

STA=change-status-ID

Displays the change status ID. This parameter cannot be changed.

CID=common-condition-ID;common-condition-information

Displays the common condition ID and the common condition information. For the common condition information, the common conditions that have been set in the Status-Change Condition Settings window, such as the ID and information needed by the system for management purposes, are displayed with the items separated by the semicolon (;). This parameter cannot be changed.

GCON

GCON includes the parameters described below.

Note that the GCON parameter is not displayed if the value of TYPE is 2 (monitoring object) or if no status change condition has been set for the monitoring group.

NAME=status-change-condition-name

Displays the status change condition name. The user can change this information. Specifiable characters are one-byte alphanumeric characters and two-byte characters (except custom characters). None of the following characters can be specified: * " ' \ : ; | = + ? < . >. If the line contains more than one NAME parameter, the same status change condition name cannot be used more than once on that line.

If the status change condition name contains a comma (,), enclose the entire GCON item in double-quotation marks (").

STA=change-status-ID

Displays the change status ID. This parameter cannot be changed.

CSTA=child-node-status-ID

Displays the status IDs of child nodes. This parameter cannot be changed.

NUM>=child-nodes-count

Displays the number of child nodes. This parameter cannot be changed. This parameter and the RATIO parameter are mutually exclusive.

RATIO>=child-node-ratio

Displays the ratio of child nodes. This parameter cannot be changed. This parameter and the NUM parameter are mutually exclusive.

individual-condition-name==individual-condition-value

Displays an individual condition if it has been set in the Status-Change Condition Settings window. If multiple individual conditions have been specified, they are separated by the semicolon (;). You can change only individual-condition-value. The == part depends on the setting in the GUI as shown below; do not change this part.

== (same as)

!= (not same as)

^= (starts with)

>= (includes)

<= (does not include)

*= (regular expression)

+= (host name comparison)

For individual-condition-value, you can specify a maximum of 1,023 bytes# of characters. If you use a semicolon (;) in an individual condition value, enter two consecutive semicolons.

#: The total length of the field is a maximum of 1,280 bytes (for example, if five individual conditions are set, the total length of all five condition values must be no greater than 1,280 bytes).

If an individual condition value contains a comma (,), enclose the entire CON item in double-quotation marks (").

Example:

To specify "individual,condition value" as the individual condition value, specify as follows:

"CON:NAME=status change condition name;

STA=700;

individual condition name==individual,condition value"

If you enclose the individual condition value in double-quotation marks ("), you must enclose the individual condition value in another set of double-quotation marks and then also enclose the entire CON item in double-quotation marks.

Example:

To specify ""individual condition value"" as the individual condition value, specify as follows:

"CON:NAME=status change condition name,;

STA=700;

individual condition name==""individual condition name"""

EVE:STA=status-ID

Displays the status ID that was set in the event generation condition. This parameter cannot be changed.

RES:JP1-resource-group-name

Displays the JP1 resource group name of the monitoring node. This parameter cannot be changed.

OWN:monitoring-node-owner's-name

Displays the name of the monitoring node owner. This parameter cannot be changed.

OPE:list-of-operation-items

Displays a list of operation items that the login user has for the monitoring node. This parameter cannot be changed.

Note

If you change the monitoring node ID, there may be adverse effects on the Visual Monitoring window. This is because the monitoring node IDs are used to manage the monitoring nodes that are displayed in the Monitoring Tree window and the Visual Monitoring window.

If you have changed a monitoring node ID, make sure that there are no problems on the Visual Monitoring window.

System profile of Central Scope (jcs_sysprofile_xxx.def)

Format

DESC_VERSION=1#1
[SystemProfile]
  FrameVisible={true | false}
  Movable={true | false}
[DisplayColor]
    :
  [ColorItem]#2
    Status=monitoring-node-status-identifier
    Name=monitoring-node-status-name
    [Label]
      R=value
      G=value
      B=value
      A=value
    [END]
    [TEXT]
      R=value
      G=value
      B=value
    [End]
  [End]
      :
[End]
[DisplayLamp]
  Status=monitoring-node-status-identifier
[End]
[End]

#1: Do not change DESC_VERSION=1.

#2: Do not change the values of Status and Name between [ColorItem] and [End].

File

For the system profile of Central Scope (jcs_sysprofile_xxx.def), the file to edit varies depending on the language in which JP1/IM runs. The following table explains the relation between the language code where JP1/IM runs and the system profile of Central Scope to edit.

Table 2‒76: Language codes where JP1/IM runs and the system profile of Central Scope

OS

Language type

Language encoding supported by JP1/IM

Definition file

Windows

Japanese

jcs_sysprofile_sjis.def (System profile (Central Scope))

jcs_sysprofile_sjis.def.model (Model file for the system profile (Central Scope))

English

jcs_sysprofile.def (System profile (Central Scope))

jcs_sysprofile.def.model (Model file for the system profile (Central Scope))

Chinese

jcs_sysprofile_GB18030.def (System profile (Central Scope))

jcs_sysprofile_GB18030.def.model (Model file for the system profile (Central Scope))

UNIX#

Japanese

Shift-JIS encoding

jcs_sysprofile_sjis.def (System profile (Central Scope))

jcs_sysprofile_sjis.def.model (Model file for the system profile (Central Scope))

EUC encoding

jcs_sysprofile_euc.def (System profile (Central Scope))

jcs_sysprofile_euc.def.model (Model file for the system profile (Central Scope))

UTF-8 encoding

jcs_sysprofile_UTF-8.def (System profile (Central Scope))

jcs_sysprofile_UTF-8.def.model (Model file for the system profile (Central Scope))

English

jcs_sysprofile.def (System profile (Central Scope))

jcs_sysprofile.def.model (Model file for the system profile (Central Scope))

Chinese

GB18030 encoding

jcs_sysprofile_GB18030.def (System profile (Central Scope))

jcs_sysprofile_GB18030.def.model (Model file for the system profile (Central Scope))

#

Only files of languages supported by the OS are included.

Use the system profile of Central Scope corresponding to the language code (jcs_sysprofile_xxx.def).

Storage directory

In Windows

For a physical host:

Scope-path\conf

For a logical host:

shared-folder\jp1scope\conf

In UNIX

For a physical host:

/etc/opt/jp1scope/conf

For a logical host:

shared-directory/jp1scope/conf

Description

Common definition information for the Central Scope viewer. The contents of this definition file are applied to the following windows:

Monitoring Tree window

Visual Monitoring window

When the definitions are applied

When you log in to Central Console, the definition takes effect. However, if you log in to Central Scope from the Event Console window, you must restart the Event Console window after editing the definition file, and then log in to Central Scope.

Information that is specified

DESC_VERSION=1

Indicates the system profile format version.

Do not change this value. If you do so, Central Scope Viewer might not operate correctly.

[SystemProfile] to [End]

Indicates the definition start tag and definition end tag for the system profile.

FrameVisible={true | false}

Specifies whether to display the monitoring node name and the space around an icon. You can specify either true or false. The value is not case sensitive. Write this parameter between SystemProfile and End.

If you specify true, the monitoring node name and the space around an icon are displayed. If you specify false, they are not displayed.

If you omit this parameter, or specify a value other than true or false, true is assumed.

If you upgrade JP1/IM - Manager from version 10-10 or earlier, this parameter is not set for the system profile of the logical host. To specify this parameter, add the description.

Movable={true | false}

Specifies whether to allow drag and drop operations for the monitoring node icon in the map display of the Monitoring Tree window, and the Visual Monitoring window. You can specify either true or false. The value is not case sensitive. Write this parameter between SystemProfile and End.

If you specify true, you can move the monitoring node icon. If you specify false, you cannot move it.

If you omit this parameter, or specify a value other than true or false, true is assumed.

If you upgrade JP1/IM - Manager from version 10-10 or earlier, this parameter is not set for the system profile of the logical host. To specify this parameter, add the description.

[DisplayColor] to [End]

Write a definition block to define the monitoring node status between DisplayColor and End. Write only one definition block between SystemProfile and End.

[ColorItem] to [End]

Write the status identifier, status name, and parameter to define the status color, and definition block between [ColorItem] and [End]. Write this definition block between [DisplayColor] and [End] for each status.

Status=monitoring-node-status-identifier

Specify the status identifier. Write this parameter between [ColorItem] and [End]. Do not change this value. If you do so, Central Scope Viewer might not operate correctly.

Name=monitoring-node-status-name

Specify the status name. Write this parameter between [ColorItem] and [End]. Do not change this value. If you do so, Central Scope Viewer might not operate correctly.

[Label] to [End]

Write parameters to specify the monitoring node status color, and whether to make the monitoring node color transparent between [Label] and [End]. When the monitoring node status changes, the color changes to the one corresponding to the new status specified between [Label] and [End]. Write this definition block only once between [ColorItem] and [End].

R=value, G=value, B=value

Specifies the status color of the monitoring node by using the RGB value. Write this parameter between [Label] and [End]. You can specify an integer from 0 to 255.

If you omit this parameter, specify an integer less than 0, or specify a value other than an integer, 0 is assumed. If you specify a value greater than 255, 255 is assumed.

A=value

Specify whether to make the monitoring node status color transparent. Write this parameter between [Label] and [End]. If the FrameVisible parameter is not specified, and true is specified for the FrameVisible parameter, the status color cannot be transparent regardless the value specified for A. You can specify an integer from 0 to 255. The smaller the value you specify, the higher the transparent ratio is. If you specify 0, the status color is completely transparent. If you specify 255, the status color is not transparent.

If you omit this parameter, or specify a value that cannot be specified, 255 is assumed.

[TEXT] to [End]

Write parameters to specify the text color of the monitoring node name between [TEXT] and [End]. When the monitoring node status changes, the monitoring node name text color changes to the one corresponding to the new status specified between [TEXT] and [End]. Write this definition block only once between [ColorItem] and [End].

R=value, G=value, B=value

Specifies the monitoring node name text color by using the RGB values. Write these parameters between [TEXT] and [End]. You can specify an integer from 0 to 255.

If you omit this parameter, specify a value less than 0, or specify a non-integer value, 0 is assumed. If you specify a value greater than 255, 255 is assumed. In the initial status after installation, 0 is specified for all of R, G, and B values.

[DisplayLamp] to [End]

Specify parameters used to specify the status when an alarm lamp turns on. When the highest monitoring node status changes, if the status identifier specified for the new status is greater than the value specified between [DisplayLamp] and [End], the applicable alarm lamp turns on. You must write this definition block between [SystemProfile] and [End].

Status=monitoring-node-status-identifier

Specify the status when an alarm lamp turns on. Write this parameter between [DisplayLamp] and [End]. You can specify a decimal integer from -2,147,483,648 to 2,147,483,647.

If you omit this parameter, or specify a value that cannot be specified, 0 is assumed. If the status indicator specified for the highest monitoring node status is greater than the value specified for this parameter, an alarm lump turns on. The following table explains the correspondences between the values specified for this parameter and the statuses when the alarm lamp turns on.

Table 2‒77: Correspondence between the specified values and the statuses when the alarm lamp turns on

Specified value

Status when the alarm lump turns on

-2,147,483,648 to 100

Initial, debug, normal, warning, error, critical, alert, and emergency

101 to 200

Debug, normal, warning, error, critical, alert, and emergency

201 to 300

Normal, warning, error, critical, alert, and emergency

301 to 400

Warning, error, critical, alert, and emergency

401 to 500

Error, critical, alert, and emergency

501 to 600

Critical, alert, and emergency

601 to 700

Alert, and emergency

701 to 800

Emergency

801 to 2,147,483,648

Does not turn on

We recommend you specify 200, 300, 400, 500, 600, 700, or 800.

Notes

The setting item name is case sensitive.

Specify a value for each item immediately after the equal sign (=). If you add a space or a tag, the value cannot be recognized.

If the start tag is unintentionally deleted, the file format invalid message (KAVB7303-E) is output, and the operation of JP1/IM - View stops. Also, if the tag is unintentionally changed, the definition is not recognized.

If the end tag is unintentionally changed or deleted, the file format invalid message (KAVB7303-E) is output, and the operation of JP1/IM - View stops.

If you edit the system profile of Central Scope (jcs_sysprofile_xxx.def), the changes are not applied to the Monitoring Tree (Editing) and Visual Monitoring (Editing) windows. If you want to change settings of these windows, edit the system profile of the Central Scope viewer (system.conf).

System profile of the Central Scope viewer (system.conf)

Format

DESC_VERSION=1
[SystemProfile]
  FrameVisible={true | false}
 [DisplayColor]
    :
  [ColorItem]
    Status=monitoring-node-status-identifier
    Name=monitoring-node-status-name
    [Label]
      R=value
      G=value
      B=value
      A=value
    [END]
    [TEXT]
      R=value
      G=value
      B=value
    [End]
  [End]
      :
[End]

[End]

File

system.conf (System profile of the Central Scope viewer)

system.conf.model (Model file of the system profile of the Central Scope viewer)

Storage directory

For Japanese operating systems:

View-path\conf\sovsystem\ja\

For English operating systems:

View-path\conf\sovsystem\en\

For Chinese operating systems:

View-path\conf\sovsystem\zh\

Description

Common definition information for Central Scope viewer. Contents of this definition file are applied to the following windows:

Monitoring Tree (Editing) window

Visual Monitoring (Editing) window

When the definitions are applied

The definitions are applied when the Monitoring Tree (Editing) window or the Visual Monitoring (Editing) window is displayed.

Information that is specified

Movable cannot be specified. All other specifications are the same as the system profile of Central Scope (jcs_sysprofile_xxx.def). For details, see System profile of Central Scope (jcs_sysprofile_xxx.def) in Chapter 2. Definition Files.

Notes

Notes specific to the system profile of the Central Scope viewer (system.conf) are provided here. For notes on other issues, see System profile of Central Scope (jcs_sysprofile_xxx.def) in Chapter 2. Definition Files.

The monitoring node in the Monitoring Tree (Editing) and Visual Monitoring (Editing) windows are always initial state. As a result, definitions for other statuses are not applied to the windows.

If you edit the system profile of the Central Scope viewer (system.conf), the changes are not applied to the Monitoring Tree and Visual Monitoring windows. If you want to change settings for these windows, edit the system profile of Central Scope (jcs_sysprofile_xxx.def).

Performance report display definition file (performance.conf)

Format

# (JP1/PFM - Web Console URL)
[URL-of-JP1/PFM-Web-Console]

File

performance.conf (performance report display definition file)

performance.conf.model (model file for the performance report display definition file)

Storage directory

In Windows

Physical host:

Console-path\conf\console\performance

Logical host:

shared-folder\jp1cons\conf\console\performance

In UNIX

Physical host:

/etc/opt/jp1cons/conf/console/performance

Logical host:

shared-directory/jp1cons/conf/console/performance

Description

This file defines the function for displaying the performance report of the host that issued an event. The file defines the URL of the connection-target instance of JP1/PFM - Web Console.

When the definitions are applied

The settings in the performance report display definition file take effect when you log in to JP1/IM - Manager in JP1/IM - View after the jco_spmd_reload command has been executed or when you log in to JP1/IM - Manager in JP1/IM - View after JP1/IM - Manager has been restarted.

Information that is specified

Tab characters, leading single-byte spaces, and trailing single-byte spaces are ignored.

Lines consisting of only single-byte spaces or tab characters and null lines (lines that contain only an end-of-line code) are ignored, and processing continues.

A line beginning with a hash mark (#) is treated as a comment.

[URL-of-JP1/PFM-Web-Console]

Specify the URL of the connection-target instance of JP1/PFM - Web Console by using single-byte alphanumeric characters and symbols.

For details about the JP1/PFM - Web Console URL, see the applicable JP1/PFM manual.

Notes

For the character encoding of the file, use the same character encoding set for the manager.

Operation definition file for IM Configuration Management - View (jcfview.conf)

Format

jcfview.login.host.max=maximum-number-of-recorded-hosts
jcfview.login.user.max={0|1}
jcfview.screen.history.enable={0|1}
jcfview.response.wait.time=server-response-wait-timeout-period
jcfview.imconfigreflect.response.wait.time=response-wait-timeout-period-for-reflection-of-system hierarchy
jcfview.screen.title.logininfo.enable={0|1}

File

jcfview.conf (operation definition file for IM Configuration Management - View)

jcfview.conf.model (model file for the operation definition file for IM Configuration Management - View

Storage directory

View-path\conf\jcfview\

Description

This file specifies the operation of IM Configuration Management - View.

When the definitions are applied

The definition takes effect when IM Configuration Management - View starts.

Information that is specified

jcfview.login.host.max=maximum-number-of-recorded-hosts

Specifies as a decimal value the maximum number of hosts that have logged in successfully. Permitted values are from 0 to 20. The default is 5.

jcfview.login.user.max={0|1}

Specifies whether to display the name of the JP1 user who logged in previously in the User name text box of the Login window. If 1 is specified, the name of the user who logged in previously is displayed. If 0 is specified, the name of the user is hidden. If you omit this parameter, or if you specify a value other than 0 or 1, 1 is assumed. The default is 1.

jcfview.screen.history.enable={0|1}

Specifies whether the function that inherits the display position and size of the IM Configuration Management - View window, as well as the selection status of the displayed buttons that were in use the last time the screen was open, is to be used. This setting applies to the IM Configuration Management window, the Edit Agent Configuration window, the Edit Remote Monitoring Configuration window, and the Display/Edit Profiles window.

The permitted values are as follows:

0: Do not use the window display settings history function.

1: Use the window display settings history function (default value).

Note that if you specify 0 and then start IM - View, all the window display settings history files will be deleted.

jcfview.response.wait.time=server-response-wait-timeout-period

Specifies in decimal notation the timeout period for waiting for a response when applying the hierarchy configuration (IM configuration) to the system.

The permitted value range is from 60,000 to 3,600,000; the default is 1,800,000. If the specified value is less than the minimum value, greater than the maximum value, invalid, or undefined, the default value is used.

When a timeout occurs, the KNAN20105-E message is displayed. If the KNAN20105-E message is issued frequently, we recommend that you revise the timeout setting.

jcfview.imconfigreflect.response.wait.time=response-wait-timeout-period-for-updating-system-hierarchy

Specifies in milliseconds in decimal notation the timeout period for waiting for the system hierarchy to be applied. The permitted value range is from 60,000 to 36,000,000; the default is 18,000,000. If the specified value is less than the minimum value, greater than the maximum value, invalid, or undefined, the default value is used.

When a timeout occurs, the KNAN20105-E message is displayed. If the KNAN20105-E message is issued frequently, revise the timeout setting.

jcfview.screen.title.logininfo.enable={0|1}

You can prevent the name of the logged-in JP1 user from being displayed in the title of the IM Configuration Management window, the Edit Agent Configuration window, the Edit Remote Monitoring Configuration window, and the Display/Edit Profiles window. When 1 is specified, the name of the logged in JP1 user is displayed. When 0 is specified, the name of the user is hidden. If you omit this parameter, or if you specify a value other than 0 or 1, 1 is assumed. The default is 1.

Example definition

jcfview.login.host.max=5
jcfview.login.user.max=1
jcfview.screen.history.enable=1
jcfview.response.wait.time=1800000
jcfview.imconfigreflect.response.wait.time=18000000
jcfview.screen.title.logininfo.enable=1

Apply-IM-configuration-method definition file (jp1cf_applyconfig.conf)

Format

[logical-host-name\JP1CONFIG]
"APPLY_CONFIG_TYPE"=dword:{00000000 | 00000001}

File

jp1cf_applyconfig.conf (file that sets the application method of IM configuration)

Storage directory

In Windows

For a physical host:

Manager-path\conf\imcf\

For a logical host:

shared-folder\JP1IMM\conf\imcf\

In UNIX

For a physical host:

Physical host: /etc/opt/jp1imm/conf/imcf/

For a logical host:

Logical host: shared-directory/jp1imm/conf/imcf/

Description

This file defines how to apply the system hierarchy.

The methods for applying the agent configurations include the differential distribution method, the batch distribution method (with the deletion of configuration information), and the batch distribution method (without the deletion of configuration information).

When the condition below is met, you can use the apply-IM-configuration-method definition file to switch between the batch distribution method (with the deletion of configuration information) and the batch distribution method (without the deletion of configuration information):

The differential distribution functionality is disabled in the JP1/Base settings for distributing configuration definition information, and the function for restricting the viewing of and operations on business groups is disabled.

For details about how to apply the system hierarchy, see 7.2.6 Applying the system hierarchy in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

When the definitions are applied

After the jbssetcnf command is executed to apply the definitions to the JP1 common definition information, the settings are applied when JP1/IM - Manager is started or restarted, or when the file is reloaded by using the jco_spmd_reload command.

Information that is specified

[logical-host-name\JP1CONFIG]

Indicates the key name of the application method of IM configuration.

For the physical host, specify JP1_DEFAULT for logical-host-name. For a logical host, specify its name for logical-host-name.

"APPLY_CONFIG_TYPE"=dword:{00000000 | 00000001}

Specify the method for applying the system hierarchy.

00000000

Specify this value to use the batch distribution method (with the deletion of configuration information) to apply the system hierarchy. Applies the system hierarchy configuration after deletion. This item is set by default.

00000001

Specify this value to use the batch distribution method (without the deletion of configuration information) apply the system hierarchy. Applies the system hierarchy configuration without deleting it.

If the value is invalid or if the common definition has not been set, the default value is assumed.

Example definition

[JP1_DEFAULT\JP1CONFIG]
"APPLY_CONFIG_TYPE"=dword:00000001

Host input information file (host_input_data.csv)

Format

product-name;file-format-version;character-encoding
Host_name,IPAddress,Host_list,Comment,Host_type,Running_host_name,Standby_host_name,VMM_host_name,Virtual_manager_type,Username,Password,Domain_name,Connection_type,Virtual_host_manager,Remote_connection_type,Authentication_section,Port_number,SSH_private_key_path
host-name,IP-address,list-of-host-names,comment,host-type,executing-host,standby-host,VMM-host,virtulization-management-type,user-name,password,domain-name,communication-type,virtulization-management-former-host-name,remote-communication-type,authentication-information-section, port-number, private-key-path

File

host_input_data.csv (host input information file)

Storage directory

In Windows

Any folder

In UNIX

Any directory

Description

This file is the export file for host input information related to hosts managed by IM Configuration Management. You can edit and import this file.

When the definitions are applied

The definitions are applied when the file is imported by using the jcfimport command.

Information that is specified

The following table describes the host information to be output to the host input information file.

Table 2‒78: Host information to be exported (host input information file)

Line

Output item

Output value

Line 1 (header information)

Product name

JP1/IM-CF

File format version

File format version.

For example, if the JP1/IM - Manager version is 10-50, 101000 is output.

Character encoding

Character encoding.

The value depends on the LANG environment variable setting of the manager. For details, see Table 2-79 Character encoding of files.

Line 2 (header information)

Host name

Host_name

IP address

IPAddress

List of host names

Host_list

Comment

Comment

Host type

Host_type

Executing host

Running_host_name

Standby host

Standby_host_name

VMM host

VMM_host_name

Virtualization management type

Virtual_manager_type

User name

Username

Password

Password

Domain name

Domain_name

Communication type

Connection_type

Virtualization management former host name

Virtual_host_manager

Remote communication type

Remote_connection_type

Authentication information section

Authentication_section

Port number

Port_number

Private key path

SSH_private_key_path

Line 3 and subsequent lines

Host name

Name of a host registered in the system hierarchy configuration

IP address

IP address of a host registered in the system hierarchy configuration (When there are multiple IP addresses, separate them by a comma (,), and enclose all IP addresses in double-quotation marks (")).

List of host names

List of host names registered on a host (When there are multiple lists, separate them by a comma (,), and enclose all lists in double-quotation marks (")).

Comment

Comment registered on a host

Host type

Type of host (physical, logical, virtual, unknown)

Executing host

Name of the host used as the executing host

Standby host

Name of the host used the standby host (When there are multiple standby host names, separate them by a comma (,), and enclose all standby host names in double-quotation marks (")).

VMM host

Name of the host on which the virtual machine monitor is running

Virtualization management type

Type of virtualization management (vCenter, JP1/SC/CM, SCVMM, HCSM, ESX#1, Hyper-V, KVM, Virtage#2)

User name

User name

Password

Password information is not output.

Domain name

Domain name of the host on which the virtual machine monitor is running.

Communication type

Communication type (http, https, ssh)

Virtualization management former host name

Host name registered on a host

Remote communication type

Communication type to be output for remote monitoring (disable, ssh, wmi)

Authentication information section

Authentication information to be output for remote monitoring (common, host, blank)

Port number

Number of the port used for communication

Private key path

Absolute path of the private key file to be used for SSH connection

#1: ESX indicates VMware ESX.

#2: Virtage indicates the Hitachi Compute Blade logical partitioning feature.

Table 2‒79: Character encoding of files

OS

Format of the LANG environment variable

Character encoding to be converted

Windows

--

Japanese OS: MS932

English OS: C (ISO-8859-1)

Chinese OS: GB18030

Linux

ja_JP.UTF-8 or ja_JP.utf8

Japanese OS: UTF-8

ja_JP.sjis or ja_JP.SJIS#

Japanese OS: Shift_JIS

C

English OS: C (ISO-8859-1)

zh_CN.gb18030

Chinese OS: GB18030

--

Other than above

UTF-8

Legend:

--: Not applicable

#: Valid only when the OS is SUSE Linux.

Output example

JP1/IM-CF;101000;MS932,,,,,,,,,,,,,,,,
Host_name,IPAddress,Host_list,Comment,Host_type,Running_host_name,Standby_host_name,VMM_host_name, Virtual_manager_type,Username,Password, Domain_name, Connection_type,Virtual_host_manager,Remote_connection_type,Authentication_section, Port_number, SSH_private_key_path
infch05340,192.168.105.251,infch05340.supp528,,physical,,,,,,,,,,disable,,
infch05356,192.168.105.193,infch05356,,physical,,,,,,,,,,disable,,
infch02272,192.168.105.84,infch02272,,physical,,,,KVM,,,,,,disable,22,<ssh_private_key_path>

Collected host information file (host_collect_data.csv)

Format

product-name;file-format-version;character-encoding
Real_host_name,OS_name,JP1_product_name,JP1_product_id,JP1_product_version,Install_path,Conf_dir,Date,Total_time,Host_name,Virtual_manager_type,Virtual_manager_version
real-host-name,OS-name,product-name,product-model-name,version,installation-path,environment-setting-file-storage-folder,update-date/time,update-date/time-GMT,host-name,virtualization-management-type,virtualization-product-version

File

host_collect_data.csv (collected host information file)

Storage directory

In Windows

Any folder

In UNIX

Any directory

Description

This file is the export file for collected host information related to managed hosts of IM Configuration Management. This file cannot be edited or imported.

Information that is specified

The following table describes the host information to be output to the collected host information file.

Table 2‒80: Host information to be exported (Collected host information file)

Line

Output item

Output value

Line 1 (header information)

Product name

JP1/IM-CF

File format version

File format version.

For example, if the JP1/IM - Manager version is 10-50, 101000 is output.

Character encoding

Character encoding.

The value depends on the LANG environment variable setting of the manager. For details, see Table 2-79 Character encoding of files.

Line 2 (header information)

Real host name

Real_host_name

OS name

OS_name

Product name

JP1_product_name

Product model name

JP1_product_id

Version

JP1_product_version

Installation path

Install_path

Storage folder for the environment settings file

Conf_dir

Update date/time

Date

Update date/time (GMT)

Total_time

Host name

Host_name

Virtualization management type

Virtual_manager_type

Virtualization product version

Virtual_manager_version

Line 3 and the subsequent lines

Real host name

Real host name of a host

OS name

Name of the OS running on a host

Product name

Name of the product running on a host

Product model name

Model name of a product

Version

Product version

Installation path

Installation path of a product

Storage folder for the environment settings file

Folder in which the environment setting file of a product is stored

Update date/time

YYYY/MM/DD hh:mm:ss

Update date/time (GMT)

YYYY/MM/DD hh:mm:ss (GMT)#1

Host name

Name of a host registered in the system hierarchy configuration

Virtualization management type

Type of virtualization management (vCenter, JP1/SC/CM, SCVMM, HCSM, ESX#2, Hyper-V, KVM, Virtage#3)

Virtualization product version#4

Version of a virtualization product.

Virtualization configuration collection date/time is output as the update date/time.

#1: When virtualization software and virtualization environment management software are used, the virtualization configuration collection date/time is output.

#2: ESX indicates VMware ESX.

#3: Virtage indicates the Hitachi Compute Blade logical partitioning feature.

#4: If the virtualization management type is HCSM, the version of an external connection interface for HCSM is displayed. For this reason, the displayed version and the actual version for HCSM might be different. Furthermore, if you obtain virtualization configuration information from HCSM, the version number is not displayed for a host whose virtualization management type is Hitachi Compute Blade logical partitioning feature.

Output example

JP1/IM-CF;101000;UTF-8,,,,,,,,,,,
Real_host_name,OS_name,JP1_product_name,JP1_product_id,JP1_product_version,Install_path,Conf_dir,Date,Total_time,Host_name,Virtual_manager_type,Virtual_manager_version
jp1_bs1,Windows,JP1/Base,P-242C-6L94,0900,C:\Program Files\Hitachi\JP1Base,C:\Program Files\Hitachi\JP1Base\conf,2009/11/28 10:45:20,1205115658437,jp1-bs1,,
jp1-bs2,Windows, , , , , ,2009/11/28 10:45:20,1205115658437,jp1-bs2,ESX,3.5
jp1-bs3,Windows, , , , , ,2009/11/28 10:45:20,1205115658437,jp1-bs3,vCenter,4.0

Profile management environment definition file (jp1cf_profile_manager.conf)

Format

[logical-host-name\JP1CONFIG\PROFILE_MANAGER\JP1BASE]
"LOGFILETRAP_AUTO_START_CONTROL"=dword:hexadecimal-number
"AGENT_PROFILE_UPDATE_NOTICE"=dword:hexadecimal-number

File

jp1cf_profile_manager.conf (profile management environment definition file)

jp1cf_profile_manager.conf.model (model file for the profile management environment definition file)

Storage directory

In Windows

Manager-path\conf\imcf

In UNIX

/etc/opt/jp1imm/conf/imcf

Description

This file defines information about the execution environment for the profile management function.

When the definitions are applied

The definition takes effect when JP1/IM - Manager is restarted after the jbssetcnf command is executed in JP1/Base to apply the definition in the profile management environment definition file to the JP1 common definition information.

Information that is specified

[logical-host-name\JP1CONFIG\PROFILE_MANAGER\JP1BASE]

Specify the key name of the profile management environment definition.

For logical-host-name, specify JP1_DEFAULT for a physical host and logical-host-name for a logical host.

"LOGFILETRAP_AUTO_START_CONTROL"=dword:hexadecimal-number

Specify whether to enable the use of the function for setting the automatic startup of log file traps in the Display/Edit Profiles window of JP1/IM - View. If this function is enabled, the Start the process automatically when the log file trap service starts check box is displayed in Startup options.

00000001: Enable

00000000: Disable

The default is 00000001 (enable).

"AGENT_PROFILE_UPDATE_NOTICE"=dword:hexadecimal-number

Specify whether to enable the use of the function that sends notifications indicating that agent profiles might have been updated when profiles are edited or applied in the Display/Edit Profiles window of JP1/IM - View.

00000001: Enable

00000000: Disable

The default is 00000001 (enable).

Remote log trap environment definition file (jp1cf_remote_logtrap.conf)

Format

[logical-host-name\JP1CONFIG\AGTLESS_MGR]
"MAX_COLLECT_EVENTLOG_DATA_SIZE"=dword:hexadecimal-number
"MAX_COLLECT_WIN_LOG_DATA_SIZE"=dword:hexadecimal-number
"MAX_COLLECT_UNIX_LOG_DATA_SIZE"=dword:hexadecimal-number
"START_OPTION"="warm" | "cold"

File

jp1cf_remote_logtrap.conf (remote log trap environment definition file)

jp1cf_remote_logtrap.conf.model (model file for the remote log trap environment definition file)

Storage directory

In Windows

Manager-path\conf\imcf

In UNIX

/etc/opt/jp1imm/conf/imcf

Description

This file defines an execution environment for the remote-monitoring log file trap function and the remote-monitoring event log trap function.

When the definitions are applied

In the common definition settings file, specify the remote log trap environment definition file as the argument for the jbssetcnf command. After that, the remote log trap environment definition file settings take effect when either of the following triggers occurs:

When JP1/IM - Manager restarts

When you perform a reload by executing the jco_spmd_reload command

Note that when this definition is applied, the total capacity of the logs that can be monitored by a single instance of JP1/IM - Manager is checked. If the capacity exceeds 10 MB, a KNAN26143-W warning message is output to the integrated trace log.

Information that is specified

[logical-host-name\JP1CONFIG\AGTLESS_MGR]

Specify the key name of the remote log trap environment definition.

For logical-host-name, specify JP1_DEFAULT for a physical host and logical-host-name for a logical host.

"MAX_COLLECT_EVENTLOG_DATA_SIZE"=dword:hexadecimal-number

Specifies in hexadecimal notation the maximum size of the event log that can be collected in one monitoring interval of the remote monitoring event log trap. You can specify any value in the range from 0x00002800 to 0x00032000 (10 KB to 200 KB). If this information is omitted, 0x00002800 (10 KB) is assumed.

"MAX_COLLECT_WIN_LOG_DATA_SIZE"=dword:hexadecimal-number

Specifies in hexadecimal notation the maximum size of the log that can be collected in one monitoring interval of the remote monitoring log file trap when the monitored host is Windows. You can specify any value in the range from 0x00002800 to 0x00032000 (10 KB to 200 KB). If this information is omitted, 0x00002800 (10 KB) is assumed.

"MAX_COLLECT_UNIX_LOG_DATA_SIZE"=dword:hexadecimal-number

Specifies in hexadecimal notation the maximum size of the log that can be collected in one monitoring interval of the remote monitoring log file trap when the monitored host is UNIX. You can specify any value in the range from 0x00002800 to 0x0000C800 (10 KB to 50 KB). If this information is omitted, 0x00002800 (10 KB) is assumed.

"START_OPTION"="warm" | "cold"

Specify whether logs that are output while remote monitoring is stopped are to be collected when remote monitoring resumes.

If "warm" is specified, logs that are output while remote monitoring is stopped will be collected.

If "cold" is specified, logs that are output while remote monitoring is stopped will not be collected.

If this information is omitted, "warm" is assumed.

Example definition

Example 1 (in Windows)

[JP1_DEFAULT\JP1CONFIG\AGTLESS_MGR]
"MAX_COLLECT_EVENTLOG_DATA_SIZE"=dword:00002800
"MAX_COLLECT_WIN_LOG_DATA_SIZE"=dword:00002800
"MAX_COLLECT_UNIX_LOG_DATA_SIZE"=dword:00002800
"START_OPTION"="warm"

Example 2 (In UNIX)

[JP1_DEFAULT\JP1CONFIG\AGTLESS_MGR]
"MAX_COLLECT_UNIX_LOG_DATA_SIZE"=dword:00002800
"START_OPTION"="warm"

If the manager host is a UNIX host and the managed host is a Windows host, remote monitoring cannot be performed. In such cases, if MAX_COLLECT_EVENTLOG_DATA_SIZE or MAX_COLLECT_WIN_LOG_DATA_SIZE is specified, it will be ignored.

Remote-monitoring log file-trap action definition file

Format

retry-times=number-of-retries
retry-interval=retry-interval
open-retry-times=number-of-retries
open-retry-interval=retry-interval
hold-count=number-of-held-JP1-events
keep-event={ OLD | NEW }
unset-extattr=attribute-suppressing-output
FILETYPE={ SEQ | SEQ2 | WRAP2 }
HEADLINE=number-of-header-lines
MARKSTR=[!]"regular-expression"
[!]"regular-expression-n"#
ACTDEF=[{EXIT}][event-level][event-ID][!]"regular-expression"
[!]"regular-expression-n"#

#: "regular-expression-n" indicates that multiple regular expressions are specified.

File

Use any file.

Storage directory

In Windows

Any folder

In UNIX

Any directory

Description

This file defines the actions for the remote monitoring log file trapping function. Its contents are referenced when the remote monitoring log file trapping function is started.

If you use UTF-8 as the encoding to save a file, save the file without attaching a BOM (byte order mark).

When the definitions are applied

The settings for the remote-monitoring log file-trap action definition file take effect at the following times:

When a reload or restart operation is performed from the Display/Edit Profiles window

For details about the Display/Edit Profiles window, see 5.9 Display/Edit Profiles window in the manual JP1/Integrated Management 2 - Manager GUI Reference.

When the jcfallogstart or jcfallogreload command is executed

For details about the jcfallogstart command, see jcfallogstart in Chapter 1. Commands. For details about the jcfallogreload command, see jcfallogreload in Chapter 1. Commands.

When JP1/IM - Manager is restarted

Information that is specified

retry-times

Specify a value from 0 to 86,400 for the number of retries to be attempted when a connection to an event service cannot be established due to a temporary communication failure. If this parameter is omitted, no retry operation is performed.

retry-interval

Specify a value from 1 to 600 (seconds) for the interval between retries to be performed when a connection to an event service cannot be established due to a communication failure. If this parameter is omitted, 10 seconds is assumed. This setting takes effect when the number of retries for connecting to an event service is set to one or a greater value. The retry interval is the interval between a failed attempt to connect to an event service and the next attempt. The time required for connection to an event service is not included. By combining retry-times and retry-interval, you can set a time equal to or longer than 24 hours, but if you do so and 24 hours or more passes after a retry attempt starts, retry processing stops.

open-retry-times

Specify a value from 1 to 3,600 as the number of retries to be performed if a log file cannot be read, or connection to the monitored host cannot be established. If this parameter is omitted, 1 is assumed. If the specified number of retries is exceeded, monitoring of the log file is stopped.

open-retry-interval

Specify a value from 3 to 600 (seconds) as the interval for retries to be performed if a log file cannot be read, or connection to the monitored host cannot be established. If this value is omitted, 3 (seconds) is assumed. The retry interval is the interval between the occurrence of an error and the next retry attempt.

hold-count

Specify a value from 1 to 100 as the number of JP1 events that can be held during retry processing. If this parameter is omitted, 100 is assumed. Executing a retry requires resources for holding JP1 events converted during retry processing. The amount of memory necessary for retry processing is as follows:

number-of-held-JP1-events × 1 KB

keep-event={ OLD | NEW }

When the number of JP1 events held during retry processing exceeds the limit, the excess JP1 events are removed. Use either of the values below to specify the type of events (old JP1 events or new JP1 events) to be kept when the number of held JP1 events exceeds the limit. If this parameter is omitted, OLD is assumed.

OLD

Specify this value if you want to keep old JP1 events. If this value is specified, values not exceeding the number of JP1 events specified in hold-count are held, and any JP1 events generated thereafter are removed.

NEW

Specify this value if you want to keep new JP1 events. If this value is specified and the set number of held JP1 events is exceeded, the JP1 events are removed starting from the oldest events.

unset-extattr

Specify this value when you do not want to output an attribute. You can set this value when the version of JP1/Base is 10-50 or later. If you do not want to output the monitoring name, specify TRAP_NAME. If you do not want to output the monitoring ID, specify TRAP_ID. If you do not want to output either of them, specify TRAP_NAME and TRAP_ID by separating them with a comma (,). The following is a specification example of when the monitoring name and monitoring ID are not output:

Example:

TRAP_NAME,TRAP_ID

This parameter must be written in a line.

FILETYPE={ SEQ | SEQ2 | WRAP2 }

Specify the data output format of the log file to trap. If this parameter is omitted, SEQ is assumed.

For details about the data output format of the log file to trap, see 7.6.3(1) Output formats of log file trap information in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

HEADLINE

Specify a value from 0 to 99,999 as the number of header lines when there is a header at the beginning of the log file to be read. If this parameter is omitted, it is assumed that there is no header.

Note that if the size of a character string in the specified header exceeds the upper limit for header size (10 kilobytes), an error occurs.

MARKSTR=[!]"regular-expression"

Specifies, using regular expressions, data that you do not want to monitor, such as data that is not log data. If this parameter is omitted, it is assumed that no data is excluded as data to be monitored. Enclose a regular expression in double-quotation marks ("). Data that is not log data refers to data that is output to a log file at a certain interval. The following are examples.

Example:

"==== 13:00:00 JP1/Base Event ===="

If an exclamation mark (!) is inserted before a double-quotation mark ("), the regular expression becomes an exclusion-condition and any data not matching the specified regular expression is not monitored.

You can specify multiple regular expressions for a single MARKSTR parameter. If multiple regular expressions are specified, the AND condition is applied. Therefore, the only data that is not subject to monitoring is the data that matches all the regular expression conditions, including the specification of the exclamation mark (!). Separate multiple regular expressions by a linefeed. On line 2 and subsequent lines, specify only values, and type at least one space before a value on each of the lines. The following example shows how to specify data that contains ==== and MARK as data that is not to be monitored:

Example:

MARKSTR="====" (linefeed)

Δ Δ Δ Δ Δ "MARK"

Legend: Δ indicates a single-byte space.

This parameter can be specified multiple times. You can specify this parameter as many times as you wish. When multiple parameters are specified, the OR condition is applied, and any data that matches any specification is not monitored.

A regular expression specified for this parameter is checked from the beginning of the entered log data to the length specified by the -m option of the jevlogstart command. If this parameter is omitted, it is assumed that all data is log data.

ACTDEF=[{EXIT}][event-level][event-ID][!]"regular-expression"

Specifies a regular expression for the log data to be converted to JP1 events, event IDs corresponding to those JP1 events, and event levels. If this parameter is omitted, it is assumed that none of the above values are specified. If there is log data that matches the regular expression, a JP1 event is issued with the specified event ID. Do not use a space or a tab before or after =, EXIT, event-level, or event-ID. If you do so, a syntax error occurs.

EXIT

If multiple ACTDEF parameters are specified and log data matches a condition specified for EXIT, monitoring of the log data ends.

If multiple ACTDEF parameters are specified and one log data item matches multiple ACTDEF parameter conditions, JP1 events equal to the number of matched conditions are issued. If EXIT is specified, a JP1 event is issued with the event ID of the condition specified for EXIT, after which no more log data is monitored.

event-level

Specify the event level for the extended attribute of a JP1 event by enclosing it in left and right angle brackets (< and >). You can specify the following values:

Emergency

Alert

Critical

Error

Warning

Notice

Information

Debug

If this parameter is omitted, Notice is assumed.

event-ID

Specify an event ID for registering a JP1 event on an event server. Separate the first four bytes (basic code) and the last four bytes (extended code) of the event ID by a colon (:), and write the ID in hexadecimal notation. Use uppercase A to F. Note that the last four bytes (the four bytes after the colon) can be omitted, in which case 0 is assumed for the omitted value. Zeros (0) are also inserted for any non-specified digits, beginning on the left side, if either the first or last four bytes have fewer than eight digits. Use a user-specifiable value from 0:0 to 1FFF:0 and 7FFF8000:0 to 7FFFFFFF:0. For an extended code, specify 0. Event ID format examples are provided below.

Example:

The following three specifications have the same meaning:

0000011A:00000000

11A:0

11A

"regular-expression"

Specify the log data to be converted to a JP1 event in a regular expression. The regular expression you can use is fixed to the extended normal expression. Enclose a regular expression in double-quotation marks ("). If an exclamation mark (!) is inserted before the first double-quotation mark ("), the regular expression becomes an exclusion-condition and any data that does not match the specified regular expression is converted.

You can specify multiple regular expressions for a single ACTDEF parameter. If multiple regular expressions are specified, the AND condition is applied. Therefore, only data that matches all the regular expression conditions, including specification of the exclamation mark (!), is converted to JP1 events. Separate multiple regular expressions by a linefeed. On line 2 and subsequent lines, specify only values, and type at least one space before a value on each of the lines. The following example shows how to specify data that contains jp1base and error as data to be converted to the JP1 event with event ID 00000333:

Example:

ACTDEF=00000333 "jp1base" (linefeed)

Δ Δ Δ Δ Δ"error"

Legend: Δ indicates a single-byte space.

More than one of this parameter can be specified. You can specify this parameter as many times as you wish. When multiple parameters are specified, the OR condition is applied, and any data that matches a specification is converted to JP1 events.

A regular expression specified for this parameter is checked from the beginning of the entered log data to the length specified as the maximum length of data converted to an event for a startup option (bytes).

This parameter cannot be omitted.

Example definition

Example definition for the MARKSTR and ACTDEF parameters

The following examples show example definitions for the MARKSTR and ACTDEF parameters based on the following log data.

Example definition 1

The log file trap conditions are listed on the left, and the example definition for the log file-trap action definition file is shown on the right.

Example definition 2

Log file trap conditions that are different from the conditions listed for example definition 1 are listed on the left, and the example definition for the log file-trap action definition file is shown on the right.

Remote-monitoring event log trap action-definition file

Format

retry-times number-of-retries
retry-interval retry-interval
open-retry-times number-of-retries-for-event-log-collection
open-retry-interval retry-interval-for-event-log-collection
trap-interval monitoring-interval
matching-level comparison-level
filter-check-level filter-check-level
# filter
filter log-type [id=event-ID] [trap-name=log-file-trap-name]
    conditional-statement-1
    conditional-statement-2
      :
    conditional-statement-n
end-filter

File

Use any file.

Storage directory

In Windows

Any folder

In UNIX

Any directory

Description

This file defines the actions of the event log trapping function for remote monitoring. Its contents of the file are referenced when the remote monitoring event log trapping function is started.

If you use UTF-8 as the encoding to save a file, save the file without attaching a BOM (byte order mark).

When the definitions are applied

The settings for the remote-monitoring event log trap action-definition file take effect at the following times:

When a reload or restart operation is executed from the Display/Edit Profiles window

For details about the Display/Edit Profiles window, see 5.9 Display/Edit Profiles window in the manual JP1/Integrated Management 2 - Manager GUI Reference.

When the jcfaleltstart or jcfaleltreload command is executed

For details about the jcfaleltstart command, see jcfaleltstart (Windows only)in Chapter 1. Commands. For details about the jcfaleltreload command, see jcfaleltreload (Windows only) in Chapter 1. Commands.

When JP1/IM - Manager is restarted

Information that is specified

retry-times

Specify a value from 0 to 86,400 for the number of retries to be attempted when a connection to an event service cannot be established due to a temporary communication failure. If this parameter is omitted, no retry operation is performed. If the specified number of retries has been attempted but none have been successful, an error occurs. By combining retry-times and retry-interval, you can set a time equal to or longer than 24 hours, but if you do so and 24 hours or more passes after a retry attempt starts, retry processing stops.

retry-interval

Specify a value from 1 to 600 (seconds) for the interval between retries to be performed when a connection to an event service could not be established due to a temporary communication failure. If this value is omitted, 10 seconds is assumed.

open-retry-times

Specify a value from 1 to 3,600 as the number of times to retry the event log collection processing when the processing fails or the connection to the monitored host fails. If this value is omitted, a retry count of 3 times is assumed. When the specified number of retries is exceeded, the monitoring of log files stops.

open-retry-interval

Specify a value from 3 to 600 (seconds) as the interval between retries when the event log collection processing fails or the connection to the monitored host fails. If this value is omitted but a value is specified for trap-interval, the value specified for trap-interval is assumed. If trap-interval is not specified, 300 seconds is assumed. The retry interval is the length of time before a retry is attempted after an error occurs.

trap-interval

Specify a value from 60 to 86,400 (seconds) as the interval for monitoring event logs. If this value is omitted, 300 (seconds) is assumed. Event log traps monitor event logs at a fixed interval.

matching-level

Specify the comparison level of an event log and the definition if the explanatory text of an event log cannot be read because the message DLL or the category DLL is not set correctly when the message or category attribute is specified for a filter. If 0 is specified, the items are not compared, but are compared with the next filter. If 1 is specified, the items are compared. If this parameter is omitted, 0 is assumed.

filter-check-level

Specify the check level when an invalid log type (a type non-existent in the system) or an invalid regular expression is specified for a filter. If 0 is specified and a filter contains an invalid log type or regular expression, the applicable filter is disabled. If at least one valid filter exists, the remote-monitoring event log trap is started or loaded successfully. If there is no valid filter, the remote-monitoring event log trap fails to start or reload. If 1 is specified and the filter has at least one invalid log type or regular expression, the remote-monitoring event log trap fails to start or reload.

If this parameter is omitted, 0 is assumed.

filter to end-filter

log-type

Specify the type of event log to be monitored.

Example:

Application

Security

System

DNS Server

Directory Service

File Replication Service

DFS Replication

When the same log type is specified for multiple filters, the condition is satisfied if the conditions for any one of the filters are met.

[id=event-ID]

Specify an event ID for registering a JP1 event on an event server. Write the ID in hexadecimal notation and separate the first four bytes (basic code) and the last four bytes (extended code) of the event ID by a colon (:). When entering hexadecimal notation, use uppercase A to F. Note that the last four bytes (the four bytes after the colon) can be omitted, in which case 0 is assumed for the omitted value. Zeros (0) are also inserted for any non-specified digits, beginning on the left side, if either the first or last four bytes have fewer than eight digits. Use a user-specifiable value from 0:0 to 1FFF:0 and 7FFF8000:0 to 7FFFFFFF:0. There can be no space or tab between id= and the value. However, there must be a space between log-type and log-file-trap-name. If you omit this value, event ID 00003A71 is assumed. Event ID format examples are provided below.

Example:

The following three specifications have the same meaning:

0000011A:00000000

11A:0

11A

[trap-name=log-file-trap-name]

Specify a log file trap name to determine the corresponding filter for the registered JP1 event converted from the event log. The first character of log-file-trap-name must be an alphanumeric character. Uppercase and lowercase are distinguished. Do not add a space or tab. If this parameter is omitted, the extended attribute E.JP1_TRAP_NAME is not created at the time of JP1 event conversion.

conditional-statement

The following explains the conditional-statement:

When a value other than type is specified for the attribute:

attribute-specification regular-expression-1 regular-expression-2 regular-expression-3...

When type is specified for the attribute

type log-type-1 log-type-2 log-type-3...

The above condition is satisfied if any of regular expressions (or log type) listed after the attribute specification exists. Note that the AND condition is applied to the conditional statements in the filter, and the OR condition is applied between filters.

Attribute settings

The following table explains the attribute settings.

Attribute name

Description

type

Log type

source

Source

category

Category

id

Event ID

user

User

message

Description

computer

Computer name

Note

When message is set as the attribute, an event log that contains Description related to xxx was not found (wording used when a message DLL is not found) as part of its description will not be able to generate a message. As a result, the log is excluded as a trap target. If character strings to be trapped are contained in the inserted paragraph, the log is not trapped.

In the above case, make sure that the message DLL mentioned in the event log description is properly configured in accordance with the Windows event log mechanism. If the message DLL is not properly configured, the log might fail to be trapped because the description cannot be read from the event log. If you want to trap a message with no message DLL, set the matching-level parameter to 1.

For details about the log information that can be monitored, see 7.6.3 Log information that can be monitored in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

Regular expressions

A regular expression is expressed as a character string enclosed in single quotation marks (') and is specified as 'xxxxx'. In the form !'...', with an exclamation mark preceding the initial single quotation mark, the character string is any string other than the specified character string. If you want to specify a single quotation mark (') as part of a regular expression, enter an escape sequence such as \'. Regular expressions can be specified only when the log type is not type.

Log types

The following table lists and describes the log types.

Log type

Description

Event level

Information

Information

Information

Warning

Warning

Warning

Error

Error

Error

Audit_success

Successful audit

Notice

Audit_failure

Failed audit

Notice

Example definition

Example definition 1: OR and AND conditions

Example definition for the OR condition

When the log type is system log, and TEXT, MSG, or -W is contained in the description.

filter "System"
    message 'TEXT' 'MSG' '-W'
end-filter

If you separate conditions with a space or a tab, the OR condition is applied.

Example definition for the AND condition

When the log type is system log, and TEXT, MSG, and -W are all contained in the description.

filter "System"
    message 'TEXT'
    message 'MSG'
    message '-W'
end-filter

If you separate conditions with a linefeed, the AND condition is applied. After a linefeed, start a new line with the attribute name.

Example definition 2: Setting multiple filters

Trap event logs whose log type is application log and that satisfy the following condition:

filter-1

Type: Application log

Category: Error

Description: Contains -E and JP1/Base.

filter-2

Type: Application log

Category: Warning

Description: Contains -W or warning.

#filter-1
filter "Application"
    type Error
    message '-E'
    message 'JP1/Base'
end-filter
#filter-2
filter "Application"
    type Warning
    message '-W' 'warning'
end-filter

Example definition 3: Using regular expressions

Traps event logs that satisfy the following conditions:

Type: Application log

Category: Error

Event ID: 111

Description: Contains -E or MSG, but not TEXT.

filter "Application"
    type Error
    id '^111$'
    message '-E' 'MSG'
    message !'TEXT'
end-filter

If you want to set event ID 111 as a condition, specify the regular expression id '^111$'. Specifying id '111' creates a condition that means that the value 111 is included in the ID. Therefore, an event ID such as 1112 or 0111 satisfies the condition. If an exclamation mark (!) is inserted before the first single quotation mark, any data that does not match the specified regular expression is selected. The regular expression is fixed to the extended regular expression of JP1/Base. For details about extended regular expressions, see the description about the regular expression syntax in the JP1/Base User's Guide.

Example definition 4: Do not convert specific event logs

Do not trap event logs whose log type is system log, whose event level is warning, and which satisfy the following conditions:

Source: AAA

Event ID: 111

Description: Contains TEXT.

#Event logs for which source is AAA are not trapped.

filter "System"
    type Warning
    source !'AAA'
end-filter
#Event logs for which source is AAA, and event ID is a value other than 111 are trapped.
filter "System"
    type Warning
    source 'AAA'
    id !'^111$'
end-filter
#Event logs for which source is AAA and event ID is 111, but whose description does not include TEXT are trapped.
filter "System"
    type Warning
    source 'AAA'
    id '^111$'
    message !'TEXT'
end-filter

Setup information file (jimdbsetupinfo.conf)

Format

#IM DATABASE SERVICE - DB Size
IMDBSIZE=value
#IM DATABASE SERVICE - Data Storage Directory
IMDBDIR=value
#IM DATABASE SERVICE - Port Number
IMDBPORT=value
#IM DATABASE SERVICE - DB Install Directory
IMDBENVDIR=value
#IM DATABASE SERVICE - Host Name
IMDBHOSTNAME=value

File

jimdbsetupinfo.conf (setup information file)

jimdbsetupinfo.conf.model (model file for the setup information file)

Storage directory

In Windows

Manager-path\conf\imdb\setup\

In UNIX

/etc/opt/jp1imm/conf/imdb/setup/

Description

This file specifies setup information, such as the size of the IM database and the directory for storing data for the IM database, when the integrated monitoring database and IM Configuration Management database are set up.

The setup information file is shared during setup of the integrated monitoring database and IM Configuration Management database. If you have set up one of the databases (integrated monitoring database or IM Configuration Management database) first and then are creating the other one, you must specify for the second database the same values as were specified for the first database.

The table below describes the approximate amount of disk space used per size of the IM database, which you must specify in the setup information file.

Note that, in addition to the areas described in the table below, approximately 0.2 gigabytes of free space is required in the directory in which to install the IM database (IMDBENVDIR), whatever the size of the IM database. For details about the specific amount of disk space used, see the Release Notes for JP1/IM - Manager. We recommend that you use the values provided in the Release Notes for JP1/IM - Manager when you estimate the amount of disk space used.

Table 2‒81: Sizes of databases that are created

Size

System database area#1, #2 (gigabytes)

Integrated monitoring database area#1, #3 (gigabytes)

IM Configuration Management database area#1, #4 (gigabytes)

Total (gigabytes)

S

2

9

2

13

M

3

33

2

38

L

7

98

11

116

#1

The system database area, the integrated monitoring database area, and the IM Configuration Management database area are created immediately under the database storage directory (IMDBDIR) specified in the setup information file.

#2

Area shared by the IM Configuration Management database and integrated monitoring database created during setup of the IM database.

#3

Area created when the jcodbsetup command is executed.

#4

Area created when the jcfdbsetup command is executed.

When the definitions are applied

The contents of this file are loaded during setup and the IM database environment is configured based on the value specified for each item.

Information that is specified

IMDBSIZE

Specifies the size of the IM database to be created as the uppercase letter S, M, or L. The default is S.

IMDBDIR

Specifies the absolute path of the directory in which data for the IM database is to be stored. JP1/IM creates the imdb directory immediately under the specified directory and then stores the IM database file (area). The default is as follows:

In Windows: Manager-path\database

An error results if a network drive or Windows reserved device file is specified. If the specified directory cannot be found, command execution fails. You must create the directory before executing the command.

In UNIX: /var/opt/jp1imm/database

Specify a directory whose status is mounted. Do not specify a directory that is easily unmounted. If the directory is unmounted during operation, database startup and access will fail. If the specified directory cannot be found, command execution fails. You must create the directory before executing the command.

For details about the necessary directory permissions, see Table 2-82 Correspondence between OS and directory permissions.

The following explains the character string that can be used in the absolute path format:

In Windows:

A string of no more than 95 characters, consisting of alphanumeric characters, _, \, (, ), and . (period). This character string must begin with the drive name.

In UNIX:

A string of no more than 95 characters, consisting of alphanumeric characters, _, /, and . (period). This character string must begin with the path delimiter (/).

IMDBPORT

Specifies the port number used by the IM database. The permitted value range is from 5001 to 65535. The default is 20700.

This port number must be different from any of the following port numbers:

Port numbers specified when other logical hosts were set up

Port numbers specified in the services file#

Port numbers used in other products' HiRDB installation

Temporary port numbers used by other products and the OS

#: Make sure that you do not specify the port number set in IMDBPORT in the services file.

IMDBENVDIR

Specifies the absolute path of the directory in which the IM database is to be installed. Creates a directory under the specified directory (JMn: n matches LOGICALHOSTNUMBER), and then install the IM database.

In Windows: Manager-path\dbms

An error results if a network drive or Windows reserved device file is specified. If the specified directory does not exist, command execution fails. Make sure that you create the directory before you execute the command.

In UNIX: /var/opt/jp1imm/dbms

Specify a directory that is in mounted status. Do not specify a directory that is easily unmounted. If the directory is unmounted during operation, database startup and access will fail. If the specified directory does not exist, command execution fails. Make sure that you create the directory before you execute the command. In addition, do not specify a path that contains a symbolic link.

The following table explains the directory permissions.

Table 2‒82: Correspondence between OS and directory permissions

OS

Permission

Linux

Owner: root

Group: root

Mode: 755

The following explains the character string that can be used in the absolute path format:

In Windows:

A string of no more than 195 characters, consisting of alphanumeric characters, _, \, (, ), and the space. This character string must begin with the drive name.

In UNIX:

A string of no more than 123 characters, consisting of alphanumeric characters, _, /, and . (period). This character string must begin with the path delimiter (/).

IMDBHOSTNAME

Specifies the host name or the IP address to be used for communication with JP1/IM - MO running on another host. If there is no linkage with JP1/IM - MO on another host, this item need not be specified.

By default, a local host name is specified. If this value is omitted, the local host name is assumed. You can specify a maximum of 32 characters. Specifiable characters are alphanumeric characters, the hyphen (-), the underscore (_), the at mark (@), and the period (.).

Example definition

#IM DATABASE SERVICE - DB Size
IMDBSIZE=S
#IM DATABASE SERVICE - Data Storage Directory
IMDBDIR=Manager-path\database
#IM DATABASE SERVICE - Port Number
IMDBPORT=20700
#IM DATABASE SERVICE - DB Install Directory
IMDBENVDIR=Manager-path\dbms
#IM DATABASE SERVICE - DB Host Name
IMDBHOSTNAME=

Cluster setup information file (jimdbclustersetupinfo.conf)

Format

#IM DATABASE SERVICE - Logical Host Number
LOGICALHOSTNUMBER=value
#IM DATABASE SERVICE - Logical Host Name
LOGICALHOSTNAME=value
#IM DATABASE SERVICE - DB Size
IMDBSIZE=S
#IM DATABASE SERVICE - Port Number
IMDBPORT=value
#IM DATABASE SERVICE - Data Storage Directory (Local Work Area)
IMDBDIR=Manager-path\db
#IM DATABASE SERVICE - Data Storage Directory (Shared Data Area)
SHAREDBDIR=shared-directory\db
#IM DATABASE SERVICE - Online Host Name
ONLINEHOSTNAME=value
#IM DATABASE SERVICE - DB Install Directory
IMDBENVDIR=Manager-path\dbms

File

jimdbclustersetupinfo.conf (cluster setup information file)

jimdbclustersetupinfo.conf.model (model file for the cluster setup information file)

Storage directory

In Windows

Manager-path\conf\imdb\setup\

In UNIX

/etc/opt/jp1imm/conf/imdb/setup/

Description

This file specifies the IM database size for a logical host, or the directory for storing data of the IM database for a logical host when the integrated monitoring database and IM Configuration Management database are set up in a cluster environment.

The cluster setup information file is shared during setup of the integrated monitoring database and IM Configuration Management database. If you have set up one of the databases (integrated monitoring database or IM Configuration Management database) first and then are creating the other one, you must specify for the second database the same values as were specified for the first database. If you are configuring a cluster environment, when you set up the secondary node, copy the cluster setup information file used for the primary node. If you set up multiple logical hosts on the same host, you must copy jimdbclustersetupinfo.conf (cluster setup information file) under a different name and change the settings.

The table below describes the approximate amount of disk space used per size of the IM database, which you must specify in the cluster setup information file.

Note that, in addition to the areas described in the table below, approximately 0.2 gigabytes of free space is required in the directory in which to install the IM database (IMDBENVDIR), whatever the size of the IM database. For details about the specific amount of disk space used, see the Release Notes for JP1/IM - Manager. We recommend that you use the values provided in the Release Notes for JP1/IM - Manager when you estimate the amount of disk space used.

Table 2‒83: Sizes of databases that are created

Size

Local disk

Shared disk

System database area (local disk)#1 (gigabytes)

System database area (shared disk)#2 (gigabytes)

Integrated monitoring database area#2 (gigabytes)

IM Configuration Management database area#2 (gigabytes)

Total (gigabytes)

S

0.1

2

9

2

13

M

0.1

3

33

2

38

L

0.2

7

98

11

116

#1

The system database area (local disk) is created immediately under the local database storage directory (IMDBDIR) specified in the cluster setup information file.

#2

The system database area (shared disk), the integrated monitoring database area, and the IM Configuration Management database area are created immediately under the shared database storage directory (SHAREDBDIR) specified in the cluster setup information file.

When the definitions are applied

The contents of this file are loaded during setup, and the IM database environment for a logical host is configured based on the value specified for each item.

Information that is specified

LOGICALHOSTNUMBER

Specify a value from 1 to 9 as the number to identify a logical host in the IM database for a logical host.

If you add a logical host, you must specify a different number. Specify the same number for both primary and secondary nodes.

LOGICALHOSTNAME

Specify the name of a logical host. This must be a logical host name that can be resolved, and specified in the jp1cohasetup and jp1cc_setup_cluster commands. The IM database does not reference the jp1hosts and jp1hosts2 files. Therefore, for LOGICALHOSTNAME, specify a logical host name whose name is in the hosts file or can otherwise be resolved using the OS's name resolution capability. The permitted value is a string of no more than 32 characters, consisting of alphanumeric characters, _, -, /, . (period), and @. The logical host name is case sensitive. As the logical host name, specify the logical host name set in JP1/Base in the correct format, especially case. For details on how to set up JP1/Base on a logical host, see the sections below in the JP1/Integrated Management 2 - Manager Configuration Guide:

In Windows

See 7.3.3(2) Setting up JP1/Base

In UNIX

See 8.3.3(2) Setting up JP1/Base

IMDBSIZE

Specify the size of the IM database for a logical host to be created by using uppercase letters S, M, or L. The default is S.

IMDBDIR

Specify the absolute path of the directory in which data of the IM database for a logical host is to be stored. Do not specify the shared disk in a cluster. JP1/IM creates the imdb directory immediately under the specified directory, and then stores the IM database file (for a local work area).

In Windows:

An error results if a network drive or Windows reserved device file is specified. If the specified directory does not exist, command execution fails. Make sure that you create the directory before you execute the command.

In UNIX:

Specify a directory that is in mounted status. Do not specify a directory that is easily unmounted. If the directory is unmounted during operation, database startup and access will fail. If the specified directory does not exist, command execution fails. Make sure that you create the directory before you execute the command.

The following table describes the directory permissions.

Table 2‒84: Correspondence between OS and directory permissions

OS

Permission

Linux

Owner: root

Group: root

Mode: 755

The following shows the character string that can be used in the absolute path format:

In Windows:

A string of no more than 95 characters, consisting of alphanumeric characters, _, \, (, ), and . (period). This character string must begin with the drive name.

In UNIX:

A string of no more than 95 characters, consisting of alphanumeric characters, _, /, and . (period). This character string must begin with the path delimiter (/).

IMDBPORT

Specify the port number used by the IM database for a logical host. The permitted value range is from 5001 to 65535.

This port number must be different from any of the following port numbers:

Port numbers specified when other logical hosts were set up

Port numbers specified in the services file#

Port numbers used in other products' HiRDB installation

Temporary port numbers used by other products and the OS

#: Make sure that you do not specify the port number set in IMDBPORT in the services file.

SHAREDBDIR

Specifies the absolute path of the directory in which data of the IM database for a logical host that is shared by the primary and secondary nodes in a cluster configuration is to be stored. Specify a directory on a shared disk. JP1/IM creates the imdb directory immediately under the specified directory, and stores the IM database files (for the shared data area) for a logical host.

The following shows the character string that can be used in the absolute path format:

In Windows:

A string of no more than 95 characters, consisting of alphanumeric characters, _, \, (, ), and . (period). This character string must begin with the drive name.

An error results if a network drive or Windows reserved device file is specified. If the specified directory does not exist, command execution fails. Make sure that you create the directory before you execute the command.

In UNIX:

A string of no more than 95 characters, consisting of alphanumeric characters, _, /, and . (period). This character string must begin with the path delimiter (/).

Specify a directory that is in mounted status. Do not specify a directory that is easily unmounted. If the directory is unmounted during operation, database startup and access will fail. If the specified directory does not exist, command execution fails. Make sure that you create the directory before you execute the command. For details about the necessary directory permissions, see Table 2-84Correspondence between OS and directory permissions.

ONLINEHOSTNAME

Specifies the host name of the primary node. Specify a host name that can be resolved for the primary node. The permitted value is a string of no more than 32 characters, consisting of alphanumeric characters, _, -, /, . (period), and @. The executing host name is also case sensitive. Specify the executing host name in the correct form, especially case.

IMDBENVDIR

Specify the absolute path of the directory in which the IM database for a logical host is to be installed. Do not specify a shared disk in the cluster. Create a directory (JMn: n matches LOGICALHOSTNUMBER) immediately under the specified directory, and then install the IM database for a logical host. The default is as follows:

In Windows: Manager-path\dbms

An error results if a network drive or Windows reserved device file is specified. If the specified directory does not exist, command execution fails. Make sure that you create the directory before you execute the command.

In UNIX: /var/opt/jp1imm/dbms

Specify a directory that is in mounted status. Do not specify a directory that is easily unmounted. If the directory is unmounted during operation, database startup and access will fail. If the specified directory does not exist, command execution fails. Make sure that you create the directory before you execute the command.

For details about the necessary directory permissions, see Table 2-84 Correspondence between OS and directory permissions.

The following shows the character string that can be used in the absolute path format: In addition, do not specify a path that contains a symbolic link.

In Windows:

A string of no more than 195 characters, consisting of alphanumeric characters, _, \, (, ), and the space. This character string must begin with the drive name.

In UNIX:

A string of no more than 123 characters, consisting of alphanumeric characters, _, /, and . (period). This character string must begin with the path delimiter (/).

Example definition

#IM DATABASE SERVICE - Logical Host Number
LOGICALHOSTNUMBER=1
#IM DATABASE SERVICE - Logical Host Name
LOGICALHOSTNAME=host1
#IM DATABASE SERVICE - DB Size
IMDBSIZE=S
#IM DATABASE SERVICE - Data Storage Directory (Local Work Area)
IMDBDIR=Manager-path\db
#IM DATABASE SERVICE - Port Number
IMDBPORT=20750
#IM DATABASE SERVICE - Data Storage Directory (Shared Data Area)
SHAREDBDIR=shared-directory\db
#IM DATABASE SERVICE - Online Host Name
ONLINEHOSTNAME=host_H1
#IM DATABASE SERVICE - DB Install Directory
IMDBENVDIR=Manager-path\dbms

Item file

Format

[@]item-name
# comment-line
    :

File

Use any file.

Storage directory

In Windows

Any folder

In UNIX

Any directory

Description

This file specifies the JP1 event attributes that are to be output during output of event reports.

The maximum size of this file is 32 kilobytes (32,768 bytes).

Definition specification

A line consisting of only single-byte spaces or tabs is ignored.

Single-byte spaces and tabs before the first parameter name on each line, and at the end of each line are ignored.

When the definitions are applied

When the jcoevtreport command with the -k option specified is executed, the specified item file is loaded and the attribute values of JP1 events are output to event reports according to the item file.

Contents of the file

item-name

Specifies the items you want to output in an event report.

The following table lists and describes the items you can specify.

No.

Specifiable item

Description

1

B.SEQNO

Serial number

2

B.ID

Event ID

3

B.PROCESSID

Source process ID

4

B.TIME

Registered time

5

B.ARRIVEDTIME

Arrived time

6

B.REASON

Reason for registration

7

B.USERID

Source user ID

8

B.GROUPID

Source group ID

9

B.USERNAME

Source user name

10

B.GROUPNAME

Source group name

11

B.SOURCESERVER

Source host

12

B.DESTSERVER

Target event server name

13

B.SOURCEIPADDR

Source IP address

14

B.DESTIPADDR

Target IP address

15

B.SOURCESEQNO

Source event database sequence number

16

B.CODESET

Code set

17

B.MESSAGE

Message

18

E.SEVERITY

Event level

19

E.USER_NAME

User name

20

E.PRODUCT_NAME

Product name

21

E.OBJECT_TYPE

Object type

22

E.OBJECT_NAME

Object name

23

E.ROOT_OBJECT_TYPE

Root object type

24

E.ROOT_OBJECT_NAME

Root object name

25

E.OBJECT_ID

Object ID

26

E.OCCURRENCE

Occurrence

27

E.START_TIME

Start time

28

E.END_TIME

End time

29

E.RESULT_CODE

Return code

30

E.JP1_SOURCEHOST

Event source host name

31

E.@JP1IM_ACTTYPE

Action type

32

E.@JP1IM_ACTCONTROL

Action

33

E.@JP1IM_SEVERE

Severe event

34

E.@JP1IM_CORRELATE

Correlation event

35

E.@JP1IM_RESPONSE

Response waiting event

36

E.@JP1IM_ORIGINAL_SEVERITY

Original severity level

37

E.@JP1IM_CHANGE_SEVERITY

New severity level

38

E.@JP1IM_DEALT

Event status

39

E.@JP1IM_RELEASE

Canceling severe events

40

E.@JP1IM_DISMISSED

Severe event deleted

41

E.@JP1IM_MEMO

Memo

42

E.@JP1IM_DISPLAY_MESSAGE

Changed display message

43

E.@JP1IM_CHANGE_MESSAGE

New display message

44

E.@JP1IM_CHANGE_MESSAGE_NAME

Display message change definition

45

E.user-specific extended attribute

Extended attribute

If there is no corresponding attribute in a JP1 event, the null character is output.

In addition, if you specify @ at the beginning of an item name, the date and time item for the basic or extended attribute is output, in the format YYYYMMDDhhmmss.

However, if any of the attributes of a JP1 event contain any of the following values, the value of the date and time item is output as is, even if @ is specified.

nonnumeric value

value less than 0, or value greater than 2,147,483,648

#comment-line

A line beginning with a hash mark (#) is treated as a comment.

Example definition

B.SEQNO
B.ID
B.PROCESSID
B.TIME
  :

Environment definition file for event report output (evtreport.conf)

Format

[logical-host-name\JP1CONSOLEMANAGER]
"PROGRAM_SPECIFIC_EX_ATTR_COLUMN"=dword:hexadecimal-value

File

evtreport.conf (environment definition file for event report output)

evtreport.conf.update (model file for the environment definition file for event report output)

Storage directory

In Windows

Console-path\default\

In UNIX

/etc/opt/jp1cons/default/

Description

This file defines the execution environment of the event report output function. It specifies whether to enable the function.

When the definitions are applied

The definitions take effect when JP1/IM - Manager is restarted after the jbssetcnf command has been executed in JP1/Base to apply the definitions to the JP1 common definition information.

Information that is specified

[logical-host-name\JP1CONSOLEMANAGER]

Indicates the key name of the JP1/IM - Manager environment settings.

For logical-host-name, specify JP1_DEFAULT for a physical host and logical-host-name for a logical host.

"PROGRAM_SPECIFIC_EX_ATTR_COLUMN"=dword:hexadecimal-value

Specifies whether to enable the function for assigning a column to each program-specific extended attribute function when program-specific extended attributes are output using the jcoevtreport command, in the same way as for basic attributes, common extended attributes, and IM attributes.

00000001: Enable

00000000: Disable

The default value is 00000001 (enable).

Example definition

[JP1_DEFAULT\JP1CONSOLEMANAGER]
"PROGRAM_SPECIFIC_EX_ATTR_COLUMN"=dword:00000001

Filter file

Format

event-condition
    :
OR
event-condition
    :
EXCLUDE
event-condition
    :

File

Use any file.

Storage directory

In Windows

Any folder

In UNIX

Any directory

Description

This file defines filter conditions to be applied during output of event reports. To load the file, execute the jcoevtreport command with the -f option specified.

The maximum size of this file is 256 kilobytes (262,144 bytes).

When the definitions are applied

When the jcoevtreport command with the -f option specified is executed, the specified item file is loaded and the JP1 events that satisfy the specified condition are acquired from the integrated monitoring database and then output to an event report.

Contents of the file

pass-conditions group, exclusion-conditions group

The jcoevtreport command outputs the JP1 events that do not satisfy any of the exclusion-conditions groups and that satisfy one of the pass-conditions groups. For the filter conditions, you can specify from 0 to 5 pass-conditions groups and from 0 to 5 exclusion-conditions groups.

In a pass-conditions group or exclusion-conditions group, you can specify from 0 to 50 event conditions. In the case of an extended attribute (user-specific information), you can specify a maximum of 5 event conditions per pass-conditions group or exclusion-conditions group.

OR

If you specify multiple condition groups, specify OR between the condition groups.

EXCLUDE

Specify EXCLUDE between a pass-conditions group and an exclusion-conditions group. Any event condition that follows EXCLUDE is treated as an exclusion-conditions group. If no event condition follows EXCLUDE, only the pass-conditions groups take effect.

event-condition

Specify the event conditions in the following format (Δ indicates a single-byte space):

attribute-nameΔcomparison-keywordΔ operand[Δoperand]...

Note that a line consisting of only spaces or tabs is ignored during processing.

attribute-name

Specifies the name of the attribute that you want to compare. To specify a basic attribute, place B. immediately before the name; to specify an extended attribute (common information or user-specific information), place E. immediately before the name. Attribute names are case sensitive.

comparison-keyword

Specifies one of BEGIN (begins with), IN (matches), NOTIN (does not match), SUBSTR (includes), NOTSUBSTR (does not include), or REGEX (regular expression) as the comparison keyword. The comparison keyword is case sensitive.

operand

Specifies a character string as the value that is to be compared with the attribute value by the specified comparison keyword. Operands are case sensitive.

Specify multiple operands by separating them with one or more consecutive spaces or a tab. The OR condition is applied to the specified operands. Note that if a regular expression is specified for the comparison keyword, only one operand can be specified.

To specify a space, a tab, end-of-line code (CR or LF), or % as a part of an operand, specify as follows:

No.

Value to be specified

How to specify

1

Tab (0x09)

%09

2

Space (0x20)

%20

3

% (0x25)

%25

4

Linefeed code LF (0x0a)

%0a

5

Carriage return code CR (0x0d)

%0d

During maximum value checking for the definition format, %20 and %25 are each treated as a single character. The character code specified after the % is not case sensitive. The following shows an example of defining ID matches 100 and 200, which selects multiple operands:

B.IDΔINΔ100Δ200

Legend:

Δ: Space (0x20)

You can specify a maximum of 4,096 bytes of operands per event condition and per event condition block (total length of operands in bytes that are specified in the event condition block). The following table shows the attribute names, comparison keywords, and operands that can be specified for event conditions.

No.

Item

Attribute name

Comparison keyword

Operand

1

Event ID

B.ID

Match

Does not match

A maximum of 100 event IDs can be specified.

Event IDs are not case sensitive.

The permitted range is from 0 to 7FFFFFFF.

2

Reason for registration

B.REASON

Match

Does not match

A maximum of 100 items can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

3

Source process ID

B.PROCESSID

4

Source user ID

B.USERID

5

Source group ID

B.GROUPID

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 items can be specified. However, if a regular expression is specified, only one item is allowed.

6

Source user name

B.USERNAME

7

Source group name

B.GROUPNAME

8

Event-issuing server name#1

B.SOURCESERVER

9

Target event server name#1

B.DESTSERVER

10

Message

B.MESSAGE

11

Event level

E.SEVERITY

Match

Specifiable values are Emergency, Alert, Critical, Error, Warning, Notice, Information, and Debug.

Multiple event levels can be specified. However, the same event level cannot be specified twice.

12

Extended attribute#2

E.xxxxxxx

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

For the extended attribute name, you can specify a character string with a maximum of 32 bytes that begins with an uppercase letter and consists of uppercase letters, numeric characters, and the underscore (_).

A maximum of 100 extended attributes can be specified. However, if a regular expression is specified, only one extended attribute is allowed.

13

Action type

E.@JP1IM_ACTTYPE

Match

Does not match

The following numeric values can be specified:

0: Not subject to an action

1: Command

2: Rule

3: Command and rule

Multiple action types can be specified.

14

Action suppression

E.@JP1IM_ACTCONTROL

The following numeric values can be specified:

0: Not subject to an action

1: Execution

2: Suppression

3: Partial suppression

Multiple action suppressions can be specified.

15

Severe event

E.@JP1IM_SEVERE

The following numeric values can be specified:

0: Not a severe event

1: Severe event

Multiple severe events can be specified.

16

Correlation event

E.@JP1IM_CORRELATE

The following numeric values can be specified:

0: Not a correlation event

1: Correlation approval event

2: Correlation failure event

Multiple correlation events can be specified.

17

Response waiting event

E.@JP1IM_RESPONSE

The following numeric values can be specified:

0: Not a response waiting event

1: Response waiting event

Multiple response waiting events can be specified.

18

Original severity level

E.@JP1IM_ORIGINAL_SEVERITY

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

Multiple original severity levels can be specified. A maximum of 100 original severity levels can be specified. However, if a regular expression is specified, only one level is allowed.

19

New severity level

E.@JP1IM_CHANGE_SEVERITY

Match

Does not match

The following numeric values can be specified:

0: No new severity level exists

1: New severity level exists

Multiple new severity levels can be specified.

20

Event status

E.@JP1IM_DEALT

The following numeric values can be specified:

0: Not processed

1: Already processed

2: Being processed

3: On hold

Multiple event statuses can be specified.

21

Severe event released

E.@JP1IM_RELEASE

The following numeric values can be specified:

0: No severe events are released

1: Severe events are released

This item can be specified multiple times.

22

Severe event deleted

E.@JP1IM_DISMISSED

The following numeric values can be specified:

0: No severe events are deleted

1: Severe events are deleted

This item can be specified multiple times.

23

Memo

E.@JP1IM_MEMO

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 memos can be specified. However, if a regular expression is specified, only one memo is allowed.

24

Changed display message#3

E.@JP1IM_DISPLAY_MESSAGE

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified. However, if a regular expression is specified, only one item is allowed.

25

New display message#3

E.@JP1IM_CHANGE_MESSAGE

Match

Does not match

The permitted range is from -2,147,483,648 to 2,147,483,647.

26

Display message change definition#3

E.@JP1IM_CHANGE_MESSAGE_NAME

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified. However, if a regular expression is specified, only one item is allowed.

27

Event source host name#2

E.JP1_SOURCEHOST

First characters

Match

Does not match

Is contained

Is not contained

Regular expression

A maximum of 100 of these items can be specified. However, if a regular expression is specified, only one item is allowed.

#1

If the integrated monitoring database and the IM Configuration Management database are enabled, and the comparison keyword is Match or Do not match, you can specify the business group name in a path format.

If the integrated monitoring database and the IM Configuration Management database are disabled, and a comparison keyword other than Match and Do not match is selected, a business group name specified in a path format is treated as a host name.

If the -ignorecasehost option of the jcoimdef command is set to ON, and a comparison keyword other than Regular expression is selected, the character string is no longer case sensitive.

#2

E.START_TIME (start time), and E.END_TIME (end time) cannot be specified.

#3

If you have upgraded from version 10-50 or earlier of JP1/IM - Manager, this item is not output unless the integrated monitoring database has been updated using the jimdbupdate command.

Example definition

B.ID IN 1
B.MESSAGE SUBSTR Warning
E.SOURCESERVER IN host1 host2 host3 host4
OR
B.ID IN 1
B.MESSAGE SUBSTR Error
E.SOURCESERVER IN host1 host2 host3 host4
EXCLUDE
E.SOURCESERVER IN host3

Details of statements in definition files

This subsection lists the types and structures of and the values that can be specified in the statements that can be specified in some of the JP1/IM definition files.

Note:

The information provided in this subsection is applicable only to the following three definition files:

Definition file for extended event attributes

Definition file for executing applications

Definition file for the Tool Launcher window

Types of statements

Table 2‒85: Types of statements

Statement category

Statement types

In-file statements

Start-of-block statement

End-of-block statement

File attribute statement

Product statement

In-block statements

Definition statement for function menu command options

Event attribute definition statement

Block attribute definition statement

Definition file for function menu execution definition identifiers

Application description definition statement

Group definition statement

Function menu display icon definition statement

Definition statement for application execution definition identifiers

Function menu identifier definition statement

Function menu display name definition statement

Sequence definition statement

Function menu parent identifier definition statement

Application path definition statement

Structures of statements

Table 2‒86: Structures of statements

Statement type

Specification format

Start-of-block statement

@define-block type=block-type

End-of-block statement

@define-block-end

File attribute statement

@file type=definition-file-type[, version=definition-format-version]

Product statement

@product name=product-name

Definition statement for function menu command options

arguments=command-arguments

Event attribute definition statement

attr name=attribute-name, title=display-item-name[, type=attribute-display-type]

Block attribute definition statement

block lang=language-type|platform=platform-type|version=version-in-use

Definition file for function menu execution definition identifiers

execute_id=application-execution-definition-identifier

Application description definition statement

description=description-of-application-execution

Group definition statement

group name=group-name, attrs=list-of-attribute-names

Function menu display icon definition statement

icon=display-icon-file-name

Definition statement for application execution definition identifiers

id=application-execution-definition-identifier

Function menu identifier definition statement

id=function-menu-identifier

Function menu display name definition statement

name=display-name

Sequence definition statement

order id=event-ID-definition-character-string, attrs=list-of-attribute-names

Function menu parent identifier definition statement

parent_id=parent-function-menu-identifier

Application path definition statement

path=command-path

Rules for generating specification components in the statements

The table below lists the values that can be specified in the specification components of the statements.

Table 2‒87: Values that can be specified in the specification components of the statements

Specification components

Specifiable values

Hexadecimal characters

From 0 to 9 and A to F

EUCJIS

EUCJIS

GB18030

GB18030

JIS

JIS

Shift-JIS

SJIS

UTF-8

UTF-8

Description of application execution

User-defined character string of from 1 to 50 bytes

Application execution definition

application-execution-definition

Application execution definition block

application-execution-def

Application execution definition identifier

From 1 to 32 alphanumeric characters

Event ID

From 1 to 8 bytes of hexadecimal characters

Event ID definition character string

event-ID|event-ID-definition-character-string enumeration-separator event-ID

Event object type definition block

event-object-def

Event extended attribute definition

extended-attributes-definition

Event attribute group definition block

event-attr-group-def

Event attribute definition block

event-attr-def

Event display sequence definition block

event-attr-order-def

Interface name

From 1 to 32 alphanumeric characters

Group name

From 1 to 32 alphanumeric characters

Command path

File name

Command arguments

User-defined character string that serves as command arguments

Subkey name

From 1 to 32 alphanumeric characters

Forward slash

/

Forward slash-separated alphanumeric character string

forward-slash|alphanumeric-characters|forward-slash-separated-alphanumeric-character-string forward-slash

|forward-slash-separated-alphanumeric-character-string alphanumeric-characters

Default

default

Version

Version character string expressed using from 1 to 7 alphanumeric characters

Version symbolic character

/|.|-

Version range specification

version space-space version

Version character

uppercase-letters|number|version-symbolic-character

File symbolic character

.|/|\\|-|_|~

File name

Character string that serves as a file path

File name character string

file-symbolic-characters|alphanumeric characters|file-name-character-string file-symbolic-characters|file-name-character-string alphanumeric-characters

Platform type

base|alphanumeric-character-string

Product name

Forward slash-separated alphanumeric character string

Block type

event-attribute-definition-block|event-attribute-group-definition-block|event-display-sequence-definition-block|application-execution-definition-block

User-defined character

alphanumeric-character|Japanese-characters|symbol

English

English

Alphabetic characters

Uppercase and lowercase alphabetic characters

Lowercase letters

From a to z

Alphanumeric characters

Alphabetic and numeric characters

Uppercase letters

From A to Z

Menu tree node definition block

function-tree-def

Integrated tree menu definition

function-definition

Function menu identifier

From 1 to 32 alphanumeric characters

Function menu identifier string

[from-0-to-9-bytes-of-function-menu-identifier enumeration-separator]

function-menu-identifier

Language type

Japanese|English

Parent function menu identifier

Function menu identifier

Numeric characters

From 0 to 9

Description

From 1 to 50 bytes of user-defined characters

Attribute value

From 1 to 10,000 bytes of characters

Attribute value type

elapsed_time

Attribute display type

attribute-value-type/display-format

Attribute name

(B|).attribute-name-character-string

Attribute name characters

uppercase-letters|numeric-characters|_

Attribute name character string

Attribute name characters consisting of from 0 to 31 uppercase letters

Attribute name list

attribute-name|list-of-attribute-names\|attribute-names

Definition file type

extended-event-attribute-definition|application-execution-definition|definition-for-opening-monitor-windows|Tool-Launcher-definition

Definition format version

0300

Supported version

ALL|version|version-range-specification

Date and time display format

date_format:display-time-zone

Japanese

Japanese

Japanese characters

Two-byte characters except one-byte kana

Japanese character encoding

Shift-JIS|EUCJIS|JIS|UTF-8

Display icon file name

file-name

Display time zone

CLIENT

Display format

Date and time display format

Display item character

alphanumeric-characters|space|-|_|Japanese-characters

Display item character string

From 0 to 64 bytes of display item character string

Display item name

Display item character string

Display name

From 1 to 32 bytes of user-defined character string

Enumeration separator

\|

3 JP1 Events

This chapter describes the types and attributes of the JP1 events that are issued by JP1/IM.

3.1 Attributes of JP1 events

This section describes the attributes of JP1 events. JP1 event attributes are categorized into basic attributes and extended attributes. This section provides a detailed description of each event.

3.1.1 Basic attributes

All JP1 events have basic attributes. This subsection provides a detailed description of the basic attributes of JP1 events.

Details of the basic attributes of JP1 events

The basic attributes are sometimes identified by prefixing their names with B., such as B.ID. When it is necessary to use the prefix B., information to that effect is provided in the manual.

Table 3‒1: Basic attributes of JP1 events

Item

Attribute name

Description

Serial number

SEQNO

The order in which the JP1 event arrived at this event server, regardless of the source of the JP1 event.

Event ID

ID

An 8-byte value that indicates the source application program that issued the JP1 event and the nature of the event.

Extended event ID

IDEXT

Eight hexadecimal characters that indicate the extended part of an event ID

Type

TYPE

Event type

Reason for registration

REASON

Reason why this JP1 event was registered in this event server.

Source process ID

PROCESSID

Process ID of the source application program.

Registered time

TIME

Time the JP1 event was registered at the source event server.

Arrived time

ARRIVEDTIME

Time the JP1 event was registered at the local event server.

Source user ID

USERID

User ID of the source process. If this is an event from Windows, -1 is set.

Source group ID

GROUPID

Group ID of the source process. If this is an event from Windows, -1 is set.

Source user name

USERNAME

User name of the source process.

Source group name

GROUPNAME

Group name of the source process. If this is an event from Windows, a space is set.

Event-issuing server name

SOURCESERVER

Name of the event server that issued the event. If the event has been forwarded, such as from JP1/Base (agent) to JP1/IM - Manager (site manager) to JP1/IM - Manager (integrated manager), the event server name of the initial JP1/Base is set.

Target event server name

DESTSERVER

If the source application program explicitly specifies forwarding of the event to another event server, the name of that event server is set.

Source IP address

SOURCEIPADDR

IP address of the source event server (this value is not accurate if the transmission was via NAT (network address translation) or a proxy, or if the JP1 event was forwarded because of environment settings).

Target IP address

DESTIPADDR

IP address of the target event server (this value is not accurate if the transmission was via NAT (network address translation) or a proxy, or if the JP1 event was forwarded because of environment settings).

Source serial number

SOURCESEQNO

Serial number at the source host (this value is not changed by forwarding).

Code set

CODESET

Name of the character code set that is used for messages, detailed information, and extended attributes.

Message

MESSAGE

Character string describing the details of the event.

Detailed information

--

Any data.

Detailed information about basic attributes is usually used by a product that issues events that are compatible with JP1/SES version 5 or earlier in order to record detailed information.

Products whose version is 6 or later typically use the JP1 event extended attributes to record detailed information.

Legend:

--: None

3.1.2 Extended attributes

Extended attributes are attributes that can be specified by a program that issues JP1 events. Extended attributes provide two types of information: common information and program-specific information. Common information is information that is common to all JP1 programs. Program-specific information applies to extended attributes that do not provide common information. This subsection provides a detailed description of common information.

Details of common information

The extended attributes are sometimes identified by prefixing their names with E., such as E.SEVERITY. When it is necessary to use the prefix E., information to that effect is provided in the manual.

The following table lists and describes the common information provided by extended attributes.

Table 3‒2: List of common information provided by extended attributes

Item

Attribute name

Description

Event level

SEVERITY

Severity of the JP1 event. The following values can be assigned (listed here in descending order of severity):

Emergency

Alert

Critical

Error

Warning

Notice

Information

Debug

User name

USER_NAME

Name of the user executing the job.

Product name

PRODUCT_NAME

Name of the program that issued the JP1 event, such as the following:

/HITACHI/JP1/AJS

/HITACHI/JP1/FTP

/HITACHI/JP1/NETMDM

/HITACHI/JP1/NPS

/HITACHI/JP1/NT_LOGTRAP

/HITACHI/JP1/PAM

/HITACHI/JP1/IM/SCOPE

Object type

OBJECT_TYPE

Name indicating the type of object that resulted in issuance of the event, such as the following:

JOB, JOBNET, BATCHJOB, ACTION, LIST

Object name

OBJECT_NAME

Name of the object that resulted in issuance of the event (such as the name of a job or a jobnet).

Root object type

ROOT_OBJECT_TYPE

Type of object. This is usually the same as the object type, but in the case of an object that has a hierarchical structure, such as a jobnet, this indicates the object type at the highest level of the hierarchy. The permissible values are the same as for the object type.

Root object name

ROOT_OBJECT_NAME

Name used to issue an execution instruction during user operation. This is usually the same as the object name, but in the case of an object that has a hierarchical structure, such as a jobnet, this indicates the name of the object at the highest level of the hierarchy.

Object ID

OBJECT_ID

Object ID.

Character string that uniquely identifies an object instance within the integrated system when it is combined with PRODUCT_NAME (the format depends on the product; this information is used to call the monitor of each product from the Tool Launcher window of JP1/IM - View).

Occurrence

OCCURRENCE

Event that occurred in the object indicated by the object name. The events include the following:

START (Start of execution)

END (End of execution)

PAUSE (Pausing execution)

RELEASE (Release of temporary stop)

RESTART (Start of re-execution)

CREATE (Creation of definition)

DESTROY (Deletion of definition)

Start time

START_TIME

Execution or re-execution start time (absolute time in seconds since UTC 1970-01-01 00:00:0). This item might not be set.

End time

END_TIME

Execution end time (absolute time in seconds since UTC 1970-01-01 00:00:0). This item might not always be available to set.

Result code

RESULT_CODE

Termination code as a decimal character string. This item might not always be available to set.

Source host name

JP1_SOURCEHOST

Name of the source host.

3.2 JP1 events issued by JP1/IM

This section describes the JP1 events that are issued by JP1/IM.

3.2.1 List of JP1 events issued by JP1/IM

Event ID

When issued

Message

Function that issues the event

00002010

When an action's execution time exceeds the action delay monitoring time.

KAVB4400-E The run time of an action for an event exceeded the action delay monitoring time.(Event_ID=event-ID, SEQNO=serial-number-in-event-database, Execution Host=action-execution-host, Action Serial Number=action-serial-number) Delay monitoring notifications will not be sent until suppression of the function for sending notifications to the action delay monitor is canceled.

Automatic Action Service

00002011

When an action is placed in Fail or Error status while the action's status is being monitored.

KAVB4402-E An event status is abnormal.(event ID = event-ID, event serial number = serial-number-in-event-database, execution host = action-execution-host, action serial number = action-serial-number) Status monitoring notifications will not be sent until suppression of the function for sending notifications to the action status monitor is canceled

Automatic Action Service

00002012

When the health check function detects an error.

KAVB8060-E An abnormality was detected in function-name. (host name = host-name, process name = process-name, process ID = process-ID) : maintenance-information

Event Console Service

Event Base Service

00002013#1

When the health check function detects an error.

KAVB8062-E An abnormality was detected in function-name. (host name = host-name, process name = process-name) : maintenance-information

Event Console Service

00002014#2

When the health check function detects error recovery.

KAVB8061-I function-name has been recovered. (host name = host-name, process name = process-name, process ID = process-ID) : maintenance-information

Event Console Service

Event Base Service

00002015

When suppression of the function for sending notification to the action delay monitor is released.

KAVB4401-I Suppression of the function for sending notifications to the action delay monitor was canceled.

Automatic Action Service

00002016

When suppression of the function for sending notification to the action status monitor is released.

KAVB4403-I Suppression of the function for sending notifications to the action status monitor was canceled.

Automatic Action Service

00002020

When an action that has been placed in delayed status during action delay monitoring wraps around in the action information file.

KAVB4404-E Although the run time of an action exceeded the action delay monitoring time, an action delay notification event could not be sent because no action information exists in the action information file.(action serial number = action-serial-number) Delay monitoring notifications will not be sent until suppression of the function for sending notifications to the action delay monitor is canceled.

Automatic Action Service

00002021

When an action that has been placed in error status during action status monitoring wraps around in the action information file.

KAVB4405-E Although an action status is abnormal, an action state notification event could not be sent because no action information exists in the action information file. Status monitoring notifications will not be sent until suppression of the function for sending notifications to the action status monitor is canceled.: maintenance-information

Automatic Action Service

000020A0

When automated action processing terminates abnormally due to a problem that prevents processing from resuming.

KAVB4054-E Automatic Action was terminated abnormally. (Hostname : host-name)

Automatic Action Service

000020A1

When an automated action is started by the jco_start (.model) command. The default is that this event is not issued.

KAVB4050-I Automatic Action was started. : logical-host-name

Automatic Action Service

000020A2

When an automated action is terminated by the jco_stop (.model) command. The default is that this event is not issued.

KAVB4051-I Automatic Action was terminated. : logical-host-name

Automatic Action Service

000020A3

When the automated action function is started by the jcachange command or by a window operation.

KAVB4055-I The action definition file was read and the automatic action function status was changed to operating. The processing will be based on the definitions read from the subsequently received (arrival-time-of-most-recently-processed-event (YYYY/MM/DD hh:mm:ss)) events. (Definition=total-number-of-effective-definitions/total-number-of-definitions-in-file, SEQNO=serial-number-of-most-recently-processed-event)

Event Base Service

000020A4

When the status of the automated action function changes from running to standby.

KAVB4056-I Automatic action was suspended. Automatic actions cannot be executed for the subsequently received (arrival-time-of-most-recently-processed-event (YYYY/MM/DD hh:mm:ss)) events. (SEQNO=serial-number-of-most-recently-processed-event)

Event Base Service

000020A5

When setting of locale information by Automatic Action Service fails.

KAVB4909-E An attempt to set locale information has failed.

Automatic Action Service

000020A6

When setting of locale information by the Event Base Service process fails.

KAVB4909-E An attempt to set locale information has failed.

Event Base Service

000020E0

When execution of an action starts.

KAVB4430-I Execution of the action for an event was requested.(Event_ID=event-ID, SEQNO=serial-number-in-event-database)

Automatic Action Service

000020E1

When execution of an action is completed.

KAVB4431-I Execution of the action for an event ended normally.(EVENT_ID=event-ID, SEQNO=serial-number-in-event-database, Return_code=termination-code)

Automatic Action Service

000020E2

When an automated action or an action under command control is placed in abnormal status.

KAVB4432-E Automatic action or command control of the action for an event ended abnormally.(EVENT_ID=event-ID, SEQNO=serial-number-in-event-database)

Automatic Action Service

000020E3#3

When an action execution request for an action status notification event is registered.

KAVB4433-I Execution of the action for an action state notification event was requested.(Event_ID=event-ID, SEQNO=serial-number-in-event-database)

Automatic Action Service

000020E4#3

When an action for an action status notification event terminates.

KAVB4434-I Execution of the action for an action state notification event ended normally.(EVENT_ID=event-ID, SEQNO=serial-number-in-event-database, Return_code=termination-code)

Automatic Action Service

000020E5#3

When an automated action or an action under command control for an action status notification event is placed in abnormal status.

KAVB4435-E Automatic action or command control of the action for an action state notification event ended abnormally.(EVENT_ID=event-ID, SEQNO=serial-number-in-event-database)

Automatic Action Service

000020E6#3

When the jcocmddef command has been set to provide notification of execution requests, but issuance of the action status notification event (000020E0 or 000020E3) for an execution request fails because the action information file has wrapped around. (Event level: Warning).

KAVB4436-W Although Execution of the action for an event was requested, an action state notification event could not be sent because no action information exists in the action information file. : maintenance-information

Automatic Action Service

000020E7#3

When the jcocmddef command has been set to provide notification of command execution terminations, but issuance of the action status notification event (000020E1 or 000020E4) for an execution termination fails because the action information file has wrapped around. (Event level: Warning).

KAVB4437-W Although Execution of the action for an event ended normally, an action state notification event could not be sent because no action information exists in the action information file. : maintenance-information

Automatic Action Service

000020E8#3

When the jcocmddef command has been set to provide notifications of abnormal command terminations, but issuance of the action status notification event (000020E2 or 000020E5) for an abnormal termination fails because the action information file has wrapped around. (Event level: Error).

KAVB4438-E Although automatic action or command control of the action for an event ended abnormally, an action state notification event could not be sent because no action information exists in the action information file. : maintenance-information

Automatic Action Service

00003F01#1

When no more events can be displayed because there are no events to be acquired from the event buffer at the connected host.

KAVB1513-W Cannot display some event(S).

There were no events to obtain from the event buffer on the connecting host.

All the events except the above will be displayed.

To search for an event which was not displayed, specify the search conditions in the event search condition settings dialog as follows:

(1) In "Search host", specify the name of the connecting host.

(2) In "Registered timeframe", specify the times when the events before and after this event were registered.

Check to see if the following conditions are met when this event appears frequently.

(1) The "Interval" value that was set for "Automatic refresh" in the Preferences window is too long.

(2) The "Num. of events to acquire at update" value that was set in the Preferences window is too small.

(3) The "Event buffer" value for the Manager that was set in the System Environment Settings window is too small.

Event Console Service

00003F02#1

When the event is not found in the event buffer on the connected host, and the event cannot be displayed either on the Monitor Events page or the Severe Events page, displays the event you want to obtain on the applicable page. To display it on the Severe Events page, forcibly treat the event as a severe event.

KAVB1540-W Cannot display some event(s). (page = page).

There were no events to obtain from the event buffer on the connecting host.

All the events except the above will be displayed.

To search for an event which was not displayed, specify the search conditions in the event search condition settings dialog as follows:

(1) In "Search host", specify the name of the connecting host.

(2) In "Registered timeframe", specify the times when the events before and after this event were registered.

Check to see if the following conditions are met when this event appears frequently.

(1) The "Interval" value that was set for "Automatic refresh" in the Preferences window is too long.

(2) The "Num. of events to acquire at update" value that was set in the Preferences window is too small.

(3) The "Event buffer" value for the Manager that was set in the System Environment Settings window is too small.

Event Console Service

00003F03#1

When an error occurs while events are being acquired from Event Service.

KAVB1516-W An error occurred in acquiring an event from the event service.

Cannot recover the error after attempting the number of retries specified in the system profile.

No more events will be displayed from now on due to this error. Please check if the event service is running or not.

If not, recover the error by re-executing the manager after starting the event service.

Event Console Service

00003F04#1

When an attempt is made to search for events using a condition that is not supported for the Event Service of JP1/Base version 06-00 (such as Is contained, Is not contained, Regular expression, or specification of multiple action statuses) or JP1/Base version 06-51 (such as Regular expression).

KAVB1527-E A condition that cannot be received by the search host is included.

Event Console Service

00003F05#1

When the filter length is found to exceed Event Service's maximum value during event search processing.

KAVB0246-E The filter condition exceeds the maximum length. (Maximum length:maximum-length)

Event Console Service

00003F06#1

When a specified regular expression is found to be invalid during event search processing.

KAVB0248-E The settings for a regular expression is incorrect.

Event Console Service

00003F07#1

When the connection between Event Base Service and Event Service is lost.

KAVB4764-W An error occurred in acquiring an event from the event service. Please check if the event service is running or not. If not, recover the error by starting the event service.

Event Base Service

00003F08#1

When an attempt is made to execute an event search with an exclusion-condition specified, but the search host's JP1/Base version is 08-11 or earlier.

KAVB0251-E The search cannot be performed for the specified condition because the search host's JP1/Base does not support the exclusion condition.

Event Console Service

00003F11

When the status of a JP1 event action is changed by an operation in one of the following windows or by entering the following command:

Event Console window

Related Events window

jcochstat command

When there is a response for a response-waiting event and the status of the response-waiting event is changed to Processed

When a response-waiting event is canceled by BJEX or JP1/AS, and the status of the response-waiting event is changed to Processed

KAVB1577-I A status operation was performed. (user who performed the operation = JP1-user, event ID = event-ID, status before operation = status-before-operation, status after operation = status-after-operation)

Event Console Service

00003F13#4

When a message is issued that provides notification that an event acquisition filter condition of JP1/IM - Manager has been changed in the System Environment Settings window or the Event Acquisition Conditions List window, or by entry of the jcochfilter command.

KAVB4014-I The event acquisition filter definition file was read. The read definitions will be used for processing from the next received event. (filter name = filter-name, last received event = arrival-time, serial number in event DB = serial-number-in-event-DB)

Event Base Service

Event ID specified in the SUCCESS_EVENT parameter in the correlation event generation definition file

When a specified correlation event generation condition results in success during correlation event generation processing.

Message specified in the FAIL_EVENT parameter in the correlation event generation definition file

Correlation event generation function

Event ID specified in the FAIL_EVENT parameter in the correlation event generation definition file

When a specified correlation event generation condition results in failure during correlation event generation processing.

Message specified in the SUCCESS_EVENT parameter in the correlation event generation definition file

Correlation event generation function

00003F15

When the integrated monitoring database is enabled and a message is sent providing notification that the severe event definition of JP1/IM - Manager (Central Console) has been changed from the Severe Event Definitions window.

KAVB1669-I The severe event definition file has been read. Next, processing will be performed using the definition read from the acquired event. (Event acquired at the end:Arrival time = arrival-time-of-the-event-acquired-at-the-end, serial number in event DB = serial-number-in-event-database-of-the-event-acquired-at-the-end)

Event Base Service

00003F16#1

When an error occurs while events are being acquired from the integrated monitoring database.

KAVB1671-W An error occurred in acquiring an event from the integrated monitoring database.

Cannot recover the error after attempting the number of retries specified in the system profile.

No more events will be displayed from now on due to this error.

Event Console Service

00003F17#4

When a message is issued providing notification that additional common exclusion-conditions have been registered from JP1/IM - View.

KAVB1150-I An additional common exclusion conditions group was registered. (common exclusion conditions group ID = common-exclusion-conditions-group-ID, common exclude conditions group name = common-exclude-conditions-group-name, registering user = user-name)

Event Base Service

00003F20#4

When a message is issued providing notification that an event acquisition filter condition of JP1/IM - Manager (Event Generation Service) has been changed in the System Environment Settings window or the Event Acquisition Conditions List window, or by entry of the jcochfilter command.

KAJV2179-I The event acquisition filter definition file was read. The read definitions will be used for processing from the next received event. (filter name = filter-name, last received event = arrival-time, serial number in event DB = serial-number-in-event-database)

Event Generation Service

00003F21

When a message is issued providing notification that a correlation event generation definition has been updated by the jcoegschange command.

KAJV2242-I The correlation event generation definition file has been read, and the definitions for the correlation event generation function have been updated. (file name = file-name)

Event Generation Service

00003F22

When the setting for regular expressions used for JP1/Base at JP1/IM - Manager startup is not extended regular expressions, and the operating mode of the common exclusion-conditions group for JP1/IM - Manager is set to extended mode

KAVB4712-W The event base service cannot use common exclusion condition groups (extended) because a regular expression used by JP1/Base is not extended. The event base service will start without any common exclusion condition groups (extended) being set.

Event Console Service

00003F23

When the setting for regular expressions used for JP1/Base at JP1/IM - Manager startup is not extended regular expressions, and the operating mode of the common exclusion-conditions group for JP1/IM - Manager is set to extended mode

KAJV2502-W The correlation event issuing service cannot use common exclusion condition groups (extended) because the regular expressions used by JP1/Base are not extended. The correlation event issuing service will start without any common exclusion condition groups (extended) being set.

Event Correlation Feature

00003F25

When a message is issued providing notification that correlation event generation processing has been restarted by the jcoegsstart command.

KAJV2243-I The correlation event generation function has been restarted.

Event Generation Service

00003F26

When a message is issued providing notification that correlation event generation processing has been terminated by the jcoegsstop command without stopping the Event Generation Service.

KAJV2234-I The correlation event generation function has stopped.

Event Generation Service

00003F28

When the number of JP1 event sets issued by the Event Generation Service exceeds the maximum value (20,000 sets).

KAJV2322-W A JP1 event (event ID = event-ID, serial number in the event database = serial-number-in-event-database) could not be correlated because the number of correlated JP1 event pairs has reached the upper limit (20,000).

Event Generation Service

00003F31#4

When a message is issued providing notification that additional common exclusion-conditions have been registered from JP1/IM - View

KAJV2188-I An additional common exclusion conditions group was registered. (common exclusion conditions group ID = common-exclusion-conditions-group-ID, common exclude conditions group name = common-exclude-conditions-group-name, registering user = user-name)

Event Generation Service

00003F41

When more response-waiting events than the maximum that can be accumulated have been issued.

KAVB0551-E The number of accumulated response-waiting events on the manager exceeded the maximum (2000).

Event Console Service

00003F42

When response-waiting data for the file for accumulated response-waiting events cannot be read.

KAVB1816-W A response-waiting event could not be displayed.

To search for the event, specify the search conditions in the dialog box for setting the event search conditions as follows:

(1) As the host to be searched for, specify the name of the connected host.

(2) As the response-waiting event, specify the target event.

(3) As the arrival timeframe, specify the times when the events before and after this event arrived.

Event Console Service

00003F51

When events are deleted from the integrated monitoring database.

KAVB1841-I The events from deletion-target-start-date-and-time to deletion-target-end-date-and-time were deleted from the integrated monitoring database.

Integrated monitoring database

00003F52

When the number of events on which an output-and-save operation has not been performed exceeds the deletion warning position.

KAVB1842-W Events not output for preservation have exceeded the deletion warning level (deletion-warning-level%).

Output-and-save function

00003F53#1

When an error occurs while events are being registered into the integrated monitoring database.

KAVB1832-E An error occur while attempting to register an event into the integrated monitoring database. The system will retry registering the event. (detailed information = detailed-information)

Event Base Service

00003F54

When an event registration error that occurred in the integrated monitoring database is recovered.

KAVB1833-I An error occur while attempting to register an event into the integrated monitoring database. However, after several retries, the event was registered into the database. The event base service is restarting event acquisition.

Event Base Service

00003F56#4

When an additional repetition event condition has been registered (added).

KAVB4673-I A repeated event condition was registered. (repeated event condition name = repeated-event-condition-name, registering user = user-name)

Repeated event monitoring suppression function

00003F57#4

When the Apply button in the List of Repeated Event Conditions is clicked.

KAVB4674-I The definition file for the repeated event condition was updated. Next, processing will be performed using the definition read from the received event. (arrival time of the last received event = arrival-time-of-the-last-received-event, serial number in the event database = serial-number-in-the-event-database)

Repeated event monitoring suppression function

00003F58

When suppression of the repeated event monitoring suppression function starts.

KAVB4676-I Suppression of repeated events that match the repeated event condition (repeated-event-condition-name) has started. (arrival time of the first suppressed event = arrival-time-of-the-first-suppressed-event, event database serial number of the first suppressed event = event-database-serial-number-of-the-first-suppressed-event)

Repeated event monitoring suppression function

00003F59

When suppression of the repeated event monitoring suppression function ends.

KAVB4677-I Suppression of repeated events that match the repeated event condition (repeated-event-condition-name) has ended. (arrival time of the suppressed event = arrival-time-of-the-first-suppressed-event(YYYY/MM/DD HH:MM:SS) - arrival-time-of-the-last-suppressed-event(YYYY/MM/DD HH:MM:SS), event database serial number of the suppressed event = event-database-serial-number-of-the-first-suppressed-event - event-database-serial-number-of-the-last-suppressed-event)

Repeated event monitoring suppression function

00003F60

When suppression of monitoring repeated events has ended

KAVB4678-I Suppression of repeated events that match the repeated event condition (repeated-event-condition-name) has terminated. (arrival time of the suppressed event = arrival-time-of-the-first-suppressed-event(YYYY/MM/DD HH:MM:SS) - arrival-time-of-the-last-suppressed-event(YYYY/MM/DD HH:MM:SS), event database serial number of the suppressed event = event-database-serial-number-of-the-first-suppressed-event - event-database-serial-number-of-the-last-suppressed-event)

Repeated event monitoring suppression function

00003F61

When a severity changing definition has been applied and jco_spmd_reload is executed.

KAVB4600-I The severity change definition has been read. Next, processing will be performed using the definition read from the received event. (arrival time of the last received event = arrival-time, serial number in the event database = serial-number-in-event-database)

Event Base Service

00003F63

When the event source host mapping definition is applied.

When jco_spmd_reload is executed.

KAVB4650-I An event-source-host mapping definition was read. Processing will be performed by the definition read from the next received event. (last received event: reception time = reception-time, event database serial number = event-database-serial-number)

Event source host mapping feature

00003F64

When a business group is updated

KAVB8453-I The business group was updated. Processing will be performed from the next-received event. (last received event: reception time = reception-time, event database serial number = event-database-serial-number)

Restriction on referencing and operating business groups

00003F65

When suppression of monitoring repeated events is regarded as continued

KAVB4679-I Suppression of repeated events that match the repeated event condition (repeated-event-condition-name) will continue. (arrival time of the suppressed event = arrival-time-of-the-first-suppressed-event(YYYY/MM/DD HH:MM:SS) - arrival-time-of-the-last-suppressed-event(YYYY/MM/DD HH:MM:SS), event database serial number of the suppressed event = event-database-serial-number-of-the-first-suppressed-event - event-database-serial-number-of-the-last-suppressed-event)

Repeated event monitoring suppression function

00003F68

When a business group is updated

KAVB8454-W The business group could not be updated. (cause = cause)

Restriction on referencing and operating business groups

00003F69

When a business group is updated

KAVB8456-E The business group could not be updated. (cause = cause)

Restriction on referencing and operating business groups

00003F6A

When a display message change definition is applied.

When jco_spmd_reload is executed.

KAVB4623-I The display message change definition has been read. Next, processing will be performed using the definition read from the received event. (arrival time of the last received event = arrival-time, serial number in the event database = event-database-serial-number)

Display message change function

00003F71

When the additional severity changing definition is registered

KAVB4802-I A severity change definition was registered. (severity change definition name = severity-change-definition-name, registered user = user-name)

Severity change function of events

00003F76

When an additional display message change definition is registered

KAVB4803-I A display message change definition was registered. (display message change definition name = display-message-change-definition-name, registering user = user-name)

Display message change function

00003F77

When a definition file for extended event attributes is reloaded

KAVB5800-I The definition file for extended event attributes was read in to JP1/IM - Manager.

Function for displaying and specifying program-specific extended attributes

00003F78

When a definition file for extended event attributes is reloaded, but some of the definition file fails to reload

KAVB5804-E An attempt to read the definition file for extended event attributes failed because part of the definition file for extended event attributes could not be read.

Function for displaying and specifying program-specific extended attributes

00003F7C

When a definition file for opening monitor windows is reloaded

KAVB1981-I The definition file for opening monitor windows was applied to JP1/IM - Manager.

Monitor startup of linked products

00003FA0#5

When command execution control receives a command execution request from the Execute Command window.

KAVB2100-I [host-name:JP1-user-name] Command execution started.

JP1/Base command execution

00003FA1#5

When execution of a command requested from the Execute Command window is completed.

KAVB2101-I [host-name:JP1-user-name] Command execution ended normally.

JP1/Base command execution

00003FA2#5

When it is detected that a command whose execution was requested from the Execute Command window cannot be executed for some reason.

KAVB2102-E [host-name:JP1-user-name] Command execution ended abnormally.

JP1/Base command execution

00003FA3#5

When execution of a command was requested from the Execute Command window but the elapsed time event issuance interval for the automated action is exceeded.

(The jcocmddef command is used to specify the elapsed time event issuance interval).

KAVB2402-W [host-name]The execution time of command execution exceeded the regulation value (numeric-value sec)

JP1/Base command execution

00003FA5#5

When the number of pre-loaded automated actions reaches a threshold value (if a threshold for the number of pre-loaded commands has been set by the jcocmddef command).

KAVB2071-W In target-host-name, the number of queued commands requested from source-host-name has exceeded the threshold (xx).

JP1/Base command execution

00003FA6#5

When the number of pre-loaded automated actions becomes 0 (if a threshold for the number of pre-loaded commands has been set by the jcocmddef command).

KAVB2072-I In target-host-name, the number of queued commands requested from source-host-name has become 0.

JP1/Base command execution

00003FB0

When the status of a monitoring node changes.

KAVB7900-I Status of monitoring-node-name is changed status from status.

Central Scope Service

00003FB1

When the number of monitoring node status change events reaches a maximum value.

KAVB7901-W The number of status change event for the monitored node monitoring-node-ID has reached the threshold.

Central Scope Service

00003FC0

When a remote monitoring log-file trap is unable to start monitoring a log file.

KNAN26102-E The remote log-file trap cannot start. (Code: code, Host name: host name, Monitoring-target-name: monitoring-target-name)

Remote monitoring feature

00003FC1

When the number of retries for reading a remote monitoring log-file trap exceeds the threshold, and monitoring of the applicable log file has stopped.

KNAN26094-E The relevant log file could not be read after the specified number of retires, so monitoring will stop. (Code: code, Host name: host-name, Monitoring-target-name: monitoring-target-name, Log file name: Log file name)

Remote monitoring feature

00003FC2

When the status of a remote monitoring log-file trap changes to abnormal.

KNAN26095-E The relevant log file can no longer be monitored. (Code: code, Host name: host-name, Monitoring-target-name: monitoring-target-name, Log file name: Log file name)

Remote monitoring feature

00003FC3

When a remote monitoring log-file trap terminates abnormally.

KNAN26057-E The remote log-file trap will stop due to error. (Code: code, Host name: host name, Monitoring-target-name: monitoring-target-name)

Remote monitoring feature

00003FC5

When the amount of data for a log file collected by a remote monitoring log-file trap exceeds the allowed upper limit for logs.

KNAN26140-W The amount of data that a remote log file trap collected from the log file exceeded the limit. The log entries output from the last collection time to this collection time will not be output as JP1 events. (host name: host name, monitoring-target name: monitoring-target-name, log file name: Log file name, previous collection time: Last collection time(yyyy/MM/dd hh:mm:ss), this collection time: This collection time(yyyy/MM/dd hh:mm:ss))

Remote monitoring feature

00003FC6

When a remote monitoring log-file trap stops as a result of executing the collection of host information on the monitored host where remote monitoring is running

KNAN26351-E All trapping of remote log files on monitored host "monitored-host-name" will now stop. (cause = cause)

Remote monitoring feature

00003FC7

When a renamed log file (backup file) cannot be found (only when the SEQ2 format is used and the monitored host is a UNIX host)

KNAN26350-W The backup files for the monitored log files were not found. The log entries output to the backup files between the previous collection time and the current collection time will not be output as JP1 events. (host name = monitored-host-name, monitoring target = monitoring-target-name, log file name = monitored-log-file-name, previous collection time = yyyy/MM/dd hh:mm:ss, current collection time = yyyy/MM/dd hh:mm:ss, user = user, command line that was executed = command-line-executed)

Remote monitoring feature

00003FC8

When a renamed log file (backup file) cannot be found (only when the SEQ2 format is used and the monitored host is a Windows host)

KNAN26352-W The backup files for the monitored log files were not found. The log entries output to the backup files between the previous collection time and the current collection time will not be output as JP1 events. (host name = monitored-host-name, monitoring target = monitoring-target-name, log file name = monitored-log-file-name, previous collection time = yyyy/MM/dd hh:mm:ss, current collection time = yyyy/MM/dd hh:mm:ss, user = user)

Remote monitoring feature

00003FC9

When a remote monitoring event log trap trap stops as a result of executing the collection of host information on the monitored host where remote monitoring is running

KNAN26353-E Trapping of remote event log files on monitored host "monitored-host-name" will now stop. (cause = cause)

Remote monitoring feature

00003FD0

When a remote monitoring event log trap is unable to start monitoring Windows events.

KNAN26107-E The remote event-log trap cannot start. (Code: code, Host name: host name)

Remote monitoring feature

00003FD1

When the number of retries for reading an event log trap for remote monitoring exceeds the threshold, and monitoring of the applicable Windows events stops.

KNAN26028-E Monitoring will now stop because the event log could not be read after the specified number of retries. (Code: code, Host name: host name)

Remote monitoring feature

00003FD2

When reading of an event log file is retried.

KNAN26027-I The system will now retry reading the event log. (Code: code, Host name: host name)

Remote monitoring feature

00003FD3

When a remote monitoring event log trap terminates abnormally.

KNAN26002-E The remote event-log trap will now stop due to error. (Code: code, Host name: host name)

Remote monitoring feature

00003FD4

When reading of an event log is successful on a retry.

KNAN26026-I An event log can now be monitored. (Host name: host name)

Remote monitoring feature

00003FD5

When the differing-components data for an event log collected by a remote monitoring event log trap exceeds the upper limit for logs.

KNAN26142-W The amount of data collected from the host by a remote event-log trap exceeded the limit. The event log entries that were output during the period from the previous collection time to the current collection time will not be output as JP1 events. (host name = host-name, previous collection time = previous-collection-time, current collection time = current-collection-time)

Remote monitoring feature

00003FD6

When an operation to write to the remote monitoring status retention file by the remote-monitoring log file trap fails.

KNAN26339-W Failed to save the state of the remote log file trap when the log was collected. (host name = monitored-host-name, monitoring target = monitoring-target-name)

Remote monitoring feature

00003FD7

When an operation to write to the remote monitoring status retention file by the remote-monitoring event log trap fails.

KNAN26340-W Failed to save the state of the remote event log trap when the log was collected. (host name = monitored-host-name)

Remote monitoring feature

00003FD8

When an operation to read the remote monitoring status retention file by the remote-monitoring log file trap fails.

KNAN26341-W Failed to restore the remote log file trap to its state when it was last terminated. (host name = monitored-host-name, monitoring target = monitoring-target-name)

Remote monitoring feature

00003FD9

When an operation to read the remote monitoring status retention file by the remote-monitoring event log trap fails.

KNAN26342-W Failed to restore the remote log file trap to its state when it was last terminated. (host name = monitored-host-name)

Remote monitoring feature

00003FDA

When the logs output while remote monitoring was stopped cannot be collected after remote monitoring resumes (warm start) because a monitored log was changed by a remote-monitoring log file trap.

KNAN26343-W The remote log file trap was not restored to its state when it was last terminated, because the trap was in a state where it could not be monitored. (details = detailed-information, host name = monitored-host-name, monitoring target = monitoring-target-name, log file name = log-file-name)

Remote monitoring feature

00003FDB

When the system recovers from an error in the operation to write to the remote monitoring status retention file by the remote-monitoring log file trap.

KNAN26345-I An error in the processing to save the state of the remote log file trap that occurred during log collection was resolved. (host name = monitored-host-name, monitoring target = monitoring-target-name)

Remote monitoring feature

00003FDC

When the system recovers from an error in the operation to write to the remote monitoring status retention file by the remote-monitoring event log trap.

KNAN26346-I An error in the processing to save the state of the remote event log trap that occurred during log collection was resolved. (host name = monitored-host-name, monitoring target = monitoring-target-name)

Remote monitoring feature

Value specified for the ACTDEF parameter#6

When an AP log file record is detected.

Data content of one line in a log file

Remote monitoring feature

Details of 00003A71, or the event ID specified in the filter block of the remote-monitoring event log trap action-definition file#7

When a log message reporting a Windows event is detected.

Event log message

Remote monitoring feature

00003F90#8

When a process terminates abnormally.

KAVB3737-E The component-name managed-process-name terminated abnormally.

JP1/IM - Manager process management

00003F91#8

When a timeout occurs during process startup.

KAVB3613-W A component-name timeout occurred in managed-process-name. Processing continues.

JP1/IM - Manager process management

00003F92#8

When a process that terminated abnormally restarts.

KAVB3616-I Restart of the component-name managed-process-name has finished.

JP1/IM - Manager process management

00006400#9

When a display message change event is issued

If the message was changed by the display message change function, the changed message is set.

If the message was not changed, the message text of the original event is set.

Issuance of a display message change event

#1: These are dummy events to which the following limitations apply:

The event cannot be searched in the Event Console window.

If the details of the event are displayed, the JP1 event basic and extended attributes are not displayed.

No action is executed pursuant to such an event even if an automated action is set.

No mapping is performed on the event even if event information mapping is defined.

This event is not subject to monitor startup.

This event is not subject to the event acquisition filter.

This event is not subject to correlation event generation processing.

This event is not registered in the event database. Therefore, when JP1/IM - Manager is restarted, this event is no longer displayed in the Event Console window.

If you change the event action status, the changes are not applied to other parts of JP1/IM - View.

#2: When recovery of JP1/Base Event Service (jevservice) is detected, the following message is displayed: KAVB8063-I.

#3: The following limitation applies to these events:

No action is executed on this event even if an automated action is set.

#4: The following limitation applies to these events:

This event is not subject to the event acquisition filter.

#5: This is a JP1 event issued by JP1/Base command execution. For details about the JP1 events, see the chapter that describes JP1 events in the JP1/Base User's Guide.

#6: For details about JP1 events issued by log file traps of JP1/Base instead of the remote monitoring function, see the chapter describing JP1 events in the JP1/Base User's Guide.

#7: For details about JP1 events issued by log file traps of JP1/Base instead of the remote monitoring function, see the chapter describing JP1 events in the JP1/Base User's Guide.

#8: This event is issued only if issuance of JP1 events in response to process errors is set. To issue such JP1 events, you must edit the IM parameter definition file and then execute the jbssetcnf command. For details about definition files, see IM parameter definition file (jp1co_param_V7.conf) in Chapter 2. Definition Files. For details about the setting procedure, see 1.18.3 Specifying settings for handling JP1/IM - Manager failures (for Windows), and 2.17.5 Specifying settings for handling JP1/IM - Manager failures (for UNIX) in the JP1/Integrated Management 2 - Manager Configuration Guide.

#9: Original event refers to the event that JP1/IM - Manager acquired from JP1/Base.

3.2.2 Details of JP1 events

This section describes the details of JP1 events.

(1) Details of event ID: 0002010

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4400-E The run time of an action for an event exceeded the action delay monitoring time.(Event_ID=event-ID, SEQNO=serial-number-in-event-database, Execution Host=action-execution-host, Action Serial Number=action-serial-number) Delay monitoring notifications will not be sent until suppression of the function for sending notifications to the action delay monitor is canceled.

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

Object ID

OBJECT_ID

Serial number of the event that caused the action

User name

USER_NAME

JP1 user who executed the action

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Action execution host

EXECHOST

Name of the host executing the action

Action status

ACTION_STATUS

Action status

Command

EXECCMD

Command whose execution was requested

Environment variable file

EXECENV

Name of the environment variable file used during execution

Action serial number

ACTION_SEQNO

Serial number of the action

ID of the action triggering event

SRC_EVENT_ID

Event ID of the event that resulted in execution of the action

Inserted time

SEND_TIME

Time the action execution request was sent

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(2) Details of event ID: 00002011

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4402-E An event status is abnormal.(event ID = event-ID, event serial number = serial-number-in-event-database, execution host = action-execution-host, action serial number = action-serial-number) Status monitoring notifications will not be sent until suppression of the function for sending notifications to the action status monitor is canceled

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

Object ID

OBJECT_ID

Serial number of the event that caused the action

User name

USER_NAME

JP1 user who executed the action

End time

END_TIME

Time the action terminated abnormally

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Action execution host

EXECHOST

Name of the host executing the action

Action status

ACTION_STATUS

Action's status

Command

EXECCMD

Command whose execution was requested

Environment variable file

EXECENV

Name of the environment variable file used during execution

Action serial number

ACTION_SEQNO

Serial number of the action

ID of the action triggering event

SRC_EVENT_ID

Event ID of the event that resulted in execution of the action

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(3) Details of event ID: 00002012

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB8060-E An abnormality was detected in function-name. (host name = host-name, process name = process-name, process ID = process-ID) : maintenance-information

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/HEALTHCHECK

Object type

OBJECT_TYPE

JCOHC

Object name

OBJECT_NAME

Name of the function in which the error was detected

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Host

HOST_NAME

Host name

Process name

PROCESS_NAME

Process name

Process ID

PROCESS_ID

Process ID

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(4) Details of event ID: 00002013

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB8062-E An abnormality was detected in function-name. (host name = host-name, process name = process-name) : maintenance-information

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/HEALTHCHECK

Object type

OBJECT_TYPE

JCOHC

Object name

OBJECT_NAME

Name of the function in which the error was detected

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Host

HOST_NAME

Host name

Process name

PROCESS_NAME

Process name

Process ID

PROCESS_ID

Process ID

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(5) Details of event ID: 00002014

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#1

Source group ID

GROUPID

From -1 to 65,535#1

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB8061-I function-name has been recovered. (host name = host-name, process name = process-name, process ID = process-ID) : maintenance-information#2

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/HEALTHCHECK

Object type

OBJECT_TYPE

JCOHC

Object name

OBJECT_NAME

Name of the recovered function

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Host

HOST_NAME

Host name

Process name

PROCESS_NAME

Process name

Process ID

PROCESS_ID

Process ID

Legend:

--: None

#1: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

#2: If recovery of JP1/Base Event Service (jevservice) is detected, the following message is issued: KAVB8063-I function-name has been recovered. (host name = host-name, process name = process-name) : maintenance-information.

(6) Details of event ID: 00002015

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4401-I Suppression of the function for sending notifications to the action delay monitor was canceled.

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

Occurrence

OCCURRENCE

NOTICE

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(7) Details of event ID: 00002016

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4403-I Suppression of the function for sending notifications to the action status monitor was canceled.

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

Occurrence

OCCURRENCE

NOTICE

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(8) Details of event ID: 00002020

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4404-E Although the run time of an action exceeded the action delay monitoring time, an action delay notification event could not be sent because no action information exists in the action information file.(action serial number = action-serial-number) Delay monitoring notifications will not be sent until suppression of the function for sending notifications to the action delay monitor is canceled.

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Action serial number

ACTION_SEQNO

Serial number of the action

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(9) Details of event ID: 00002021

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4405-E Although an action status is abnormal, an action state notification event could not be sent because no action information exists in the action information file. Status monitoring notifications will not be sent until suppression of the function for sending notifications to the action status monitor is canceled.: maintenance-information

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

User name

USER_NAME

JP1 user who executed the action

End time

END_TIME

Time the action terminated abnormally

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Action execution host

EXECHOST

Serial number of the action

Action status

ACTION_STATUS

Action's status

Command

EXECCMD

Command whose execution was requested

Environment-variable file name

EXECENV

Name of the environment variable file used during execution

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(10) Details of event ID: 000020A0

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4054-E Automatic Action was terminated abnormally. (Hostname : host-name)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

JCAMAIN

Occurrence

OCCURRENCE

TERMINATE

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(11) Details of event ID: 000020A1

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the automated action started

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4050-I Automatic Action was started. : logical-host-name

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

JCAMAIN

Occurrence

OCCURRENCE

START

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(12) Details of event ID: 000020A2

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the automated action was running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4051-I Automatic Action was terminated. : logical-host-name

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

JCAMAIN

Occurrence

OCCURRENCE

TERMINATE

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(13) Details of event ID: 000020A3

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#1

Source group ID

GROUPID

From -1 to 65,535#1

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the logical host where the automated action is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4055-I The action definition file was read and the automatic action function status was changed to operating. The processing will be based on the definitions read from the subsequently received (arrival-time-of-most-recently-processed-event (YYYY/MM/DD hh:mm:ss)) events. (Definition=total-number-of-effective-definitions/total-number-of-definitions-in-file, SEQNO=serial-number-of-most-recently-processed-event)#2

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

RUN

#1: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

#2: If the automated action has not received the event, -- is displayed for YYYY/MM/DD hh:mm:ss and for serial-number-of-last-event-processed.

(14) Details of event ID: 000020A4

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#1

Source group ID

GROUPID

From -1 to 65,535#1

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the logical host where the automated action was running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4056-I Automatic action was suspended. Automatic actions cannot be executed for the subsequently received (arrival-time-of-most-recently-processed-event (YYYY/MM/DD hh:mm:ss)) events. (SEQNO=serial-number-of-most-recently-processed-event)#2

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

STANDBY

#1: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

#2: If the automated action has not received an event, -- is displayed for YYYY/MM/DD hh:mm:ss and for serial-number-of-last-event-processed.

(15) Details of event ID: 000020A5

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the erroneous automated action process was running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4909-E An attempt to set locale information has failed.

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

JCAMAIN

Occurrence

OCCURRENCE

ERROR

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(16) Details of event ID: 000020A6

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Event Base Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the erroneous Event Base Service process was running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4909-E An attempt to set locale information has failed.

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

ERROR

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(17) Details of event ID: 000020E0

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the automated action is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4430-I Execution of the action for an event was requested.(Event_ID=event-ID, SEQNO=serial-number-in-event-database)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

Object ID

OBJECT_ID

Serial number of the event that caused the action

User name

USER_NAME

JP1 user who executed the action

Start time

START_TIME

Time the action execution request was completed

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Action execution host

EXECHOST

Name of the host executing the action

Action status

ACTION_STATUS

Action status RUNNING

Command

EXECCMD

Command whose execution was requested

Environment-variable file name

EXECENV

Name of the environment variable file used during execution

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(18) Details of event ID: 000020E1

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the automated action was running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4431-I Execution of the action for an event ended normally.(EVENT_ID=event-ID, SEQNO=serial-number-in-event-database, Return_code=termination-code)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

Object ID

OBJECT_ID

Serial number of the event that caused the action

User name

USER_NAME

JP1 user who executed the action

End time

END_TIME

Time the action execution request was completed

Termination code

RESULT_CODE

Action's termination code

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Action execution host

EXECHOST

Name of the host executing the action

Action status

ACTION_STATUS

Action status ENDED

Command

EXECCMD

Command whose execution was requested

Environment-variable file name

EXECENV

Name of the environment variable file used during execution

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(19) Details of event ID: 000020E2

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the automated action was running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4432-E Automatic action or command control of the action for an event ended abnormally.(EVENT_ID=event-ID, SEQNO=serial-number-in-event-database)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

Object ID

OBJECT_ID

Serial number of the event that caused the action

User name

USER_NAME

JP1 user who executed the action

End time

END_TIME

Time the action terminated abnormally

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Action execution host

EXECHOST

Name of the host executing the action

Action status

ACTION_STATUS

Action status ERROR or FAIL

Detailed abnormal termination information

ERROR_INFO

Message indicating the nature of the error

Command

EXECCMD

Command whose execution was requested

Environment-variable file name

EXECENV

Name of the environment variable file used during execution

Cause of error

EXECERR

Maintenance information in the event of an error

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(20) Details of event ID: 000020E3

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the automated action is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4433-I Execution of the action for an action state notification event was requested.(Event_ID=event-ID, SEQNO=serial-number-in-event-database)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

Object ID

OBJECT_ID

Serial number of the event that caused the action

User name

USER_NAME

JP1 user who executed the action

Start time

START_TIME

Time the action execution request was completed

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Action execution host

EXECHOST

Name of the host executing the action

Action status

ACTION_STATUS

Action status RUNNING

Command

EXECCMD

Command whose execution was requested

Environment-variable file name

EXECENV

Name of the environment variable file used during execution

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(21) Details of event ID: 000020E4

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the automated action was running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4434-I Execution of the action for an action state notification event ended normally.(EVENT_ID=event-ID, SEQNO=serial-number-in-event-database, Return_code=termination-code)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

Object ID

OBJECT_ID

Serial number of the event that caused the action

User name

USER_NAME

JP1 user who executed the action

End time

END_TIME

Time the action execution request was completed

Termination code

RESULT_CODE

Action's termination code

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Action execution host

EXECHOST

Name of the host executing the action

Action status

ACTION_STATUS

Action status ENDED

Command

EXECCMD

Command whose execution was requested

Environment-variable file name

EXECENV

Name of the environment variable file used during execution

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(22) Details of event ID: 000020E5

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the automated action was running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4435-E Automatic action or command control of the action for an action state notification event ended abnormally.(EVENT_ID=event-ID, SEQNO=serial-number-in-event-database)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

Object ID

OBJECT_ID

Serial number of the event that caused the action

User name

USER_NAME

JP1 user who executed the action

End time

END_TIME

Time the action terminated abnormally

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Action execution host

EXECHOST

Name of the host executing the action

Action status

ACTION_STATUS

Action status ERROR or FAIL

Detailed abnormal termination information

ERROR_INFO

Message indicating the nature of the error

Command

EXECCMD

Command whose execution was requested

Environment-variable file name

EXECENV

Name of the environment variable file used during execution

Cause of error

EXECERR

Maintenance information in the event of an error

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(23) Details of event ID: 000020E6

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the automated action was running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4436-W Although Execution of the action for an event was requested, an action state notification event could not be sent because no action information exists in the action information file. : maintenance-information

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

User name

USER_NAME

JP1 user who executed the action

Start time

START_TIME

Time the action execution request was completed

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Action execution host

EXECHOST

Name of the host executing the action

Action status

ACTION_STATUS

Action status RUNNING

Command

EXECCMD

Command whose execution was requested

Environment-variable file name

EXECENV

Name of the environment variable file used during execution

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(24) Details of event ID: 000020E7

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the automated action was running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4437-W Although Execution of the action for an event ended normally, an action state notification event could not be sent because no action information exists in the action information file. : maintenance-information

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

End time

END_TIME

Time execution of the action ended

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Action execution host

EXECHOST

Name of the host executing the action

Action status

ACTION_STATUS

Action status ENDED

Command

EXECCMD

Command whose execution was requested

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(25) Details of event ID: 000020E8

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the automated action was running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4438-E Although automatic action or command control of the action for an event ended abnormally, an action state notification event could not be sent because no action information exists in the action information file. : maintenance-information

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/JCAMAIN

Object type

OBJECT_TYPE

ACTION

Object name

OBJECT_NAME

JCAMAIN

End time

END_TIME

Time the action terminated abnormally

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Action execution host

EXECHOST

Name of the host executing the action

Action status

ACTION_STATUS

Action status ERROR or FAIL

Detailed abnormal termination information

ERROR_INFO

Message indicating the nature of the error

Command

EXECCMD

Command whose execution was requested

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(26) Details of event ID: 00003F01

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

-1

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time of an event that can be acquired

Source user ID

USERID

0

Source group ID

GROUPID

0

Source user name

USERNAME

Blank

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

0

Message

MESSAGE

KAVB1513-W Cannot display some event(S).

There were no events to obtain from the event buffer on the connecting host.

All the events except the above will be displayed.

To search for an event which was not displayed, specify the search conditions

in the event search condition settings dialog as follows:

(1) In "Search host", specify the name of the connecting host.

(2) In "Registered timeframe", specify the times when the events before and after this event were registered.

Check to see if the following conditions are met when this event appears frequently.

(1) The "Interval" value that was set for "Automatic refresh" in the Preferences window is too long.

(2) The "Num. of events to acquire at update" value that was set in the Preferences window is too small.

(3) The "Event buffer" value for the Manager that was set in the System Environment Settings window is too small.

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

EVENT

Object name

OBJECT_NAME

\SYSTEM\ALL

Occurrence

OCCURRENCE

LOST

(27) Details of event ID: 00003F02

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

-1

Source process ID

PROCESSID

0

Registered time

TIME

Registered time

Arrived time

ARRIVEDTIME

Arrival time of an event that can be acquired

Source user ID

USERID

0

Source group ID

GROUPID

0

Source user name

USERNAME

Blank

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

0

Message

MESSAGE

KAVB1540-W Cannot display some event(s). (page = page)

There were no events to obtain from the event buffer on the connecting host.

All the events except the above will be displayed.

To search for an event which was not displayed, specify the search conditions in the event search condition settings dialog as follows:

(1) In "Search host", specify the name of the connecting host.

(2) In "Registered timeframe", specify the times when the events before and after this event were displayed.

Check to see if the following conditions are met when this event appears frequently.

(1) The "Interval" value that was set for "Automatic refresh" in the Preferences window is too long.

(2) The "Num. of events to acquire at update" value that was set in the Preferences window is too small.

(3) The "Event buffer" value for the Manager that was set in the System Environment Settings window is too small.

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

EVENT

Object name

OBJECT_NAME

\SYSTEM\ALL

Occurrence

OCCURRENCE

LOST

(28) Details of event ID: 00003F03

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

-1

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Time the error occurred

Source user ID

USERID

0

Source group ID

GROUPID

0

Source user name

USERNAME

Blank

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

0

Message

MESSAGE

KAVB1516-W An error occurred in acquiring an event from the event service.

Cannot recover the error after attempting the number of retries specified in the system profile.

No more events will be displayed from now on due to this error. Please check if the event service is running or not.

If not, recover the error by re-executing the manager after starting the event service.

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

Event Service

Occurrence

OCCURRENCE

DISCONNECT

(29) Details of event ID: 00003F04

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

-1

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Time the error occurred

Source user ID

USERID

0

Source group ID

GROUPID

0

Source user name

USERNAME

Blank

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

0

Message

MESSAGE

KAVB1527-E A condition that cannot be received by the search host is included.

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

Event Service

Occurrence

OCCURRENCE

PARAM_ERROR

(30) Details of event ID: 00003F05

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

-1

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Time the error occurred

Source user ID

USERID

0

Source group ID

GROUPID

0

Source user name

USERNAME

Blank

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

0

Message

MESSAGE

KAVB0246-E The filter condition exceeds the maximum length. (Maximum length:maximum-length)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

Event Service

Occurrence

OCCURRENCE

OVER_LENGTH

(31) Details of event ID: 00003F06

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

-1

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Time the error occurred

Source user ID

USERID

0

Source group ID

GROUPID

0

Source user name

USERNAME

Blank

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

0

Message

MESSAGE

KAVB0248-E The settings for a regular expression is incorrect.

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

Event Service or IM database

Occurrence

OCCURRENCE

REGEXP_ERROR

(32) Details of event ID: 00003F07

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

-1

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Time the error occurred

Source user ID

USERID

0

Source group ID

GROUPID

0

Source user name

USERNAME

Blank

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

0

Message

MESSAGE

KAVB4764-W An error occurred in acquiring an event from the event service. Please check if the event service is running or not. If not, recover the error by starting the event service.

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

Event Service

Occurrence

OCCURRENCE

DISCONNECT

(33) Details of event ID: 00003F08

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

-1

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Time the error occurred

Source user ID

USERID

0

Source group ID

GROUPID

0

Source user name

USERNAME

Blank

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

0

Message

MESSAGE

KAVB0251-E The search cannot be performed for the specified condition because the search host's JP1/Base does not support the exclusion condition.

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

Event Service

Occurrence

OCCURRENCE

EXCLUDE_ERROR

(34) Details of event ID: 00003F11

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of occurrence

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#1

Source group ID

GROUPID

From -1 to 65,535#1

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB1577-I A status operation was performed. (user who performed the operation = JP1-user#2, event ID = event-ID, status before operation = status-before-operation#3, status after operation = status-after-operation#3)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVTCON

Occurrence

OCCURRENCE

PROCESS

User-specific or program-spe-cific information

Serial number of the handled event

PROCESSUPDATE_SEQNO

Serial number of the JP1 event whose action's status was changed (decimal number)

Source serial number of the handled event

PROCESSUPDATE_ORIGINALSEQNO

Source serial number of the JP1 event whose action's status was changed (decimal number)

Event level of the handled event

PROCESSUPDATE_SEVERITY

Event level of the JP1 event whose action's status was changed (one of the following: Emergency, Alert, Critical, Error, Warning, Notice, Information, or Debug)

Source event server name of the handled event

PROCESSUPDATE_SOURCESERVER

Name of the event-issuing server (server that issued the JP1 event whose action's status was changed)

Message for the handled event

PROCESSUPDATE_MESSAGE

Message (for the JP1 event whose action's status was changed)

Registration time of the handled event

PROCESSUPDATE_TIME

Time of registration (time the JP1 event whose action's status was changed was registered; displayed in the Event Details window in the format MM/DD hh:mm:ss)

#1: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

#2: The value that is actually displayed for JP1-user depends on the status, as follows:

When the action status was changed from JP1/IM - View version 08-01 or later: JP1-user-who-changed-the-action-status

When the action status was changed from JP1/IM - View version 07-00 or earlier: -

When the action status was changed by the jcochstat command: jcochstat

When the action status was changed because there was a response to a response-waiting event: system

When the action status was changed because a response-waiting event was canceled: system

#3: status-before-action and status-after-action depend on the handling method, as shown below:

Processed: PROCESSED

Unprocessed: UNPROCESSED

Processing: PROCESSING

Held: HELD

Processed -> Deleted: PROCESSED+DELETE

Unprocessed -> Deleted: UNPROCESSED+DELETE

Processing -> Deleted: PROCESSING+DELETE

Held -> Deleted: HELD+DELETE

(35) Details of event ID: 00003F13

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of occurrence

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the logical host where the event base server is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4014-I The event acquisition filter definition file was read. The read definitions will be used for processing from the next received event. (filter name = filter-name, last received event = arrival-time, serial number in event DB = serial-number)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(36) Details of the event ID specified in the SUCCESS_EVENT parameter in the correlation event generation definition file

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

IDBASE

User-defined event ID

(must be in the range from 0 to 1FFF and from 7FFF8000 to 7FFFFFFF)

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

User-defined message

Extended attribute

Common information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/GENERATE_EVENT

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EGS

Occurrence

OCCURRENCE

SUCCESS

User-specific or program-spe-cific information

Relation Event serial number

JP1_GENERATE_SOURCE_SEQNO

Serial numbers of related events separated by the space (Δ), as shown below:

serial-number-1Δserial-number-2Δ...Δserial-number-n (n: value from 1 to 100)

Correlation event generation condition name

JP1_GENERATE_NAME

Name of the correlation event generation condition that resulted in approval

Note: You can define as correlation event attributes additional attributes that are not listed in this table. For details, see Correlation event generation definition file in Chapter 2. Definition Files.

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(37) Details of the event ID specified in the FAIL_EVENT parameter in the correlation event generation definition file

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

IDBASE

User-defined event ID

(must be in the range from 0 to 1FFF and from 7FFF8000 to 7FFFFFFF)

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Extended attribute

Common information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/GENERATE_EVENT

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EGS

Occurrence

OCCURRENCE

FAIL

User-specific or program-spe-cific information

Relation Event serial number

JP1_GENERATE_SOURCE_SEQNO

Serial numbers of related events separated by the space (Δ), as shown below:

serial-number-1Δserial-number-2Δ...Δserial-number-n (n: value from 1 to 100)

Correlation event generation condition name

JP1_GENERATE_NAME

Name of the correlation event generation condition that resulted in failure

Note: You can define as correlation event attributes additional attributes that are not listed in this table. For details, see Correlation event generation definition file in Chapter 2. Definition Files.

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(38) Details of event ID: 00003F15

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

3F15

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of Automatic Action Service

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#1

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#1

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the logical host where the event base server is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB1669-I The severe event definition file has been read. Next, processing will be performed using the definition read from the acquired event. (Event acquired at the end:Arrival time = arrival-time-of-the-event-acquired-at-the-end, serial number in event DB = serial-number-in-event-database-of-the-event-acquired-at-the-end)#2

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

RUN

#1: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

#2: If Event Base Service has not received the event, -- is displayed for arrival-time-of-last-event-acquired and for serial-number-of-last-event-acquired.

(39) Details of event ID: 00003F16

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

-1

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Time the error occurred

Source user ID

USERID

0

Source group ID

GROUPID

0

Source user name

USERNAME

Blank

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

0

Message

MESSAGE

KAVB1671-W An error occurred in acquiring an event from the integrated monitoring database.

Cannot recover the error after attempting the number of retries specified in the system profile.

No more events will be displayed from now on due to this error.

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

IM Database

Occurrence

OCCURRENCE

DISCONNECT

(40) Details of event ID: 00003F17

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the logical host where the event base server is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB1150-I An additional common exclusion conditions group was registered. (common exclusion conditions group ID = common-exclusion-conditions-group-ID, common exclude conditions group name = common-exclude-conditions-group-name, registering user = user-name)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(41) Details of event ID: 00003F20

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the logical host where the Event Generation Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAJV2179-I The event acquisition filter definition file was read. The read definitions will be used for processing from the next received event. (filter name = filter-name, last received event = arrival-time, serial number in event DB = serial-number-in-event-database)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EGS

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EGS

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(42) Details of event ID: 00003F21

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the logical host where the Event Generation Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAJV2242-I The correlation event generation definition file has been read, and the definitions for the correlation event generation function have been updated. (file name = file-name)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EGS

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EGS

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(43) Details of event ID: 00003F22

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the logical host where the event base server was running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4712-W The event base service cannot use common exclusion condition groups (extended) because a regular expression used by JP1/Base is not extended. The event base service will start without any common exclusion condition groups (extended) being set.

Extended attribute

Common information

Event level

SEVERITY

Notice

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

Notice

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(44) Details of event ID: 00003F23

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the logical host where the event base server is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAJV2502-W The correlation event issuing service cannot use common exclusion condition groups (extended) because the regular expressions used by JP1/Base are not extended. The correlation event issuing service will start without any common exclusion condition groups (extended) being set.

Extended attribute

Common information

Event level

SEVERITY

Notice

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EGS

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EGS

Occurrence

OCCURRENCE

Notice

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(45) Details of event ID: 00003F25

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the logical host where the Event Generation Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAJV2243-I The correlation event generation function has been restarted.

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EGS

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EGS

Occurrence

OCCURRENCE

START

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(46) Details of event ID: 00003F26

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the logical host where the Event Generation Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAJV2234-I The correlation event generation function has stopped.

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EGS

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EGS

Occurrence

OCCURRENCE

STOP

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(47) Details of event ID: 00003F28

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAJV2322-W A JP1 event (event ID=event-ID, serial number in the event database=serial-number) could not be correlated because the number of correlated JP1 event pairs has reached the upper limit (20,000).

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EGS

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EGS

Occurrence

OCCURRENCE

RUN

Note: JP1 event 00003F28 is output once when the number of JP1 event sets reaches the maximum value. After that, this event is not output again until the number of JP1 event sets drops down to 16,000 or fewer.

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(48) Details of event ID: 00003F31

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the logical host where the Event Generation Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAJV2188-I An additional common exclusion conditions group was registered. (common exclusion conditions group ID = common-exclusion-conditions-group-ID, common exclude conditions group name = common-exclude-conditions-group-name, registering user = user-name)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EGS

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EGS

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(49) Details of event ID: 00003F41

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of occurrence

Arrived time

ARRIVEDTIME

Arrived time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB0551-E The number of accumulated response-waiting events on the manager exceeded the maximum (2000).

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVTCON

Occurrence

OCCURRENCE

NOTICE

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(50) Details of event ID: 00003F42

Attribute type

Item

Attribute name

Description

Basic attribute

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of occurrence

Arrived time

ARRIVEDTIME

Arrived time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB1816-W A response-waiting event could not be displayed.

To search for the event, specify the search conditions in the dialog box for setting the event search conditions as follows:

(1) As the host to be searched for, specify the name of the connected host.

(2) As the response-waiting event, specify the target event.

(3) As the arrival timeframe, specify the times when the events before and after this event arrived.

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVTCON

Occurrence

OCCURRENCE

PROCESS

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(51) Details of event ID: 00003F51

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F51

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#1

Source group ID

GROUPID

From -1 to 65,535#1

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB1841-I The events from deletion-target-start-date-and-time to deletion-target-end-date-and-time were deleted from the integrated monitoring database.#2

Extended attribute

Common information

Event level

SEVERITY

Notice

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Deletion start date

DEL_STARTDAY

Deletion start date, expressed as absolute time in seconds (displayed in the Event Details window in the format MM/DD hh:mm:ss)

Deletion end date

DEL_ENDDAY

Deletion end date, expressed as absolute time in seconds (displayed in the Event Details window in the format MM/DD hh:mm:ss)

#1: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

#2: The format of deletion-start-date and deletion-end-date is replaced in the KAVB1841-I message with YYYY/MM/DD hh:mm:ss.

(52) Details of event ID: 00003F52

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F52

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB1842-W Events not output for preservation have exceeded the deletion warning level (deletion-warning-level%).

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

NOTICE

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(53) Details of event ID: 00003F53

Attribute type

Item

Attribute name

Description

Basic attribute

Source host

SOURCESERVER

Name of the event-issuing server

Message

MESSAGE

KAVB1832-E An error occur while attempting to register an event into the integrated monitoring database. The system will retry registering the event. (detailed information = detailed-information)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

NOTICE

(54) Details of event ID: 00003F54

Attribute type

Item

Attribute name

Description

Basic attribute

Source host

SOURCESERVER

Name of the event-issuing server

Message

MESSAGE

KAVB1833-I An error occur while attempting to register an event into the integrated monitoring database. However, after several retries, the event was registered into the database. The event base service is restarting event acquisition.

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

NOTICE

(55) Details of event ID: 00003F56

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F56

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrived time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the logical host where the event base server is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4673-I A repeated event condition was registered. (repeated event condition name = repeated-event-condition-name, registering user = user-name)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(56) Details of event ID: 00003F57

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F57

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrived time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the host or the logical host where the event base server is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4674-I The definition file for the repeated event condition was updated. Next, processing will be performed using the definition read from the received event. (arrival time of the last received event = arrival-time-of-the-last-received-event, serial number in the event database = serial-number-in-the-event-database)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(57) Details of event ID: 00003F58

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F58

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrived time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the host or the logical host where the event base server is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4676-I Suppression of repeated events that match the repeated event condition (repeated-event-condition-name) has started. (arrival time of the first suppressed event = arrival-time-of-the-first-suppressed-event, event database serial number of the first suppressed event = event-database-serial-number-of-the-first-suppressed-event)

Extended attribute

Common information

Event level

SEVERITY

Notice

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Duplicate attribute value information 1

SAMEATTR1

Stores the first (listed at the top) attribute name and its value as a duplicate attribute value condition in attribute-name=attribute-value format. If a duplicate attribute value condition is not specified, a blank is stored.

You can specify a maximum of 1,024 bytes for the attribute value. For a value larger than 1,024 bytes, split it, but do so without splitting a multi-byte character.

Duplicate attribute value information 2

SAMEATTR2

Stores the second attribute name and its value as a duplicate attribute value condition in attribute-name=attribute-value format. If there are fewer than two duplicate attribute value conditions, a blank is stored.

You can specify a maximum of 1,024 bytes for the attribute value. For a value larger than 1,024 bytes, split it, but do so without splitting a multi-byte character.

Duplicate attribute value information 3

SAMEATTR3

Stores the third attribute name and its value as a duplicate attribute value condition in attribute-name=attribute-value format. If there are fewer than three duplicate attribute value conditions, a blank is stored.

You can specify a maximum of 1,024 bytes for the attribute value. For a value larger than 1,024 bytes, split it, but do so without splitting a multi-byte character.

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(58) Details of event ID: 00003F59

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F59

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrived time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the host or the logical host where the event base server is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4677-I Suppression of repeated events that match the repeated event condition (repeated-event-condition-name) has ended. (arrival time of the suppressed event = arrival-time-of-the-first-suppressed-event(YYYY/MM/DD HH:MM:SS) - arrival-time-of-the-last-suppressed-event(YYYY/MM/DD HH:MM:SS), event database serial number of the suppressed event = event-database-serial-number-of-the-first-suppressed-event - event-database-serial-number-of-the-last-suppressed-event)

Extended attribute

Common information

Event level

SEVERITY

Notice

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Duplicate attribute value information 1

SAMEATTR1

Stores the first (listed at the top) attribute name and its value as a duplicate attribute value condition in attribute-name=attribute-value format. If a duplicate attribute value condition is not specified, a blank is stored.

You can specify maximum of 1,024 bytes for the attribute value. For a value larger than 1,024 bytes, split it, but do so without splitting a multi-byte character.

Duplicate attribute value information 2

SAMEATTR2

Stores the second attribute name and its value as a duplicate attribute value conditions in attribute-name=attribute-value format. If there are fewer than two duplicate attribute value conditions, a blank is stored.

You can specify a maximum of 1,024 bytes for the attribute value. For a value larger than 1,024 bytes, split it, but do so without splitting a multi-byte character.

Duplicate attribute value information 3

SAMEATTR3

Stores the third attribute name and its value as a duplicate attribute value condition in attribute-name=attribute-value format. If there are fewer than three duplicate attribute value conditions, a blank is stored.

You can specify a maximum of 1,024 bytes for the attribute value. For a value larger than 1,024 bytes, split it, but do so without splitting a multi-byte character.

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(59) Details of event ID: 00003F60

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F60

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Registered time

Arrived time

ARRIVEDTIME

Arrived time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the host or the logical host where the event base server is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4678-I Suppression of repeated events that match the repeated event condition (repeated-event-condition-name) has terminated. (arrival time of the suppressed event = arrival-time-of-the-first-suppressed-event(YYYY/MM/DD HH:MM:SS) - arrival-time-of-the-last-suppressed-event(YYYY/MM/DD HH:MM:SS), event database serial number of the suppressed event = event-database-serial-number-of-the-first-suppressed-event - event-database-serial-number-of-the-last-suppressed-event)

Extended attribute

Common information

Event level

SEVERITY

Notice

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Duplicate attribute value information 1

SAMEATTR1

Stores the first (listed at the top) attribute name and its value as a duplicate attribute value condition in attribute-name=attribute-value format. If a duplicate attribute value condition is not specified, a blank is stored.

You can specify a maximum of 1,024 bytes for the attribute value. For a value larger than 1,024 bytes, split it, but do so without splitting a multi-byte character.

Duplicate attribute value information 2

SAMEATTR2

Stores the second attribute name and its value as a duplicate attribute value condition in attribute-name=attribute-value format. If there is only one duplicate attribute value condition, a blank is stored.

You can specify a maximum of 1,024 bytes for the attribute value. For a value larger than 1,024 bytes, split it, but do so without splitting a multi-byte character.

Duplicate attribute value information 3

SAMEATTR3

Stores the third attribute name and its value as a duplicate attribute value condition in attribute-name=attribute-value format. If there are fewer than three duplicate attribute value conditions, a blank is stored.

You can specify a maximum of 1,024 bytes for the attribute value. For a value larger than 1,024 bytes, split it, but do so without splitting a multi-byte character.

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(60) Details of event ID: 00003F61

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F61

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#1

Source group ID

GROUPID

From -1 to 65,535#1

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the server or logical host where Event Base Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4600-I The severity change definition has been read. Next, processing will be performed using the definition read from the received event. (arrival time of the last received event = arrival-time, serial number in the event database = serial-number-in-event-database)#2

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

RUN

#1: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

#2: The format of arrival-time is replaced in the KAVB4600-I message with YYYY/MM/DD hh:mm:ss. The time set in arrival-time is based on the time zone set in the machine where JP1/IM - Manager is running.

(61) Details of event ID: 00003F63

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F63

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#1

Source group ID

GROUPID

From -1 to 65,535#1

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the server or logical host where the Event Base Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4650-I An event-source-host mapping definition was read. Processing will be performed by the definition read from the next received event. (last received event: reception time = reception-time, event database serial number = event-database-serial-number)#2

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

RUN

#1: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

#2: The format of arrival-time is replaced in the KAVB4650-I message with YYYY/MM/DD hh:mm:ss. The time set in arrival-time is based on the time zone set in the machine where JP1/IM - Manager is running.

(62) Details of event ID: 00003F64

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F64

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#1

Source group ID

GROUPID

From -1 to 65,535#1

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the host or logical host where the Event Base Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB8453-I The business group was updated. Processing will be performed from the next-received event. (last received event: reception time = reception-time, event database serial number = event-database-serial-number)#2

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

RUN

#1: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

#2: The format of arrival-time is replaced in the KAVB8453-I message with YYYY/MM/DD hh:mm:ss. The time set in arrival-time is based on the time zone set in the machine where JP1/IM - Manager is running.

(63) Details of event ID: 00003F65

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F65

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Registered time

Arrived time

ARRIVEDTIME

Arrived time

Source user ID

USERID

-1 to 65,535#

Source group ID

GROUPID

-1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the host or logical host where the Event Base Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4679-I Suppression of repeated events that match the repeated event condition (repeated-event-condition-name) will continue. (arrival time of the suppressed event = arrival-time-of-the-first-suppressed-event(YYYY/MM/DD HH:MM:SS) - arrival-time-of-the-last-suppressed-event(YYYY/MM/DD HH:MM:SS), event database serial number of the suppressed event = event-database-serial-number-of-the-first-suppressed-event - event-database-serial-number-of-the-last-suppressed-event)

Extended attribute

Common information

Event level

SEVERITY

Notice

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Duplicate attribute value information 1

SAMEATTR1

Stores the first (listed at the top) attribute name and its value as a duplicate attribute value condition in attribute-name=attribute-value format. If a duplicate attribute value condition is not specified, a blank is stored.

You can specify a maximum of 1,024 bytes for the attribute value. For a value larger than 1,024 bytes, split it, but do so without splitting a multi-byte character.

Duplicate attribute value information 2

SAMEATTR2

Stores the second attribute name and its value as a duplicate attribute value conditions in attribute-name=attribute-value format. If there are fewer than two duplicate attribute value conditions, a blank is stored.

You can specify a maximum of 1,024 bytes for the attribute value. For a value larger than 1,024 bytes, split it, but do so without splitting a multi-byte character.

Duplicate attribute value information 3

SAMEATTR3

Stores the third attribute name and its value as a duplicate attribute value condition in attribute-name=attribute-value format. If there are fewer than three duplicate attribute value conditions, a blank is stored.

You can specify a maximum of 1,024 bytes for the attribute value. For a value larger than 1,024 bytes, split it, but do so without splitting a multi-byte character.

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(64) Details of event ID: 00003F68

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F68

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the server or logical host where the Event Base Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB8454-W The business group could not be updated. (cause = cause)

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVTCON

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(65) Details of event ID: 00003F69

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F69

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65,535#

Source group ID

GROUPID

From -1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the server or logical host where Event Base Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB8456-E The business group could not be updated. (cause = cause)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVTCON

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(66) Details of event ID: 00003F6A

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F6A

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Registered time

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65535#1

Source group ID

GROUPID

From -1 to 65535#1

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the server or logical host where Event Base Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4623-I The display message change definition has been read. Next, processing will be performed using the definition read from the received event. (arrival time of the last received event = arrival-time, serial number in the event database = event-database-serial-number)#2

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

RUN

#1: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

#2: The format of arrival-time is replaced in the KAVB4623-I message with YYYY/MM/DD hh:mm:ss. The time set in arrival-time is based on the time zone set in the machine where JP1/IM - Manager is running.

(67) Details of event ID: 00003F71

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F71

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Registered time

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

-1 to 65,535#

Source group ID

GROUPID

-1 to 65,535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the server or logical host where Event Base Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4802-I A severity change definition was registered. (severity change definition name = severity-change-definition-name, registering user = user-name)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVTCON

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(68) Details of event ID: 00003F76

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F76

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Registered time

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65535#

Source group ID

GROUPID

From -1 to 65535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the server or logical host where Event Base Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB4803-I A display message change definition was registered. (display message change definition name = display-message-change-definition-name, registering user = user-name)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVFLOW

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVFLOW

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(69) Details of event ID: 00003F77

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F77

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Registered time

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65535#

Source group ID

GROUPID

From -1 to 65535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the server or logical host where Event Console Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB5800-I The definition file for extended event attributes was read in to JP1/IM - Manager.

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVTCON

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(70) Details of event ID: 00003F78

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F78

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Registered time

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65535#

Source group ID

GROUPID

From -1 to 65535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the server or logical host where Event Console Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB5804-E An attempt to read the definition file for extended event attributes failed because part of the definition file for extended event attributes could not be read.

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVTCON

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(71) Details of event ID: 00003F7C

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00003F7C

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

0

Registered time

TIME

Registered time

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

From -1 to 65535#

Source group ID

GROUPID

From -1 to 65535#

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

Blank

Event-issuing server name

SOURCESERVER

Name of the server or logical host where Event Console Service is running

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB1981-I The definition file for opening monitor windows was applied to JP1/IM - Manager.

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/EVENTCONSOLE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

EVTCON

Occurrence

OCCURRENCE

RUN

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(72) Details of event ID: 00003FB0

Attribute type

Item

Attribute name

Description

Basic attribute

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Message

MESSAGE

KAVB7900-I Status of monitoring-node-name is changed status from status.

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/SCOPE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

IM_CS

Occurrence

OCCURRENCE

STATUS_CHANGE

User-specific or program-spe-cific information

Monitoring node ID

MON_NODE_ID

ID of the monitoring node

Monitoring node name

MON_NODE_NAME

Name of the monitoring node

Monitoring node status#1

MON_NODE_STATUS

StatusID of the monitoring node

Information about the JP1 event resulting in the status change#2

attributes

Attributes (the name of a basic attribute is prefixed with JCS_B_, and the name of an extended attribute is prefixed with JCS_E_)

#1: For the monitoring node status (E.MON_NODE_STATUS), the status of the monitoring node that issued the JP1 event is stored in StatusID, expressed as a numeric value as shown below:

Value of StatusID (monitoring node status):

Emergency: 800; Alert: 700; Critical: 600; Error: 500; Warning: 400; Normal: 300; Debug: 200; Initial: 100

For example, if a JP1 event is issued when the monitoring node status has changed to Emergency, its monitoring node status (E.MON_NODE_STATUS) would be 800.

#2: The item Information about the JP1 event resulting in the status change cannot be checked by JP1/IM - View. All information about the JP1 event resulting in the status change is stored in this item as sets of attribute-name-attribute-value. If 00003FB0 exceeds the maximum length for a JP1 event (10,000 bytes), JP1/IM stores as much JP1 event information as fits. If the number of extended attributes exceeds 100, JP1/IM stores as much JP1 event information as fits, but no more than 100 extended attributes. The attributes E.JCS_B_TIME (registration time of the JP1 event resulting in the status change) and E.JCS_B_ARRIVEDTIME (arrival time of the JP1 event resulting in the status change) are stored in this item in GMT in the format YYYY/MM/DD hh:mm:ss.

(73) Details of event ID: 00003FB1

Attribute type

Item

Attribute name

Description

Basic attribute

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Event ID

--

00003FB1

Message

MESSAGE

KAVB7901-W The number of status change event for the monitored node monitoring-node-ID# has reached the threshold.

Extended attribute

Common information

Event level

SEVERITY

WARNING

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/SCOPE

Object type

OBJECT_TYPE

SERVICE

Object name

OBJECT_NAME

IM_CS

Occurrence

OCCURRENCE

NOTICE

User-specific or program-spe-cific information

Monitoring node ID

MON_NODE_ID

ID of the monitoring node

Number of status change events

EVHIST_NUMBER

Number of status change events

Legend:

--: None

#: Only one JP1 event with event ID 00003FB1 is issued even if a single JP1 event triggered more than 100 status change events from multiple monitoring objects. A maximum of 10 monitoring object IDs can be listed in monitoring-node-ID in the message, separated by the comma. If there are more than 10 monitoring object IDs, ... is displayed following the last listed ID.

(74) Details of event ID: 00003FC0

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FC0

Message

MESSAGE

KNAN26102-E The remote log-file trap cannot start. (Code: code, Host name: host name, Monitoring-target-name: monitoring-target-name)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

In Windows:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP/program-name,

where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP

In UNIX:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP/program-name,

where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitoring name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitoring name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitoring stop time

WATCH_STOP_TIME

Time that log file monitoring stopped (absolute time in seconds since UTC 1970-01-01 00:00:00)

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(75) Details of event ID: 00003FC1

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FC1

Message

MESSAGE

KNAN26094-E The relevant log file could not be read after the specified number of retires, so monitoring will stop. (Code: code, Host name: host-name, Monitoring-target-name: monitoring-target-name, Log file name: Log file name)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

In Windows:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP/program-name,

where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP

In UNIX:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP/program-name,

where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitoring name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitoring name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitoring stop time

WATCH_STOP_TIME

Time that log file monitoring stopped (absolute time in seconds since UTC 1970-01-01 00:00:00)

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(76) Details of event ID: 00003FC2

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FC2

Message

MESSAGE

KNAN26095-E The relevant log file can no longer be monitored. (Code: code, Host name: host-name, Monitoring-target-name: monitoring-target-name, Log file name: Log file name)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

In Windows:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP/program-name, where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP

In UNIX:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP/program-name, where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitoring name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitoring name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Time an abnormality detected

WATCH_CHECK_TIME

Time that a log file error was detected (absolute time in seconds since UTC 1970-01-01 00:00:00)

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(77) Details of event ID: 00003FC3

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FC3

Message

MESSAGE

KNAN26057-E The remote log-file trap will stop due to error. (Code: code, Host name: host name, Monitoring-target-name: monitoring-target-name)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

In Windows:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP/program-name, where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP

In UNIX:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP/program-name, where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitoring name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitoring name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Time an abnormality detected

WATCH_CHECK_TIME

Time that a log file error was detected (absolute time in seconds since UTC 1970-01-01 00:00:00)

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(78) Details of event ID: 00003FC5

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FC5

Message

MESSAGE

KNAN26140-W The amount of data that a remote log file trap collected from the log file exceeded the limit. The log entries output from the last collection time to this collection time will not be output as JP1 events. (host name: host name, monitoring-target name: monitoring-target-name, log file name: Log file name, previous collection time: Last collection time(yyyy/MM/dd hh:mm:ss), this collection time: This collection time(yyyy/MM/dd hh:mm:ss))

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

In Windows:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP/program-name, where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP

In UNIX:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP/program-name, where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitoring name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitoring name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(79) Details of event ID: 00003FC6

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FC6

Message

MESSAGE

KNAN26351-E All trapping of remote log files on monitored host "monitored-host-name" will now stop. (cause = cause)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

In Windows:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP

In UNIX:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitored host name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitored host name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitoring stop time

WATCH_STOP_TIME

Time that log file monitoring stopped (absolute time in seconds since UTC 1970-01-01 00:00:00)

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(80) Details of event ID: 00003FC7

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FC7

Message

MESSAGE

KNAN26350-W The backup files for the monitored log files were not found. The log entries output to the backup files between the previous collection time and the current collection time will not be output as JP1 events. (host name = monitored-host-name, monitoring target = monitoring-target-name, log file name = monitored-log-file-name, previous collection time = yyyy/MM/dd hh:mm:ss, current collection time = yyyy/MM/dd hh:mm:ss, user = user, command line that was executed = command-line-executed)

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

In Windows:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP/program-name, where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP

In UNIX:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP/program-name, where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitoring target name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitored host name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(81) Details of event ID: 00003FC8

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FC8

Message

MESSAGE

KNAN26352-W The backup files for the monitored log files were not found. The log entries output to the backup files between the previous collection time and the current collection time will not be output as JP1 events. (host name = monitored-host-name, monitoring target = monitoring-target-name, log file name = monitored-log-file-name, last collection time = yyyy/MM/dd hh:mm:ss, current collection time = yyyy/MM/dd hh:mm:ss, user = user)

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

In Windows:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP/program-name, where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP

In UNIX:

When the -p option of the jcfallogstart command is specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP/program-name, where program-name is the log data output source program name specified by the -p option of the jevlogstart command.

When the -p option of the jcfallogstart command is not specified:

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitoring target name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitored host name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(82) Details of event ID: 00003FC9

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FC9

Message

MESSAGE

KNAN26353-E Trapping of remote event log files on monitored host "monitored-host-name" will now stop. (cause = cause)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/REMOTE_NTEVENT_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitored host name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitored host name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitoring stop time

WATCH_STOP_TIME

Time that log file monitoring stopped (absolute time in seconds since UTC 1970-01-01 00:00:00)

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(83) Details of event ID: 00003FD0

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FD0

Message

MESSAGE

KNAN26107-E The remote event-log trap cannot start. (Code: code, Host name: host name)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/REMOTE_NTEVENT_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitored host name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitored host name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Error detection time

ERROR_TIME

Time that the error occurred (absolute time in seconds since UTC 1970-01-01 00:00:00)

API where error occurred

ERROR_FUNCTION

Name of the Windows API where the error occurred

Cause of error

ERROR_CAUSE_ID

Error cause code

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(84) Details of event ID: 00003FD1

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FD1

Message

MESSAGE

KNAN26028-E Monitoring will now stop because the event log could not be read after the specified number of retries. (Code: code, Host name: host name)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/REMOTE_NTEVENT_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitored host name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitored host name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Error detection time

ERROR_TIME

Time that the error occurred (absolute time in seconds since UTC 1970-01-01 00:00:00)

API where error occurred

ERROR_FUNCTION

Name of the Windows API where the error occurred

Cause of error

ERROR_CAUSE_ID

Error cause code

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(85) Details of event ID: 00003FD2

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FD2

Message

MESSAGE

KNAN26027-I The system will now retry reading the event log. (Code: code, Host name: host name)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/REMOTE_NTEVENT_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitored host name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitored host name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Error detection time

ERROR_TIME

Time that the error occurred (absolute time in seconds since UTC 1970-01-01 00:00:00)

API where error occurred

ERROR_FUNCTION

Name of the Windows API where the error occurred

Cause of error

ERROR_CAUSE_ID

Error cause code

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(86) Details of event ID: 00003FD3

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FD3

Message

MESSAGE

KNAN26002-E The remote event-log trap will now stop due to error. (Code: code, Host name: host name)

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/REMOTE_NTEVENT_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitored host name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitored host name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Error detection time

ERROR_TIME

Time that the error occurred (absolute time in seconds since UTC 1970-01-01 00:00:00)

Cause of error

ERROR_CAUSE_ID

Error cause code

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(87) Details of event ID: 00003FD4

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FD4

Message

MESSAGE

KNAN26026-I An event log can now be monitored. (Host name: host name)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/REMOTE_NTEVENT_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitored host name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitored host name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Error detection time

ERROR_TIME

Time that the error occurred (absolute time in seconds since UTC 1970-01-01 00:00:00)

Error recovery time

RECOVER_TIME

Time that the program was recovered after the error (absolute time in seconds since UTC 1970-01-01 00:00:00)

Cause of error

ERROR_CAUSE_ID

Error cause code

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(88) Details of event ID: 00003FD5

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FD5

Message

MESSAGE

KNAN26142-W The amount of data that a remote event-log trap collected from the host exceeded the limit. The event-log entries output from the last collection time to this collection time will not be output as JP1 events. (host name = host name,previous collection time = Last collection time(yyyy/MM/dd hh:mm:ss),this collection time = This collection time(yyyy/MM/dd hh:mm:ss))

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/REMOTE_NTEVENT_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitored host name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitored host name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(89) Details of event ID: 00003FD6

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FD6

Message

MESSAGE

KNAN26339-W Failed to save the state of the remote log file trap when the log was collected. (host name = monitored-host-name, monitoring target = monitoring-target-name)

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

In Windows:

(When the -p option of the jcfallogstart command is specified)

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP/program-name, where program-name is the name of the program that output the log data and that is specified for the -p option of the jevlogstart command

(When the -p option of the jcfallogstart command is not specified)

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP

In UNIX:

(When the -p option of the jcfallogstart command is specified)

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP/program-name, where program-name is the name of the program that output the log data and that is specified for the -p option of the jevlogstart command

(When the -p option of the jcfallogstart command is not specified)

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitoring target name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitoring target name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(90) Details of event ID: 00003FD7

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FD7

Message

MESSAGE

KNAN26340-W Failed to save the state of the remote event log trap when the log was collected. (host name = monitored-host-name)

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/REMOTE_NTEVENT_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitored host name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitored host name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(91) Details of event ID: 00003FD8

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FD8

Message

MESSAGE

KNAN26341-W Failed to restore the remote log file trap to its state when it was last terminated. (host name = monitored-host-name, monitoring target = monitoring-target-name)

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

In Windows:

(When the -p option of the jcfallogstart command is specified)

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP/program-name, where program-name is the name of the program that output the log data and that is specified for the -p option of the jevlogstart command

(When the -p option of the jcfallogstart command is not specified)

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP

In UNIX:

(When the -p option of the jcfallogstart command is specified)

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP/program-name, where program-name is the name of the program that output the log data and that is specified for the -p option of the jevlogstart command

(When the -p option of the jcfallogstart command is not specified)

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitoring target name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitoring target name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(92) Details of event ID: 00003FD9

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FD9

Message

MESSAGE

KNAN26342-W Failed to restore the remote log file trap to its state when it was last terminated. (host name = monitored-host-name)

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/REMOTE_NTEVENT_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitored host name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitored host name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(93) Details of event ID: 00003FDA

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FDA

Message

MESSAGE

KNAN26343-W The remote log file trap was not restored to its state when it was last terminated, because the trap was in a state where it could not be monitored. (details = detailed-information, host name = monitored-host-name, monitoring target = monitoring-target-name, log file name = log-file-name)

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

In Windows:

(When the -p option of the jcfallogstart command is specified)

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP/program-name, where program-name is the name of the program that output the log data and that is specified for the -p option of the jevlogstart command

(When the -p option of the jcfallogstart command is not specified)

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP

In UNIX:

(When the -p option of the jcfallogstart command is specified)

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP/program-name, where program-name is the name of the program that output the log data and that is specified for the -p option of the jevlogstart command

(When the -p option of the jcfallogstart command is not specified)

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitoring target name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitoring target name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(94) Details of event ID: 00003FDB

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FDB

Message

MESSAGE

KNAN26345-I An error in the processing to save the state of the remote log file trap that occurred during log collection was resolved. (host name = monitored-host-name, monitoring target = monitoring-target-name)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

In Windows:

(When the -p option of the jcfallogstart command is specified)

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP/program-name, where program-name is the name of the program that output the log data and that is specified for the -p option of the jevlogstart command

(When the -p option of the jcfallogstart command is not specified)

/HITACHI/JP1/IM/REMOTE_NT_LOGTRAP

In UNIX:

(When the -p option of the jcfallogstart command is specified)

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP/program-name, where program-name is the name of the program name that output the log data and that is specified for the -p option of the jevlogstart command

(When the -p option of the jcfallogstart command is not specified)

/HITACHI/JP1/IM/REMOTE_UX_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitoring target name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitoring target name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(95) Details of event ID: 00003FDC

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003FDC

Message

MESSAGE

KNAN26346-I An error in the processing to save the state of the remote event log trap that occurred during log collection was resolved. (host name = monitored-host-name, monitoring target = monitoring-target-name)

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/REMOTE_NTEVENT_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Monitored host name

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Monitored host name

Occurrence

OCCURRENCE

NOTICE

User-specific or program-specific information

Monitored host name

JP1_SOURCEHOST

Monitored host name

Legend:

--: None

(96) Event ID: Value specified for the ACTDEF parameter of the remote monitoring log file trap definition file

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

The value specified for the ACTDEF parameter

Message

MESSAGE

Data content of one line in a log file

Event issuing time

--

Time that the event was issued

Extended attribute

Common information

Event level

SEVERITY

Severity specified by the ACTDEF parameter in the action definition file

Product name

PRODUCT_NAME

In Windows:

When the -p option is specified for the jcfallogdef command, the jcfallogstart command, and the startup option of remote monitoring:

/HITACHI/JP1/NT_LOGTRAP/program-name,

where program-name is the log data output source program name specified by the -p option.

When the -p option is not specified for the jcfallogdef command, the jcfallogstart command, and the startup option for remote monitoring:

/HITACHI/JP1/NT_LOGTRAP

In UNIX:

When the -p option is specified for the jcfallogdef command, the jcfallogstart command, and the startup option for remote monitoring:

/HITACHI/JP1/UX_LOGTRAP/program-name,

where program-name is the log data output source program name specified by the -p option.

When the -p option is not specified for the jcfallogdef command, the jcfallogstart command, and the startup option for remote monitoring:

/HITACHI/JP1/UX_LOGTRAP

Object type

OBJECT_TYPE

LOGFILE

Object name

OBJECT_NAME

Name of log file to be monitored

Root object type

ROOT_OBJECT_TYPE

LOGFILE

Root object name

ROOT_OBJECT_NAME

Name of log file to be monitored

User-specific or program-specific information

Platform

PLATFORM

In Windows: NT

In UNIX: UNIX

PP name

PPNAME

/HITACHI/JP1/IM/REMOTE_MONITORING/LOGTRAP

Host name

JP1_SOURCEHOST

Event source host name (Monitored host name)

Monitoring ID

E.JP1_TRAP_ID#

ID number of a log file trap

Monitoring name

E.JP1_TRAP_NAME#

Monitoring name

Legend:

--: None

#: An attribute that exists when the JP1/Base version of Manager is 10-50 or later.

(97) Details of event ID: 00003A71, or the event ID specified in the filter block of the remote-monitoring event log trap action-definition file

Attribute type

Item

Attribute name

(WMI attribute name)

Description

Basic attribute

Event ID

B.ID

Event ID specified in the filter block of the remote-monitoring event log trap action-definition file.

If no event ID is specified, the value is set to 00003A71.

Message

B.MESSAGE

(Message or InsertionStrings)

Event log message.#1

A maximum of 1,023 bytes. If the limit is exceeded, the excess bytes are discarded.

Event issuing time

--

Time that the event was issued

Extended attribute

Common information

Event level

E.SEVERITY

(EventType)

Registration is according to the event log type:

Error: Error

Warning: Warning

Information: Information, details, and other types of information

Notice: Successful audit, failed audit

Event source product name

E.PRODUCT_NAME

(SourceName)

/HITACHI/JP1/NTEVENT_LOGTRAP/source

Object type

E.OBJECT_TYPE

E.ROOT_OBJECT_TYPE

LOGFILE

Object name

E.OBJECT_NAME

E.ROOT_OBJECT_NAME

NTEVENTLOG

User-specific or program-specific information

Event log registration date and time

E.A0

(TimeGenerated)

time_t type (absolute time in seconds since UTC 1970-01-01 00:00:00)

Computer name

E.A1

(ComputerName)

Computer name value

host-name.domain-name-displayed-when-hostname-command- executed

Type

E.A2

(Logfile)

Value indicating the event log type

Type

E.A3

(Type)

Value corresponding to the event log level

Category

E.A4

(CategoryString or Category)

Value for the event log task category

Event ID

E.A5

(EventCode)

Value for the event log event ID

User name

E.A6

(User)

Value for the event log user name

Platform

E.PLATFORM

NT

PP name

E.PPNAME

/HITACHI/JP1/IM/AGENTLESS/EVENTLOGTRAP

Event source host name

E.JP1_SOURCEHOST#2

Monitored host name

Log file trap name

E.JP1_TRAP_NAME

Log file trap name specified in the remote-monitoring event log trap action-definition file. Not output if unspecified (attribute does not exist).

Legend:

--: None

#1: If the message DLL in which the description of an event log is coded is not set correctly, the inserted phrase or the detail code is enclosed in double-quotation marks (") to register it in a JP1 event message.

#2: An attribute that exists only when the common definition (ATTR_EVENT_LOGTRAP_SOURCEHOST) is 1.

(98) Details of event ID: 00003F90

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003F90

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of jco_spmd

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB3737-E The component-name managed-process-name terminated abnormally.

Extended attribute

Common information

Event level

SEVERITY

Error

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/SPMD

Object type

OBJECT_TYPE

SPMD

Object name

OBJECT_NAME

Name of the process that terminated abnormally

Occurrence

OCCURRENCE

NOTICE

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(99) Details of event ID: 00003F91

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003F91

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of jco_spmd

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB3613-W A component-name timeout occurred in managed-process-name. Processing continues.

Extended attribute

Common information

Event level

SEVERITY

Warning

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/SPMD

Object type

OBJECT_TYPE

SPMD

Object name

OBJECT_NAME

Name of the process resulting in a start timeout

Occurrence

OCCURRENCE

NOTICE

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(100) Details of event ID: 00003F92

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

--

00003F92

Serial number

SEQNO

Serial number

Source process ID

PROCESSID

Process ID of jco_spmd

Registered time

TIME

Time of registration

Arrived time

ARRIVEDTIME

Arrival time

Source user ID

USERID

In Windows

From -1 to 65,535#

In UNIX

0

Source group ID

GROUPID

In Windows

From -1 to 65,535#

In UNIX

0

Source user name

USERNAME

In Windows

SYSTEM

In UNIX

root

Source group name

GROUPNAME

In Windows

Blank

In UNIX

root

Event-issuing server name

SOURCESERVER

Name of the event-issuing server

Source serial number

SOURCESEQNO

Source serial number

Message

MESSAGE

KAVB3616-I Restart of the component-name managed-process-name has finished.

Extended attribute

Common information

Event level

SEVERITY

Information

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/SPMD

Object type

OBJECT_TYPE

SPMD

Object name

OBJECT_NAME

Name of the process that was restarted

Occurrence

OCCURRENCE

NOTICE

Legend:

--: None

#: The substitute user ID and substitute group ID specified in the event server settings file of JP1/Base are set. If they are not specified, -1 is set.

(101) Details of event ID: 00006400

Attribute type

Item

Attribute name

Description

Basic attribute

Event ID

ID

00006400

Serial number

SEQNO

Serial number#

Reason for registration

REASON

Value from 1 to 4#

Source process ID

PROCESSID

0

Registered time

TIME

Registered time#

Arrived time

ARRIVEDTIME

Arrival time#

Source user ID

USERID

In Windows#

From -1 to 65535

In UNIX#

0

Source group ID

GROUPID

In Windows#

From -1 to 65535#

In UNIX#

0

Source user name

USERNAME

In Windows#

SYSTEM

In UNIX#

root

Source group name

GROUPNAME

In Windows#

Blank

In UNIX#

root

Event-issuing server name

SOURCESERVER

Event-issuing server name#

Target event server name

DESTSERVER

Target event server name#

Source IP address

EVIPADDR

Event source IP address#

IPv4: The format is aaa.bbb.ccc.ddd (decimal values of 1-3 digits with no leading zeros).

IPv6: The format is aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh (hexadecimal values of from 1 to 4 digits with no leading zeros).

Destination IP address

--

Event destination IP address#

Source serial number

SOURCESEQNO

Source serial number#

Code set

--

Language code that JP1/IM - Manager is using#

Message

MESSAGE

If the message was changed by the display message change function, the changed message is set.

If the message was not changed, the message text of the original event is set.

Detailed information

--

Not set

Extended attribute

Common information

Event level

SEVERITY

If the event level of the original event was changed by the severity changing function, the changed event level is set.

If the event level was not changed, the original event's event level is set.

User name

USER_NAME

Original event's USER_NAME

Product name

PRODUCT_NAME

/HITACHI/JP1/IM/MO

Object type

OBJECT_TYPE

Original event's OBJECT_TYPE

Object name

OBJECT_NAME

Original event's OBJECT_NAME

Root object type

ROOT_OBJECT_TYPE

Original event's ROOT_OBJECT_TYPE

Root object name

ROOT_OBJECT_NAME

Original event's ROOT_OBJECT_NAME

Object ID

OBJECT_ID

Original event's OBJECT_ID

Occurrence

OCCURRENCE

Original event's OCCURRENCE

Start time

START_TIME

Original event's START_TIME

End time

END_TIME

Original event's END_TIME

Return code

RESULT_CODE

Original event's RESULT_CODE

Basic attribute of original event

Serial number

B_SEQNO

Original event's serial number

Event ID

B_ID

Original event's event ID.

The format is basic-code:extended-code. The basic code and extended code are hexadecimal values of up to 8 digits with no leading zeros.

Reason for registration

B_REASON

Original event's reason for registration

Source process ID

B_PID

Original event's source process ID

Registered time

B_DATE

Sets the date portion of the original event's registered date and time in the format YYYY/MM/DD. The result is a character string that has been converted to the server's time zone.

B_TIME

Sets the time portion of the original event's registered date and time in the format hh:mm:ss. The result is a character string that has been converted to the server's time zone.

Arrived time

B_ARVDATE

Sets the date portion of the original event's arrival date and time in the format YYYY/MM/DD. The result is a character string that has been converted to the server's time zone.

B_ARVTIME

Sets the time portion of the original event's arrival date and time in the format hh:mm:ss. The result is a character string that has been converted to the server's time zone.

Source user ID

B_USRID

Original event's source user ID

Source group ID

B_GRPID

Original event's source group ID

Source user name

B_USR

Original event's source user name

Source group name

B_GRP

Original event's source group name

Event-issuing server name

B_HOST

Original event's event-issuing server name

Destination event server name

B_DESTSERVER

Original event's destination event server name

Source IP address

B_IPADDR

Original event's source IP address

Destination IP address

B_DESTIPADDR

Original event's destination IP address

Sequence number by source

B_SRCNO

Original event's sequence number by source

Code set

B_CODESET

Original event's code set

Message

B_MSG

Original event's message

Detailed information

B_DETAIL

Original event's detailed information

If the detailed information is a character string: Set to the detailed information character string unchanged

If the detailed information is in binary format: Set to blank

Extended attribute of original event: Common information

Event level

E_SEVERITY

Original event's SEVERITY

(if the event level was changed by the severity changing function, the changed event level is set)

Product name

E_PRODUCT_NAME

Original event's PRODUCT_NAME

Extended attribute of original event: Program-specific information

Extended attribute of original event: Program-specific information

E_*

The original event's extended attribute program-specific information is set.

These are items with E_ prefixed to the original event's attribute name.

For example, if the original event's extended attribute name is PLATFORM and the content is NT, the event's attribute name after conversion will be E_PLATFORM, and the content will still be NT.

However, if the original event's extended attribute name is 31 bytes long or greater, the E_ will be omitted from the converted event attribute name.

JP1/IM - M program-specific information

Event source information

EVTSRC_INFO

When the host mapping function is enabled in JP1/IM - Manager:

Source host (E.JP1_SOURCEHOST)

When the host mapping function is disabled in JP1/IM - Manager:

Event-issuing server name (B.SOURCESERVER)

JP1/IM - MO version

MO_VERSION

1100

Event source name

EVTSRC_NAME

When E.JP1ADD_EVTSRC_NAME is in the original event:

E.JP1ADD_EVTSRC_NAME

When E.JP1ADD_EVTSRC_NAME is not in the original event:

Event-issuing server name (B.SOURCESERVER)

Target system name

SYSTEM_NAME

When E.JP1ADD_SYSTEM_NAME is in the original event:

E.JP1ADD_SYSTEM_NAME

When E.JP1ADD_SYSTEM_NAME is not in the original event:

In a non-Japanese language environment, ALLSYSTEM is set.

Extended attribute storage result

ADDEXTATTR_RESULT

The extended attributes' storage result is set.

The sum of the following values is set as a two-byte hexadecimal value.

0: The values of all extended attributes were able to be stored.

1: The maximum number of extended attributes (100) was reached, so some attributes could not be stored.

2: The maximum total size of extended attributes (10 KB) was reached, so some attributes could not be stored.

4: One or more extended attributes were stored without the E_ prefix because the maximum name length was exceeded.

8: One or more extended attributes could not stored due to a naming conflict with other extended attributes.

Legend:

--: None

#: Set by JP1/Base.

Note: Original event refers to the event that JP1/IM - Manager acquired from JP1/Base.

4 Lists of System-Monitoring Objects (for Central Scope)

This chapter describes the system-monitoring objects provided by JP1/IM.

4.1 About system-monitoring objects

System-monitoring objects are provided by the system, and the basic setting items for each product are already defined.

For details about functions related to monitoring trees and monitoring objects to be described in this chapter, and how to view tables, see 5.2 Monitoring tree in the JP1/Integrated Management 2 - Manager Overview and System Design Guide. Also, for details about how to set monitoring trees or monitoring objects, see 6.3 Using the GUI to create a monitoring tree in the JP1/Integrated Management 2 - Manager Configuration Guide.

4.2 List of products for which system-monitoring objects are supported

The table below lists the products for which JP1/IM - Manager provides system-monitoring objects and, for each product, indicates whether the automatic generation function is supported.

Support of the automatic generation function for products for which JP1/IM - Manager provides system-monitoring objects

Table 4‒1: Products for which JP1/IM - Manager provides system-monitoring objects and the automatic generation function support status

Product name

Automatic generation function

JP1/AJS2 07-00 or later, JP1/AJS3 09-00 or later

Supported#3

JP1/Cm2/SSO Version 7 or Version 8#1, #2

Supported#3

JP1/Cm2/SSO 07-00 or later#1, #2

Supported#3

JP1/PFM 07-00 or later

Supported#3

JP1/PAM 07-00 or later

Not supported

JP1/Software Distribution 07-00 or later

Not supported

HP NNM Version 7 or Version 8#2

Not supported

JP1/NNMi

Not supported

JP1/IM - Central Console 07-00 or later

Supported#3

Cosminexus 06-00 or later

Supported#3

HiRDB 07-02 or later

Not supported

#1: The product name for version 7 is JP1/PFM/SSO.

#2: To use the automatic generation function, JP1/Base Version 7 or Version 8 must be installed on the host where the linked product is installed.

#3: To use the automatic generation function, JP1/Base version 07-00 or later must be installed on the host where the linked product is installed. You also need an installed copy of JP1/IM - View with the same version as JP1/IM - Manager.

4.3 System-monitoring objects for JP1/AJS

The AJS Monitoring Object and Jobnet Monitoring (AJS) system-monitoring objects are provided For JP1/AJS.

4.3.1 AJS Monitoring system-monitoring object

Table 4‒2: Overview of the system-monitoring object

Item

Description

Monitoring node type

AJS Monitoring Object

Purpose

Monitoring of JP1/AJS itself for failures and for the jobnet execution status

Basic information

Object name

Complete name of the jobnet (scheduler-service-name:/jobnet-name)

Example: AJSROOT1:/Job_A/Order_Processing

Host name

Host name of the manager where JP1/AJS - Manager is installed

Example: host01

Table 4‒3: Status change conditions

Status change condition

Common condition# and individual condition

Condition name

Status

Condition

Values to be compared

Jobnet warning event (AJS)

Warning

Jobnet warning event (AJS)#

Event ID (B.ID)

00004108, 00004122, 00004123

Object ID (E.OBJECT_NAME)

Object name in the basic information

Event-issuing server name (B.SOURCESERVER)

Host name in the basic information

Jobnet error event (AJS)

Error

Jobnet error event (AJS)#

Event ID (B.ID)

00004104, 00004131, 00004142, 00004143, 00004144

Object ID (E.OBJECT_NAME)

Object name in the basic information

Event-issuing server name (B.SOURCESERVER)

Host name in the basic information

System warning event (AJS)

Warning

System warning event (AJS)#

Event ID (B.ID)

00004154, 00004164, 00004171, 000041F1

Event-issuing server name (B.SOURCESERVER)

Host name in the basic information

System error event (AJS)

Error

System error event (AJS)#

Event ID (B.ID)

00004110, 00004130, 00004152, 00004162, 00004170, 000041F0, 000041F3

Event-issuing server name (B.SOURCESERVER)

Host name in the basic information

#: This is a common condition (condition commonly used in monitoring objects).

4.3.2 Jobnet Monitoring (AJS) system-monitoring object

Table 4‒4: Overview of the system-monitoring object

Item

Description

Monitoring node type

Jobnet Monitoring(AJS)

Purpose

Monitoring of job execution status

Basic information

Job execution host

Name of the host that executes the job

Example: jp1-agent

Event-issuing server

Name of the host where JP1/AJS - Manager is installed

Example: jp1-manager

Registration name

Complete name of the root jobnet (scheduler-service-name:/root-jobnet-name)

Example: AJSROOT1:/Job_A/Order_Processing

Table 4‒5: Status change conditions

Status change condition

Common condition# and individual condition

Condition name

Status

Condition

Values to be compared

Job warning event (AJS)

Warning

Job warning event (AJS)#

Event ID (B.ID)

00004109

Registration name (E.ROOT_OBJECT_NAME)

Registration name in the basic information

Execution host name (E.C0)

Job execution host in the basic information

Event-issuing server name (B.SOURCESERVER)

Event-issuing server in the basic information

Job error event (AJS)

Error

Job error event (AJS)#

Event ID (B.ID)

00004107

Registration name (E.ROOT_OBJECT_NAME)

Registration name in the basic information

Execution host name (E.C0)

Job execution host in the basic information

Event-issuing server name (B.SOURCESERVER)

Event-issuing server in the basic information

#: This is a common condition (condition commonly used in monitoring objects).

4.4 System-monitoring objects for JP1/Cm2/SSO

The SSO Monitoring, category monitoring (SSO), and application monitoring (SSO) system- monitoring objects are provided for JP1/Cm2/SSO version 8 or earlier.

4.4.1 Settings for monitoring system-monitoring objects for JP1/Cm2/SSO version 8 or earlier

This subsection provides necessary settings for monitoring system-monitoring objects for JP1/Cm2/SSO version 8 or earlier. The following items must be set:

Because JP1/Cm2/SSO version 8 or earlier does not issue JP1 events, you must use the JP1/Base function to convert SNMP traps (issued by JP1/Cm2/SSO for HP NNM version 7.5 or earlier) into JP1 events. During the conversion, you must use the SNMP trap conversion function of JP1/Base to set capturing of the variable binding of an SNMP trap.

To monitor application monitoring (SSO), you must edit the definition file (ssoapmon.def) for JP1/Cm2/SSO version 8 or earlier so that the source name of the variable binding for an SNMP trap is captured.

4.4.2 SSO Monitoring system-monitoring object

Table 4‒6: Overview of the system-monitoring object

Item

Description

Monitoring node type

SSO Monitoring

Purpose

Monitoring of failures in JP1/Cm2/SSO version 8 or earlier itself

Basic information

Host name

Host name of a monitoring server where JP1/Cm2/SSO version 8 or earlier is installed

Example: host01

Table 4‒7: Status change conditions

Status change condition

Common condition#1 and individual condition

Condition name

Status

Condition

Values to be compared

System Alert event (SSO)

Alert

System Alert event (SSO)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

---.15#2

Event-issuing host name (E.SNMP_VARBIND6)

Host name in the basic information

System error event (SSO)

Error

System error event (SSO)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

---.13#2

Event-issuing host name (E.SNMP_VARBIND6)

Host name in the basic information

#1: This is a common condition (condition commonly used in monitoring objects).

#2: --- is replaced with .iso.org.dod.internet.private.enterprises.hitachi.systemAP.comet.sso.0.

4.4.3 Category Monitoring (SSO) system-monitoring object

Table 4‒8: Overview of the system-monitoring object

Item

Description

Monitoring node type

Category Monitoring (SSO)

Purpose

Monitoring of the resource status monitored by JP1/Cm2/SSO version 8 or earlier

Basic information

Category name

Category name

Event-issuing host name

Host name of a monitoring server where JP1/Cm2/SSO version 8 or earlier is installed

Example: host01

Host name

Host name of a server monitored by JP1/Cm2/SSO version 8 or earlier

Example: host02

Table 4‒9: Status change conditions

Status change condition

Common condition#1 and individual condition

Condition name

Status

Condition

Values to be compared

Resource Alert event (SSO)

Alert

Resource Alert event (SSO)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

---.24#2

Source name (E.SNMP_VARBIND12)

Host name in the basic information

Event-issuing host name (E.SNMP_VARBIND11)

Event-issuing host name in the basic information

Category name (E.SNMP_VARBIND2)

Category name in the basic information

Resource error event (SSO)

Error

Resource error event (SSO)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

---.(21|23)#2

Source name (E.SNMP_VARBIND12)

Host name in the basic information

Event-issuing host name (E.SNMP_VARBIND11)

Event-issuing host name in the basic information

Category name (E.SNMP_VARBIND2)

Category name in the basic information

#1: This is a common condition (condition commonly used in monitoring objects).

#2: --- is replaced with .iso.org.dod.internet.private.enterprises.hitachi.systemAP.comet.sso.0.

4.4.4 Application Monitoring (SSO) system-monitoring object

Table 4‒10: Overview of the system-monitoring object

Item

Description

Monitoring node type

Application Monitoring (SSO)

Purpose

Monitoring of the application status monitored by JP1/Cm2/SSO version 8 or earlier

Basic information

Event-issuing host name

Host name of a monitoring server where JP1/Cm2/SSO version 8 or earlier is installed

Example: host01

Application name

Name of an application monitored by JP1/Cm2/SSO version 8 or earlier

Example:JP1/PFM

Host name

Host name of a server whose resources are to be collected and monitored by JP1/Cm2/SSO version 8 or earlier

Example: host02

Table 4‒11: Status change conditions

Status change condition

Common condition#1 and individual condition

Condition name

Status

Condition

Values to be compared

Application Alert event (SSO)

Alert

Application Alert event (SSO)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

---.(109|112|115)#2

Source name (E.SNMP_VARBIND3)

Host name in the basic information

Event-issuing host name (E.SNMP_VARBIND2)

Event-issuing host name in the basic information

Application name (E.SNMP_VARBIND1)

Application name in the basic information

Application error event (SSO)

Error

Application Alert event (SSO)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

---.(108|110|111|113|116|118)#2

Source name (E.SNMP_VARBIND3)

Host name in the basic information

Event-issuing host name (E.SNMP_VARBIND2)

Event-issuing host name in the basic information

Application name (E.SNMP_VARBIND1)

Application name in the basic information

Process monitoring failure warning event (SSO)

Alert

Process monitoring failure warning event (SSO)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

---.304#2

Host name of a monitored machine (E.SNMP_VARBIND1)

Host name in the basic information

Event-issuing host name (E.SNMP_VARBIND4)

Event-issuing host name in the basic information

Process monitoring failure error event (SSO)

Error

Process monitoring failure error event (SSO)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

---.303#2

Host name of a monitored machine (E.SNMP_VARBIND1)

Host name in the basic information

Event-issuing host name (E.SNMP_VARBIND4)

Event-issuing host name in the basic information

#1: This is a common condition (condition commonly used in monitoring objects).

#2: --- is replaced with .iso.org.dod.internet.private.enterprises.hitachi.systemAP.comet.sso.0.

4.5 System-monitoring objects for JP1/PFM

The Agent Monitoring (PFM) system-monitoring objects are provided for JP1/PFM.

4.5.1 Settings for monitoring system-monitoring objects for JP1/PFM

This subsection explains the necessary settings for monitoring system-monitoring objects for JP1/PFM. The following items must be set:

To manage events issued by JP1/PFM - Manager, you must specify the alarm settings of JP1/PFM - Manager in such a manner that a JP1 event is issued as an action of command execution when the alarm status changes (this is because the default setting does not issue JP1/events).

4.5.2 Agent Monitoring (PFM) system-monitoring object

Table 4‒12: Overview of the system-monitoring object

Item

Description

Monitoring node type

Agent Monitoring(PFM)

Purpose

Monitoring of the status of the JP1/PFM agent

Basic information

Object ID

Service ID of the JP1/PFM agent

Example: TA1host01

Event-issuing server

Name of the host where JP1/PFM - Manager is installed

Example: pfm-manager

Host name

Name of the host where JP1/PFM - Agent is installed

Example: pfm-agent

Table 4‒13: Status change conditions

Status change condition

Common condition#1 and individual condition

Condition name

Status

Condition

Values to be compared

Resource error event (PFM)

Error

Resource error event (PFM)#2

Event level (E.SEVERITY)

Error

Product name (E.PRODUCT_NAME)

/PFM/ALARM_EVENT

Object ID (E.OBJECT_ID)

Object ID in the basic information

Name of the host where the alarm occurred (E.JPC_AGENT)

Host name in the basic information

Event-issuing server name (B.SOURCESERVER)

Event-issuing server in the basic information

Resource warning event (PFM)

Warning

Resource warning event (PFM)#1

Event level (E.SEVERITY)

Warning

Product name (E.PRODUCT_NAME)

/PFM/ALARM_EVENT

Object ID (E.OBJECT_ID)

Object ID in the basic information

Name of the host where the alarm occurred (E.JPC_AGENT)

Host name in the basic information

Event-issuing server name (B.SOURCESERVER)

Event-issuing server in the basic information

#1: This is a common condition (condition commonly used in monitoring objects).

#2: The JP1/PFM service is identified by the product ID and function ID contained in the service ID. The following services are supported:

Service whose product ID is not P (PFM - Manager)

Service whose function ID is A (Agent Collector)

4.6 System-monitoring objects for JP1/PAM

The Metric Monitoring (PAM) and Object Monitoring (PAM) system-monitoring objects are provided for JP1/PAM.

4.6.1 Metric Monitoring (PAM) system-monitoring object

Table 4‒14: Overview of the system-monitoring object

Item

Description

Monitoring node type

Metric Monitoring(PAM)

Purpose

Monitoring of the metric status of JP1/PAM

Basic information

Host name

Name of the host monitored by JP1/PAM

Example: host1

Table 4‒15: Status change conditions

Status change condition

Common condition# and individual condition

Condition name

Status

Condition

Values to be compared

Metric error event (PAM)

Error

Metric error event (PAM)#

Event ID (B.ID)

00004602, 00004604, 0000460B

Host name (E.PAM_HOSTNAME)

Host name in the basic information

Metric warning event (PAM)

Warning

Metric warning event (PAM)#

Event ID (B.ID)

00004600, 00004603, 00004609

Host name (E.PAM_HOSTNAME)

Host name in the basic information

#: This is a common condition (condition commonly used in monitoring objects).

4.6.2 Object Monitoring (PAM) system-monitoring object

Table 4‒16: Overview of the system-monitoring object

Item

Description

Monitoring node type

Object monitoring(PAM)

Purpose

Monitoring of the status of objects managed by JP1/PAM

Basic information

Host name

Name of the host monitored by JP1/PAM

Example: host1

Table 4‒17: Status change conditions

Status change condition

Common condition# and individual condition

Condition name

Status

Condition

Values to be compared

Object error event (PAM)

Error

Object error event (PAM)#

Event ID (B.ID)

00004620, 00004625

Host name (E.PAM_HOSTNAME)

Host name in the basic information

#: This is a common condition (condition commonly used in monitoring objects).

4.7 System-monitoring objects for JP1/Software Distribution

The SD Monitoring and Distribution Job Monitoring (SD) system-monitoring objects are provided for JP1/Software Distribution.

4.7.1 SD Monitoring system-monitoring object

Table 4‒18: Overview of the system-monitoring object

Item

Description

Monitoring node type

SD Monitoring

Purpose

Monitoring of JP1/Software Distribution Manager itself for failures

Basic information

Host name

Host name of the manager where JP1/Software Distribution Manager is installed

Example: host01

Table 4‒19: Status change conditions

Status change condition

Common condition# and individual condition

Condition name

Status

Condition

Values to be compared

Critical system event (NETM/DM)

Critical

Critical system event (NETM/DM)#

Event ID (B.ID)

00010401

Event-issuing server name (B.SOURCESERVER)

Host name in the basic information

#: This is a common condition (condition commonly used in monitoring objects).

4.7.2 Distribution Job Monitoring (SD) system-monitoring object

Table 4‒20: Overview of the system-monitoring object

Item

Description

Monitoring node type

Distribution Job Monitoring (SD)

Purpose

Monitoring of the execution status of distribution jobs by JP1/Software Distribution

Basic information

Host name

Host name of the manager where JP1/Software Distribution Manager is installed

Example: host01

Table 4‒21: Status change conditions

Status change condition

Common condition# and individual condition

Condition name

Status

Condition

Values to be compared

Distribution job error event (Software Distribution)

Error

Distribution job error event (Software Distribution)#

Event ID (B.ID)

00010403

Event-issuing server name (B.SOURCESERVER)

Host name in the basic information

#: This is a common condition (condition commonly used in monitoring objects).

4.8 JP1/NNMi-type system-monitoring objects

The NNMi monitoring (NNMi) and node monitoring (NNMi) system-monitoring objects are provided for JP1/NNMi.

4.8.1 Settings for monitoring system-monitoring objects for JP1/NNMi

This subsection explains the settings required when monitoring JP1/NNMi-type system-monitoring objects. When monitoring NNMi incidents issued by JP1/NNMi, management incidents and SNMP traps are not differentiated.

When using NNMi monitoring (NNMi) or node monitoring (NNMi), set the extended attribute (NNMI_FAMILY_UK) for the JP1 event converted from the NNMi incident issued by JP1/IM - EG for NNMi.

If you do not set the NNMI_FAMILY_UK extended attribute, you cannot perform monitoring by using NNMi monitoring (NNMi) or node monitoring (NNMi).

For details about setting the NNMI_FAMILY_UK extended attribute and NNMI incidents, see the manual Job Management Partner 1/Integrated Management 2 - Event Gateway for Network Node Manager i Description, User's Guide and Reference.

4.8.2 NNMi Monitoring system-monitoring object

Table 4‒22: Overview of the system-monitoring object

Item

Description

Monitoring node type

NNMi Monitoring

Purpose

Monitoring of JP1/NNMi itself for failures

Basic information

Host name

Host name of the manager where JP1/NNMi is installed

Example: host01

Table 4‒23: Status change conditions

Status change condition

Common condition# and individual condition

Condition name

Status

Condition

Values to be compared

System alert event (NNMi)

Alert

System alert event (NNMi)#

Event ID (B.ID)

00006100

Name of the node where the event occurred (E.NNMI_SRC_NODE_NAME)

Host name

Critical system event (NNMi)

Critical

Critical system event (NNMi)#

Event ID (B.ID)

00006100

Name of the node where the event occurred (E.NNMI_SRC_NODE_NAME)

Host name

System warning event (NNMi)

Warning

System warning event (NNMi)#

Event ID (B.ID)

00006100

Name of the node where the event occurred (E.NNMI_SRC_NODE_NAME)

Host name

#: This is a common condition (condition used in common by monitoring objects).

4.8.3 Node Monitoring (NNMi) system-monitoring object

Table 4‒24: Overview of the system-monitoring object

Item

Description

Monitoring node type

Node Monitoring (NNMi)

Purpose

Monitoring of the status of nodes monitored by JP1/NNMi

Basic information

Host name

Host name of the node monitored by JP1/ NNMi

Example: host01

Table 4‒25: Status change conditions

Status change condition

Common condition# and individual condition

Condition name

Status

Condition

Values to be compared

Network alert event (NNMi)

Alert

Network alert event (NNMi)#

Event ID (B.ID)

00006100

Name of the node where the event occurred (E.NNMI_SRC_NODE_NAME)

Host name in the basic information

Critical network event (NNMi)

Critical

Critical network event (NNMi)#

Event ID (B.ID)

00006100

Name of the node where the event occurred (E.NNMI_SRC_NODE_NAME)

Host name in the basic information

Network warning event (NNMi)

Warning

Network warning event (NNMi)#

Event ID (B.ID)

00006100

Name of the node where the event occurred (E.NNMI_SRC_NODE_NAME)

Host name in the basic information

#: This is a common condition (condition commonly used in monitoring objects).

4.9 System-monitoring objects for HP NNM

The NNM Monitoring and Node Monitoring (NNM) system-monitoring objects are provided for HP NNM version 8 or earlier.

4.9.1 NNM Monitoring system-monitoring object

Table 4‒26: Overview of the system-monitoring object

Item

Description

Monitoring node type

NNM Monitoring

Purpose

Monitoring of HP NNM version 8 or earlier itself for failures

Basic information

Host name

Host name of the manager where HP NNM version 8 or earlier is installed

Example: host01

Table 4‒27: Status change conditions

Status change condition

Common condition#1 and individual condition

Condition name

Status

Condition

Values to be compared

System alert event (NNM)

Alert

System alert event (NNM)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

~.(50790429|58851330|

59179066|59179227|

59179229|59179230|

40000020)#2

Name of the node where the event occurred (E.SNMP_VARBIND2)

Host name in the basic information

Critical system event (NNM)

Critical

Critical system event (NNM)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

~.(58720265|58720270|

58851329|58851332|

59179058|59181005|

59181006|59179225|

59179228|59179232|

59179234|59180002|

59180005|59180100|

59181002|59181004|

58982397|58982398|

58982401|58982402|

58982415|58982417|

58982422|59179061|

40000028|58720263)#2

Name of the node where the event occurred (E.SNMP_VARBIND2)

Host name in the basic information

System error event (NNM)

Error

System error event (NNM)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

~.(58720266|59047936|

59179226|59179233|

59179235|58982408|

58982414|50790430|

40000021)#1

Name of the node where the event occurred (E.SNMP_VARBIND2)

Host name in the basic information

System warning event (NNM)

Warning

System warning event (NNM)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

~.(40000027|58982399|

59179065)#2

Name of the node where the event occurred (E.SNMP_VARBIND2)

Host name in the basic information

#1: This is a common condition (condition commonly used in monitoring objects).

#2: Replace ~ with .iso.org.dod.internet.private.enterprises.hp.nm.openView.hpOpenView.0.

4.9.2 Node Monitoring (NNM) system-monitoring object

Table 4‒28: Overview of the system-monitoring object

Item

Description

Monitoring node type

Node Monitoring(NNM)

Purpose

Monitoring of the status of nodes monitored by HP NNM version 8 or earlier

Basic information

Host name

Host name of the node monitored by HP NNM version 8 or earlier

Example: host01

Table 4‒29: Status change conditions

Status change condition

Common condition#1 and individual condition

Condition name

Status

Condition

Values to be compared

Critical network event (NNM)

Critical

Critical network event (NNM)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

~.58916868#2

Name of the node where the event occurred (E.SNMP_VARBIND2)

Host name in the basic information

Network warning event (NNM)

Warning

Network warning event (NNM)#1

Event ID (B.ID)

00003A80

SNMP Object ID (E.SNMP_OID)

~.(40000083|40000084|40000085|50790400|58916865)#2

Name of the node where the event occurred (E.SNMP_VARBIND2)

Host name in the basic information

#1: This is a common condition (condition commonly used in monitoring objects).

#2: Replace ~ with .iso.org.dod.internet.private.enterprises.hp.nm.openView.hpOpenView.0.

4.10 System-monitoring objects for JP1/IM - Manager

The IM Monitoring system-monitoring object is provided for JP1/IM - Manager.

4.10.1 IM Monitoring system-monitoring object

Table 4‒30: Overview of the system-monitoring object

Item

Description

Monitoring node type

IM Monitoring

Purpose

Monitoring of JP1/IM - Manager itself for failures

Basic information

Host name

Host name of the manager where JP1/IM - Manager is installed

Example: host01

Table 4‒31: Status change conditions

Status change condition

Common condition# and individual condition

Condition name

Status

Condition

Values to be compared

System warning event (IM)

Warning

System warning event (IM)#

Event ID (B.ID)

000020E6, 000020E7, 00003F91

Event-issuing server name (B.SOURCESERVER)

Host name in the basic information

System error event (IM)

Error

System error event (IM)#

Event ID (B.ID)

00002010, 00002011, 00002012, 00002020, 00002021, 000020A0, 000020E2, 000020E5, 000020E8, 00003F90

Event-issuing server name (B.SOURCESERVER)

Host name in the basic information

#: This is a common condition (condition commonly used in monitoring objects).

4.11 System-monitoring objects for Cosminexus

The Logical Server Monitoring (Cosminexus) and J2EE Application Monitoring (Cosminexus) system-monitoring objects are provided for Cosminexus.

4.11.1 Logical Server Monitoring (Cosminexus) system-monitoring object

Table 4‒32: Overview of the system-monitoring object

Item

Description

Monitoring node type

Logical Server Monitoring(Cosminexus)

Purpose

Monitoring of JP1 events related to failures at the server level#

Basic information

Domain name

Domain name of the Cosminexus server

Example: DOM001

Logical host name

Name of the logical host monitored by Cosminexus

Example: APSV001

#: JP1 events whose event level is Warning or higher are monitored.

Table 4‒33: Status change conditions

Status change condition

Common condition# and individual condition

Condition name

Status

Condition

Values to be compared

Logical server emergency event (Cosminexus)

Emergency

Logical server emergency event (Cosminexus)#

Event ID

(B.ID)

00012000, 00012080

Domain name (E.DOMAIN_NAME)

Domain name in the basic information

Logical server name (E.LOGICAL_SERVER_NAME)

Logical host name in the basic information

Logical server alert event (Cosminexus)

Alert

Logical server alert event (Cosminexus)#

Event ID

(B.ID)

00012001, 00012081

Domain name (E.DOMAIN_NAME)

Domain name in the basic information

Logical server name (E.LOGICAL_SERVER_NAME)

Logical host name in the basic information

Logical server critical event (Cosminexus)

Critical

Logical server critical event (Cosminexus)#

Event ID

(B.ID)

00012002, 00012082

Domain name (E.DOMAIN_NAME)

Domain name in the basic information

Logical server name (E.LOGICAL_SERVER_NAME)

Logical host name in the basic information

Logical server error event (Cosminexus)

Error

Logical server error event (Cosminexus)#

Event ID

(B.ID)

00012003, 00012083

Domain name (E.DOMAIN_NAME)

Domain name in the basic information

Logical server name (E.LOGICAL_SERVER_NAME)

Logical host name in the basic information

Logical server warning event (Cosminexus)

Warning

Logical server warning event (Cosminexus)#

Event ID

(B.ID)

00012004, 00012084

Domain name (E.DOMAIN_NAME)

Domain name in the basic information

Logical server name (E.LOGICAL_SERVER_NAME)

Logical host name in the basic information

#: This is a common condition (condition commonly used in monitoring objects).

4.11.2 J2EE Application Monitoring (Cosminexus) system-monitoring object

Table 4‒34: Overview of the system-monitoring object

Item

Description

Monitoring node type

J2EE Application Monitoring(Cosminexus)

Purpose

Monitoring of JP1 events related to failures at the application level#

Basic information

Domain name

Domain name of the Cosminexus server

Example: DOM001

Logical host name

Name of the logical host monitored by Cosminexus

Example: APSV001

J2EE application name

Name of the J2EE application on the logical host that is monitored by Cosminexus

Example: API

#: JP1 events whose event level is Warning or higher are monitored.

Table 4‒35: Status change conditions

Status change condition

Common condition# and individual condition

Condition name

Status

Condition

Values to be compared

J2EE application emergency event (Cosminexus)

Emergency

J2EE application emergency event (Cosminexus)#

Event ID

(B.ID)

00012090, 000120D0

Domain name (E.DOMAIN_NAME)

Domain name in the basic information

Logical server name (E.LOGICAL_SERVER_NAME)

Logical host name in the basic information

J2EE application name

(E.APPLICATION_NAME)

J2EE application name in the basic information

J2EE application alert event (Cosminexus)

Alert

J2EE application alert event (Cosminexus)#

Event ID

(B.ID)

00012091, 000120D1

Domain name (E.DOMAIN_NAME)

Domain name in the basic information

Logical server name (E.LOGICAL_SERVER_NAME)

Logical host name in the basic information

J2EE application name

(E.APPLICATION_NAME)

J2EE application name in the basic information

J2EE application critical event (Cosminexus)

Critical

J2EE application critical event (Cosminexus)#

Event ID

(B.ID)

00012092, 000120D2

Domain name (E.DOMAIN_NAME)

Domain name in the basic information

Logical server name (E.LOGICAL_SERVER_NAME)

Logical host name in the basic information

J2EE application name

(E.APPLICATION_NAME)

J2EE application name in the basic information

J2EE application error event (Cosminexus)

Error

J2EE application error event (Cosminexus)#

Event ID

(B.ID)

00012093, 000120D3

Domain name (E.DOMAIN_NAME)

Domain name in the basic information

Logical server name (E.LOGICAL_SERVER_NAME)

Logical host name in the basic information

J2EE application name

(E.APPLICATION_NAME)

J2EE application name in the basic information

J2EE application warning event (Cosminexus)

Warning

J2EE application warning event (Cosminexus)#

Event ID

(B.ID)

00012094, 000120D4

Domain name (E.DOMAIN_NAME)

Domain name in the basic information

Logical server name (E.LOGICAL_SERVER_NAME)

Logical host name in the basic information

J2EE application name

(E.APPLICATION_NAME)

J2EE application name in the basic information

#: This is a common condition (condition commonly used in monitoring objects).

4.12 System-monitoring objects for HiRDB

The HiRDB Monitoring system-monitoring objects are provided for HiRDB.

4.12.1 Settings for monitoring system-monitoring objects for HiRDB

This subsection provides necessary settings for monitoring system-monitoring objects for HiRDB. The following items must be set:

To manage HiRDB-related events, you must specify settings in such a manner that the failure information managed by HiRDB is issued as JP1events (this is because the default setting does not issue JP1 events).

4.12.2 HiRDB Monitoring system-monitoring object

Table 4‒36: Overview of the system-monitoring object

Item

Description

Monitoring node type

HiRDB Monitoring

Purpose

Monitoring of HiRDB itself for failures

Basic information

Host name

Name of the host where HiRDB is installed

Example: host02

HiRDB identifier

Identifier for identifying HiRDB

Example: PDB1

Table 4‒37: Status change conditions

Status change condition

Common condition# and individual condition

Condition name

Status

Condition

Values to be compared

HiRDB emergency event

Emergency

HiRDB emergency event#

Product name (E.PRODUCT_NAME)

/HITACHI/HiRDB

Event level (E.SEVERITY)

Emergency

Event-issuing server name (B.SOURCESERVER)

Host name in the basic information

Registration name (E.ROOT_OBJECT_NAME)

HiRDB identifier in the basic information

HiRDB alert event

Alert

HiRDB alert event#

Product name (E.PRODUCT_NAME)

/HITACHI/HiRDB

Event level (E.SEVERITY)

Alert

Event-issuing server name (B.SOURCESERVER)

Host name in the basic information

Registration name (E.ROOT_OBJECT_NAME)

HiRDB identifier in the basic information

HiRDB critical event

Critical

HiRDB critical event#

Product name (E.PRODUCT_NAME)

/HITACHI/HiRDB

Event level (E.SEVERITY)

Critical

Event-issuing server name (B.SOURCESERVER)

Host name in the basic information

Registration name (E.ROOT_OBJECT_NAME)

HiRDB identifier in the basic information

HiRDB error event

Error

HiRDB error event#

Product name (E.PRODUCT_NAME)

/HITACHI/HiRDB

Event level (E.SEVERITY)

Error

Event-issuing server name (B.SOURCESERVER)

Host name in the basic information

Registration name (E.ROOT_OBJECT_NAME)

HiRDB identifier in the basic information

HiRDB warning event

Warning

HiRDB warning event#

Product name (E.PRODUCT_NAME)

/HITACHI/HiRDB

Event level (E.SEVERITY)

Warning

Event-issuing server name (B.SOURCESERVER)

Host name in the basic information

Registration name (E.ROOT_OBJECT_NAME)

HiRDB identifier in the basic information

#: This is a common condition (condition commonly used in monitoring objects).

4.13 System-monitoring objects for JP1/ServerConductor

The Physical Host Monitoring (System Manager) system-monitoring objects are provided for JP1/ServerConductor.

4.13.1 Settings for monitoring system-monitoring objects for JP1/ServerConductor

This subsection provides necessary settings for monitoring system-monitoring objects for JP1/ServerConductor. The following items must be set:

To manage events related to a physical host managed by JP1/ServerConductor, you must set an alert detected by the manager service of JP1/ServerConductor to be issued as a JP1 event (this is because the default setting does not issue JP1 events).

4.13.2 Physical Host Monitoring (System Manager) Monitoring system-monitoring object

Table 4‒38: Overview of the system-monitoring object

Item

Description

Monitoring node type

Physical Host Monitoring (System Manager)

Purpose

Monitoring of failures related to physical hosts managed by JP1/ServerConductor

Basic information

Host name

Name of a physical host managed by System Manager

Example: host02

Table 4‒39: Status change condition

Status change condition

Common condition# and individual condition

Condition name

Status

Condition

Values to be compared

Physical host emergency event

Emergency

Physical host emergency event#

Product name (E.PRODUCT_NAME)

/HITACHI/SYSTEM_MANAGER

Event level (E.SEVERITY)

Emergency

Name of a physical host managed by JP1/ServerConductor (E.HSM_SERVER)

Host name in the basic information

Physical host alert event

Alert

Physical host alert event#

Product name (E.PRODUCT_NAME)

/HITACHI/SYSTEM_MANAGER

Event level (E.SEVERITY)

Alert

Name of a physical host managed by JP1/ServerConductor (E.HSM_SERVER)

Host name in the basic information

Physical host critical event

Critical

Physical host critical event#

Product name (E.PRODUCT_NAME)

/HITACHI/SYSTEM_MANAGER

Event level (E.SEVERITY)

Critical

Name of a physical host managed by JP1/ServerConductor (E.HSM_SERVER)

Host name in the basic information

Physical host error event

Error

Physical host error event#

Product name (E.PRODUCT_NAME)

/HITACHI/SYSTEM_MANAGER

Event level (E.SEVERITY)

Error

Name of a physical host managed by JP1/ServerConductor (E.HSM_SERVER)

Host name in the basic information

Physical host warning event

Warning

Physical host warning event#

Product name (E.PRODUCT_NAME)

/HITACHI/SYSTEM_MANAGER

Event level (E.SEVERITY)

Warning

Name of a physical host managed by JP1/ServerConductor (E.HSM_SERVER)

Host name in the basic information

#: This is a common condition (condition commonly used in monitoring objects).

5 Monitoring Tree Models (for Central Scope)

This chapter describes the structure of monitoring trees that are generated automatically.

5.1 Templates used to generate monitoring trees automatically

The configuration of an automatically-generated monitoring tree varies depending on the template selected in the Auto-generation - Select Configuration window. The following templates are provided by Central Console:

Work-oriented tree template

Server-oriented tree template

Monitoring tree models are defined for each template. Use the definitions collected from each host to generate monitoring trees automatically according to the monitoring tree model.

5.2 Monitoring tree model for the work-oriented tree

The following figures show the monitoring tree model that is generated when the work-oriented tree template is selected for generating a monitoring tree automatically.

Monitoring tree model generated when the work-oriented tree template is selected

Figure 5‒1: Monitoring tree model (work-oriented tree template)

Figure 5‒2: Monitoring tree model (work-oriented tree template)

5.3 Monitoring tree model for the server-oriented tree

The following figures show the monitoring tree model that is generated when the server-oriented tree template is selected for generating a monitoring tree automatically.

Monitoring tree model generated when the server-oriented tree template is selected

Figure 5‒3: Monitoring tree model (server-oriented tree template)

Figure 5‒4: Monitoring tree model (server-oriented tree template)

Index

Symbols

!JP1_CS_APP0.conf (start program definition file)[1]

!JP1_CS_FTOOL0.conf (toolbar definition file)[1]

!JP1_CS_FTREE0.conf (icon operation definition file)[1]

.system (system profile)[1]

A

actdef.conf

automated action definition file[1]

automated action definition file (for conversion)[1]

action_complete_xxx.conf (settings file for completed-action linkage function)[1]

action.conf.update (automated action environment definition file)[1]

action information file, reducing size of[1]

actnotice.conf (automatic action notification definition file)[1]

alternate keyword string[1]

alternate registry string[1]

alternate strings[1]

alternate keyword string[1]

alternate registry string[1]

attr_list.conf (file that defines which items are displayed for event conditions)[1]

auto_dbbackup_xxx.conf (automatic backup and recovery settings file for monitoring object database)[1]

automated action definition file (actdef.conf)[1]

automated action definition file (for conversion)

actdef.conf[1]

checking size of automated action definition parameter[1]

checking specified information[1]

definition specification[1]

parameter groups and AND conditions[1]

priority order of event monitoring conditions[1]

automated action definition parameter, checking size of[1]

automated action environment definition file (action.conf.update)[1]

automatic action notification definition file (actnotice.conf)[1]

automatic backup and recovery settings file for monitoring object database (auto_dbbackup_xxx.conf)[1]

automatic input definition file for a display message change definition (chmsg_auto_list.conf)[1]

B

basic attributes[1]

C

cancellation processing, if target host restarts during[1]

Category name definition file for IM management nodes (imdd_category_name.conf)[1]

Central Scope

system-monitoring object[1]

checking specified information[1]

chmsg_attr_list.conf (display item definition file for a display message change definition)[1]

chmsg_auto_list.conf (automatic input definition file for a display message change definition)[1]

chmsgevent.conf (environment definition file for events after the display message is changed)[1]

cluster setup information file (jimdbclustersetupinfo.conf)[1]

commands[1]

automated action and command execution[1]

Central Scope environment setup[1]

changing monitoring node status[1]

checking contents of JP1/IM - Manager definition file[1]

checking contents of JP1/IM - View definition file[1]

configuration definition[1]

correlation event generation[1]

counting number of nodes managed by JP1/IM - Manager[1]

email notification function[1]

event[1]

filter[1]

format of explanation of[1]

IM Configuration Management[1]

IM Configuration Management (remote monitoring configuration)[1]

IM database[1]

jcacancel[1]

jcachange[1]

jcadefconv[1]

jcamakea[1]

jcashowa[1]

jcastatus[1]

jcfaleltdef (Windows only)[1]

jcfaleltreload (Windows only)[1]

jcfaleltstart (Windows only)[1]

jcfaleltstat (Windows only)[1]

jcfaleltstop (Windows only)[1]

jcfallogdef[1]

jcfallogreload[1]

jcfallogstart[1]

jcfallogstat[1]

jcfallogstop[1]

jcfcolvmesx[1]

jcfcolvmhcsm[1]

jcfcolvmkvm[1]

jcfcolvmscvmm (Windows only)[1]

jcfcolvmvc[1]

jcfcolvmvirtage[1]

jcfdbsetup[1]

jcfdbunsetup[1]

jcfexport[1]

jcfimport[1]

jcfmkcsdata[1]

jcfmkhostsdata[1]

jcfthreaddmp (Windows only)[1]

jcfview (Windows only)[1]

jcfvirtualchstat[1]

jco_killall.cluster (UNIX only)[1]

jco_spmd_reload[1]

jco_spmd_status[1]

jco_start.cluster (UNIX only)[1]

jco_start (UNIX only)[1]

jco_stop.cluster (UNIX only)[1]

jco_stop (UNIX only)[1]

jcoappexecfcheck (Windows only)[1]

jcoattrfcheck[1]

jcochafmode (UNIX only)[1]

jcochcefmode[1]

jcochfilter[1]

jcochstat[1]

jcodbsetup[1]

jcodbunsetup[1]

jcoegschange[1]

jcoegscheck[1]

jcoegsstart[1]

jcoegsstatus[1]

jcoegsstop[1]

jcoevtreport[1]

jcofuncfcheck (Windows only)[1]

jcogencore[1]

jcohctest[1]

jcoimdef[1]

jcomonitorfcheck[1]

jcothreaddmp (Windows only)[1]

jcovcfsetup (Windows only)[1]

jcoview_log.bat (Windows only)[1]

jcoview (Windows only)[1]

jcschstat[1]

jcsdbexport[1]

jcsdbimport[1]

jcsdbsetup[1]

jcshostsexport[1]

jcshostsimport[1]

jddcreatetree[1]

jddsetaccessuser[1]

jddsetproxyuser[1]

jddupdatetree[1]

jim_log.bat (Windows only)[1]

jim_log.sh (UNIX only)[1]

jimdbbackup[1]

jimdbreclaim[1]

jimdbrecovery[1]

jimdbrorg[1]

jimdbstatus[1]

jimdbstop[1]

jimdbupdate[1]

jimmail (Windows only)[1]

jimmailpasswd (Windows only)[1]

jimnodecount[1]

jp1cc_setup_cluster (UNIX only)[1]

jp1cc_setup (UNIX only)[1]

jp1cf_setup_cluster (UNIX only)[1]

jp1cf_setup (UNIX only)[1]

jp1cfhasetup (Windows only)[1]

jp1cohasetup (Windows only)[1]

jp1cohaverup[1]

jp1cs_setup_cluster (UNIX only)[1]

jp1cs_setup (UNIX only)[1]

jp1cshasetup (Windows only)[1]

jp1cshaverup.bat (Windows only)[1]

jp1cshaverup (UNIX only)[1]

jp1csverup.bat (Windows only)[1]

jp1csverup (UNIX only)[1]

list of[1]

migrating monitoring object database information[1]

SpmSetSvcCon (Windows only)[1]

startup, termination, and setup[1]

troubleshooting[1]

upgrading[1]

view[1]

communication environment definition file

console.conf.update[1]

tree_view.conf.update[1]

view.conf.update[1]

configuration file for converting information (event_info_replace.conf)[1]

configuration file for monitoring tree[1]

console.conf.update (communication environment definition file)[1]

conventions

diagrams[1]

fonts and symbols[1]

version numbers[1]

correlation event generation definition file[1]

details of event ID specified in FAIL_EVENT parameter in[1]

details of event ID specified in SUCCESS_EVENT parameter in[1]

correlation event generation environment definition file[1]

correlation event generation function status

running[1]

standby[1]

starting[1]

stopped[1]

stopping[1]

correlation event generation system profile (egs_system.conf)[1]

counting number of nodes managed by JP1/IM - Manager[1]

D

defaultUser (user profile)[1]

definition file

performance report display definition file (performance.conf)[1]

profile management environment definition file (jp1cf_profile_manager.conf)[1]

remote log trap environment definition file (jp1cf_remote_logtrap.conf)[1]

definition file for automatic delete mode of status change event[1]

definition file for executing applications[1]

alternate string[1]

checking[1]

definition file for extended event attributes[1]

checking[1]

definition file for extended event attributes (extended file)[1]

definition file for monitoring object initialization mode[1]

definition file for object types[1]

definition file for on memory mode of status change condition[1]

definition file for opening monitor windows[1]

checking[1]

definition file for Tool Launcher window[1]

checking[1]

definitionfiles

Category name definition file for IM management nodes (imdd_category_name.conf)[1]

Host name definition file (imdd_host_name.conf)[1]

IM management node link definition file (imdd_nodeLink_def.conf)[1]

Intelligent Integrated Management Base definition file (imdd.properties)[1]

System node definition file (imdd_systemnode.conf)[1]

Target host definition file for configuration collection (imdd_target_host.conf)[1]

definition files[1]

apply-IM-configuration-method definition file (jp1cf_applyconfig.conf)[1]

auto-input definition file for repeated event condition (event_storm_auto_list.conf)[1]

auto-input definition file for severity change definition (chsev_auto_list.conf)[1]

automated action definition file (actdef.conf)[1]

automated action definition file (actdef.conf) (for conversion)[1]

automated action environment definition file (action.conf.update)[1]

automatic action notification definition file (actnotice.conf)[1]

automatic backup and recovery settings file for monitoring object database (auto_dbbackup_xxx.conf)[1]

automatic input definition file for a display message change definition (chmsg_auto_list.conf)[1]

cluster setup information file (jimdbclustersetupinfo.conf)[1]

collected host information file (host_collect_data.csv)[1]

command button definition file (cmdbtn.conf)[1]

common definition settings file (for changing attribute of JP1 events)[1]

common-exclusion-conditions auto-input definition file (common_exclude_filter_auto_list.conf)[1]

common-exclusion-conditions display item definition file (common_exclude_filter_attr_list.conf)[1]

communication environment definition file (console.conf.update)[1]

communication environment definition file (tree_view.conf.update)[1]

communication environment definition file (view.conf.update)[1]

components of[1]

configuration file for converting information (event_info_replace.conf)[1]

Configuration file for incident inheritance information (incident_info.conf)[1]

configuration file for monitoring tree[1]

correlation event generation definition file[1]

correlation event generation environment definition file[1]

correlation event generation system profile (egs_system.conf)[1]

definition file for manually registering incident (incident.conf)[1]

display item definition file for a display message change definition (chmsg_attr_list.conf)[1]

display item definition file for repeated event condition (event_storm_attr_list.conf)[1]

display item definition file for severity change definition (chsev_attr_list.conf)[1]

display message change definition file[1]

email environment definition file (jimmail.conf)[1]

environment definition file for event report output (evtreport.conf)[1]

Environment definition file for events after the display message is changed (chmsgevent.conf)[1]

event guide information file (jco_guide.txt)[1]

event-source-host mapping definition file (user_hostmap.conf)[1]

extended startup process definition file (jp1co_service.conf)[1]

for automatic delete mode of status change event[1]

for executing applications[1]

for extended event attributes[1]

for extended event attributes (extended file)[1]

format of explanation of[1]

for monitoring object initialization mode[1]

for object types[1]

for on memory mode of status change condition[1]

for opening monitor windows[1]

for Tool Launcher window[1]

guide information file (jcs_guide.txt)[1]

health check definition file (jcohc.conf)[1]

host information file (jcs_hosts)[1]

host input information file (host_input_data.csv)[1]

icon operation definition file (!JP1_CS_FTREE0.conf)[1]

IM parameter definition file (jp1co_param_V7.conf)[1]

IM-View settings file (tuning.conf)[1]

list of[1]

naming rules for[1]

non-encryption communication host configuration file (nosslhost.conf)[1]

operation definition file for IM Configuration Management - View (jcfview.conf)[1]

operation log definition file (imm_operationlog.conf)[1]

overview of[1]

remote-monitoring event log trap action-definition file[1]

remote-monitoring log file-trap action definition file[1]

settings file for completed-action linkage function (action_complete_xxx.conf)[1]

settings file for maximum number of status change events (evhist_warn_event_xxx.conf)[1]

setup information file (jimdbsetupinfo.conf)[1]

severity changing definition file[1]

start program definition file (!JP1_CS_APP0.conf)[1]

status event definition file (processupdate.conf)[1]

storage locations for[1]

structures of[1]

system color definition file (systemColor.conf)[1]

system profile (.system)[1]

system profile of Central Scope (jcs_sysprofile_xxx.def)[1]

system profile of Central Scope viewer (system.conf)[1]

that define which items are displayed for event conditions (attr_list.conf)[1]

toolbar definition file (!JP1_CS_FTOOL0.conf)[1]

user profile (defaultUser | profile_user-name)[1]

Web page call definition file (hitachi_jp1_product-name.html)[1]

definition specification[1]

diagram conventions[1]

display item definition file for a display message change definition (chmsg_attr_list.conf)[1]

display message change definition file[1]

E

egs_system.conf (correlation event generation system profile)[1]

environment definition file for event report output (evtreport.conf)[1]

Environment definition file for events after the display message is changed (chmsgevent.conf)[1]

event_info_replace.conf (configuration file for converting information)[1]

event guide information file (jco_guide.txt)[1]

event ID

value specified for the ACTDEF parameter (remote monitoring log file trap definition file)[1]

event ID, details of

00002010[1]

00002011[1]

00002012[1]

00002013[1]

00002014[1]

00002015[1]

00002016[1]

00002020[1]

00002021[1]

000020A0[1]

000020A1[1]

000020A2[1]

000020A3[1]

000020A4[1]

000020A5[1]

000020A6[1]

000020E0[1]

000020E1[1]

000020E2[1]

000020E3[1]

000020E4[1]

000020E5[1]

000020E6[1]

000020E7[1]

000020E8[1]

00003A71[1]

00003F01[1]

00003F02[1]

00003F03[1]

00003F04[1]

00003F05[1]

00003F06[1]

00003F07[1]

00003F08[1]

00003F11[1]

00003F13[1]

00003F15[1]

00003F16[1]

00003F17[1]

00003F20[1]

00003F21[1]

00003F22[1]

00003F23[1]

00003F25[1]

00003F26[1]

00003F28[1]

00003F31[1]

00003F41[1]

00003F42[1]

00003F51[1]

00003F52[1]

00003F53[1]

00003F54[1]

00003F56[1]

00003F57[1]

00003F58[1]

00003F59[1]

00003F60[1]

00003F61[1]

00003F63[1]

00003F64[1]

00003F65[1]

00003F68[1]

00003F69[1]

00003F6A[1]

00003F71[1]

00003F76[1]

00003F77[1]

00003F78[1]

00003F7C[1]

00003F90[1]

00003F91[1]

00003F92[1]

00003FB0[1]

00003FB1[1]

00003FC0[1]

00003FC1[1]

00003FC2[1]

00003FC3[1]

00003FC5[1]

00003FC6[1]

00003FC7[1]

00003FC8[1]

00003FC9[1]

00003FD0[1]

00003FD1[1]

00003FD2[1]

00003FD3[1]

00003FD4[1]

00003FD5[1]

00003FD6[1]

00003FD7[1]

00003FD8[1]

00003FD9[1]

00003FDA[1]

00003FDB[1]

00003FDC[1]

00006400[1]

event ID specified in the filter block of the remote-monitoring event log trap action-definition file[1]

event monitoring conditions, priority order of[1]

evhist_warn_event_xxx.conf (settings file for maximum number of status change events)[1]

evtreport.conf (environment definition file for event report output)[1]

extended attributes[1]

extended definition file

common-exclusion-condition[1]

extended startup process definition file (jp1co_service.conf)[1]

F

file that defines which items are displayed for event conditions (attr_list.conf)[1]

filter file[1]

font conventions[1]

G

guide information file (jcs_guide.txt)[1]

guide message file[1]

H

health check definition file (jcohc.conf)[1]

hitachi_jp1_product-name.html (Web page call definition file)[1]

host information file (jcs_hosts)[1]

Host name definition file (imdd_host_name.conf)[1]

I

icon operation definition file (!JP1_CS_FTREE0.conf)[1]

IM management node link definition file (imdd_nodeLink_def.conf)[1]

IM parameter definition file (jp1co_param_V7.conf)[1]

IM-View settings file (tuning.conf)[1]

Intelligent Integrated Management Base definition file (imdd.properties)[1]

item file[1]

J

jcacancel[1]

jcachange[1]

jcadefconv[1]

jcamakea[1]

jcashowa[1]

jcastatus[1]

jcfaleltdef (Windows only)[1]

jcfaleltreload (Windows only)[1]

jcfaleltstart (Windows only)[1]

jcfaleltstat (Windows only)[1]

jcfallogdef[1]

jcfallogreload[1]

jcfallogstart[1]

jcfallogstat[1]

jcfallogstop[1]

jcfcolvmesx[1]

jcfcolvmscvmm (Windows only)[1]

jcfdbsetup[1]

jcfdbunsetup[1]

jcfexport[1]

jcfimport[1]

jcfmkcsdata[1]

jcfmkhostsdata[1]

jcfthreaddmp (Windows only)[1]

jcfview.conf (operation definition file for IM Configuration Management - View)[1]

jcfview (Windows only)[1]

jcfvirtualchstat[1]

jco_guide.txt (event guide information file)[1]

jco_killall.cluster (UNIX only)[1]

jco_spmd_reload[1]

jco_spmd_status[1]

jco_start.cluster (UNIX only)[1]

jco_start (UNIX only)[1]

jco_stop.cluster (UNIX only)[1]

jco_stop (UNIX only)[1]

jcoappexecfcheck (Windows only)[1]

jcoattrfcheck[1]

jcochafmode (UNIX only)[1]

jcochcefmode[1]

jcochfilter[1]

jcochstat[1]

jcodbsetup[1]

jcodbunsetup[1]

jcoegschange[1]

jcoegscheck[1]

jcoegsstart[1]

jcoegsstatus[1]

jcoegsstop[1]

jcoevtreport[1]

jcofuncfcheck (Windows only)[1]

jcogencore[1]

jcohc.conf (health check definition file)[1]

jcohctest[1]

jcoimdef[1]

jcomonitorfcheck[1]

jcothreaddmp (Windows only)[1]

jcovcfsetup (Windows only)[1]

jcoview_log.bat (Windows only)[1]

jcoview (Windows only)[1]

jcs_guide.txt (guide information file)[1]

jcs_hosts (host information file)[1]

jcschstat[1]

jcsdbexport[1]

jcsdbimport[1]

jcsdbsetup[1]

jcshostsexport[1]

jcshostsimport[1]

jddcreatetree[1]

jddsetaccessuser[1]

jddsetproxyuser[1]

jddupdatetree[1]

jim_log.bat (Windows only)[1]

jim_log.sh (UNIX only)[1]

jimdbbackup[1]

jimdbclustersetupinfo.conf (cluster setup information file)[1]

jimdbreclaim[1]

jimdbrecovery[1]

jimdbrorg[1]

jimdbsetupinfo.conf (setup information file)[1]

jimdbstatus[1]

jimdbstop[1]

jimdbupdate[1]

jimmail (Windows only)[1]

jimmailpasswd (Windows only)[1]

jimnodecount[1]

jp1cc_setup_cluster (UNIX only)[1]

jp1cc_setup (UNIX only)[1]

jp1cf_setup_cluster (UNIX only)[1]

jp1cf_setup (UNIX only)[1]

jp1cfhasetup (Windows only)[1]

jp1co_param_V7.conf (IM parameter definition file)[1]

jp1co_service.conf (extended startup process definition file)[1]

jp1cohasetup (Windows only)[1]

jp1cohaverup[1]

jp1cs_setup_cluster (UNIX only)[1]

jp1cs_setup (UNIX only)[1]

jp1cshasetup (Windows only)[1]

jp1cshaverup.bat (Windows only)[1]

jp1cshaverup (UNIX only)[1]

jp1csverup.bat (Windows only)[1]

jp1csverup (UNIX only)[1]

JP1 events[1]

attributes of[1]

details of[1]

issued by JP1/IM[1]

list of[1]

M

monitoring tree models

Central Scope[1]

server-oriented tree[1]

work-oriented tree[1]

N

nodes managed by JP1/IM - Manager, number of

counting[1]

non-encryption communication host configuration file (nosslhost.conf)[1]

nosslhost.conf (non-encryption communication host configuration file)[1]

O

operation definition file for IM Configuration Management - View (jcfview.conf)[1]

operation log definition file (imm_operationlog.conf)[1]

P

parameter groups and AND conditions[1]

performance report display definition file (performance.conf)[1]

primary data

JP1/IM - Manager (UNIX)[1]

JP1/IM - View and JP1/IM - Manager (Windows)[1]

processupdate.conf (status event definition file)[1]

profile_user-name (user profile)[1]

profile management environment definition file (jp1cf_profile_manager.conf)[1]

R

regular expressions[1]

notes about[1]

notes on[1]

remote log trap environment definition file (jp1cf_remote_logtrap.conf)[1]

S

secondary data

JP1/IM - Manager (UNIX)[1]

JP1/IM - View and JP1/IM - Manager (Windows)[1]

server-oriented tree[1]

settings file for completed-action linkage function (action_complete_xxx.conf)[1]

settings file for maximum number of status change events (evhist_warn_event_xxx.conf)[1]

setup information file (jimdbsetupinfo.conf)[1]

severity changing definition file[1]

SpmSetSvcCon (Windows only)[1]

start program definition file (!JP1_CS_APP0.conf)[1]

startup options, notes about[1]

statements[1]

details of[1]

rules for generating specification components in[1]

structures of[1]

types of[1]

status event definition file (processupdate.conf)[1]

symbol conventions[1]

system-monitoring objects[1]

Cosminexus[1]

HiRDB[1]

HP NNM[1]

JP1/AJS[1]

JP1/Cm2/SSO[1]

JP1/IM - Manager[1]

JP1/NNMi[1]

JP1/PAM[1]

JP1/PFM[1]

JP1/ServerConductor[1]

JP1/Software Distribution[1]

list of (for Central Scope)[1]

list of supported products[1]

System node definition file (imdd_systemnode.conf)[1]

system profile (.system)[1]

T

Target host definition file for configuration collection (imdd_target_host.conf)[1]

template

generating monitoring trees automatically[1]

toolbar definition file (!JP1_CS_FTOOL0.conf)[1]

tree_view.conf.update (communication environment definition file)[1]

tuning.conf (IM-View settings file)[1]

U

user profile (defaultUser | profile_user-name)[1]

V

version number conventions[1]

view.conf.update (communication environment definition file)[1]

W

Web page call definition file (hitachi_jp1_product-name.html)[1]

work-oriented tree[1]