IBM Tivoli Netcool/OMNIbusnWeb GUI Administration …“の資料の内容 IBM Tivoli Netcool/OMNIbus Web GUI は、 Web ベース・アプリケーションであり、 1 つ以上のデータ・ソースからのネットワーク・イベントを処理し、そのイ

Tivoli Netcool/OMNIbusバージョン 8 リリース 1

Web GUI Administration API(WAAPI) ユーザーズ・ガイド

SC43-0819-10

IBM

Tivoli Netcool/OMNIbusバージョン 8 リリース 1

Web GUI Administration API(WAAPI) ユーザーズ・ガイド

SC43-0819-10

IBM

注記

本書および本書で紹介する製品をご使用になる前に、特記事項に記載されている情報をお読みください。

本書は、IBM Tivoli Netcool/OMNIbus (製品番号 5724-S44) バージョン 8 リリース 1、および新しい版で明記されていない限り、以降のすべてのリリースおよびモディフィケーションに適用されます。

お客様の環境によっては、資料中の円記号がバックスラッシュと表示されたり、バックスラッシュが円記号と表示されたりする場合があります。

原典： SC27-6506-10Tivoli Netcool/OMNIbusVersion 8 Release 1Web GUI Administration API (WAAPI) User's Guide

発行：日本アイ・ビー・エム株式会社

担当：トランスレーション・サービス・センター

© Copyright IBM Corporation 2011, 2017.

目次

この資料の内容 . . . . . . . . . . . . v対象読者. . . . . . . . . . . . . . . . vマニュアル . . . . . . . . . . . . . . . vアクセシビリティー . . . . . . . . . . . viiTivoli 技術研修 . . . . . . . . . . . . . viiサポート情報 . . . . . . . . . . . . . . vii本書の規則 . . . . . . . . . . . . . . viii

第 1 章 Web GUI Administration API(WAAPI) . . . . . . . . . . . . . . . 1WAAPI について . . . . . . . . . . . . . 1

Web GUI を変更するための比較手順 . . . . . 3WAAPI クライアントと Web GUI サーバーの間の通信 . . . . . . . . . . . . . . . . . 3セキュリティー . . . . . . . . . . . . . 4

第 2 章 WAAPI の使用 . . . . . . . . 7WAAPI プロパティー・ファイルのセットアップ . . 7サーバーへの WAAPI 要求の送信 . . . . . . . 8

第 3 章 WAAPI 要求 . . . . . . . . . 11WAAPI 要求の構造 . . . . . . . . . . . 11

WAAPI XML 文書の特性 . . . . . . . . 13サンプル要求 . . . . . . . . . . . . . 15

ユーザー要求 . . . . . . . . . . . . . . 15ユーザーの保守 . . . . . . . . . . . . 15ユーザーの変更 . . . . . . . . . . . . 15ユーザー・リストの取得 . . . . . . . . . 26

ビュー要求 . . . . . . . . . . . . . . 26ビューの作成 . . . . . . . . . . . . . 26ビューの作成または置換 . . . . . . . . . 31ビューの変更 . . . . . . . . . . . . . 32ビューの削除 . . . . . . . . . . . . . 33ビュー・リストの取得 . . . . . . . . . . 33

マップ要求 . . . . . . . . . . . . . . 34マップの作成 . . . . . . . . . . . . . 34マップの作成または置換 . . . . . . . . . 52マップの削除 . . . . . . . . . . . . . 53マップ・リストの取得 . . . . . . . . . . 53マップの変更 . . . . . . . . . . . . . 53マップ・ビジュアルの追加 . . . . . . . . 54マップ・ビジュアルの追加または置換 . . . . 54マップ・ビジュアルの削除 . . . . . . . . 55マップ・ビジュアルの変更 . . . . . . . . 55

リソース要求 . . . . . . . . . . . . . . 56リソースの追加 . . . . . . . . . . . . 56リソースの作成または置換 . . . . . . . . 57リソースの削除 . . . . . . . . . . . . 57リソース・リストの取得 . . . . . . . . . 58

ファイル要求 . . . . . . . . . . . . . . 58

ディレクトリーの追加 . . . . . . . . . . 58ファイルの追加 . . . . . . . . . . . . 59ファイルの作成または置換 . . . . . . . . 60ファイルの削除 . . . . . . . . . . . . 60ディレクトリーの削除 . . . . . . . . . . 61ディレクトリーの再帰的削除 . . . . . . . 61

メニュー要求 . . . . . . . . . . . . . . 61メニューの作成 . . . . . . . . . . . . 62メニューの作成または置換 . . . . . . . . 64メニューの削除 . . . . . . . . . . . . 64メニュー・リストの取得 . . . . . . . . . 65メニューの変更 . . . . . . . . . . . . 65

ツール要求 . . . . . . . . . . . . . . 66ツールの作成 . . . . . . . . . . . . . 66ツールの作成または置換 . . . . . . . . . 74ツールの削除 . . . . . . . . . . . . . 75ツール・リストの取得 . . . . . . . . . . 75ツールの変更 . . . . . . . . . . . . . 75

プロンプト要求 . . . . . . . . . . . . . 76プロンプトの作成または置換 . . . . . . . 77プロンプトの削除 . . . . . . . . . . . 84プロンプト・リストの取得 . . . . . . . . 84プロンプトの変更 . . . . . . . . . . . 85

CGI 要求 . . . . . . . . . . . . . . . 85CGI スクリプトの登録 . . . . . . . . . 85CGI スクリプトの作成または置換 . . . . . . 86CGI スクリプトの変更 . . . . . . . . . 87CGI スクリプトの登録抹消 . . . . . . . . 87

フィルター要求 . . . . . . . . . . . . . 88フィルターの追加 . . . . . . . . . . . 88フィルターの作成または置換 . . . . . . . 93フィルターの削除 . . . . . . . . . . . 93フィルター・リストの取得 . . . . . . . . 94フィルターの変更 . . . . . . . . . . . 94デフォルト・ビューの設定 . . . . . . . . 95

フィルター・コレクション要求 . . . . . . . . 95フィルター・コレクションの作成 . . . . . . 96フィルター・コレクションへのフィルターの追加 97フィルター・コレクションの作成または置換 . . 97フィルター・コレクションの削除 . . . . . . 98フィルター・コレクションからのフィルターの削除 . . . . . . . . . . . . . . . . 98フィルター・コレクションのリストの取得 . . . 99フィルター・コレクションの変更 . . . . . . 99フィルター・コレクションのビューの設定 . . . 100

メトリック要求 . . . . . . . . . . . . . 100メトリックの作成 . . . . . . . . . . . 100メトリックの作成または置換 . . . . . . . 105メトリックの削除 . . . . . . . . . . . 106メトリック・リストの取得 . . . . . . . . 106メトリックの変更 . . . . . . . . . . . 106

© Copyright IBM Corp. 2011, 2017 iii

関係要求 . . . . . . . . . . . . . . . 107関係の作成 . . . . . . . . . . . . . 107関係の作成または置換 . . . . . . . . . 110関係の削除 . . . . . . . . . . . . . 111関係リストの取得 . . . . . . . . . . . 111関係の変更 . . . . . . . . . . . . . 111

その他の要求 . . . . . . . . . . . . . 112システム状況報告の生成 . . . . . . . . . 112フィルターとビューの再ロード . . . . . . 113ロード・バランシング・クラスターからのノードの削除 . . . . . . . . . . . . . . . 113Web GUI キャッシュと ObjectServer のデータベースとの再同期 . . . . . . . . . . . 113

付録 A. WAAPI プロパティーとコマンド行オプション . . . . . . . . . . . 115

付録 B. リモート・ホストへの WAAPIクライアントのインストール . . . . . 121

付録 C. WAAPI のセキュリティー . . . 123セキュア WAAPI 接続の作成 . . . . . . . . 123

WAAPI SSL 接続 (サーバーのみの認証) の作成 124WAAPI SSL 接続の作成 (クライアント/サーバー認証) . . . . . . . . . . . . . . 125FIPS 140–2 が有効の WAAPI SSL 接続 (サーバーのみの認証) の作成 . . . . . . . . . 127FIPS 140–2 が有効の WAAPI SSL 接続 (クライアント/サーバー認証) の作成 . . . . . . 129WAAPI クライアントでの SP800-131a 移行モードの設定 . . . . . . . . . . . . . . 131WAAPI クライアントでの SP800-131 厳密モードの設定 . . . . . . . . . . . . . . 132

WAAPI パスワード暗号化の使用可能化 . . . . 133AES を使用した WAAPI パスワードの暗号化 134FIPS 140–2 モードの暗号化を使用した WAAPIパスワードの暗号化 . . . . . . . . . . 135

waapi.init プロパティー・ファイルの保護 . . . . 136

特記事項 . . . . . . . . . . . . . . 137商標 . . . . . . . . . . . . . . . . 140

索引 . . . . . . . . . . . . . . . 141

iv IBM Tivoli Netcool/OMNIbus: Web GUI Administration API (WAAPI) ユーザーズ・ガイド

この資料の内容

IBM Tivoli Netcool/OMNIbus Web GUI は、Web ベース・アプリケーションであり、1 つ以上のデータ・ソースからのネットワーク・イベントを処理し、そのイベント・データをさまざまなグラフィカル・フォーマットでユーザーに表示します。

「IBM Tivoli Netcool/OMNIbus Web GUI Administration API (WAAPI) ユーザーズ・ガイド」では、WAAPI と呼ばれる XML アプリケーション・プログラミング・インターフェースを使用して Tivoli Netcool/OMNIbus Web GUI を管理する方法を示します。

対象読者本書は、Tivoli Netcool/OMNIbus Web GUI の管理者を対象としています。この資料には、WAAPI を使用して Web GUI を管理する方法が記載されています。

本書では、管理者が XML に関する相応な知識を持っていると想定しています。特に、管理者は以下の概念について把握しているものとします。

v XML が使用するルール、ロジック、およびコンポーネント

v エレメント、属性、およびマークアップの概念

v XML 文書タイプ定義 (DTD) に対する、整形式の文書および妥当な文書の作成方法

マニュアルこのセクションでは、Tivoli Netcool/OMNIbus ライブラリー内のマニュアルと関連資料をリストします。またこのセクションでは、Tivoli のマニュアルにオンラインでアクセスする方法についても説明します。

Tivoli Netcool/OMNIbus ライブラリー

Tivoli Netcool/OMNIbus ライブラリーには、以下の資料があります。

v IBM Tivoli Netcool/OMNIbus Installation and Deployment Guide,

Tivoli Netcool/OMNIbus のインストールおよびアップグレード手順を含み、セキュリティーおよびコンポーネント通信の構成方法を説明します。また、TivoliNetcool/OMNIbus アーキテクチャーの例が含まれており、その実装方法について説明します。

v IBM Tivoli Netcool/OMNIbus 管理ガイド,

Tivoli Netcool/OMNIbus 管理者 GUI、ツール、およびプロセス制御を使用して管理用タスクを実行する方法を説明します。また、ObjectServer SQL の構文および自動化の説明と例も含まれています。

v IBM Tivoli Netcool/OMNIbus Web GUI 管理およびユーザーズ・ガイド,

© Copyright IBM Corp. 2011, 2017 v

Tivoli Netcool/OMNIbus Web GUI を使用した、管理タスクおよびイベント視覚化タスクの実行方法が記載されています。

v IBM Tivoli Netcool/OMNIbus User's Guide,

デスクトップ・ツールについて概説し、これらのツールを使用したイベント管理に関連したオペレーター・タスクについて説明します。

v IBM Tivoli Netcool/OMNIbus プローブとゲートウェイ・ガイド,

プローブ・ルール・ファイル構文やゲートウェイ・コマンドなどの、プローブおよびゲートウェイに関する概説および参照情報が含まれています。

v IBM Tivoli Monitoring for Tivoli Netcool/OMNIbus Agent ユーザーズ・ガイド,

Tivoli Netcool/OMNIbus のヘルス・モニター・エージェントのインストール方法についての説明、およびそのエージェントに関する参照情報が記載されています。

v IBM Tivoli Netcool/OMNIbus Event Integration Facility リファレンス,

ご使用のネットワーク環境および貴社固有のニーズに合わせて調整されたイベント・アダプターを開発する方法について説明しています。この資料では、ソースでイベントをフィルター処理する方法についても説明しています。

v IBM Tivoli Netcool/OMNIbus Error Messages Guide,

Tivoli Netcool/OMNIbus のシステム・メッセージおよびそれらのメッセージへの対処方法について説明しています。

v IBM Tivoli Netcool/OMNIbus Web GUI Administration API (WAAPI) User'sGuide,

WAAPI と呼ばれる XML アプリケーション・プログラミング・インターフェースを使用して Tivoli Netcool/OMNIbus Web GUI を管理する方法を示します。

v IBM Tivoli Netcool/OMNIbus ObjectServer HTTP インターフェースリファレンス・ガイド, ObjectServer HTTP インターフェースと呼ばれるアプリケーション・プログラミング・インターフェース (API) の URI および共通の動作を説明します。API を使用可能にする方法を説明し、JSON ペイロード、および HTTP要求と応答の例を提供します。

v IBM Tivoli Netcool/OMNIbus ObjectServer OSLC インターフェースリファレンス・ガイド, ObjectServer OSLC インターフェースと呼ばれる Open Servicesfor Lifecycle Collaboration (OSLC) アプリケーション・プログラミング・インターフェース (API) のサービス、リソース、および共通の動作を説明します。API を使用可能にする方法を説明し、サービス・プロバイダー定義、RDF/XMLペイロード、および HTTP 要求と応答の例を提供します。

他の IBM 製品 (DB2、IBM Tivoli Monitoring、Tivoli Common Reporting など) を使用して、Tivoli Netcool/OMNIbus の機能を拡張する場合は、その製品のインフォメーション・センターを参照して、関連資料を入手してください。

vi IBM Tivoli Netcool/OMNIbus: Web GUI Administration API (WAAPI) ユーザーズ・ガイド

用語へのオンライン・アクセス

IBM Terminology Web サイトでは、IBM 製品ライブラリーの用語が 1 カ所の便利なロケーションにまとめられています。「IBM Terminology Web site」にアクセスするには、次の Web アドレスを使用します。

http://www.ibm.com/software/globalization/terminology

マニュアルへのオンライン・アクセス

IBM では、この製品およびその他のすべての Tivoli 製品に関する資料を、使用可能になった時点および更新された時点で、以下の Tivoli ダウンロード・サイトに載せています。

ftp://public.dhe.ibm.com/software/tivoli/Netcool/NetcoolOmnibus/library/

注: レターサイズ以外の紙に PDF 文書を印刷する場合、Adobe Reader でレター・サイズのページを指定の紙に印刷できるように、「ファイル」 > 「印刷」ウィンドウでオプションを設定します。

アクセシビリティーアクセシビリティー機能は、運動障害または視覚障害など身体に障害を持つユーザーがソフトウェア・プロダクトを快適に使用できるようにサポートします。

この製品では、インターフェースを音声で聞きナビゲートするための支援技術を使用することができます。また、マウスの代わりにキーボードを使用してグラフィカル・ユーザー・インターフェースのほとんどの機能を操作することができます。

追加情報については、Web GUI のアクセシビリティー機能にあるアクセシビリティーの付録を参照してください。

Tivoli® 技術研修

以下は英語のみの対応となります。Tivoli技術研修の情報については、以下の IBMTivoli Education Web サイトを参照してください。

http://www.ibm.com/software/tivoli/education

サポート情報ご使用の IBM ソフトウェアに問題がある場合は、速やかに解決する必要があります。IBM は、お客様が必要とされているサポートを受けられるよう、以下の方法を提供しています。

オンラインIBM ソフトウェア・サポート・サイト http://www.ibm.com/software/support/probsub.html にアクセスし、指示に従います。

IBM Support AssistantIBM Support Assistant (ISA) は、IBM ソフトウェア製品についての質問と問題を解決するのに役立つ、無償のローカル・ソフトウェア保守サービ

この資料の内容 vii

http://www.ibm.com/software/globalization/terminology

ftp://public.dhe.ibm.com/software/tivoli/Netcool/NetcoolOmnibus/library/

http://www.ibm.com/software/tivoli/education

http://www.ibm.com/software/support/probsub.html

http://www.ibm.com/software/support/probsub.html

ス・ワークベンチです。ISA を利用すると、問題判別のためのサポート関連情報と保守性ツールに素早くアクセスできます。ISA ソフトウェアをインストールするには、http://www.ibm.com/software/support/isa にアクセスしてください。

資料このガイドの内容や編成を改善するためのご意見については、以下の TivoliNetcool/OMNIbus 資料開発チームにお送りください。

mailto://[email protected]

本書の規則本書では、特別な用語および操作、ならびにオペレーティング・システム固有のコマンドおよびパスについて、いくつかの規則を使用しています。

Web GUI のホーム・ディレクトリー

WEBGUI_HOMEWeb GUI がインストールされているディレクトリーを指します。このディレクトリーは、Web GUI ホーム・ディレクトリーとして知られています。デフォルトは以下のとおりです。

UNIX

Linux

/opt/IBM/tivoli/netcool/omnibus_webgui

Windows C:¥IBM¥tivoli¥netcool¥omnibus_webgui

Web GUI ホーム・ディレクトリーは、 Jazz for Service Management ホーム・ディレクトリーとは異なります。

Jazz for Service Management のホーム・ディレクトリー

WAS_HOMEWebSphere Application Server がインストールされているロケーションを指します。このロケーションは、インストール時に指定できます。デフォルトは以下のとおりです。

UNIX

Linux

/opt/IBM/WebSphere/AppServer

Windows C:¥Program Files¥IBM¥WebSphere¥AppServer

JazzSM_HOMEJazz for Service Management がインストールされているロケーションを指します。このロケーションは、インストール時に指定できます。デフォルトは以下のとおりです。

UNIX

Linux

/opt/IBM/JazzSM

Windows C:¥Program Files¥IBM¥JazzSM

JazzSM_WAS_ProfileJazz for Service Management に使用されているアプリケーション・サーバー・プロファイルのロケーションを指します。このロケーションは、Jazzfor Service Management ホーム・ディレクトリーの /profile/ サブディレクトリー内にあります。

UNIX

Linux

/opt/IBM/JazzSM/profile

viii IBM Tivoli Netcool/OMNIbus: Web GUI Administration API (WAAPI) ユーザーズ・ガイド

http://www.ibm.com/software/support/isa

mailto://[email protected]

Windows

C:¥Program Files¥IBM¥JazzSM¥profile

DASH_HOMEDashboard Application Services Hub がインストールされているロケーションを指します。このロケーションは、インストール時に指定できます。デフォルトは以下のとおりです。

UNIX

Linux

/opt/IBM/JazzSM/ui

Windows C:¥Program Files¥IBM¥JazzSM¥ui

他の Jazz for Service Management インストール・ディレクトリーについては、Jazz for Service Management インフォメーション・センター(http://www-01.ibm.com/support/knowledgecenter/SSEKCU/welcome) を参照してください。

オペレーティング・システムに依存する変数およびパス

本書では、環境変数の指定やディレクトリー表記に UNIX の規則を使用します。

Windows コマンド行を使用する場合、環境変数では $variable を %variable% に置き換え、ディレクトリーのパスでは各スラッシュ (/) を円記号 (¥) に置き換えてください。例えば、UNIX システムで、$NCHOME 環境変数は Netcool® ホーム・ディレクトリーのパスを示します。Windows システムでは、%NCHOME% 環境変数が Netcool ホーム・ディレクトリーのパスを示します。環境変数の名前は、Windows 環境と UNIX 環境で必ずしも同じではありません。例えば、Windows環境の %TEMP% は、UNIX 環境の $TMPDIR に相当します。

Windows システムで bash シェルを使用している場合は、UNIX 規則を使用できます。

Netcool ホーム・ロケーション

Netcool ホーム・ロケーションとは、Tivoli Netcool/OMNIbus がインストールされる基本ディレクトリーです。Netcool ホーム・ロケーションは、NCHOME 環境変数によって定義されます。NCHOME の値は以下のとおりです。

v UNIX Linux $NCHOME のデフォルト値は /opt/IBM/tivoli/netcool です。

v Windows %NCHOME% のデフォルト値は C:¥IBM¥Tivoli¥Netcool です。

ディレクトリーやコマンドのパスが NCHOME 変数で始まる場合、その情報はサポートされるオペレーティング・システムすべてに適用されます。

NCHOME 環境変数を使用する他の製品 (IBM Tivoli Network Manager IPEdition など) を Netcool ホーム・ロケーションにインストールできます。各製品は、固有のコンポーネントやファイルを、Netcool ホーム・ロケーション内の専用の product サブディレクトリーにインストールします。すべての製品に共通のファイルは、Netcool ホーム・ロケーション内の共用サブディレクトリーにインストールされます。

この資料の内容 ix

http://www-01.ibm.com/support/knowledgecenter/SSEKCU/welcome

キューイング・グラフィックの規則

Tivoli Netcool/OMNIbus の資料には、トピックまたは説明の一部分が特定の条件下でのみ適用されることを示すキューイング・グラフィックが含まれています。以下の表に、各グラフィックの意味を示します。

表 1. Tivoli Netcool/OMNIbus のキューイング・グラフィック

グラフィック説明

PureDataWeb GUI テキストまたは説明は、Web GUI コンポーネントにのみ適用されます。

UNIX テキストまたは説明は、UNIX オペレーティング・システム (AIX® およびSolaris を含む) にのみ適用されます。以下のキューイング・グラフィックは、必要な場合、AIX および Solaris に使用されます。

AIX

Solaris

Linux テキストまたは説明は、Linux オペレーティング・システムにのみ適用されます。

Windows テキストまたは説明は、Windows オペレーティング・システムにのみ適用されます。

32-bit テキストまたは説明は、32 ビット・オペレーティング・システムにのみ適用されます。

64-bit テキストまたは説明は、64 ビット・オペレーティング・システムにのみ適用されます。

FIPS 1402 テキストまたは説明は、FIPS 140-2 暗号化の使用または構成にのみ適用されます。

Default テキストまたは説明は、デフォルト動作を記述しているか、デフォルト構成にのみ適用されます。

Fix Pack 1 テキストまたは説明は、グラフィックで示されているフィックスパック番号にのみ適用されます。テキストで記述されている機能または機能拡張は、示されているフィックスパックのインストール後にのみ使用できます。

注: サーバー・コンポーネントのフィックスパックと Web GUI コンポーネントのフィックスパックは、別々にリリースされます。Web GUI のフィックスパックは、以下のように示されます。

PureDataWeb GUI

Fix Pack 1

Administrator テキストまたは説明は、Web GUI 管理者にのみ適用されます。つまり、ncw_user 役割と ncw_admin 役割が割り当てられているユーザーです。

C テキストまたは説明は、C プログラミング言語にのみ適用されます。

Java テキストまたは説明は、Java™ プログラミング言語にのみ適用されます。

書体の規則

本書では、以下の書体の規則を使用します。

太字

x IBM Tivoli Netcool/OMNIbus: Web GUI Administration API (WAAPI) ユーザーズ・ガイド

v 周囲のテキストとの区別が難しい小文字コマンドおよび大/小文字混合コマンド

v インターフェース・コントロール (チェック・ボックス、プッシュボタン、ラジオ・ボタン、スピン・ボタン、フィールド、フォルダー、アイコン、リスト・ボックス、リスト・ボックス内の項目、複数列のリスト、コンテナー、メニュー選択、メニュー名、タブ、プロパティー・シート)、ラベル (「ヒント:」、および「オペレーティング・システムの考慮事項:」など)

v 本文中のキーワードおよびパラメーター

イタリック

v 引用 (例: 資料、ディスケット、および CD のタイトル)

v 本文中で定義される語句 (例: 非交換回線は Point-to-Point 回線と呼ばれます)

v 語句および文字の強調 (語単位の強調の例: 「語 that は制限節を導くために使用します。」、文字単位の強調の例: 「LUN アドレスの先頭文字には、文字 L を使用してください。」)

v 本文中の新規用語 (定義リスト内を除く): ビューは、データが含まれたワークスペース内のフレームです。

v 入力する必要がある変数および値: ... ここで myname は .... を表します。

モノスペース

v 例およびコード例

v 周囲のテキストから区別するのが困難なファイル名、プログラミング・キーワード、およびその他のエレメント

v ユーザー宛のメッセージ・テキストおよびプロンプト

v ユーザーが入力する必要があるテキスト

v 引数またはコマンド・オプションの値

この資料の内容 xi

xii IBM Tivoli Netcool/OMNIbus: Web GUI Administration API (WAAPI) ユーザーズ・ガイド

第 1 章 Web GUI Administration API (WAAPI)

WAAPI の概要と、Web GUI サーバーとの通信方法についてお読みください。また、WAAPI が提供するセキュリティー・メカニズムについても記されています。

WAAPI についてWAAPI は XML ベースの API であり、Web GUI サーバーをリモートまたはローカル管理できるようにします。

WAAPI を使用すると、Web GUI 自体のグラフィカル・ユーザー・インターフェースを使用しなくても、サーバーを管理できます。これは特に、対話式機能では長時間かかる、大量の情報更新に役立ちます。例えば、複数のフィルターの追加または変更は、Web GUI の対話式機能よりも、WAAPI を使用した方が効率的に行える場合があります。

このインターフェースは Web GUI サーバーと一緒にインストールされ、サーバー自体からの管理が可能になります。また WAAPI クライアントをリモート・サーバーにインストールし、そこから Web GUI を管理することもできます。

要求のタイプ

WAAPI を使用した管理コマンドを要求と言います。WAAPI を使用すると、対話式インターフェースによって使用可能な多くの機能を管理できます。例えば、フィルターの追加、変更、および削除が可能です。

また、特殊な管理タスクの中には WAAPI によってのみ可能な機能もあります。例えば、すべてのシステムのフィルターおよびビューの再ロードが可能です。

WAAPI で使用可能なすべての要求は、次のタイプにグループ化されます。

v ユーザー

任意の数のユーザー特性の変更、ユーザー・リストの取得、アクティブな WebGUI 役割がなくなったユーザーの Web GUI 構成データの削除を行います。

v ビュー

ビューの作成、変更、削除、およびリスト作成を行います。

v マップ

マップの作成、変更、削除、およびリスト作成を行います。また、マップへのビジュアルの追加、ビジュアルの変更および削除を行います。

v リソース

リソースは、マップに表示する項目が含まれるグラフィックス・ファイルです。リソースには、マップ・オブジェクトとして使用するマップの背景イメージとグラフィックスが含まれます。リソースを追加、削除、およびリスト作成できます。

© Copyright IBM Corp. 2011, 2017 1

v ファイル

Web GUI サーバーにおいてディレクトリーとファイルの追加と削除を行います。

v メニュー

アクティブ・イベント・リスト (AEL) に表示するメニューの作成、変更、削除、およびリスト作成を行います。

v ツール

イベント管理ツールの追加、変更、および削除を行います。

v プロンプト

Web GUI には複数のタイプのプロンプトが備わっていて、イベント管理ツールはこれを使用してユーザーからの情報を取得できます。プロンプトの追加、変更、削除、およびリスト作成が可能です。

v CGI スクリプト

CGI スクリプトを登録、変更、および登録解除します。

v フィルター

フィルターの追加、変更、削除、およびリスト作成を行います。また、フィルターのデフォルト・ビューを設定できます。

v フィルター・コレクション

フィルター・コレクションの追加、変更、削除、およびリスト作成を行います。また、フィルター・コレクションにフィルターを追加したり、フィルター・コレクションからフィルターを削除したりすることもできます。

v メトリック (ゲージ)

Web GUI がゲージ形式で表示するメトリックの作成、変更、削除、およびリスト作成を行います。

v 関係

イベント関係の作成、変更、削除、およびリスト作成を行います。

v その他

他のどのカテゴリーにも適合しない各種要求です。

– Web GUI キャッシュを ObjectServer と再同期します。

– ロード・バランシング・クラスターからノードを削除します。

– システム状況報告を生成します。

– すべてのフィルターとビューを再ロードします。

2 IBM Tivoli Netcool/OMNIbus: Web GUI Administration API (WAAPI) ユーザーズ・ガイド

Web GUI を変更するための比較手順Dashboard Application Services Hub で変更できるほとんどの Web GUI コンポーネントで、DTD に同等の XML 構成の命令が定義されています。

次に示す例では、アクティブ・イベント・リスト (AEL) でフィールド・ビューを変更するための比較手順について説明します。

Web GUI の手順

次の手順の例では、Dashboard Application Services Hub の Web GUI を使用して AEL でフィールド・ビューを変更する方法を説明します。

1. 「管理」 > 「イベント管理ツール」 > 「ビュー」をクリックします。

2. 「ビュー」リストから、変更するビューを選択します。

3. 「使用可能なフィールド」リストから、変更するフィールドを選択します。

4. 「Title」と「Data」の位置調整値を「Left」に変更します。

5. 列の幅を 12 に設定します。

6. 「保存」をクリックします。

同等の WAAPI 手順

次の手順の例では、WAAPI クライアントを使用して AEL でフィールド・ビューを変更する方法を説明します。

1. WAAPI DTD のルールに従って XML コマンド・ファイルを作成します。例:

<methodCall><method methodName="view.modifyView"><view viewName="myview" acl="*"><columns><visualEntry fieldName="myfield"fieldTitle="myfieldtitle"dataJustify="left"titleJustify="left"columnWidth="12"/>

</columns></view></method>

</methodCall>

2. WAAPI クライアントを始動して、コマンド・ファイルを Web GUI サーバーに送信します。

WAAPI クライアントと Web GUI サーバーの間の通信WAAPI クライアントが Web GUI サーバーと通信する方法。

通信方式の特性

WAAPI クライアントと Web GUI サーバーとの間の通信には、以下の特性があります。

v 要求/応答モデルを使用します。

v 同期型です。

v 要求は XML 形式です。

第 1 章 Web GUI Administration API (WAAPI) 3

v 応答はテキスト形式です。

v クライアントとサーバーの間では HTTP 接続または HTTPS 接続を使用します。

通信の概要

使用する WAAPI クライアントが Web GUI サーバーと一緒にインストールされた場合であっても、クライアントのリモート・インストールであっても、サーバーと通信する方法はまったく同じです。

1. 管理者が、1 つ以上の要求を 1 つ以上の XML ファイルの中に作成します。

2. 管理者が WAAPI クライアントを実行し、それに XML ファイルを提供します。

3. WAAPI により、HTTP 接続を介してサーバーにファイルが送信されます。

この接続では SSL と暗号化を使用して、データのセキュリティー維持に役立てることができます。

4. サーバーが要求を受信し、それを実行します。

5. サーバーは、同じ HTTP 接続を介して要求の出力をクライアントに返します。

6. WAAPI クライアントが出力を受信します。その処理方法は、使用する出力ファイルを管理者が要求の送信時に指定したかどうかによって異なります。

管理者が出力ファイルを指定した場合、WAAPI は対象ファイルを必要に応じて作成し、そのファイルに出力を送信します。それ以外の場合、WAAPI は管理者がクライアントを実行した画面に出力を送信します。

セキュリティーWAAPI クライアントには多数のセキュリティー機能があり、Web GUI クライアントとやり取りされるデータの整合性を保つのに役立ちます。

WAAPI には、サーバーとの間でやり取りされるデータを保護するために使用可能な以下の 3 つの方法が備わっています。

v サーバーへの接続の保護

v パスワードの暗号化

v WAAPI プロパティー・ファイルの保護

Web GUI サーバーへのセキュア接続

無保護の HTTP 接続の代わりに、Web GUI サーバーとの間で SSL を使用してセキュア接続をセットアップできます。この接続は、以下のいずれかの方法でセットアップできます。

v FIPS 140-2 を使用しないサーバーのみの認証

v FIPS 140-2 を使用しないサーバーとクライアントの認証

v FIPS 140-2 を使用したサーバーのみの認証

v FIPS 140-2 を使用したサーバーとクライアントの認証


NIST SP800-131a 暗号化の使用可能化

米国連邦情報・技術局 (NIST) SP800-131a セキュリティー標準をサポートするように、Web GUI を構成できます。SP800-131a には、他の標準 (例えば、FIPS 140-2)よりも長い鍵の長さや、より強力な暗号化が必要です。SP800-131a には、トランスポート層セキュリティー (TLS) V1.2 が必要です。

SP800-131a は 2 つのモード (移行と厳密) で実行できます。移行モードは、SP800-131a の厳密な適用に徐々に移行する場合に使用します。移行モードでは、厳密な適用よりも弱い鍵やアルゴリズムを使用できます。また、移行モードでは、TLS v1.0 および v1.1 の使用も可能です。その結果、既存の FIPS 140-2 準拠証明書を引き続き使用できるので、移行モードは、FIPS 140-2 からセキュリティー設定をアップグレードする場合に便利です。

パスワードの暗号化

使用するセキュア接続のタイプにかかわらず、WAAPI により、使用するパスワードを暗号化する手段が提供されます。無保護の HTTP 接続は、AES パスワード暗号化を使用できます。セキュア接続を使用する場合、AES または FIPS 140-2 の暗号化を指定できます。接続で FIPS 140-2 を使用する場合、使用可能となるのはFIPS 140-2 パスワード暗号化だけです。

WAAPI プロパティー・ファイルの保護

WAAPI プロパティー・ファイル (waapi.init) には、多数の機密データ項目が含まれます。例えば、WAAPI 要求を実行するサーバーの管理ユーザーのユーザー名とパスワードを保持することが少なくありません。このデータを権限のないユーザーから守り、管理者だけが使用できるようにすることが重要です。そのためには、オペレーティング・システムのアクセス制御メカニズムを使用して、対象ファイルへのアクセスを制限できます。

関連資料:

123 ページの『付録 C. WAAPI のセキュリティー』WAAPI には、Web GUI サーバーとの通信を確実に保護するのに役立つ多数のセキュリティー機能があります。

第 1 章 Web GUI Administration API (WAAPI) 5


第 2 章 WAAPI の使用

ご使用の環境における WAAPI プロパティー・ファイルのセットアップ方法、および WAAPI クライアントを使用して要求を Web GUI サーバーに送信する方法。

WAAPI プロパティー・ファイルのセットアップWAAPI プロパティー (waapi.init) を使用して、ご使用の環境に適合させます。

手順

WAAPI 初期設定ファイル内のプロパティーを、ご使用の環境に合わせて設定します。まれにしか値を変更しないプロパティーの値を設定します。以下に例を挙げます。

v waapi.host

v waapi.port

v waapi.user

v waapi.password

v セキュア接続と暗号化のプロパティー

このようにすると、コマンド行で入力する必要のあるオプション数を最小限にすることができます。

注: waapi.user プロパティーと waapi.password プロパティーを設定する場合は、許可された管理者以外のユーザーがアクセスできないようにプロパティー・ファイルが保護されていることを確認してください。複数の Web GUI サーバーを 1 箇所から管理する場合は、サーバーごとに 1 つずつ、複数のプロパティー・ファイルを使用できます。このようにして、各サーバーのプロパティーを調整できます。また、プロパティー・ファイルを使用してプロパティーのデフォルト値を保持することも可能です。コマンド行オプションを使用すると、いつでもプロパティー設定をオーバーライドできます。

関連資料:

115 ページの『付録 A. WAAPI プロパティーとコマンド行オプション』ここでは、WAAPI クライアントのプロパティーおよびコマンド行オプションについて説明します。


サーバーへの WAAPI 要求の送信要求を Web GUI サーバーに送信するには、要求を入れた WAAPI コマンド・ファイルを作成し、WAAPI クライアントを実行してそのファイルをサーバーに送信します。

手順1. WAAPI コマンド・ファイルは、次のようにして作成します。

a. サフィックスが .xml の 8 ビット Unicode Transformation Format(UTF-8) テキスト・ファイルを作成します。

b. 要求をファイルに追加します。

ヒント: コマンド・ファイルのテンプレートとして、クライアントに備わっているサンプルの WAAPI ファイルを使用します。

c. UTF-8 を使用してファイルを適切なディレクトリーに保存します。

2. クライアントを実行し、サーバーにファイルを送信するには、次のようにします。

a. 使用するオペレーティング・システムに応じて、次のコマンドを入力します。

v UNIX Linux WEBGUI_HOME/waapi/bin/runwaapi options -file

waapi_command_file

v Windows WEBGUI_HOME¥waapi¥bin¥runwaapi.cmd options -file

waapi_command_file

次のように置き換えます。

web_gui_home_dir

この部分は、Web GUI のインストール・ディレクトリーに置き換えます。クライアントをリモート・システムで実行している場合には、クライアントをインストールした場所を指定します。

options

この部分は、必要な追加のコマンド行オプションと置き換えます。一般的に使用されるオプションについては、以下の表で説明しています。

表 2. よく使用される WAAPI コマンド行オプション

機能オプション

ファイルへの出力のリダイレクト -outfile filepath

filepath は、WAAPI コマンド・ファイルから出力を受け取るファイルのパスに置き換えてください。


表 2. よく使用される WAAPI コマンド行オプション (続き)

機能オプション

コマンド・ファイルを実行するユーザー名とパスワードの指定

-user username -password password

username は使用するアカウントの名前に、password はそのアカウントのパスワードに置き換えます。注: これらのオプションを使用する場合、画面とコマンド履歴を消去し、資格情報がセキュアな状態に保たれるようにしてください。

代わりのプロパティー・ファイルの使用 -props propsfile

propsfile は、使用する WAAPI プロパティー・ファイルのパス名に置き換えます。

waapi_command_file

この部分は WAAPI コマンド・ファイルの名前に置き換えます。

例えば、Windows システムでは次のようになります。

c:¥ibm¥netcool¥omnibus_webgui¥waapi¥bin¥runwaapi.cmd-file newFilters.xml

第 2 章 WAAPI の使用 9


第 3 章 WAAPI 要求

WAAPI 要求は XML 文書であり、Web GUI サーバーを管理するための指示が入っています。

WAAPI 要求を使用して以下の項目を管理できます。

v 15 ページの『ユーザー要求』

v 26 ページの『ビュー要求』

v 34 ページの『マップ要求』

v 56 ページの『リソース要求』

v 58 ページの『ファイル要求』

v 61 ページの『メニュー要求』

v 66 ページの『ツール要求』

v 76 ページの『プロンプト要求』

v 85 ページの『CGI 要求』

v 88 ページの『フィルター要求』

v 95 ページの『フィルター・コレクション要求』

v 100 ページの『メトリック要求』

v 107 ページの『関係要求』

v 112 ページの『その他の要求』

注: 属性の名前の中には、長いものがあります。以下の構文説明では、そうした長い名前は 2 行以上に分割されています。ただし、作成する XML においては、それぞれの属性名は改行なしの単一の文字シーケンスとして入力してください。

WAAPI 要求の構造WAAPI 要求は XML 文書であり、オプションの XML 宣言と、それに続く<methodCall> ルート・エレメントが入ります。要求には、留意する必要のある追加の特性が多数あります。

v 『XML 宣言』

v 12 ページの『<methodCall> ルート・エレメント』

v 12 ページの『ルート・エレメントの基本形式』

v 12 ページの『ツール要求、プロンプト要求、メトリック要求、および関係要求のルート・エレメント』

v 12 ページの『ルート・エレメントの内容』

XML 宣言

オプションとして、WAAPI 要求は XML 宣言で開始することもできます。今回のリリースの Web GUI の場合、この宣言は次のようになります。

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


<methodCall> ルート・エレメント

ルート・エレメントは要求の内容を保持します。ツール要求、プロンプト要求、メトリック要求の場合、ルート・エレメントによって名前空間も定義されます。

ルート・エレメントの基本形式

ルート・エレメントの基本形式は次のとおりです。

<methodCall>

</methodCall>

ツール要求、プロンプト要求、メトリック要求、および関係要求のルート・エレメント

ツール要求、プロンプト要求、メトリック要求、および関係要求のルート・エレメントの形式は、次のとおりです。

<methodCall xmlns:type=namespace-url>

</methodCall>

ここで、type は要求 (ツール、プロンプト、メトリック、または関係) のタイプで、namespace-url は名前空間の完全修飾 URL です。ツール、プロンプト、メトリック、および関係の各要求の場合のみ、名前空間 URL が必要になります。

プロンプト、ツール、メトリック、および関係の各要求の名前空間 URL については、以下の表で説明しています。

表 3. 名前空間 URL

要求のタイプ名前空間 URL

ツール "http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"

プロンプト "http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2"

メトリック "http://www.ibm.com/tivoli/netcool/webtop/metrics/7.3.1"

関係 "http://www.ibm.com/tivoli/netcool/webtop/relationships/7.4"

ルート・エレメントの内容

ルート・エレメントは形式がどのようなものであれ、1 つ以上の <method> エレメントが入ります。こうした各エレメントには、Web GUI データの 1 つの項目を操作する 1 つの要求が入ります。後のセクションで、WAAPI が操作可能なデータ・タイプごとに <method> エレメントのフォーマットと内容を取り上げます。<method> エレメントには、データ項目のタイプとそのデータで実行する操作を定義する methodName 属性が入ります。<method> エレメントには、データ項目を定義する子エレメントが入ります。

例えば、methodCall 属性の値が view.createView の場合、<method> エレメントには、Web GUI ビューのコレクションに追加するビューの特性をそれぞれ定義する1 つ以上の <view> エレメントが入ります。

ルート・エレメントには、任意の組み合わせの Web GUI データ項目のメソッド呼び出しを含めることができます。エレメントにツール、プロンプト、メトリック、


および関係の各要求の任意の組み合わせが含まれる場合、<methodCall> エレメントに対応するそれぞれの xmlns 属性を含めます。

例えば、<methodCall> エレメントにビュー、ツール、およびプロンプトの<method> エレメントが含まれる場合、<methodCall> エレメントを次のように指定します。

<methodCall xmlns="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"xmlns="http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2" >



</methodCall>

WAAPI XML 文書の特性WAAPI 要求が含まれる XML 文書には、留意すべき特性が多数あります。

v 『文書タイプ定義 (DTD)』

v 『XML エレメントの順序』

v 14 ページの『大/小文字の区別』

v 14 ページの『内容と値の制約事項』

v 14 ページの『コメント』

文書タイプ定義 (DTD)

各 WAAPI 要求は整形式でなければならず、WAAPI クライアントによって文書タイプ定義 (DTD) に照らして妥当性検査されます。DTD は、要求内に示されるエレメントの構文に関する一連のルールを定義します。

DTD は、XML 要求に配置できるステートメント、エレメントの表示順序、ネスト可能なエレメント、属性を持つエレメントなどを定義します。 WAAPI DTD は次の場所にあります。

WEBGUI_HOME/waapi/etc/waapi.dtd

XML エレメントの順序

通常、WAAPI DTD は順序に対して柔軟性があります。要求ファイルが整形式である場合は、DTD で大部分の子ステートメントを構文解析できます。ただし、一部のエレメントでは、子エレメントを特定の順序で配置することが要求されます。

順序に対して柔軟性があるエレメントの例には、<supermenu> があります。<supermenu> エレメントには、<tool>、<separator>、および <menu> の 3 つのタイプの子エレメントを含めることができます。これらのエレメントは、<supermenu>エレメント階層内で任意の順序で配置できます。エレメントを配置する順序は、これらの命令で作成される AEL ツール・メニューの外観に反映されます。

一方、<method> エレメントと <view> エレメントの子エレメントは、正しい順序で配置する必要があります。以下の表に、<method> と <view> の子エレメントを配置すべき順序を定義します。

第 3 章 WAAPI 要求 13

表 4. 子エレメントの順序

エレメント子エレメントの順序

method 1. user

2. view

3. filter

4. map

5. resources

6. supermenu

7. tools

8. cgi

9. file

10. tool:tool

11. prompt:prompt

12. filterCollection

13. metric:metric

14. relationship:relationship

view 1. columns

2. sorting

大/小文字の区別

XML 文書では、エレメント名と属性名には大/小文字の区別があります。メソッド定義で指定したのと同じ大/小文字を使用してください。また、一部のエレメントの内容や一部の属性の値にも大/小文字の区別があります。メソッド定義のエレメントの内容と属性値の説明には、大/小文字の区別に関する情報が含まれています。特に、列挙値はメソッド定義に示されているとおりに指定してください。

内容と値の制約事項

一部のエレメントの内容と一部の属性の値に関しては、制約事項が存在します。例えば、属性値に含めることができる文字数に制限がある場合があります。各メソッド定義のエレメントと属性の説明で、適用される内容の制約事項が定義されています。

コメント

標準の XML 構文を使用して WAAPI 要求にコメントを入れることができます。コメントは構文  で終了します。開始構文と終了構文の間にコメントを入れます。コメントは、単一行にも複数行にもできます。

例:






サンプル要求Web GUI は広範囲に渡るサンプル要求を備えています。

Web GUI サーバーのインストールには、一連のサンプル要求が含まれています。これらを、使用する要求のモデルにできます。以下のディレクトリーにサンプルがあります。

WEBGUI_HOME/waapi/etc/samples

ここで、WEBGUI_HOME は Web GUI のインストール・ディレクトリーです。例えば、ibm/tivoli/netcool/omnibus_webgui などです。

ユーザー要求ユーザー要求は、Web GUI ユーザーに対して作動します。ユーザーの変更、ユーザー・リストの取得、および Web GUI ユーザー特権を持っていないユーザーの構成情報の削除を行う機能があります。WAAPI にはシステムに定義されたユーザーを処理するための 3 つのメソッドがあります。つまり、ユーザーの保守、ユーザーの変更、およびユーザー・リストの取得です。

ユーザーの保守ユーザーを保守するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="user.maintainUsers" />

このメソッドを使用して、ncw_user 役割も ncw_admin 役割も持たなくなったすべてのユーザーの Web GUI 構成データを削除します。構成データには、以下の情報が含まれます。

v 設定

v フィルター定義

v ビュー定義

例<methodCall>

<method methodName="user.maintainUsers" /></methodCall>

ユーザーの変更ユーザーを変更するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="user.modifyUser">

このメソッド呼び出しを使用して、以下に挙げるユーザー特性をいくつでも変更できます。

v デフォルト・フィルター

v ホーム・ページ

v イベント・ビューアーの設定


v AEL 特性 (以下が含まれます)

– AEL に対するアクセス

– 最新表示のデフォルトの最小時間

– AEL に表示する項目

<method> エレメントには、変更するユーザーとユーザー特性をそれぞれ指定する 1つ以上の <user> エレメントが入ります。変更する特性に対応する <user> の属性だけを含めます。属性を省略すると、対応する特性は変更されません。

<user>

<user> エレメントはユーザーの特性を定義します。以下の属性があります。

表 5. <user> エレメントの属性

属性名必須またはオプション説明

name 必須変更するユーザーを指定します。

値: Web GUI ユーザーのユーザー名。

デフォルト値: なし

filter オプションユーザーの AEL に表示されるイベント重大度レベルを定義します。

値: ストリング


homepage オプションユーザーのホーム・ページの URL (Web GUI のコンテキスト・ルートからの相対指定)。

値: ホーム・ページの名前と場所。

デフォルト値: /index.html

ael_user オプションユーザーがアクティブ・イベント・リスト (AEL)にアクセス可能かどうかを指定します。

値: true または false

デフォルト値: true

ael_user_properties_acknowledge_font_color

オプション確認済みイベントのフォント色を定義します。


デフォルト値: White

ael_user_properties_allow_select

オプションユーザーが ACL で自分自身の設定ができるかどうかを指定します。



ael_user_properties_allow_custom_refresh

オプション AEL 表示をユーザーが最新表示できるかどうかを指定します。この属性の値は、次のいずれかになります。


デフォルト値: false


表 5. <user> エレメントの属性 (続き)


ael_user_properties_refresh_time

オプション対象ユーザーの AEL の最新表示時間 (秒) を指定します。

値: 整数

デフォルト値: 60

ael_user_properties_minimum_refresh_time

オプションユーザーが指定可能な最小最新表示時間 (秒) を指定します。この属性の値は、ael_user_properties_refresh_

time の値以下でなければなりません。

値: 整数。


ael_user_properties_show_colors

オプションユーザーの AEL で色を使用するかどうかを指定します。



ael_user_properties_show_info オプション AEL の「アラート」メニューに、「情報」ウィンドウを表示するオプションを含めるかどうかを指定します。



ael_user_properties_show_journal

オプションアラートの「情報」ウィンドウに「ジャーナル」タブを含めるかどうかを指定します。



ael_user_properties_show_details

オプションアラートの「情報」ウィンドウに「詳細」タブを含めるかどうかを指定します。



ael_user_properties_show_menubar

オプション AEL ウィジェットにメニュー・バーを含めるかどうかを指定します。



ael_user_properties_show_graphicconversions

オプション AEL に重大度アイコンを表示するかどうかを指定します。

値: show、showwithtext、または dontshow

デフォルト値: show

ael_user_properties_show_preferences

オプション AEL の「編集」メニューまたは、ツールバーの「設定」アイコンから、「設定」ウィンドウにユーザーがアクセスできるかどうかを指定します。






ael_user_properties_monitor_show_number

オプションイベントの総数を AEL のモニター・ボックスに表示するかどうかを指定します。



ael_user-properties_monitor_show_highest

オプション最大重大度レベルを AEL のモニター・ボックスに表示するかどうかを指定します。



ael_user_properties_monitor_show_highest_color

オプション最大重大度レベルの色を AEL のモニター・ボックスに表示するかを指定します。



ael_user_properties_monitor_show_lowest

オプション最小重大度レベルを AEL のモニター・ボックスに表示するかどうかを指定します。



ael_user_properties_monitor_show_lowest_color

オプション最小重大度レベルの色を AEL のモニター・ボックスに表示するかどうかを指定します。



ael_user_properties_monitor_show_border

オプションイベント・ダッシュボード内、または SmartPageコマンドを使用してモニター・ボックス・スタイルで表示された AEL 内の、モニター・ボックスを囲む境界線の色を、ボックスまたは AEL に表示される最大重大度レベルと同じ色にするかどうかを指定します。



ael_user_properties_monitor_show_metric

オプションメトリックを AEL のモニター・ボックスに表示するかどうかを指定します。



ael_user_properties_monitor_distribution_meter

オプションユーザーの AEL モニター・ボックス上にアラートを示すために使用する配布メーターのタイプを指定します。

値: histogram、lavalamp、または none。

デフォルト値: histogram




ael_user_properties_flash_time

オプション AEL 内のアラートのフラッシュ時間 (ミリ秒) を指定します。この属性が有効なのは、ael_user_properties_flash_enabled の値が true の場合だけです。

値: 整数


ael_user_properties_flash_brightness

オプション AEL 内のアラートのフラッシュの輝度を指定します。この属性が有効なのは、ael_user_properties_flash_enabled の値が true の場合だけです。

値: 整数


ael_user_properties_flash_enabled

オプション AEL の未通知イベントをフラッシュするかどうかを指定します。



ael_user_properties_show_summarybar

オプション要約バーを AEL の下端に表示するかどうかを指定します。



ael_user_properties_show_toolbar

オプションツールバーを AEL の上部に表示するかどうかを指定します。



ael_user_properties_monitor_font_name

オプション AEL のモニター・ボックス上のテキストに使用するフォント名を指定します。


デフォルト値: Dialog

ael_user_properties_monitor_font_size

オプション AEL のモニター・ボックス上で使用するフォント・サイズを指定します。

値: 整数


ael_user_properties_timeformat オプション AEL およびイベント・ビューアーで表示される日時の形式を指定します。

値: short、long、または日時形式。

デフォルト値: short

ael_user_properties_eventlist_font_name

オプション AEL で使用するフォントの名前を指定します。


デフォルト値: Dialog




ael_user_properties_eventlist_font_size

オプション AEL で使用されるフォント・サイズを指定します。

値: 整数


ael_user_properties_eventlist_width

オプション AEL の全幅 (ピクセル) を指定します。

値: 整数


ael_user_properties_eventlist_height

オプション AEL の全高 (ピクセル) を指定します。

値: 整数


ael_user_properties_notify_enabled

オプション AEL でイベントが追加または変更された時に通知(音など) を行うかどうかを指定します。



ael_user_properties_notify_when_iconized

オプションユーザーが AEL をアイコン化した場合、新しいイベントの到着時に AEL を再表示するかどうかを指定します。



ael_user_properties_notify_always

オプション AEL が開いた状態、閉じた状態、またはアイコン化されているかに関係なく、イベントの到着時にユーザーが通知を受け取るかどうかを指定します。



ael_user_properties_notify_insert

オプション AEL にイベントが追加された時にユーザーが通知を受け取るかどうかを指定します。



ael_user_properties_notify_delete

オプションイベントが AEL から削除された時にユーザーが通知を受け取るかどうかを指定します。



ael_user_properties_notify_update

オプション AEL 内の任意のイベントが更新された時にユーザーが通知を受け取るかどうかを指定します。



ael_user_properties_notify_play_sound

オプション使用する通知に音の再生を含めるかどうかを指定します。






ael_user_properties_notify_sound_url

オプション通知として再生する音の URL を指定します。



ael_user_properties_notify_flash_icon

オプション通知の一部として AEL アイコンをフラッシュさせるかどうかを指定します。



ael_user_properties_notify_open_window

オプション通知の一部としてウィンドウを開くかどうかを指定します。



ael_user_properties_notify_open_url

オプション通知の一部として URL を開くかどうかを指定します。



ael_user_properties_notify_url オプション ael_user_properties_notify_open_url の値が trueの場合に開く URL を指定します。



ael_user_properties_notify_url_target

オプション ael_user_notify_url で指定された URL を開くブラウザーのターゲットを指定します。HTML でフレームが定義されている場合、フレーム名としてターゲットを指定できます (例えば、UpperFrame)。

値: _blank、またはフレーム名。


ael_user_properties_monitor_num_cols

オプション AEL に表示されるモニター・ボックス・アプレットの列数を指定します。

値: 整数


ael_user_properties_allow_journal_edit

オプションユーザーが、AEL に関連付けられたジャーナルを編集できるかどうかを指定します。



ael_user_properties_allow_filter_builder_access

オプションユーザーが、AEL からフィルター・ビルダーにアクセスできるかどうかを指定します。



ale_user_properties_allow_view_builder_access

オプションユーザーが、AEL からビュー・ビルダーにアクセスできるかどうかを指定します。






ael_user_properties_allow_filters_and_views_use

オプションユーザーが AEL で事前定義フィルターおよびビューを選択できるかどうかを指定します。



event_dashboard_monitor_show_tooltip オプションこの属性は、イベント・ダッシュボードのモニター・ボックスにおける拡張ツールチップの表示を、ユーザーがオンまたはオフにできるようにします。



event_viewer_allow_column_moving オプションこの属性は、ユーザーがイベント・リストで列をドラッグして移動できるようにします。



event_viewer_allow_custom_sorting オプションこの属性は、ユーザーが列見出しのソート・アイコンをクリックしてイベント・リストでカスタム・ソートを実行できるようにします。



event_viewer_column_locking オプションイベント・リストの列の固定を有効または無効にします。有効にした場合、現在のビューでロック済みとして定義された列は、水平方向のスクロール時に常に表示されます。



event_viewer_flashing オプション alerts.status 表の Flash フィールドが 1 に設定されているアラートについて、イベント・リストでのフラッシュを有効または無効にします。



event_viewer_notifications オプションイベント・リストのアラートの通知を有効または無効にします。



event_viewer_popup_notify_insert オプションイベント・リストに新規に挿入されたイベントに対するポップアップ・メッセージを有効にします。



event_viewer_popup_notify_modify オプションイベント・リストで変更されている既存のイベントに対するポップアップ・メッセージを有効にします。






event_viewer_popup_notify_delete オプションイベント・リストで削除されているイベントに対するポップアップ・メッセージを有効にします。



event_viewer_show_event_search オプションユーザーが「情報」ウィンドウの「イベント検索」タブを表示することを許可します。



event_viewer_sound_notify_insert オプションイベント・リストに新規に挿入されたイベントに対する音通知を有効にします。



event_viewer_sound_notify_modify オプションイベント・リストで変更されている既存のイベントに対する音通知を有効にします。



event_viewer_sound_notify_delete オプションイベント・リストで削除されているイベントに対する音通知を有効にします。



event_viewer_sound_notify_file オプションイベント・リストでの音通知のためにタイプmp3、wav、または ogg のファイルを指定します。


デフォルト値: empty

event_viewer_eventlist_font_name オプションイベント・ビューアーで使用するフォントの名前を指定します。

値: フリー・テキスト

デフォルト値: Helvetica

event_viewer_eventlist_font_size オプションイベント・ビューアーで使用するフォントのサイズを指定します。

値: 整数 (5 以上)


event_viewer_eventlist_icon_display

オプションイベント・ビューアーでアイコン・ベースの値を表示する方法を指定します。

値: icon、iconandtext、または text

デフォルト値 : icon

event_viewer_eventlist_padding オプションイベント・ビューアー内のテキストの周囲の縦方向の埋め込み (ピクセル数) を指定します。

値: 整数 (0 以上)





event_viewer_row_coloring オプションイベント重大度に応じて、イベント・ビューアー内の行に色を付けます。



event_viewer_show_toolbar オプションイベント・ビューアーのツールバーを表示または非表示にします。



event_viewer_show_toolbar_refresh

オプションイベント・ビューアーのツールバーの「最新表示」ボタンを表示または非表示にします。



event_viewer_show_toolbar_freeze

オプションイベント・ビューアーのツールバーの「凍結」ボタンを表示または非表示にします。



event_viewer_show_toolbar_filters_views

オプションイベント・ビューアーのツールバーのフィルター・コントロールおよびビュー・コントロールを表示または非表示にします。



event_viewer_show_toolbar_summary

オプションイベント・ビューアーのツールバーの「イベント要約」ボタンを表示または非表示にします。



event_viewer_show_toolbar_preferences

オプションイベント・ビューアーのツールバーの「設定」ボタンを表示または非表示にします。



event_viewer_show_toolbar_quick_filter

オプションイベント・ビューアーのツールバーの「簡易フィルター」フィールドを表示または非表示にします。



event_viewer_show_menu オプションイベント・ビューアーのメニュー・バーを表示または非表示にします。



event_viewer_show_status_bar オプションイベント・ビューアーのステータス・バーを表示または非表示にします。






map_editor_user_properties_show_grid

オプションマップ・エディターにグリッドを表示するかどうかを指定します。



map_editor_user_properties_snap_to_grid

オプションマップ・エディター内のオブジェクトをグリッドに合わせるかどうかを指定します。



map_editor_user_properties_grid_size

オプションマップ・エディター内のグリッドのサイズを指定します。

値: 整数


map_editor_user_properties_editor_width

オプションマップ・エディターの表示域の全幅 (ピクセル) を指定します。

値: 整数


map_editor_user_properties_editor_height

オプションマップ・エディターの表示域の全高 (ピクセル) を指定します。

値: 整数


maps_enable_accessibility_tooltips

オプションライトウェイト・マップに対するアクセシビリティー・ツールチップの表示を指定します。



例

以下の例の場合、user1 というユーザーが変更され、次の特性が定義されます。

v デフォルトのフィルターには、すべての重大度が表示されます。

v 以下の AEL 特性が変更されます。

– 最新表示の時間は 90 秒です。

– 最新表示の最小間隔は 70 秒です。

– ユーザーは AEL の「設定」ウィンドウにアクセスできます。

– ユーザーは AEL の最新表示を強制できません。

– ユーザーは、独自の設定を行えます。

– AEL の「情報」ウィンドウには、「詳細」タブと「ジャーナル」タブが含まれます。

– 「アラート」メニューには、「情報」ウィンドウを開くためのオプションが含まれます。


<methodCall><method methodName="user.modifyUser"><user name="user1"

filter ="Severity>=0"ael_user_properties_refresh_time="90"ael_user_properties_minimum_refresh_time="70"ael_user_properties_show_preferences ="true"ael_user_properties_allow_custom_refresh = "false"ael_user_properties_allow_select = "true"ael_user_properties_show_details ="true"ael_user_properties_show_info ="false"ael_user_properties_show_journal = "true">

</user></method>

</methodCall>

ユーザー・リストの取得ユーザー・リストを取得するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="user.getList" />

このメソッドを使用して、ncw_user 役割または ncw_admin 役割のどちらかを持つ、Web GUI に定義された全ユーザーのログイン・ユーザー名が入ったリストを取得します。

例<methodCall>

<method methodName="user.getList" /></methodCall>

ビュー要求ビュー要求は、Web GUI ビューに対して作用します。ビューを作成、変更、および削除する機能があります。また、Web GUI サーバーに定義されているビューのリストを取得できます。 WAAPI にはビューを処理するための 5 つのメソッドがあります。つまり、ビューの作成、ビューの作成または置換、ビューの変更、ビューの削除、およびビュー・リストの取得です。

ビューの作成ビューを作成するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="view.create">

このメソッドを使用して、AEL、イベント・ビューアー、LEL、テーブル・ビュー、およびイベント・ダッシュボードで使用する新しいビューを作成します。<method> エレメントには、1 つ以上の <view> エレメントが入り、それぞれが新しいビューの特性を定義します。<view> エレメントには、<columns>、<sorting>、および <grouping> の各エレメントを最大で 1 つずつ含めることができます。

v 27 ページの『<view>』

v 27 ページの『<columns>』

v 28 ページの『<visualEntry>』

v 28 ページの『<sorting>』


v 29 ページの『<sortColumn>』

v 29 ページの『<grouping>』

v 29 ページの『<groupColumn』

v 30 ページの『ユーザー・ビューの例』

<view>

<view> エレメントはビューを定義します。以下の属性があります。

表 6. <view> エレメントの属性


viewName 必須ビューの固有名を指定します。



datasource オプションビューのイベントを提供するデータ・ソースの名前。複数のデータ・ソースを指定する場合は、コンマ区切りのリストを使用します。


デフォルト値: NCOMS

user オプションユーザー・ビューの場合、この属性はビューが関連付けられているユーザーを識別します。属性の値は、ユーザー ID のコンマ区切りのリストです。

値: ユーザー ID のリスト


type オプションビューのタイプ。

値: global、system、group、またはuser

デフォルト値: system

relationshipName オプションイベント・ビューアーに適用されるビューで使用するイベント関係の名前。イベント関係は、イベント間の関係によってイベント・ビューアーを編成します。例えば、根本原因と症状によって編成します。



<columns>

<columns> エレメントは <view> エレメントの子であり、1 回指定するか、まったく指定しないかのいずれかです。このエレメントを指定する場合には、その中に任意の数の <visualEntry> エレメントを含めます。


<visualEntry>

<visualEntry> エレメントは <columns> エレメントの子であり、ビュー内のフィールドの外観を定義します。このエレメントの属性は以下のとおりです。

表 7. <visualEntry> エレメントの属性


fieldName 必須ビューに含めるフィールドの名前。これは、ビュー・ビルダーの「使用可能なフィールド」リストの項目に類似しています。

値: ObjectServer テーブルのフィールドの名前。


fieldTitle 必須ビューにおいてこのフィールドの列タイトルとして使用する名前。



dataJustify 必須列でテキストの位置調整を行う方法を指定します。

値: centre、left、または right。

デフォルト値: left

titleJustify 必須列タイトルを位置調整する方法を指定します。

値: centre、left、または right

デフォルト値: left

columnWidth 必須ピクセル単位の列の幅。

値: 整数


columnLocked オプション列の位置をロックするかどうか、またはユーザーが列の順序を並べ替えることができるようにするかどうかを指定します。



datasource オプションフィールドのデータを提供するデータ・ソースの名前。

値: データ・ソースの名前


<sorting>

<sorting> エレメントは <view> エレメントの子であり、1 回指定するか、まったく指定しないかのいずれかです。このエレメントを指定する場合には、ビュー内の


イベントのソート順序を定義する任意の数の <sortColumn> エレメントを中に入れます。

<sortColumn>

<sortColumn> エレメントは、ビューでリスト・イベントをソートする際に使用するフィールドを定義します。複数の <sortColumn> がある場合、ビュー内の項目は<sortColumn> エレメントの出現順でソートされます。

このエレメントの属性は以下のとおりです。

表 8. <sortColumn> エレメントの属性


fieldName 必須ビュー内のフィールドの名前。

値: フィールドの名前。


order 必須列項目のソート順序。

値: asc (昇順) または desc (降順)。

デフォルト値: asc

datasource オプション指定されたフィールドを提供するデータ・ソースの名前。

値: データ・ソースの名前。


<grouping>

<grouping> エレメントは <view> エレメントの子であり、1 回指定するか、まったく指定しないかのいずれかです。このエレメントを指定する場合、このビューを使用するときにイベント・ビューアーでイベントをグループ化する方法を定義する、任意の数の <groupColumn> エレメントを中に入れます。

<groupColumn

<groupColumn> エレメントは、イベント・ビューアーが使用するビューのリスト・イベントをグループ化するときに使用するフィールドを定義します。複数の<groupColumn> エレメントがある場合、ビュー内の項目は <groupColumn> エレメントの出現順でグループ化されます。

このエレメントの属性は以下のとおりです。

表 9. <groupColumn> エレメントの属性


fieldName 必須ビュー内のフィールドの名前。これは、ビュー・ビルダーの「使用可能なフィールド」リストの項目に類似しています。

値: フィールドの名前。



注:

v WAAPI DTD では、任意の数の <groupColumn> エレメントを使用できます。ただし、使用可能なグループ化レベルの最大数は Web GUI 初期設定ファイル(server.init) の columngrouping.maximum.columns プロパティーによって設定されます。デフォルトでは、このプロパティーの値は 3 ですが、管理者は別の値に設定できます。

このプロパティーによって定義されている値よりも多くのレベルを指定すると、サーバーがエラーを返します。

v server.init の columngrouping.allowedcolumns プロパティーにより、グループ化に使用可能なフィールドの名前が定義されます。このプロパティーのデフォルト値は、次のとおりです。

Acknowledged,AlertGroup,Class,Customer,Location,Node,NodeAlias,NmosCauseType,NmosManagedStatus,Severity,Service

管理者はこの値を変更できます。リスト内にない列をこのプロパティーに指定すると、サーバーがエラーを返します。

ユーザー・ビューの例

以下の例の場合、次の特性を持つ SeveritySummary というユーザー・ビューが作成されます。

v ビューには、以下のようにフォーマット設定されたフィールドが含まれています。

表 10. ユーザー・ビューの作成例: フィールドとそのフォーマット設定

フィールドフィールド・タイトル

データの位置調整

タイトルの位置調整列の幅

重大度 Sev 中央中央 5

Acknowledged Ack 中央中央 3

Node Node 左方左方 12

AlertGroup Alert Group 左方左方 10

Summary Summary 左方左方 40

LastOccurrence Last Occurrence 左方左方 14

v Severity 列と Acknowledged 列はロックされます。

v ビューでは、デフォルトのデータ・ソースを使用します。

v ビューでは、Severity の降順で項目がソートされます。

v ncoadmin ユーザーと tipadmin ユーザーがビューを使用可能です。

v ビューでは、Node によって項目がグループ化されます。

<methodCall><method methodName="createView"><view viewName="SeveritySummary"user="ncoadmin,tipadmin"type="user"><columns><visualEntry fieldName="Severity"fieldTitle="Sev"


dataJustify="centre"titleJustify="center"columnWidth="5"columnLocked="true" /><visualEntry fieldname="Acknowledged"fieldTitle="Ack"datajustify="centre"titleJustify="center"columnWidth="3"columnLocked="true" /><visualEntry fieldName="Node"fieldTitle="Node"dataJustify="left"titleJustify="left"columnWidth="12" /><visualEntry fieldName="AlertGroup"fieldTitle="Alert Group"dataJustify="left"titleJustify=left"columnWidth="10" /><visualEntry fieldName="Summary"fieldTitle="Summary"dataJustify="left"titleJustify="left"columnWidth="40" /><visualEntry fieldName="LastOccurrence"fieldTitle="Last Occurrence"dataJustify="left"titleJustify="left"columnWidth="14" />

</columns><sorting><sortColumn fieldName="Severity" order="desc" />

</sorting><grouping><groupColumn fieldName="Node" />

</grouping></view></method></methodCall>

ビューの作成または置換ビューを作成または置換するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="view.createOrReplaceView">

このメソッドを使用して、既存のビューを置換するか、まだ存在しない場合には新規作成します。<method> エレメントには、1 つ以上の <view> エレメントが入り、それぞれがビューの特性を定義します。各 <view> エレメントには、<columns> エレメント、<sorting> エレメント、および <grouping> エレメントを最大で 1 つずつ含めることができます。 <columns> エレメントを指定する場合には、任意の数の<visualEntry> エレメントを中に入れます。また、<sorting> エレメントを指定する場合には、それぞれの中に任意の数の <sortColumn> エレメントを入れます。<grouping> エレメントを指定する場合、任意の数の <groupColumn> エレメントを中に含めることができます。

<view> エレメントとそのサブエレメントについて詳しくは、 27 ページの『<view>』を参照してください。


以下の例の場合、アラートの最後のオカレンスについて要約したOccurrenceSummary というビューが作成または置換されます。Severity、Node、Summary、LastOccurrence の 4 つの列が入っています。これらの列は、ビューの作成例の対応する列と同じ方法でフォーマット設定されます。

<methodCall><method methodName="view.createOrReplaceView"><view viewName="OccurrenceSummary"user="ncoadmin,tipadmin"type="user"><columns><visualEntry fieldName="Severity"fieldTitle="Sev"dataJustify="centre"titleJustify="center"columnWidth="5"columnLocked="true" /><visualEntry fieldName="Node"fieldTitle="Node"dataJustify="left"titleJustify="left"columnWidth="12" /><visualEntry fieldName="Summary"fieldTitle="Summary"dataJustify="left"titleJustify="left"columnWidth="40" /><visualEntry fieldName="LastOccurrence"fieldTitle="Last Occurrence"dataJustify="left"titleJustify="left"columnWidth="14" />

</columns><sorting><sortColumn fieldName="LastOccurrence" order="desc" />

</sorting></view></method></methodCall>

ビューの変更ビューを変更するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="view.modifyView">

このメソッドを使用して、既存のビューの特性を変更します。必要に応じて、<columns>、<sorting>、および <grouping> エレメントの一部またはそれらすべてを、それぞれの子エレメントと共に含めます。例えば、ビューのソート方式を変更する場合、ソート方式を定義するのに必要な <sorting> エレメントに<sortColumn> エレメントを入れて指定します。


例

以下の例の場合、view1 というビューを変更し、次の変更を加えます。

v ビューに以下の 2 つのフィールドを組み込みます。

Node


Serial

v ビューでは、Severity フィールドの昇順で項目がソートされます。

<methodCall><method methodName="view.modifyView"><view viewName="view1"><columns><visualEntry fieldName="Node"fieldTitle="Node"dataJustify="left"titleJustify="left"columnWidth="18" />

<visualEntry fieldName="Serial"fieldTitle="Serial"dataJustify="left"titleJustify="left"columnWidth="12" />

</columns><sorting><sortColumn fieldName="Severity" order="asc" /></sorting></view></method></methodCall>

ビューの削除ビューを削除するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="view.delete">

<method> エレメントには、削除するビューをそれぞれ指定する 1 つ以上の<view> エレメントが入ります。view エレメントに含めるのは、viewName 属性だけです。


例

以下の例の場合、viewsample2 というビューが削除されます。

<methodCall><method methodName="view.deleteView"><view viewName="viewsample2"></view></method></methodCall>

ビュー・リストの取得ビュー・リストを取得するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="view.getList">

このメソッドは、Web GUI に定義されているすべてのビューの名前リストを返します。リストには、ビューのタイプごとに別個のセクションがあります。

このメソッドが返すのは名前だけで、リストの属性は返しません。


例<methodCall><method methodName="view.getList"></method></methodCall>

マップ要求マップは、イベントおよびそのロケーションを表示するためのビジュアル手段を提供します。マップおよびマップ・ビジュアルを作成、変更、および削除する機能があります。また、サーバーに定義されているマップのリストを取得できます。WAAPI にはマップを処理するための 5 つのメソッドがあります。つまりマップの作成、マップの作成または置換、マップの変更、マップの削除、マップ・リストの取得です。WAAPI にはマップ・ビジュアルを処理するための 4 つのメソッドがあります。つまり、マップ・ビジュアルの追加、マップ・ビジュアルの追加または置換、マップ・ビジュアルの変更、およびマップ・ビジュアルの削除です。

マップの作成マップを作成するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="map.createMap">

このメソッドを使用して、新しいマップを作成します。<method> エレメントには、新しいマップの特性をそれぞれ定義する 1 つ以上の <map> エレメントが入ります。<map> エレメントには、任意の数の <text>、<button>、<monitor>、<line>、<icon> の各エレメントが入ります。

v 『<map>』

v 35 ページの『<text>』

v 38 ページの『<button>』

v 41 ページの『<monitor>』

v 45 ページの『<icon>』

v 48 ページの『<line>』

v 51 ページの『例』

<map>

<map> エレメントはマップを定義します。以下の属性があります。

表 11. <map> エレメントの属性


name 必須マップの固有名を指定します。



bgImage オプションマップの背景として使用するイメージのパス。




表 11. <map> エレメントの属性 (続き)


bgColor オプションマップの背景として使用する色の名前。



h オプションピクセル単位のマップの高さ。

値: 整数


w オプションピクセル単位のマップの幅。

値: 整数


<text>

<text> エレメントは <map> エレメントの子であり、マップ上のテキスト・ラベルの特性を定義します。このエレメントは何度でも指定可能で、指定された場合には以下の属性を持ちます。

表 12. <text> エレメントの属性


filter オプションフィールドに関連付けるフィルターを定義します。



filterType オプション filter 属性で定義するフィルターのタイプ。

値: global または system


name 必須テキスト・ラベルの名前。



label オプションラベルに表示されるテキスト。



datasource オプションラベルに関連付けるデータ・ソースの名前。複数のデータ・ソースを指定する場合、コンマ区切りリストを使用します。




表 12. <text> エレメントの属性 (続き)


x オプションラベルの水平位置 (マップ左からのピクセル数)。

値: 整数


y オプションラベルの垂直位置 (マップ下部からのピクセル数)。

値: 整数


translucency オプションラベルの透明性レベル。

値: 0 以上 100 以下の範囲の整数。


rotate オプションラベルを回転させる角度。



show_shadow オプションマップ上でラベルにシャドーを付けて表示するかどうかを指定します。



font オプションラベルに使用するフォントの名前。



size オプションラベルに使用するフォントのポイント・サイズ。

値: 整数


justify オプションラベル内のテキストの位置合わせを定義します。

値: center、left、または right


style オプションラベルのテキスト・スタイル (太字など)。



color オプションテキストに使用する色の名前。






action オプションユーザーがテキスト・ラベルをクリックしたときに実行するアクション。

値: ストリング。イベント・リストを開くために指定できる値は次のとおりです。

v URL を開くには、「URL のオープン」または「進む」。URL は url 属性で指定されます。

v アクティブ・イベント・リストを開くには、「アクティブ・イベント・リスト (AEL)」または「ael」。

v ライトウェイト・イベント・リストを開くには、「ライトウェイト・イベント・リスト (LEL)」。

v テーブル・ビューを開くには、「イベント・テーブル (テーブル・ビュー)」。

v イベント・ビューアーを開くには、「イベント・ビューアー」。

v Dashboard Application ServicesHub ワイヤーを使用してNodeClickedOn イベントを送信するには、「イベント・リストの更新(ワイヤーを使用)」。このオプションの場合は、イベント・ビューアーまたは AEL に対するシステム・ワイヤーまたはカスタム・ワイヤーが構成されていることを確認してください。


url オプションテキスト・ラベルのアクション・ターゲットとなる Uniform ResourceLocator。



target オプション url 属性値の出力用の、ブラウザー内のターゲット・ウィンドウ。この属性がない場合、出力によって、現在のブラウザー・ウィンドウのコンテンツが置換されます。


デフォルト値: _blank




flash オプションテキスト・ラベルがフラッシュするかどうかを定義します。



<button>

<button> エレメントは <map> エレメントの子であり、マップ上のボタンの特性を定義します。このエレメントは何度でも指定可能で、指定された場合には以下の属性を持ちます。

表 13. <button> エレメントの属性


filter オプションボタンに関連付けるフィルターを定義します。






name 必須ボタンの名前。



label オプションボタンに表示されるテキスト。



datasource オプションボタンに関連付けるデータ・ソースの名前。複数のデータ・ソースを指定する場合、コンマ区切りリストを使用します。



x オプションボタンの水平位置 (マップ左からのピクセル数)。

値: 整数


y オプションボタンの垂直位置 (マップ下部からのピクセル数)。

値: 整数



表 13. <button> エレメントの属性 (続き)


translucency オプションボタンの透明性レベル。



show_shadow オプションマップ上でボタンにシャドーを付けて表示するかどうかを指定します。



font オプションボタン・テキストに使用するフォントの名前。



size オプションボタン・テキストに使用するフォントのポイント・サイズ。

値: 整数


font_color オプションボタン・テキストに使用する色の名前。



style オプションボタン・テキストのテキスト・スタイル(太字など)。



color オプションボタンに使用する色の名前。






action オプション値: ストリング。イベント・リストを開くために指定できる値は次のとおりです。








url オプションボタンのアクション・ターゲットとなるUniform Resource Locator。






flash オプションボタンがフラッシュするかどうかを定義します。






w オプションピクセル単位のボタンの幅。

値: 整数


h オプションピクセル単位のボタンの高さ。

値: 整数


type オプションボタンのタイプ。長方形など。

値: rectangle、rounded、またはellipse

デフォルト値: rectangle

arc_diameter オプションボタンの曲率の度数。

値: 整数


transparent オプションボタンを透明にするかどうかを定義します。



legend オプションボタンの凡例。



<monitor>

<monitor> エレメントは <map> エレメントの子であり、マップ上のモニター・ボックスの特性を定義します。このエレメントは何度でも指定可能で、指定された場合には以下の属性を持ちます。

表 14. <monitor> エレメントの属性


filter オプションモニター・ボックスに関連付けるフィルターを定義します。






name 必須モニター・ボックスの名前。




表 14. <monitor> エレメントの属性 (続き)


label オプションモニター・ボックスに表示されるテキスト。



datasource オプションモニター・ボックスに関連付けるデータ・ソースの名前。複数のデータ・ソースを指定する場合、コンマ区切りリストを使用します。



x オプションモニター・ボックスの水平位置 (マップ左からのピクセル数)。

値: 整数


y オプションモニター・ボックスの垂直位置 (マップ下部からのピクセル数)。

値: 整数


translucency オプションモニター・ボックスの透明性レベル。



show_shadow オプションマップ上でモニター・ボックスにシャドーを付けて表示するかどうかを指定します。



font オプションモニター・ボックス・テキストに使用するフォントの名前。



size オプションモニター・ボックス・テキストに使用するフォントのポイント・サイズ。

値: 整数


style オプションモニター・ボックス・テキストのテキスト・スタイル (太字など)。



color オプションボタンに使用する色の名前。






action オプションユーザーがモニター・ボックスをクリックしたときに実行するアクション。









url オプションモニター・ボックスのアクション・ターゲットとなる Uniform ResourceLocator。









flash オプションボタンがフラッシュするかどうかを定義します。



w オプションピクセル単位のモニター・ボックスの幅。

値: 整数


h オプションピクセル単位のモニター・ボックスの高さ。

値: 整数


type オプションモニター・ボックスのタイプ。ヒストグラムなど。

値: lavalamp または histogram

デフォルト値: histogram

flash オプションモニター・ボックスがフラッシュするかどうかを定義します。



show_label オプションモニター・ボックス上にラベルを表示するかどうかを定義します。



show_total オプションモニター・ボックス上にアラート合計数を表示するかどうかを定義します。



show_highest オプションモニター・ボックス上に最高の重大度を表示するかどうかを定義します。



show_lowest オプションモニター・ボックス上に最低の重大度を表示するかどうかを定義します。



show_metric オプションモニター・ボックス上にメトリックを表示するかどうかを定義します。






show_highest_severity_as_border

オプションモニター・ボックスの境界線として、フィルターがキャプチャーする最高の重大度アラートの色を使用するかどうかを定義します。



foreground_color オプションモニター・ボックスの前景に使用する色の名前。



background_color オプションモニター・ボックスの背景に使用する色の名前。



<icon>

<icon> エレメントは <map> エレメントの子であり、マップ上のアイコンの特性を定義します。このエレメントは何度でも指定可能で、指定された場合には以下の属性を持ちます。

表 15. <icon> エレメントの属性


filter オプションアイコンに関連付けるフィルターを定義します。






name 必須アイコンの名前。



label オプションアイコンに表示されるテキスト。




表 15. <icon> エレメントの属性 (続き)


datasource オプションアイコンに関連付けるデータ・ソースの名前。複数のデータ・ソースを指定する場合、コンマ区切りリストを使用します。



x オプションアイコンの水平位置 (マップ左からのピクセル数)。

値: 整数


y オプションアイコンの垂直位置 (マップ下部からのピクセル数)。

値: 整数


translucency オプションアイコンの透明性レベル。



show_shadow オプションマップ上でアイコンにシャドーを付けて表示するかどうかを指定します。



font オプションアイコン・テキストに使用するフォントの名前。



font_color オプションアイコン・テキストに使用する色の名前。



size オプションアイコン・テキストに使用するフォントのポイント・サイズ。

値: 整数


style オプションアイコン・テキストのテキスト・スタイル (太字など)。



url オプションアイコンのアクション・ターゲットとなる Uniform Resource Locator。






action オプションユーザーがアイコンをクリックしたときに実行するアクション。












flash オプションアイコンがフラッシュするかどうかを定義します。



w オプションピクセル単位のアイコンの幅。

値: 整数





h オプションピクセル単位のアイコンの高さ。

値: 整数


arc_diameter オプションアイコンの曲率の度数。

値: 整数


legend オプションアイコンの凡例。



image オプションアイコンに使用するイメージ・ファイルの名前。



entity_status_indicator オプションアイコンのフィードバック・プロパティーを定義します。

値: Highlight Bar、Fill Background、または Glow Background。


<line>

<line> は <map> エレメントの子であり、マップ上のラインの特性を定義します。このエレメントは何度でも指定可能で、指定された場合には以下の属性を持ちます。

表 16. <line> エレメントの属性


filter オプションラインに関連付けるフィルターを定義します。






name 必須ラインの名前。




表 16. <line> エレメントの属性 (続き)


label オプションラインに表示されるテキスト。



datasource オプションラインに関連付けるデータ・ソースの名前。複数のデータ・ソースを指定する場合、コンマ区切りリストを使用します。



x オプションラインの水平位置 (マップ左からのピクセル数)。

値: 整数


y オプションラインの垂直位置 (マップ下部からのピクセル数)。

値: 整数


translucency オプションラインの透明性レベル。



show_shadow オプションマップ上でラインにシャドーを付けて表示するかどうかを指定します。






action オプションユーザーがラインをクリックしたときに実行するアクション。









url オプションラインのアクション・ターゲットとなるUniform Resource Locator。









flash オプションラインがフラッシュするかどうかを定義します。



thickness オプションピクセル単位のラインの厚さ。

値: 整数


x2 オプションライン末尾の水平位置 (マップ左からのピクセル数)。

値: 整数


y2 オプションライン末尾の垂直位置 (マップ下部からのピクセル数)。

値: 整数


color オプションラインに使用する色の名前。



例

以下の例の場合、テキスト・ラベルが 2 つ、ボタンが 3 つ、モニター・ボックスが 3 つ入った map1 というマップが作成されます。

<methodCall><method methodName="map.createMap"><map name="map1"><text name="map1" label="map1" x="547" y="30" font="Helvetica" size="22"justify="center" style="bi" color="black" rotate="315" />

<text name="ael_instructions" label="Click Monitor Box for Tableview"x="550" y="141" font="Helvetica" size="10" justify="center"style="b" color="black" />

<button name="button1" label="Active Event List" x="296" y="146""Active Event List (AEL)" filter="Example_LastDay" filtertype="system"target="hidden" w="98" h="20" color="lightGray" type="rectangle"arc_diameter="20" transparent="false" legend="Label" font="Helvetica"size="11" font_color="black" show_shadow="true" />

<button name="button2" label="Active Event List" x="144" y="146"action="Active Event List (AEL)" filter="Example_Critical"

filtertype="system"target="hidden" w="98" h="20" color="lightGray" type="rectangle"arc_diameter="20" transparent="false" legend="Label" font="Helvetica"size="11" font_color="black" show_shadow="true" />

<button name="button3" label="Active Event List" x="21" y="146"action="Active Event List (AEL)" filter="Example_Unassigned"

filtertype="system"target="hidden" w="98" h="20" color="lightGray" type="rectangle"


arc_diameter="20" transparent="false" legend="Label" font="Helvetica"size="11" font_color="black" show_shadow="true" />

<monitor name="lastday" label="Last Day" x="294" y="10"action="Event Table (Table View)"

target="_blank" filter="Example_LastDay" filtertype="system" w="100"h="126" type="histogram" show_label="true" show_total="true"show_highest="false" show_lowest="false" show_metric="true"foreground_color="red" background_color="lightGray" font="Helvetica"size="10" style="p" show_highest_severity_as_border="false" />

<monitor name="critical" label="Critical" x="142" y="10"action="Event Table (Table View)"

target="_blank" filter="Example_Critical" filtertype="system" w="100"h="126" type="histogram" show_label="true" show_total="true"show_highest="false" show_lowest="false" show_metric="true"foreground_color="black" background_color="lightGray" font="Helvetica"size="10" style="p" show_highest_severity_as_border="false" />

<monitor name="unassigned" label="Unassigned" x="17" y="10"action="Event Table (Table View)"

target="_blank" filter="Example_Unassigned" filtertype="system" w="100"h="126" type="histogram" show_label="true" show_total="true"show_highest="false" show_lowest="false" show_metric="true"foreground_color="black" background_color="lightGray" font="Helvetica"size="10" style="p" show_highest_severity_as_border="false" />

</map></method></methodCall>

マップの作成または置換マップを作成または置換するときの <method> エレメントのフォーマットは次のとおりです。

<method methodName="map.createOrReplaceMap">

このメソッドを使用して、既存のマップを置換するか、マップがまだ存在しない場合には作成します。<method> エレメントには、マップの特性をそれぞれ定義する 1つ以上の <map> エレメントが入ります。各 <map> エレメントには、任意の数の<text>、<button>、<monitor>、<icon>、および <line> エレメントが入ります。詳しくは、 34 ページの『<map>』を参照してください。

以下の例の場合、モニター・ボックスが 2 つとテキスト・ラベルが 1 つ含まれるmap3 というマップが作成または置換されます。

<methodCall><method methodName="map.createOrReplaceMap"><map name="map3"><text name="ael_instructions" label="Click Monitor Box for Tableview"x="550" y="141" font="Helvetica" size="10" justify="center"style="b" color="black" />

<monitor name="critical" label="Critical" x="142" y="10" action="table"target="_blank" filter="Example_Critical" filtertype="system" w="100"h="126" type="histogram" show_label="true" show_total="true"show_highest="false" show_lowest="false" show_metric="true"foreground_color="black" background_color="lightGray" font="Helvetica"size="10" style="p" show_highest_severity_as_border="false" />

<monitor name="unassigned" label="Unassigned" x="17" y="10" action="table"target="_blank" filter="Example_Unassigned" filtertype="system" w="100"h="126" type="histogram" show_label="true" show_total="true"show_highest="false" show_lowest="false" show_metric="true"


foreground_color="black" background_color="lightGray" font="Helvetica"size="10" style="p" show_highest_severity_as_border="false" />

</map></method>

</methodCall>

マップの削除マップを削除するときの <method> エレメントのフォーマットは次のとおりです。

<method methodName="map.deleteMap">

このメソッドを使用して、既存のマップを削除します。<method> エレメントには、削除するマップをそれぞれ指定する 1 つ以上の <map> エレメントが入ります。<map> エレメントに含めるのは、name 属性だけです。詳しくは、 34 ページの『<map>』を参照してください。

以下の例の場合、map2 というマップが削除されます。

<methodCall><method methodName="map.deleteMap">

<map name="map2"></map>

</method></methodCall>

マップ・リストの取得マップ・リストを取得するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="map.getList">

このメソッドは、Web GUI に定義されているすべてのマップのリストを返します。

<methodCall><method methodName="map.getList"></method>

</methodCall>

マップの変更マップを変更するときの <method> エレメントのフォーマットは次のとおりです。

<method methodName="map.modifyMap">

このメソッドを使用して、既存のマップを変更します。<method> エレメントには、変更するマップと特性をそれぞれ指定する 1 つ以上の <map> エレメントが入ります。各 <map> エレメントには、任意の数の <text>、<button>、<monitor>、<icon>、および <line> エレメントが入ります。詳しくは、 34 ページの『<map>』を参照してください。

以下の例の場合、map1 というマップに次の変更を加えます。

v 背景色を白に設定します。

v マップの幅を 850 ピクセルに変更します。

v マップの高さを 490 ピクセルに変更します。


<methodCall><method methodName="map.modifyMap">

<map name="map1" bgImage="" bgColor="white" w="850" h="490" ></map>


マップ・ビジュアルの追加マップにビジュアルを追加するときの <method> エレメントのフォーマットは次のとおりです。

<method methodName="map.addMapVisual">

このメソッドを使用して、既存のマップに 1 つ以上のオブジェクトを追加します。<method> エレメントには、新しいオブジェクトの追加先となるマップを指定する 1つ以上の <map> エレメントが入ります。各 <map> エレメントには、任意の数の<text>、<button>、<monitor>、<icon>、<line> エレメントが入り、それぞれはマップに追加する新しいオブジェクトを定義します。詳しくは、 34 ページの『<map>』を参照してください。

以下の例の場合、map2 というマップにテキスト・ラベルとモニター・ボックスが追加されます。

<methodCall><method methodName="map.addMapVisual"><map name="map2"><text name="map2" label="map2" x="147" y="30" font="Helvetica" size="22"justify="center" style="bi" color="black" />

<monitor name="lastday" label="Last Day" x="131" y="92" action="table"url="" target="_blank" filter="ExampleLastDay" filtertype="system"w="100" h="126" type="histogram" show_label="true" show_total="true"show_highest="false" show_lowest="false" show_metric="true"foreground_color="red" background_color="lightGray" font="Helvetica"size="10" style="p" show_highest_severity_as_border="false" />


マップ・ビジュアルの追加または置換マップ・オブジェクトを追加または置換するときの <method> エレメントのフォーマットは次のとおりです。

<method methodName="map.createOrReplaceMapVisual">

このメソッドを使用して、新しいオブジェクトをマップに追加するか、対象オブジェクトが既に存在する場合にはそれを置換します。<method> エレメントには、コンテンツを変更する 1 つ以上の <map> エレメントが入ります。各 <map> エレメントには、任意の数の <text>、<button>、<monitor>、<icon>、<line> エレメントが入り、それぞれは追加または置換するオブジェクトを定義します。<map> エレメントに含めるのは、name 属性だけです。詳しくは、 34 ページの『<map>』を参照してください。

以下の例の場合、map2 というマップにアイコンが作成または置換されます。

<methodCall><method methodName="map.createOrReplaceMapVisual"><map name="map2">


<icon name="visual_3" label="Active Icon" x="75" y="233" action="ael"filter="Example_Critical" filtertype="system" target="hidden" w="30" h="19"type="rectangle" arc_diameter="10" legend="None" font="Helvetica"size="10" font_color="black" image="blocks.png"entity_status_indicator="Glow Background"/>


マップ・ビジュアルの削除マップからオブジェクトを削除するときの <method> エレメントのフォーマットは次のとおりです。

<method methodName="map.deleteMapVisual">

このメソッドを使用して、マップから 1 つ以上のオブジェクトを削除します。<method> エレメントには、変更するマップをそれぞれ指定する 1 つ以上の <map>エレメントが入ります。各 <map> エレメントには、削除するオブジェクトを指定する 1 つ以上の <text>、<button>、<monitor>、<icon>、または <line> エレメントを含めることが可能です。これらのエレメントのいずれも、中に含めるのは name属性だけです。詳しくは、 34 ページの『<map>』を参照してください。

以下の例の場合、visual_4 というテキスト・ラベルが map1 というマップから削除されます。

<methodCall><method methodName="map.deleteMapVisual"><map name="map1"><text name="visual_4" /></map></method></methodCall>

マップ・ビジュアルの変更マップ上のオブジェクトを変更するときの <method> エレメントのフォーマットは次のとおりです。

<method methodName="map.modifyMapVisual">

このメソッドを使用して、マップ上のオブジェクトの特性を変更します。<method>

エレメントには、変更するマップを識別する 1 つ以上の <map> エレメントが入ります。各 <map> エレメントには、変更するオブジェクトを定義する 1 つ以上の<text>、<button>、<monitor>、<icon>、および <line> エレメントが入ります。<map> エレメントに含めるのは、name 属性だけです。詳しくは、 34 ページの『<map>』を参照してください。

以下の例の場合、map1 というマップ上にある visual_1 というテキスト・ラベルに次の変更が加えられます。

v ラベルが My Active Button に設定されます。

v ボタンの水平位置が 230 ピクセルに変更されます。

v ボタンの垂直位置が 188 ピクセルに変更されます。

<methodCall><method methodName="map.modifyMapVisual"><map name="map1">


<button name="visual_1" label="My Active Button" x="230" y="188" /></map></method></methodCall>

リソース要求リソースは、Web GUI マップに表示可能なイメージです。リソースを追加および削除する機能、さらには Web GUI サーバー上に定義されているリソースのリストを取得する機能があります。 WAAPI にはマップ・リソースを処理するための 4つのメソッドがあります。つまり、リソースの追加、リソースの作成または置換、リソースの削除、およびリソース・リストの取得です。

リソースの追加リソースを追加するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="resource.addResource">

このメソッドを使用して、リソースをシステムに追加します。<method> エレメントには、リソースの追加先マップをそれぞれ定義する 1 つ以上の <resources> エレメントが入ります。<resources> エレメントには、リソースをそれぞれ指定する 1つ以上の <resource> エレメントが入ります。

<resources>

<resources> エレメントはマップ用の一連のリソースを定義します。以下の属性があります。

表 17. <resources> エレメントの属性


mapName 必須リソースの追加先マップの名前。



<resource>

<resource> エレメントは <resources> の子エレメントです。このエレメントはマップのリソースを定義します。以下の属性があります。

表 18. <resource> エレメントの属性


name 必須マップに追加するリソースの名前。




例

以下の例の場合、ny.gif というイメージが map1 というマップに追加されます。

<methodCall><method methodName="resource.addResource"><resources mapName="map1"><resource name="ny.gif" /></resources></method></methodCall>

リソースの作成または置換リソースを作成または置換するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="createOrReplaceResource">

このメソッドを使用して、マップにリソースを追加するか (対象リソースがマップに含まれていない場合)、マップ上のリソースの既存のインスタンスを置換します。<method> エレメントには、変更するマップを指定する任意の数の <resources> エレメントが入ります。詳しくは、 56 ページの『<resources>』を参照してください。各 <resources> エレメントには、追加または置換するリソースをそれぞれ指定する 1 つ以上の <resource> エレメントが入ります。詳しくは、 56 ページの『<resource>』を参照してください。

例

以下の例の場合、ny.gif というイメージが map1 というマップに追加されるか、そのマップで置換されます。

<methodCall><method methodName="resource.creatOrReplaceResource"><resources mapName="map1"><resource name="ny.gif" /></resources></method></methodCall>

リソースの削除リソースを削除するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="removeResource">

このメソッドを使用して、マップからリソースを削除します。<method> エレメントには、変更するマップを指定する任意の数の <resources> エレメントが入ります。詳しくは、 56 ページの『<resources>』を参照してください。各 <resources> エレメントには、追加または置換するリソースをそれぞれ指定する 1 つ以上の<resource> エレメントが入ります。詳しくは、 56 ページの『<resource>』を参照してください。

例

以下の例の場合、ny.gif というリソースが map1 というマップから削除されます。


<methodCall><method methodName="resource.removeResource"><resources mapName="map1"><resource name="ny.gif" /></resources></method></methodCall>

リソース・リストの取得リソース・リストを取得するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="resource.getList">

このメソッドは Web GUI サーバーに定義されているすべてのリソースのリストを返します。子エレメントはありません。リストにはマップごとに独自のセクションがあります。

例<methodCall><method methodName="resource.getList"></method></methodCall>

ファイル要求ファイル要求を使用すると、Web GUI サーバー上のファイルおよびディレクトリーを操作できます。ファイルおよびディレクトリーの作成と削除が可能です。WAAPI にはファイルを処理するための 6 つのメソッドがあります。つまり、ディレクトリーの追加、ファイルの追加、ファイルの作成または置換、ファイルの削除、ディレクトリーの削除、およびディレクトリーの再帰的削除です。

ディレクトリーの追加Web GUI サーバーにディレクトリーを追加するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="file.addDir">

このメソッドを使用して、Web GUI サーバー上に新しいディレクトリーを作成します。 <method> エレメントには、システム上に作成するディレクトリーをそれぞれ定義する 1 つ以上の <file> エレメントが入ります。各 <file> エレメントには、作成するディレクトリーを定義する dirName 属性を入れます。

v 『<file>』


<file>

<file> エレメントは、処理するファイルまたはディレクトリーの特性を定義します。このエレメントの属性は以下のとおりです。


表 19. <file> エレメントの属性


fileName オプション処理するファイルの名前。



dirName オプション作業するディレクトリーの指定。



toDir オプションコマンドの宛先ディレクトリー。



fromDir オプションコマンドのソース・ディレクトリー。



例

以下の例では、data という名前のディレクトリーを OMNIbusWebGUI.war ディレクトリー内 (JazzSM_WAS_Profile/installedApps/JazzSMNode01Cell/isc.ear/OMNIbusWebGUI.war 内) に作成します。

<methodCall><method methodName="file.addDir"><file dirName="data"></file></method></methodCall

ファイルの追加Web GUI サーバーにファイルを追加するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="file.addFile">

このメソッドを使用して、Web GUI サーバー上にファイルを作成します。<method> エレメントには、作成するファイルの名前と場所をそれぞれ定義する 1つ以上の <file> エレメントが入ります。<file> エレメントの内容が、新規ファイルの内容になります。詳しくは、 58 ページの『<file>』を参照してください。

例

以下の例の場合、data.txt というファイルが OMNIbusWebGUI.war ディレクトリー内に作成されます。

<methodCall><method methodName="file.addFile"><file fileName="data.txt" toDir="data"></file></method></methodCall>


ファイルの作成または置換ファイルを作成または置換するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="file.createOrReplaceFile">

このメソッドを使用して、同じ名前を持つ既存のファイルを置換するか、対象ファイルが存在しない場合にこれを作成します。 <method> エレメントには、作成または置換するファイルをそれぞれ指定する 1 つ以上の <file> エレメントが入ります。<file> エレメントの内容が、新規ファイルの内容になります。詳しくは、 58ページの『<file>』を参照してください。

例

以下の例の場合、hello.txt というファイルが OMNIbusWebGUI.war ディレクトリーに作成または置換され、ファイルの内容が「Hello world」というテキストに設定されます。

<methodCall><method methodName="file.createOrReplaceFile"><file fileName="hello.txt" toDir"data"></file></method><methodCall>

ファイルの削除ファイルを削除するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="file.deleteFile">

このメソッドを使用して、Web GUI サーバーのファイルを削除します。 <method>エレメントには、削除するファイルの名前と場所をそれぞれ定義する 1 つ以上の<file> エレメントが入ります。詳しくは、 58 ページの『<file>』を参照してください。

例

以下の例の場合、ファイル hello.txt が OMNIbusWebGUI.war ディレクトリーから削除されます。

<methodCall><method methodName="file.deleteFile"><file fileName="hello.txt" fromDir="data"></file></method></methodCall>


ディレクトリーの削除ディレクトリーを削除するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="deleteDir">

このメソッドを使用して、Web GUI サーバーのディレクトリーを削除します。<method> エレメントには、削除するディレクトリーをそれぞれ定義する 1 つ以上の <file> エレメントが入ります。各ディレクトリーは、空でなければなりません。詳しくは、 58 ページの『<file>』を参照してください。

例

以下の例の場合、test というディレクトリーが削除されます。

<methodCall><method methodName="deleteDir"><file dirName="test"></file></method></methodCall>

ディレクトリーの再帰的削除ディレクトリーを再帰的に削除するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="file.recurseRemove">

このメソッドを使用して、ディレクトリーとその内容すべてを削除します。このメソッドは、ディレクトリー・ツリーを削除する場合に役立ちます。<method> エレメントには、すべての内容と一緒に削除するディレクトリーをそれぞれ定義する 1 つ以上の <file> エレメントが入ります。詳しくは、 58 ページの『<file>』を参照してください。

例

以下の例の場合、data というディレクトリーが再帰的に削除されます。

<methodCall><method methodName="recurseRemove"><file dirName="data"></file></method><methodCall>

メニュー要求メニューによって、ユーザーは Web GUI 機能にアクセスできるようになります。メニューを作成、変更、および削除する機能があります。また、システム上のすべてのメニューのリストを取得することもできます。WAAPI にはメニューを処理するための 5 つのメソッドがあります。つまり、メニューの作成、メニューの作成または置換、メニューの変更、メニューの削除、およびメニュー・リストの取得です。


メニューの作成メニューを作成するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="menu.createMenu">

このメソッドを使用して新しいメニューを作成します。ここにツール、サブメニュー、およびセパレーターを含めることができます。<method> エレメントには、1 つ以上の <supermenu> エレメントが入ります。各 <supermenu> エレメントには、メニューの内容を定義する任意の数の <separator>、<menu>、および <tool> エレメントが入ります。

v 『<supermenu>』

– 『<separator>』

– 『<menu>』

– 63 ページの『<tool>』


<supermenu>

<supermenu> エレメントはメニューのコンテナーで、以下の属性があります。

表 20. <supermenu> エレメントの属性


name 必須メニューの固有名を指定します。



label オプション AEL に表示されるメニューのタイトル。


デフォルト値: name 属性の値。

mnemonic オプションメニューを選択するためにユーザーがAlt キーと組み合わせて使用できる単一文字。

値: 単一の英字。


<separator>

<separator> エレメントは <supermenu> エレメントの子であり、メニューの分離線の場所を定義し、何度でも指定できます。このエレメントには内容も属性もありません。

<menu>

<menu> エレメントは <supermenu> エレメントの子であり、サブメニューの場所を定義します。このエレメントは何度でも指定可能で、以下の属性があります。


表 21. <menu> エレメントの属性


name 必須メニューの固有名を指定します。



label 必須 AEL に表示されるメニューのタイトル。



mnemonic オプションメニューを選択するためにユーザーがAlt キーと組み合わせて使用できる単一文字。



<tool>

<tool> エレメントは <supermenu> エレメントの子であり、メニュー上にオプションとして表示するツールを定義します。このエレメントは何度でも指定でき、以下の属性があります。

表 22. <tool> エレメントの属性


name 必須ツールの固有名を指定します。



label 必須 AEL のメニューに表示されるツールのタイトル。



mnemonic オプションツールが含まれるメニューを選択するためにユーザーが Alt キーと組み合わせて使用できる単一文字。



shortcut オプションツールを選択するためにユーザーが Ctrlキーと組み合わせて使用できる単一文字。




例

以下の例では mentu1 と toolMenu1 という空のメニューを作成し、他の機能がここに項目を追加できるようにします。

<methodCall><method methodName="menu.createMenu"><supermenu name="menu1" ></supermenu><supermenu name="toolMenu1"></supermenu></method></methodCall>

メニューの作成または置換メニューを作成または置換するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="menu.createOrReplaceMenu">

このメソッドを使用して、新しいメニューを作成するか、既存のメニューを置換します。メニューには、ツール、サブメニュー、セパレーターを含めることができます。<method> エレメントには、1 つ以上の <supermenu> エレメントが入ります。各 <supermenu> エレメントには、メニューの内容を定義する任意の数の<separator>、<menu>、および <tool> エレメントが入ります。詳しくは、 62 ページの『<supermenu>』を参照してください。

例

以下の例の場合、toolMenu2 というメニューが作成または置換され、そこに 2 つのツールが追加されます。

<methodCall><method methodName="menu.createOrReplaceMenu"><supermenu name="toolMenu2"><tool shortcut="" label="Ping" name="Ping" mnemonic="" /><tool shortcut="" label="commandTool1" name="commandTool1" mnemonic="" /></supermenu><method></methodCall>

メニューの削除メニューを削除するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="menu.deleteMenu">

このメソッドを使用して、既存のメニューを削除します。<method> エレメントには、削除するメニューをそれぞれ指定する 1 つ以上の <supermenu> エレメントが入ります。<supermenu> エレメントに含めるのは、name 属性だけです。

例

以下の例の場合、menu1 というメニューが削除されます。


<methodCall><method methodName="menu.deleteMenu"><supermenu name="menu1"></supermenu></method></methodCall>

メニュー・リストの取得メニュー・リストを取得するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="menu.getList">

このメソッドは、Web GUI に定義されているすべてのメニューのリストを返します。

例<methodCall><method methodName="menu.getList"></method></methodCall>

メニューの変更メニューを変更するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="menu.modifyMenu">

このメソッドを使用して、既存のメニューを変更します。<method> エレメントには、1 つ以上の <supermenu> エレメントが入ります。各 <supermenu> エレメントには、メニューの内容を定義する任意の数の <separator>、<menu>、および <tool>エレメントが入ります。

例

以下の例では、menu1 に 1 つのメニューと 2 つのツールを追加し、次いでさらに別のツールと一緒にこのメニューを toolMenu2 に追加します。

<methodCall><method methodName="menu.modifyMenu">

<supermenu name="menu1" mnemonic="n" ><menu name="alerts" label="Alerts" mnemonic="a" /><separator /><tool name="acknowledge" label="Acknowledged" mnemonic="a"shortcut="ctrl+a" /><separator /><tool name="prioritise" label="Prioritize" mnemonic="p" shortcut="" /></supermenu>

<supermenu name="toolMenu1"><tool shortcut="" label="Ping" name="Ping" mnemonic="" /><separator /><menu name="menu1" label="menu1"/><separator /><tool shortcut="" label="commandTool1" name="commandTool1" mnemonic="" /></supermenu></method></methodCall>


ツール要求ツールは、AEL でイベントを管理するための拡張機能をユーザーに提供します。メニューを作成、変更、および削除する機能があります。また、システムに定義されているすべてのツールのリストを取得することもできます。WAAPI にはツールを処理するための 5 つのメソッドがあります。つまり、ツールの作成、ツールの作成または置換、ツールの変更、ツールの削除、およびツール・リストの取得です。

ツールの作成ツールを作成するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="createTool">

以下の各エレメントは、特定のツールを定義します。

v 『<tool:tool>』

– 67 ページの『<tool:access>』

- 67 ページの『<tool:osfield>』

v 67 ページの『<tool:criterion>』

– 68 ページの『<tool:equals>』

– 68 ページの『<tool:notequals>』

v 69 ページの『<tool:security>』

69 ページの『<tool:sql>』

– 69 ページの『<tool:journal>』

– 70 ページの『<tool:cgiurl>』

- 70 ページの『<tool:fieldlist>』

v 71 ページの『<tool:field>』

– 71 ページの『<tool:cmdline>』

- 71 ページの『<tool:command>』

– 72 ページの『<tool:script>』

v 72 ページの『使用上の注意』

v 72 ページの『例: SQL ツール』

v 73 ページの『例: CGI/URL ツール』

v 73 ページの『スクリプト・ツール』

<tool:tool>

<tool:tool> エレメントはツール用のコンテナーであり、何度でも指定できます。このエレメントの属性は以下のとおりです。

表 23. <tool:tool> エレメントの属性


name 必須ツールの固有名を指定します。




表 23. <tool:tool> エレメントの属性 (続き)


datasource オプションツールが使用するデータ・ソース。複数のデータ・ソースを指定する場合、コンマ区切りリストを使用します。


デフォルト値: デフォルトのデータ・ソース

<tool:access>

<tool:access> エレメントは <tool:tool> エレメントの子であり、ツールのアクセス基準を定義します。このエレメントに属性はありませんが、以下に挙げる子エレメントがこの順序で含まれます。

v <tool:osfield>

v <tool:security>

<tool:osfield>

<tool:osfield> エレメントには、ツールが使用する ObjectServer フィールドが含まれます。このエレメントには、任意の数の <tool:criterion> エレメントが含ま

れます。 Fix Pack 3

表 24. <tool:osfield> エレメントの属性


operator オプション条件マッチングの実行方法を指定します。operator=all では、ツールを使用可能にするために、リストされているすべての条件が一致することが必要になります。operator=any では、ツールを使用可能にするために、リストされている条件のいずれか 1 つが一致することが必要になります。

値: any または all

デフォルト値: all

<tool:criterion>

<tool:criterion> エレメントは <tool:osfield> エレメントと <tool:security>エレメントの子です。ツールのアクセス基準を定義し、1 つ以上の <tool:equals>エレメントが入ります。さらに、このエレメントには以下の属性があります。


表 25. <tool:criterion> エレメントの属性


name 必須ツールのアクセスのタイプ。

値: Class または Group。このエレメントが <tool:osfield> の子である場合、この属性の値は Class にする必要があります。このエレメントが<tool:security> の子である場合には、この属性の値は Group でなければなりません。

Fix Pack 3

alerts.conversion 表の他の

フィールドは値として使用できます。


<tool:equals>

<tool:equals> エレメントは <tool:criterion> の子であり、親エレメントによって定義されたオブジェクトに値を割り当てます。このエレメントには内容がありませんが、以下の属性があります。

表 26. <tool:equals> エレメントの属性


value 必須アクセス基準の値を指定します。



datasource オプション基準で使用するデータ・ソース。複数のデータ・ソースを指定する場合、コンマ区切りリストを使用します。



Fix Pack 3

<tool:notequals>

<tool:notequals> エレメントは <tool:criterion> の子であり、親エレメントによって定義されたオブジェクトに、不一致の値を割り当てます。このエレメントには内容がありませんが、以下の属性があります。


表 27. <tool:notequals> エレメントの属性


value 必須アクセス基準の不一致の値を指定します。



datasource オプション基準で使用するデータ・ソース。複数のデータ・ソースを指定する場合、コンマ区切りリストを使用します。



<tool:security>

<tool:security> エレメントは、AEL ツールのアクセス基準を定義します。このツールには、アクセス基準を定義する任意の数の <tool:criterion> エレメントが入ります。このエレメントには属性がありません。<tool:criterion> エレメントについて詳しくは、 67 ページの『<tool:criterion>』を参照してください。

<tool:sql>

<tool:sql> エレメントには、SQL コマンドと、SQL AEL ツールの関連オプションが入ります。このエレメントは空ですが、以下の属性があります。

表 28. <tool:sql> エレメントの属性


foreach オプションツールが、AEL の各選択行に作用するかどうかを定義します。



command 必須ツールの SQL コマンド。



<tool:journal>

<tool:journal> エレメントには、AEL ツールの実行時に作成されるジャーナル項目が入ります。このエレメントは空ですが、以下の属性があります。


表 29. <tool:journal> エレメントの属性





entry 必須ジャーナル項目のテキスト。



<tool:cgiurl>

<tool:cgiurl> エレメントは CGI/URL ツールを定義します。このエレメントには<tool:fieldlist> エレメントが入ります。以下の属性があります。

表 30. <tool:cgiurl> エレメントの属性





windowforeach オプション AEL に対してツールが実行されるときに、行ごとに出力ウィンドウを表示するかどうかを定義します。



method オプションツールがデータをサーバーに送信するために使用する方法。

値: GET または POST

デフォルト値: GET

target オプション url 属性で指定された URL にリンクされたツールの出力用の、ブラウザー内のターゲット・ウィンドウ。



url 必須ツールのアクション・ターゲットとなるUniform Resource Locator。



<tool:fieldlist>

<tool:fieldlist> エレメントは <tool:cgiurl> の子であり、ツールと一緒に使用する ObjectServer フィールドを定義します。このエレメントには ObjectServer フ


ィールドをそれぞれ指定する 1 つ以上の <tool:field> エレメントが入ります。属性はありません。

<tool:field>

<tool:field> エレメントは <tool:fieldlist> の子であり、ツールで使用するObjectServer フィールドの名前を定義します。このエレメントは空ですが、以下の属性があります。

表 31. <tool:field> エレメントの属性


name 必須 ObjectServer フィールドの名前。



<tool:cmdline>

<tool:cmdline> エレメントは、コマンド行ツールを定義します。このエレメントには 1 つ以上の <tool:command> エレメントが入り、属性はありません。

<tool:command>

<tool:command> エレメントは <tool:cmdline> の子であり、コマンド行ツールに関連したプラットフォーム固有のコマンドを定義します。このエレメントは空ですが、以下の属性があります。

表 32. <tool:command> エレメントの属性


enabled オプションツールを使用可能にするか使用不可にするかを定義します。platform 属性と連動し、特定のプラットフォームでツールが使用可能かどうかを決定するために使用します。



platform 必須ツールの適用先となるプラットフォームを示します。enabled 属性と連動し、特定のプラットフォームでツールが使用可能かどうかを決定するために使用します。

値: Windows、Solaris、Linux、HPUX、または AIX


executable 必須ツールの実行時に実行するコマンド。




表 32. <tool:command> エレメントの属性 (続き)





<tool:script>

<tool:script> エレメントは、スクリプト・ツールを定義します。このエレメントは空ですが、以下の属性があります。

表 33. <tool:script> エレメントの属性





command 必須ツールのスクリプト。



使用上の注意

通常、<tool:journal> エレメントは他のツールと一緒に使用され、ツールの実行内容を記録するジャーナル項目を作成します。例えば、<tool:sql> エレメントによって実行されたアクションを記録するために <tool:journal> エレメントを使用できます。

組織内の任意のプラットフォームで実行可能なコマンド行ツールを作成するには、複数の <tool:cmdline> エレメントを使用します。それぞれにプラットフォーム固有のコマンドを含めて、すべて同一または類似の結果が得られるようにします。例えば、Windows 用と Linux 用の別々のエレメントを設けることができるかもしれません。 74 ページの『ツールの作成または置換』の例には、この手法が示されています。

例: SQL ツール

以下の例の場合、sqlSample1 という SQL ツールが作成されます。

<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"><method methodName="tool.createTool"><tool:tool name="sqlSample1"><tool:access>


<tool:osfield><tool:criterion name="Class"><tool:equals value="7450"/><tool:equals value="7500"/></tool:criterion>

</tool:osfield><tool:security><tool:criterion name="Group"><tool:equals value="restricted"/><tool:equals value="Desktop"/></tool:criterion>

</tool:security></tool:access><tool:sql foreach="true"command="update alerts.status set Summary='sqlTest1' where Serial=@Serial;"/><tool:journal foreach="true"entry="Tool executed on event Class CONVERSION(@Class)."/>

</tool:tool></method></methodCall>

例: CGI/URL ツール

以下の例の場合、cmsSample1 という CGI/URL ツールが作成されます。

<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"><method methodName="tool.createTool"><tool:tool name="cmdSample"><tool:access><tool:osfield/><tool:security><tool:criterion name="Group"><tool:equals value="restricted"/><tool:equals value="Desktop"/></tool:criterion>

</tool:security></tool:access><tool:cmdline><tool:command foreach="true" enabled="true" platform="Windows"executable="start cmd /k c:¥temp¥sample.bat {@Class} {@Node}"/>

<tool:command foreach="true" enabled="true" platform="Solaris"executable="xterm -e /bin/sh -c '/tmp/sample.sh {@Class} {@Node}; read a'"

/><tool:command foreach="true" enabled="false" platform="AIX"executable="xterm -e /bin/sh -c '/tmp/sample.sh {@Class} {@Node}; read a'"

/></tool:cmdline></tool:tool></method></methodCall>

スクリプト・ツール

以下の例の場合、scriptSample1 というスクリプト・ツールが作成されます。

<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"><method methodName="tool.createTool"><tool:tool name="scriptSample"><tool:access><tool:osfield/><tool:security><tool:criterion name="Group"><tool:equals value="restricted"/><tool:equals value="Desktop"/></tool:criterion>

</tool:security></tool:access><tool:script foreach="false" command="alert('{@Node}');"/></tool:tool></method></methodCall>

ツールの作成または置換ツールを作成または置換するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="createOrReplaceTool">

このメソッドを使用して、新しいツールを作成するか、既存のツールを置換します。<method> エレメントには、1 つ以上の <tool:tool> エレメントが入ります。各 <tool:tool> エレメントの中には、1 つの <tool:access> エレメントに続けて、以下に挙げるエレメントのいずれか 1 つを何回でも指定できます。

v <tool:sql>

v <tool:journal>

v <tool:cgiurl>

v <tool:cmdline>

v <tool:script>

以下の各エレメントは、特定のツールを定義します。詳しくは、 66 ページの『<tool:tool>』を参照してください。

例

以下の例の場合、cmdSample というツールが作成または置換されます。

<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"><method methodName="tool.createOrReplaceTool"><tool:tool name="cmdSample"><tool:access><tool:osfield/><tool:security/></tool:access><tool:cmdline><tool:command foreach="true" enabled="true" platform="Windows"executable="start cmd /k c:¥temp¥sample.bat {@Class} {@Node}"/>

<tool:command foreach="true" enabled="true" platform="Linux"executable="xterm -e /bin/sh -c '/tmp/sample.sh {@Class} {@Node}; read a'"/>

<tool:command foreach="true" enabled="true" platform="AIX"executable="xterm -e /bin/sh -c '/tmp/sample.sh {@Class} {@Node}; read a'"/>

</tool:cmdline></tool:tool></method></methodCall>


ツールの削除ツールを削除するときの <method> エレメントのフォーマットは次のとおりです。

<method methodName="tool.deleteTool">

このメソッドを使用して、既存のツールを削除します。<method> エレメントには、削除するツールをそれぞれ指定する 1 つ以上の <tool:tool> エレメントが入ります。<tool:tool> エレメントに含めるのは、name 属性だけです。

例

以下の例の場合、sqlSample1、sqlSample2、cgiSample、cmdSample、scriptSample、scriptSample2 というそれぞれのツールが削除されます。

<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1">

<method methodName="tool.deleteTool"><tool:tool name="sqlSample1"/><tool:tool name="sqlSample2"/><tool:tool name="cgiSample"/><tool:tool name="cmdSample"/><tool:tool name="scriptSample"/><tool:tool name="scriptSample2"/>


ツール・リストの取得ツール・リストを取得するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="tool.getList">

このメソッドは、Web GUI に定義されているすべてのツールのリストを返します。

例<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1">

<method methodName="tool.getList"/></method></methodCall>

ツールの変更ツールを変更するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="modifyTool">

このメソッドを使用して、既存のツールを変更します。<method> エレメントには、1 つ以上の <tool:tool> エレメントが入ります。各 <tool:tool> エレメントの中には、1 つの <tool:access> エレメントに続けて、以下に挙げるエレメントのいずれか 1 つを何回でも指定できます。

v <tool:sql>

v <tool:journal>

v <tool:cgiurl>


v <tool:cmdline>

v <tool:script>

詳しくは、 66 ページの『<tool:tool>』を参照してください。

例

以下の例の場合、sqlSample1 と cgiSample というツールが変更されます。

<methodCall xmlns:tool="http://www.ibm.com/tivoli/netcool/webtop/tools/2.1"><method methodName="tool.modifyTool"><tool:tool name="sqlSample1"><tool:access><tool:osfield><tool:criterion name="Class"><tool:equals value="7450"/></tool:criterion>

</tool:osfield><tool:security/></tool:access><tool:sql foreach="true"command="update alerts.status set Summary='sqlTest1' where Serial=@Serial;"/><tool:journal foreach="true" entry="Tool executed on event Class @Class."/></tool:tool>

<tool:tool name="cgiSample"><tool:access><tool:osfield><tool:criterion name="Class"><tool:equals value="7500"/></tool:criterion>

</tool:osfield><tool:security/></tool:access><tool:cgiurl foreach="true" windowforeach="true" target="_blank"method="GET" url="$(SERVER)/cgi-bin/sample.cgi"><tool:fieldlist><tool:field name="Class"/><tool:field name="Node"/>

</tool:fieldlist></tool:cgiurl></tool:tool></method></methodCall>

プロンプト要求プロンプトは、特定のタイプのツールと関連付けられます。ツールが必要とする情報をユーザーが入力または選択するためのプロンプト・ウィンドウまたはポップアップ・メニューが生成されます。プロンプトを作成、変更、削除するための機能があります。また、サーバー上に定義されているプロンプトのリストを取得できます。WAAPI には、プロンプトを処理するための 5 つのメソッドがあります。つまり、プロンプトの作成、プロンプトの作成または置換、プロンプトの変更、プロンプトの削除、およびプロンプト・リストの取得です。

WAAPI プロンプトのファイルには複数のプロンプト例が含まれています。それは、 webgui-home/waapi/etc/samples/samplerequest_prompt.xml にあります。


プロンプトの作成または置換プロンプトを作成または置換するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="prompt.creatOrReplacePrompt">

このメソッドを使用して、新しいプロンプトを作成するか、既存のプロンプトを置換します。<method> エレメントには、新しいプロンプトの特性をそれぞれ定義する1 つ以上の <prompt:prompt> エレメントが入ります。<prompt:prompt> エレメントには、オプションの <prompt:parameters> エレメント 1 つと、それに続くオプションの <prompt:choice> エレメント 1 つが入ります。詳しくは『<prompt:prompt>』を参照してください。また <prompt:prompt> エレメントとそのサブエレメントの使用法について詳しくは、 79 ページの『使用上の注意』を参照してください。

v 『<prompt:prompt>』

v 『<prompt:parameters>』

v 78 ページの『<prompt:additionalParams>』

v 78 ページの『<prompt:param>』

v 79 ページの『<prompt:choice>』

v 79 ページの『<prompt:item>』

v 79 ページの『使用上の注意』

v 82 ページの『例: プロンプトの作成』

v 83 ページの『例: プロンプトの置換』

<prompt:prompt>

<prompt:prompt> エレメントはプロンプトを定義します。以下の属性があります。

表 34. <prompt:prompt> エレメントの属性


name 必須プロンプトの固有名を指定します。



type 必須プロンプトのタイプ。

値: String、Integer、Float、Password、Time、Lookup、FixedChoice、DynamicChoice、MultiLlineString、FormattedString、RealTimeDynamicChoice のいずれかの値。


<prompt:parameters>

<prompt:parameters> エレメントは <prompt:prompt> の子であり、プロンプトのパラメーターを定義します。このエレメントは 1 回指定するか、プロンプトがパラメ


ーターを必要としない場合には省略できます。プロンプトのタイプによっては、このエレメントに <prompt:additionalParameters> エレメントが 1 つ入ります。<prompt:parameters> エレメントには、以下の属性があります。

表 35. <prompt:parameters> エレメントの属性


label 必須プロンプト・ウィンドウに表示するテキスト。必要な情報に関するユーザー・ガイダンスを提供します。



order 必須プロンプト・ウィンドウでプロンプトが占める順序 (他のプロンプトとの相対順序)

値: 整数


localized 必須プロンプトをローカライズできるかどうかを定義します。



errorMessage オプションユーザーがプロンプトに適切でない情報を指定したときに表示されるテキスト。



defaultValue オプションユーザーが選択可能な、プロンプトに対するデフォルト応答。



<prompt:additionalParams>

<prompt:additionalParams> は <prompt:parameters> の子であり、以下のタイプのツールで必要となる追加パラメーターを提供します。

v ルックアップ

v 動的選択

v 定型式ストリング

v リアルタイム動的選択

このエレメントには、追加パラメーターをそれぞれ定義する、任意の数の<prompt:param> エレメントが入ります。属性はありません。

<prompt:param>

<prompt:param> エレメントは <prompt:additionalParams> の子であり、ツールの追加パラメーターの名前と値を定義します。使用上の注意に、このエレメントの使用法の詳細情報を記載します。このエレメントは空で、以下の属性があります。


表 36. <prompt:param> エレメントの属性


name 必須パラメーターの名前。



value 必須パラメーターの値。

値: プロンプトのタイプに依存しますが、通常はストリング。


<prompt:choice>

<prompt:choice> エレメントは <prompt:prompt> の子であり、固定選択プロンプトのメニューの選択項目を定義します。属性はありませんが、メニュー上の選択項目をそれぞれが定義する 1 つ以上の <prompt:item> エントリーが入ります。

<prompt:item>

<prompt:item> エレメントは <prompt:choice> の子で、1 回以上指定できます。それぞれのオカレンスによって、固定選択プロンプトのメニュー上の選択項目が定義されます。このエレメントの属性は以下のとおりです。

表 37. <prompt:item> エレメントの属性


value 必須ユーザーがこのオプションを選択するときに、プロンプトが返す値。



label 必須メニュー上で、この選択項目に関して表示されるテキスト。



使用上の注意

以下の注意事項に、各タイプのプロンプトで <prompt:prompt> の子エレメントを使用する方法について示します。

ストリング

単一の <prompt:parameters> エレメントを組み込み、その中に、表示するプロンプトのストリング、他のプロンプトとの相対順序、エラー・メッセージ、ローカライズされたインディケーター、およびデフォルト値を含めます。その他すべての子エレメントは省略します。


整数


浮動小数点


パスワード

単一の <prompt:parameters> エレメントを組み込み、その中に、表示するプロンプトのストリング、他のプロンプトとの相対順序、およびローカライズされたインディケーターを含めます。その他すべての子エレメントは省略します。

時刻

単一の <prompt:parameters> エレメントを組み込み、その中に、表示するプロンプトのストリング、他のプロンプトとの相対順序、およびローカライズされたインディケーターを含めます。その他すべての子エレメントは省略します。

ルックアップ

単一の <prompt:parameters> エレメントを組み込み、その中に、表示するプロンプトのストリング、他のプロンプトとの相対順序、およびローカライズされたフラグを含めます。また、<prompt:additionalParams> エレメントを 1 つ指定します。その中には、属性として以下の値を指定した <prompt:param> エレメントを 1 つ含めます。

表 38. ルックアップ・プロンプトの <prompt:param> エレメントの値

属性値

name file

value ルックアップ・リストに表示される項目が入ったファイルのパス。例:

/tmp/lookup.txt

固定選択

単一の <prompt:parameters> エレメントを組み込み、その中に、表示するプロンプトのストリング、他のプロンプトとの相対順序、およびローカライズされたフラグを含めます。また、メニューの選択項目ごとに <prompt:item> エレメントを入れた<prompt:choice> エレメントを指定します。

動的選択

単一の <prompt:parameters> エレメントを組み込み、その中に、表示するプロンプトのストリング、他のプロンプトとの相対順序、およびローカライズされたフラグ


を含めます。また、<prompt:additionalParams> エレメントを 1 つ指定します。その中には、属性として以下の値を指定した <prompt:param> エレメントを 1 つ含めます。

表 39. 動的選択プロンプトの <prompt:param> エレメントの値

属性値

name sqlCommand

value 表から最大 2 つの列を求める ObjectServer SQL コマンド。ObjectServerが返す各行は、サブメニューまたはリスト内の項目としてユーザーに表示されます。複数の ObjectServer に対して実行する場合、SQL コマンドで選択可能なのは、そのすべてに共通の列と列値だけです。例:

select Conversion, Value from alerts.conversionswhere Colname='Severity' order by Value desc;

複数行ストリング


定型式ストリング

単一の <prompt:parameters> エレメントを組み込み、その中に、表示するプロンプトのストリング、他のプロンプトとの相対順序、エラー・メッセージ、ローカライズされたインディケーター、およびデフォルト値を含めます。また、<prompt:additonalParams> エレメントを 1 つ指定します。その中には、属性として以下の値を指定した <prompt:param> 項目を 1 つ含めます。

表 40. 定型式ストリング・プロンプトの <prompt:param> エレメントの値

属性値

name フォーマット

value ユーザーが入力するストリングと一致する必要がある正規表現。例:

^[a-zA-Z]{3}¥d{3}$

リアルタイム動的選択


表 41. 定型式ストリング・プロンプトの <prompt:param> エレメントの値

属性値

name sqlCommand


表 41. 定型式ストリング・プロンプトの <prompt:param> エレメントの値 (続き)

属性値

value 表から最大 2 つの列を求める ObjectServer SQL コマンド。ObjectServerが返す各行は、サブメニューまたはリスト内の項目としてユーザーに表示されます。複数の ObjectServer に対して実行する場合、SQL コマンドで選択可能なのは、そのすべてに共通の列と列値だけです。例:

select Conversion, Value from alerts.conversionswhere Colname='Type' order by Value desc;

リアルタイム動的選択プロンプトでは、ツールの実行時に生成される ObjectServer照会の結果が入ったスクロール可能リストが作成されます。このプロンプトは、頻繁に変更される可能性がある ObjectServer 表からのデータに使用します。このプロンプト・タイプはリアルタイムに実行されるので、Web GUI サーバーの負荷を軽減するため、あまり頻繁に使用しないでください。

例: プロンプトの作成

以下の例の場合、各タイプのプロンプトが 1 つずつ作成されます。

<methodCall xmlns:prompt="http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2"><method methodName="prompt.createPrompt"><prompt:prompt type="String" name="testString"><prompt:parameters label="Type in a string value" order="100"errorMessage="String value cannot be empty" localized="false"defaultValue="Default string"/>

</prompt:prompt>

<prompt:prompt type="Integer" name="testInteger"><prompt:parameters label="Type in an integer value" order="110"errorMessage="Invalid integer value" localized="false" defaultValue="5"/>

</prompt:prompt>

<prompt:prompt type="Float" name="testFloat"><prompt:parameters label="Type in a float value" order="120"errorMessage="Invalid float value" localized="false" defaultValue="1.0"/>

</prompt:prompt>

<prompt:prompt type="Password" name="testPassword"><prompt:parameters label="Type in the password" order="130"localized="false"/>

</prompt:prompt>

<prompt:prompt type="Time" name="testTime"><prompt:parameters label="Specify a date/time" order="140"errorMessage="Invalid date/time value" localized="false"/>

</prompt:prompt>

<prompt:prompt type="Lookup" name="testLookup"><prompt:parameters label="Select a lookup option" order="150"localized="false"><prompt:additionalParams><prompt:param name="file" value="/tmp/lookup.txt"/></prompt:additionalParams></prompt:parameters>


</prompt:prompt>

<prompt:prompt type="FixedChoice" name="testFixedChoice"><prompt:parameters label="Select a fixed option" order="160"localized="false"defaultValue="fixed2"/><prompt:choice><prompt:item value="fixed1" label="Fixed One"/><prompt:item value="fixed2" label="Fixed Two"/><prompt:item value="fixed3" label="Fixed Three"/></prompt:choice></prompt:prompt>

<prompt:prompt type="DynamicChoice" name="testDynamicChoice"><prompt:parameters label="Select a dynamic option" order="170"localized="false"><prompt:additionalParams><prompt:param name="sqlCommand"value="select Conversion, Value from alerts.conversionswhere Colname='Severity' order by Value desc;"/></prompt:additionalParams></prompt:parameters>

</prompt:prompt>

<prompt:prompt type="MultilineString" name="testMultilineString"><prompt:parameters label="Type in a journal entry" order="0"errorMessage="Journal entry cannot be empty" localized="false"defaultValue="Journal entry"/></prompt:prompt>

<prompt:prompt type="FormattedString" name="testFormattedString"><prompt:parameters label="Type in the ticket ID (3 letters, 3 digits)"order="180" errorMessage="Invalid ticket ID format" localized="false"defaultValue="ABC123"><prompt:additionalParams><prompt:param name="format" value="^[a-zA-Z]{3}¥d{3}$"/></prompt:additionalParams></prompt:parameters></prompt:prompt>

<prompt:prompt type="RealTimeDynamicChoice" name="testRealTimeDynamicChoice"><prompt:parameters label="Select a real-time dynamic option" order="190"localized="false"><prompt:additionalParams><prompt:param name="sqlCommand" value="select Conversion, Value fromalerts.conversions where Colname='Type' order by Value desc;"/>

</prompt:additionalParams></prompt:parameters></prompt:prompt>


例: プロンプトの置換

以下の例の場合、testFormattedString という既存のプロンプトの定義が置換されます。


<methodCall xmlns:prompt="http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2"><method methodName="prompt.createOrReplacePrompt"><prompt:prompt type="FormattedString" name="testFormattedString">

<prompt:parameters label="Type in the ticket ID (3 letters, 3 digits)"order="180" errorMessage="Invalid ticket ID format" localized="false"defaultValue="Bbc123"><prompt:additionalParams><prompt:param name="format" value="^[a-zA-Z]{3}¥d{3}$"/></prompt:additionalParams></prompt:parameters>

</prompt:prompt></method>

</methodCall>

プロンプトの削除プロンプトを削除するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="prompt.deletePrompt">

このメソッドを使用して、既存のプロンプトを削除します。<method> エレメントには、削除するプロンプトをそれぞれ識別する 1 つ以上の <prompt:prompt> エレメントが入ります。<prompt:prompt> エレメントに含めるのは、name 属性だけです。

例

以下の例の場合、testString というプロンプトが削除されます。

<methodCall xmlns:prompt="http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2"><method methodName="prompt.deletePrompt">

<prompt:prompt name="testString"/></method>

</methodCall>

プロンプト・リストの取得プロンプト・リストを取得するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="prompt.getList" />

このメソッドを使用して、定義されたプロンプトの名前が含まれるリストを取得します。

例<methodCall xmlns:prompt="http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2">

<method methodName="prompt.getList"/>

</methodCall>


プロンプトの変更プロンプトを変更するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="prompt.modifyPrompt">

このメソッドを使用して、既存のプロンプトを変更します。<method> エレメントには、新しいプロンプトの特性をそれぞれ定義する 1 つ以上の <prompt:prompt> エレメントが入ります。<prompt:prompt> エレメントには、オプションの<prompt:parameters> エレメント 1 つと、それに続くオプションの<prompt:choice> エレメント 1 つが入ります。詳しくは 77 ページの『<prompt:prompt>』を参照してください。また <prompt:prompt> エレメントとそのサブエレメントの使用法について詳しくは、 79 ページの『使用上の注意』を参照してください。

例

以下の例の場合、testFixedChoice というプロンプトが変更されます。

<methodCall xmlns:prompt="http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2"><method methodName="prompt.modifyPrompt"><prompt:prompt type="FixedChoice" name="testFixedChoice">

<prompt:parameters label="Select a fixed option" order="160"localized="false" defaultValue="fixed6"/><prompt:choice><prompt:item value="fixed4" label="Fixed Four"/><prompt:item value="fixed5" label="Fixed Five"/><prompt:item value="fixed6" label="Fixed Six"/>

</prompt:choice></prompt:prompt>


CGI 要求CGI 要求は、Web GUI においてツールとして使用される CGI スクリプトに対して作用します。スクリプトを登録、変更、および登録抹消する機能があります。WAAPI では、CGI スクリプトを処理するための 4 つのメソッドがあります。つまり CGI スクリプトの登録、CGI スクリプトの作成または置換、CGI スクリプトの変更、および CGI スクリプトの登録抹消です。

CGI スクリプトの登録CGI スクリプトを登録するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="cgi.registerCGI">

このメソッドを使用して、CGI スクリプトを Web GUI サーバーに登録します。<method> エレメントには、登録するスクリプトをそれぞれ定義した <cgi> エレメントが 1 つ以上入ります。

v 86 ページの『<cgi>』



<cgi>

<cgi> エレメントは CGI スクリプトの特性を定義します。以下の属性があります。

表 42. <cgi> エレメントの属性


name 必須 CGI スクリプトの固有名を指定します。



useSmartPageCommands オプションスクリプトの実行時に SmartPage コマンドを使用するかどうかを定義します。



fileName オプションスクリプトが含まれるファイルのパス名。


デフォルト値: この属性を省略すると、<cgi> エレメントの内容にスクリプトが入ります。

例

以下の例の場合、nco_myping.cgi という名前のファイルに含まれる myping というスクリプトが登録されます。

<methodCall><method methodName="cgi.registerCGI"><cgi name="myping" acl="*" useSmartPageCommands="true"fileName="/home/nco_myping.cgi"></cgi></method></methodCall>

CGI スクリプトの作成または置換CGI スクリプトを作成または置換するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="cgi.createOrReplaceCGI">

このメソッドを使用して、新しい CGI スクリプトを Web GUI サーバーに登録するか、既に存在している場合に既存の定義を置換します。<method> エレメントには、登録するスクリプトをそれぞれ定義した <cgi> エレメントが 1 つ以上入ります。詳しくは、『<cgi>』を参照してください。

以下の例の場合、myping1 というスクリプトが作成または置換されます。

<methodCall><method methodName="cgi.createOrReplaceCGI"><cgi name="myping1" acl="*" useSmartPageCommands="false"


fileName="/home/nco_myping1.cgi"></cgi></method></methodCall>

CGI スクリプトの変更CGI スクリプトを変更するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="cgi.modifyCGI">

このメソッドを使用して、既に登録済みの CGI スクリプトを変更します。<method> エレメントには、CGI スクリプトの特性をそれぞれ変更する <cgi> エレメントが 1 つ以上入ります。詳しくは、 86 ページの『<cgi>』を参照してください。

例

以下の例の場合、myping というスクリプトの useSmarypage 属性の値が変更されます。

<methodCall><method methodName="cgi.modifyCGI"><cgi name="myping" acl="example" useSmartPageCommands="false" ></cgi></method></methodCall>

CGI スクリプトの登録抹消CGI スクリプトを登録抹消するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="cgi.unregisterCGI">

このメソッドを使用して、既に登録済みの CGI スクリプトを登録抹消します。<method> エレメントには、登録抹消する CGI スクリプトをそれぞれ指定した<cgi> エレメントが 1 つ以上入ります。<cgi> エレメントに含めるのは、name 属性だけです。

例

以下の例の場合、myping というスクリプトが登録抹消されます。

<methodCall><method methodName="cgi.unregisterCGI"><cgi name="myping" ></cgi></method></methodCall>


フィルター要求フィルター要求は、アクティブ・イベント・リスト (AEL)、イベント・ビューアー、ライトウェイト・イベント・リスト (LEL)、テーブル・ビュー、およびイベント・ダッシュボードのモニター・ボックスで、イベントを表示するために使用されるフィルターに対して作用します。フィルターを作成、変更、削除、およびリストする機能があります。また、デフォルト・ビューを設定することもできます。WAAPI にはフィルターを操作するための 6 つのメソッドがあります。つまり、フィルターの追加、フィルターの作成または置換、フィルターの変更、フィルターの削除、フィルター・リストの取得、およびフィルターのデフォルト・ビューの設定です。

フィルターの追加フィルターを追加するための <method> エレメントのフォーマットは次のとおりです。

<method methodCall="filter.addFilter">

このメソッドを使用して、AEL、イベント・ビューアー、LEL、テーブル・ビュー、およびイベント・ダッシュボードで使用する新しいフィルターを定義します。<method> エレメントには、1 つ以上の <filter> エレメントが入り、それぞれが新しいフィルターの特性を定義します。

依存フィルターの場合、<filter> エレメントには <dependentlist> エレメントの1 つ以上のインスタンスが入ります。

v 『<filter>』

v 90 ページの『<dependentlist>』

v 91 ページの『依存フィルターの規則』

v 91 ページの『例: イベント・フィルター』

v 92 ページの『例: グループ・フィルター』

v 92 ページの『例: 依存フィルター』

<filter>

<filter> エレメントはフィルターの特性を定義します。以下の属性があります。

表 43. <filter> エレメントの属性


name 必須フィルターの固有名を指定します。



user オプションユーザー・フィルターの場合、この属性はフィルターが関連付けられているユーザーを識別します。属性の値は、ユーザー ID のコンマ区切りのリストです。

値: ユーザー ID のリスト



表 43. <filter> エレメントの属性 (続き)


group オプショングループ・フィルターの場合、この属性はフィルターが関連付けられているグループを識別します。属性の値は、グループ ID のコンマ区切りのリストです。

値: グループ ID のリスト


sql オプションイベントをフィルタリングするときに使用するフィールドとその値を定義するSQL WHERE 節の値。

値: SQL WHERE 節


mode オプションフィルターが依存フィルターかどうかを定義します。依存フィルターの場合にのみ、この属性を含めます。

値: dependent


description オプションフィルターのテキスト説明を定義します。



filtercollection オプションフィルターがメンバーとして属するフィルター・コレクションの名前を指定します。



type オプションフィルターのタイプを示します。

値: global、system、user、またはgroup


view オプションフィルターに関連付けるビューを示します。



viewtype オプションビューのタイプを示します。

値: global、system、または user



表 43. <filter> エレメントの属性 (続き)


datasource オプションフィルタリング対象のイベントを提供するデータ・ソースを示します。複数のデータ・ソースを指定する場合、コンマ区切りリストを使用します。この属性は、フィルターを追加する場合には必須です。



metriclabel オプションイベント・ダッシュボードのモニター・ボックスに表示される集約統計データを記述するラベルを定義します。


デフォルト値: Metric:

metricshow オプションイベント・ダッシュボードのモニター・ボックスに表示されるメトリック値の計算基準を定義します。

値: Average、Count、Sum、Minimum、または Maximum

デフォルト値: Average

metricof オプションイベント・ダッシュボードのモニター・ボックスに表示されるメトリック値を計算する際に使用する ObjectServer フィールドを定義します。

値: フィールド名

デフォルト値: Severity

<dependentlist>

<dependentlist> エレメントは依存フィルターが使用するフィルターのリストを示します。以下の属性があります。

表 44. <dependentList> エレメントの属性


type 必須依存フィルター・リストにおけるフィルター・タイプを示します。

値: global、system、group、またはuser



表 44. <dependentList> エレメントの属性 (続き)


list 必須依存フィルターに関連付けるフィルターを定義します。この属性値には、1 つ以上のフィルター名で構成されるコンマ区切りリストが入ります。

値: フィルター名のリスト


依存フィルターの規則

<dependentList> エレメントの type 属性の値によって示される依存フィルターの各タイプは、以下のように特定のタイプのフィルターにのみ依存できます。

表 45. 依存フィルターが依存できるフィルターのタイプの規則

依存フィルターのタイプルール

グローバル・システム

グローバル・フィルターまたはシステム依存フィルター:

v システム・フィルターとグローバル・フィルターに依存できます。

v どのユーザー・フィルターにも依存できません。

ユーザーユーザー依存フィルター:

v グローバル・フィルターとシステム・フィルターに依存できます。

v 同じユーザー用の他のユーザー・フィルターに依存できます。

グループグループ依存フィルター:

v グローバル・フィルターとシステム・フィルターに依存できます。

v 同じユーザー・グループ用の他のグループ・フィルターに依存できます。

v どのユーザー・フィルターにも依存できません。

例: イベント・フィルター

以下の例の場合、次の特性を持つ exampleFilter1 という名前のフィルターが追加されます。

v SQL WHERE 節は Severity>=0 です。

v メトリック・ラベルは Metric: です。

v フィルターに関連付けられているビュー名は advanced です。

v フィルターはグローバル・フィルターです。

v データ・ソース名は NCOMS です。

<methodCall><method methodName="filter.addFilter"><filter name="exampleFilter1"sql="Severity >=0"metriclabel="Metric : "view="advanced"type="global"


datasource="NCOMS"/></method></methodCall>

例: グループ・フィルター

以下の例の場合、次の特性を持つ exampleGroupFilter という名前のグループ・フィルターが追加されます。



v フィルターに関連付けられているビュー名は advanced で、これは global ビューです。

v フィルターは、Netcool_OMNIbus_Admin グループと Netcool_OMNIbus_User グループのユーザーが使用できます。


<methodCall><method methodName="filter.addFilter"><filter name="exampleGroupFilter"sql="Severity >=0"metriclabel="Metric : "view="advanced"viewtype="global"type="group"group="Netcool_OMNIbus_Admin,Netcool_OMNIbus_User"datasource="NCOMS"/>


例: 依存フィルター

以下の例の場合、次の特性を持つ exampleFilter3 という依存フィルターが追加されます。





v フィルターは、dependentfilter1 というフィルターと dependentfilter2 というフィルターに依存しています。

<methodCall><method methodName="filter.addFilter"><filter name="exampleFilter3"metriclabel="Metric : "view="advanced"type="global"mode="dependent"datasource="NCOMS"><dependentlist type="global" list="dependentFilter1,dependentFilter2"/></filter></method></methodCall>


フィルターの作成または置換フィルターを作成または置換するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="filter.createOrReplaceFilter">

このメソッドを使用して、新しいフィルターを作成するか、既存のフィルターを置換します。 <method> エレメントには、フィルターの特性をそれぞれ定義する 1 つ以上の <filter> エレメントが入ります。詳しくは、 88 ページの『<filter>』を参照してください。

依存フィルターの場合、<filter> エレメントには <dependentlist> エレメントの1 つ以上のインスタンスが入ります。詳しくは、 90 ページの『<dependentlist>』を参照してください。

以下の例の場合、次の特性を持つ exampleFilter2 という名前のフィルターが作成または置換されます。


v メトリック・ラベルは My Metric: です。




<methodCall><method methodName="filter.createOrReplaceFilter"><filter name="exampleFilter2"sql="Severity >=1"metriclabel="My Metric : "view="advanced"type="global"datasource="NCOMS"/></method></methodCall>

フィルターの削除フィルターを削除するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="filter.deleteFilter">

このメソッドを使用して、既存のフィルターを削除します。<method> エレメントには、1 つ以上の <filter> エレメントが入り、それぞれが削除するフィルターを指定します。<filter> エレメントには、name 属性と type 属性が入ります。また、ユーザー・フィルターの場合には、フィルターを削除する対象となるユーザーを定義する user 属性を含めます。同様にグループ・フィルターの場合にも、フィルターを削除する対象となるグループを定義する group 属性を使用します。詳しくは、88 ページの『<filter>』を参照してください。

例

以下の例の場合、グローバル・フィルター exampleFilter1 と exampleFilter3、ユーザー・フィルター exampleFilter2、およびグローバル依存フィルター


dependentFilter1 と dependentFilter2 が削除されます。ユーザー・フィルターは、ユーザー ID webtopadminuser と root から削除されます。

<methodCall><method methodName="filter.deleteFilter"><filter name="exampleFilter1" type="global"/><filter name="exampleFilter2" type="user" user="webtopadminuser,root"/><filter name="exampleFilter3" type="global"/><filter name="dependentFilter1" type="global"/><filter name="dependentFilter2" type="global"/></method></methodCall>

フィルター・リストの取得フィルター・リストを取得するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="filter.getList" />

このメソッドを使用して、定義されたフィルターの名前が含まれるリストを取得します。このリストには、フィルター・タイプ (global、system、user、group) ごとに別個のセクションが含まれます。

このメソッドが返すのは名前だけで、フィルターの属性は返しません。

例<methodCall><method methodName="filter.getList" /></methodCall>

フィルターの変更フィルターを変更するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="filter.modify">

このメソッドを使用して、既存のフィルターの特性を変更します。<method> エレメントには、既存のフィルターの新しい特性をそれぞれ定義する 1 つ以上の<filter> エレメントが入ります。変更する特性に対応する <filter> の属性だけを含めます。属性を省略すると、対応する特性は変更されません。詳しくは、 88 ページの『<filter>』を参照してください。

依存フィルターの場合、<filter> エレメントには <dependentlist> エレメントの1 つ以上のインスタンスが入ります。詳しくは、 90 ページの『<dependentlist>』を参照してください。

例

以下の例の場合、exampleFilter1 というフィルターに変更を加え、フィルターの特性を次のように変更します。

v SQL WHERE 節が lastOccurrence >= getdate-1800 になります。

v メトリック・ラベルは MyMetric: となります。

また、この例では以下の特性がフィルターに追加されます。


v ビューはグローバル・ビューです。

v メトリック値は、SubDivision フィールドの平均です。

<methodCall><method methodName="filter.modifyFilter"><filter name="exampleFilter1"sql="LastOccurrence >= getdate -1800"metriclabel="MyMetric:"metricshow="Average"metricof="SubDivision"view = "advanced"viewtype="global"type="global"datasource="NCOMS"/></method></methodCall>

デフォルト・ビューの設定デフォルト・ビューを設定するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="filter.setDefaultView">

このメソッドを使用して、フィルターに関連付けるデフォルト・ビューを決定します。 <method> エレメントには、デフォルト・ビューと関連付けるフィルターをそれぞれ指定する 1 つ以上の <filter>エレメントが入ります。 <filter> エレメントには、フィルターを指定する name と、フィルターのデフォルト・ビューを示すview 属性と viewtype 属性を含めます。詳しくは、 88 ページの『<filter>』を参照してください。

例

以下の例の場合、Default というグローバル・ビューが exampleFilter1 というフィルターに関連付けられます。

<methodCall><method methodName="filter.setDefaultView"><filter name="exampleFilter1" view="Default" viewtype="global"/></method></methodCall>

フィルター・コレクション要求フィルター・コレクションとはフィルターを論理的にグループ化したもので、通常は、Netcool/Webtop からマイグレーションされたエンティティー・データに対して使用されます。フィルター・コレクションを作成、変更、削除、およびリストする機能があります。また、コレクションにフィルターを追加したりコレクションから削除したり、フィルター・コレクションのリストを取得したり、さらにはデフォルト・ビューを設定したりできます。

WAAPI にはフィルター・コレクションを操作するための 8 つのメソッドがあります。つまり、フィルター・コレクションの作成、フィルター・コレクションの作成または置換、フィルター・コレクションの変更、フィルター・コレクションの削除、フィルター・コレクションへのフィルターの追加、フィルター・コレクション


からのフィルターの削除、フィルター・コレクションのリストの取得、およびフィルター・コレクション用ビューの設定です。

フィルター・コレクションの作成フィルター・コレクションを作成するための <method> エレメントのフォーマットは次のとおりです。

<method methodCall="filtercollection.createFilterCollection">

このメソッドを使用して、フィルターの新しいコレクションを定義します。<method> エレメントには、新しいコレクションの特性をそれぞれ定義する 1 つ以上の <filterCollection> エレメントが入ります。これらの各エレメントには、コレクションの一部となるフィルターを示す <filter> エレメントが 1 つ以上入ります。指定できるのは、システム内に既存のシステム・フィルターとグローバル・フィルターだけです。<filter> エレメントに入るのは、フィルターを識別する name属性と type 属性だけです。詳しくは、 88 ページの『<filter>』を参照してください。

v 『<filterCollection>』


<filterCollection>

<filterCollection> エレメントは、フィルター・コレクションの特性を定義します。このエレメントは、name および type 属性だけを使ってコレクション内のフィルターを指定する 1 つ以上の <filter> エレメントを収容し、以下の属性を持ちます。

表 46. <filterCollection> エレメントの属性


name 必須フィルター・コレクションの固有名を指定します。



description オプションフィルター・コレクションのテキスト説明を定義します。



viewName オプションフィルターに関連付けるビューを示します。



viewType オプションビューのタイプを示します。


デフォルト値: global


例

以下の例の場合、Example_Critical と AllEvents という 2 つのフィルターが入った testcollection というフィルター・コレクションが作成されます。

<methodCall><method methodName="filtercollection.createFilterCollection"><filterCollection name="testcollection" viewName="Default"viewType="global" description="A collection of filters for testing"><filter name="Example_Critical" type="system"/><filter name="AllEvents" type="global"/></filterCollection></method></methodCall>

フィルター・コレクションへのフィルターの追加コレクションにフィルターを追加するための <method> エレメントのフォーマットは次のとおりです。

<method methodCall="filtercollection.addFilter">

このメソッドを使用して、既存のフィルター・コレクションにフィルターを追加します。 <method> エレメントには、コレクションをそれぞれ指定する 1 つ以上の<filterCollection> エレメントが入ります。詳しくは、 96 ページの『<filterCollection>』を参照してください。これらの各エレメントには、コレクションに追加するフィルターを示す <filter> エレメントが 1 つ以上入ります。指定できるのは、システム内に既存のシステム・フィルターとグローバル・フィルターだけです。<filter> エレメントに入るのは、フィルターを識別する name 属性とtype 属性だけです。詳しくは、 88 ページの『<filter>』を参照してください。

例

以下の例の場合、Last10Mins フィルターと Information フィルターがtestcollection2 というコレクションに追加されます。

<methodCall><method methodName="filtercollection.addFilter"><filterCollection name="testcollection2"><filter name="Last10Mins" type="global"/><filter name="Information" type="global"/></filterCollection></method></methodCall>

フィルター・コレクションの作成または置換フィルター・コレクションを作成または置換するための <method> エレメントのフォーマットは次のとおりです。

<method methodCall="filtercollection.createOrReplaceFilterCollection">

このメソッドを使用して、新しいフィルター・コレクションを定義するか、既存のフィルター・コレクションを置換します。<method> エレメントには、コレクションの特性をそれぞれ定義する 1 つ以上の <filterCollection> エレメントが入ります。詳しくは、 96 ページの『<filterCollection>』を参照してください。これらの各エレメントには、コレクションの一部となるフィルターを示す <filter> エレメントが 1 つ以上入ります。指定できるのは、システム内に既存のシステム・フィル


ターとグローバル・フィルターだけです。<filter> エレメントに入るのは、フィルターを識別する name 属性と type 属性だけです。詳しくは、 88 ページの『<filter>』を参照してください。

例

以下の例の場合、testcollection2 というフィルター・コレクションが作成または置換されます。

<methodCall><method methodName="filtercollection.createOrReplaceFilterCollection"><filterCollection name="testcollection2" viewName="Default"viewType="global" description="Another collection of filters for testing"><filter name="Escalated" type="global"/><filter name="AllEvents" type="global"/></filterCollection></method></methodCall>

フィルター・コレクションの削除フィルター・コレクションを削除するための <method> エレメントのフォーマットは次のとおりです。

<method methodCall="filtercollection.deleteFilterCollection">

このメソッドを使用して、既存のフィルター・コレクションを削除します。<method> エレメントには、削除するコレクションをそれぞれ指定する 1 つ以上の<filterCollection> エレメントが入ります。<filterCollection> エレメントに含めるのは、name 属性だけです。詳しくは、 96 ページの『<filterCollection>』を参照してください。

例

以下の例の場合、testCollection というフィルター・コレクションが削除されます。

<methodCall><method methodName="filtercollection.deleteFilterCollection"><filterCollection name="testcollection"/></method></methodCall>

フィルター・コレクションからのフィルターの削除コレクションからフィルターを削除するための <method> エレメントのフォーマットは次のとおりです。

<method methodCall="filtercollection.deleteFilter">

このメソッドを使用して、既存のフィルター・コレクションからフィルターを削除します。 <method> エレメントには、コレクションをそれぞれ指定する 1 つ以上の<filterCollection> エレメントが入ります。詳しくは、 96 ページの『<filterCollection>』を参照してください。これらの各エレメントには、コレクションから削除するフィルターを示す <filter> エレメントが 1 つ以上入ります。<filter> エレメントに入るのは、フィルターを識別する name 属性と type 属性だけです。詳しくは、 88 ページの『<filter>』を参照してください。


例

以下の例の場合、Information というフィルターが testcollection2 というコレクションから削除されます。

<methodCall><method methodName="filtercollection.deleteFilter"><filterCollection name="testcollection2"><filter name="Information" type="global"/></filterCollection></method></methodCall>

フィルター・コレクションのリストの取得フィルター・コレクションのリストを取得するための <method> エレメントのフォーマットは次のとおりです。

<method methodCall="filtercollection.getList">

このメソッドを使用して、定義されたフィルター・コレクションのリストを取得します。

例<methodCall><method methodName="filtercollection.getList /></methodCall>

フィルター・コレクションの変更フィルター・コレクションを変更するための <method> エレメントのフォーマットは次のとおりです。

<method methodCall="filtercollection.modifyFilterCollection">

このメソッドを使用して、既存のフィルター・コレクションの特性を変更します。<method> エレメントには、コレクションの特性をそれぞれ定義する 1 つ以上の<filterCollection> エレメントが入ります。これらの各エレメントには、コレクションの一部となるフィルターを示す <filter> エレメントが 1 つ以上入ります。指定できるのは、システム内に既存のシステム・フィルターとグローバル・フィルターだけです。<filter> エレメントに入るのは、フィルターを識別する name 属性とtype 属性だけです。

例

以下の例の場合、testCollection2 というフィルター・コレクションが変更されます。

<methodCall><method methodName="filtercollection.modifyFilterCollection"><filterCollection name="testcollection2" viewName="Default" viewType="global"description="A new description for testcollection2"><filter name="TaskList" type="global"/><filter name="NetcoolStatus" type="global"/></filterCollection></method></methodCall>


フィルター・コレクションのビューの設定コレクションのデフォルト・ビューを設定するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="filtercollection.setView">

このメソッドを使用して、フィルターと関連付けるビューを設定します。<method>

エレメントには、デフォルト・ビューを関連付けるコレクションをそれぞれ指定する 1 つ以上の <filterCollection> エレメントが入ります。<filterCollection>

エレメントには、フィルターを識別するための name 属性と、フィルターのビューを指定するための viewName 属性と viewType 属性を含めます。詳しくは、 96 ページの『<filterCollection>』を参照してください。

例

以下の例の場合、testcollection2 というフィルター・コレクション用のビューが設定されます。

<methodCall><method methodName="filtercollection.setView"><filterCollection name="testcollection2" viewName="DefaultTable"viewType="global"/>


メトリック要求メトリック要求は、Web GUI がゲージ形式で表示するパフォーマンス・メトリックに対して作用します。メトリックを作成、変更、置換、および削除する機能があります。また、現在定義されているメトリックのリストを取得することもできます。 WAAPI にはメトリックを処理するための 5 つのメソッドがあります。つまり、メトリックの作成、メトリックの作成または置換、メトリックの変更、メトリックの削除、およびメトリック・リストの取得です。

メトリックの作成メトリックを作成するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="metric.create">

このメソッドを使用して、ゲージで使用する新しいメトリックを定義します。<method> エレメントには、新しいメトリックの特性をそれぞれ定義する 1 つ以上の <metric:metric> エレメントが入ります。

各 <metric:metric> エレメントには、<metric:command> エレメントの 1 つのインスタンスが入ります。次に、<metric:command> エレメントには <metric:text> エレメントが 1 つ入ります。

v 101 ページの『<metric:metric>』

v 102 ページの『<metric:command>』

v 103 ページの『<metric:text>』



<metric:metric>

<metric:metric> エレメントはメトリックの特性を定義します。以下の属性があります。

表 47. <metric:metric> エレメントの属性


name 必須メトリックの固有名を指定します。



description オプションユーザーがマウス・ポインターをゲージ上に移動させたときに表示されるメトリックのテキスト説明を定義します。説明にメトリックの現行値を含めるには、適切な場所で {0} を使用します。



descriptionKey オプション定義されているすべてのメトリックの中で、対象の説明属性を固有に識別するキー。この属性を省略すると、システムによって固有キーが自動生成されます。


デフォルト値: システム生成値。

displayName オプションゲージ・ページで、ゲージの下に表示されるメトリックの名前。



displayNameKey オプション定義されているすべてのメトリックの中で、対象の displayName 属性を固有に識別するキー。この属性を省略すると、システムによって固有キーが自動生成されます。


デフォルト値: システム生成値

units オプションメトリックの表示単位を定義します。例えば、発生したインシデントの数や、サーバーへのクライアント接続の数などです。



unitsKey オプション定義されているすべてのメトリックの中で、対象の単位属性を固有に識別するキー。この属性を省略すると、システムによって固有キーが生成されます。




表 47. <metric:metric> エレメントの属性 (続き)


maxValue オプションメトリックの単位で表されるメトリックの最大値を定義します。

値: 整数


minValue オプションメトリックの単位で表されるメトリックの最小値を定義します。

値: 整数


threshold1 オプションメトリックの低範囲と中範囲の間のしきい値を定義します。この属性は、メトリック値範囲のパーセンテージでしきい値を定義します。この値は threshold2 よりも小さくなければなりません。

値: 整数


threshold2 オプションメトリックの中範囲と高範囲の間のしきい値を定義します。この属性は、メトリック値範囲のパーセンテージでしきい値を定義します。この値は threshold1 よりも大きくなければなりません。

値: 整数


各 <metric::metric> に含めることができるのは、<metric:command> の 1 つのインスタンスです。

<metric:command>

<metric:command> エレメントは、メトリックの値を生成するコマンドを定義します。通常これは、ObjectServer データベースを照会する SQL コマンドです。このエレメントは、以下の属性を持つことが可能です。

表 48. <metric:command> エレメントの属性


type オプションメトリックの値を生成するコマンドのタイプを定義します。現時点でこの属性に有効な唯一の値は、sql です。


デフォルト値: sql


表 48. <metric:command> エレメントの属性 (続き)


mode オプションメトリックが使用されるときのモードを定義します。基本モードでは、指定されたデータベース表でアクティブになっているすべての制限フィルターが適用されます。拡張モードの場合、ユーザーがゲージを使用してメトリックにアクセスするときに制限フィルターはまったく適用されません。

値: basic または advanced

デフォルト値: advanced

<metric:command> エレメントを指定する場合、その中には <metric:text> エレメントの 1 つのインスタンスが入ります。

<metric:text>

<metric:text> エレメントには、メトリックの値を生成するコマンドが入ります。このエレメントには、次の属性があります。

表 49. <metric:text> エレメントの属性


data 説明を参照メトリックの値を生成するために使用されるコマンドのテキストが入ります。この属性は、<metric:command> エレメントの mode 属性が省略される場合、または値が advanced の場合には必須です。



selectField 説明を参照メトリックの値を生成するために使用するコマンドの SELECT 節の表フィールド、または集約関数を含めます。この属性は、<metric:command> エレメントのmode 属性の値が basic である場合に必須となります。



whereClause 説明を参照メトリックの値を生成するために使用するコマンドの WHERE 節を含めます。この属性は、<metric:command> エレメントの mode 属性の値が basic である場合に必須となります。




表 49. <metric:text> エレメントの属性 (続き)


databaseName 説明を参照メトリックの値を生成するために使用するコマンドのデータベース名節を含めます。この属性は、<metric:command> エレメントの mode 属性の値が basic である場合に必須となります。



tableName 説明を参照メトリックの値を生成するために使用するコマンドの表の名前の節を含めます。この属性は、<metric:command> エレメントの mode 属性の値が basic である場合に必須となります。



例

以下の例の場合、拡張モードで metricsample1 というメトリックが作成されます。このメトリックによって、未処理の重大なイベントの数が測定されます。このメトリックには以下の特性があります。

v 最小値は 0 で、最大値は 10000 です。

v 低範囲から中範囲のしきい値は 30% です。

v 中範囲から高範囲のしきい値は 70% です。

<methodCall xmlns:metric="http://www.ibm.com/tivoli/netcool/webtop/metrics/7.4.0"><method methodName="metric.createMetric"><metric:metric name="metricsample1"displayName="MetricSample1"description="Critical events. Current value: {0}"units="events"maxValue="10000"minValue="0"threshold1="30"threshold2="70"><metric:command type="sql"><metric:text data="select sum(Tally) from alerts.status where Severity=5;"/></metric:command></metric:metric></method></methodCall>

以下の例の場合、同様のメトリックが基本モードで作成されます。そのため、ユーザーがこのメトリックがアクセスする際にアクティブなすべての制限フィルターが適用されます。

<methodCall><method methodName="metric.createMetric"><metric:metric name="metricsample1"displayName="MetricSample1"description="Critical events. Current value {0}"units="events"maxValue="10000"


minValue="0"threshold1="30"threshold2="70"><metric:command type="sql" mode="basic"><metric:text selectField="sum(Tally)" whereClause="Severity=5"databaseName="alerts" tableName="status"/></metric:command></metric:metric></method></methoodCall>

メトリックの作成または置換メトリックを作成または置換するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="metric.createOrReplaceMetric">

このメソッドを使用して、既存のメトリックを置換するか、まだ存在しない場合には新規作成します。<method> エレメントには、新しいメトリックの特性をそれぞれ定義する 1 つ以上の <metric:metric> エレメントが入ります。各<metric:metric> エレメントには <metric:command> エレメントが 1 つ入り、次にこのエレメントには <metric:text> エレメントが 1 つ入ります。詳しくは、これらのエレメントに関する以下の説明を参照してください。




例

以下の例の場合、拡張モードで metricsample2 というメトリックが作成または置換されます。この新しいメトリックによって、未処理の重要イベントの数が測定されます。このメトリックには以下の特性があります。

v 最小値は 0 です。

v 最大値は 100 です。

v 低範囲から中範囲のしきい値は 40% です。

v 中範囲から高範囲のしきい値は 80% です。

<methodCall xmlns:metric="http://www.ibm.com/tivoli/netcool/webtop/metrics/7.4.0"><method methodName="metric.createOrReplaceMetric"><metric:metric name="metricsample2"displayName="MetricSample2"description="Major events. Current value: {0}"units="events"maxValue="100"minValue="0"threshold1="40"threshold2="80"><metric:command type="sql"><metric:text data="select sum(Tally) from alerts.status where Severity=4;"/></metric:command></metric:metric></method></methodCall>

基本モードでメトリックを作成または置換するには、基本モードにおけるメトリックの作成例に示されている <metric:command> エレメントと <metric:text> エレメ


ントと同じフォーマットを使用します。

メトリックの削除メトリックを削除するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="metric.deleteMetric">

このメソッドを使用して、既存のメトリックを削除します。<method> エレメントには、削除するメトリックをそれぞれ指定する 1 つ以上の <metric:metric> エレメントが入ります。<metric:metric> エレメントに含めるのは、name 属性だけです。詳しくは、 101 ページの『<metric:metric>』を参照してください。

例

以下の例の場合、metricsample2 というメトリックが削除されます。

<methodCall xmlns:metric="http://www.ibm.com/tivoli/netcool/webtop/metrics/7.4.0"><method methodName="metric.deleteMetric"><metric:metric name="metricsample2"/></method></methodCall>

メトリック・リストの取得メトリック・リストを取得するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="metric.getList" />

このメソッドを使用して、定義されたメトリックの名前が入ったリストを取得します。

例<methodCall xmlns:metric="http://www.ibm.com/tivoli/netcool/webtop/metrics/7.4.0"><method methodName="metric.getList" /></methodCall>

メトリックの変更メトリックを変更するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="metric.modifyMetric">

このメソッドを使用して、既存のメトリックの特性を変更します。<method> エレメントには、既存のメトリックの新しい特性をそれぞれ定義する 1 つ以上の<metric:metric> エレメントが入ります。変更する特性に対応する<metric:metric> の属性だけを含めます。属性を省略すると、対応する特性は変更されません。

メトリックと関連付けられたコマンドを変更するには、<metric:command> エレメントを含め、次にこのエレメントに <metric:text> エレメントを含めます。

詳しくは、これらのエレメントに関する以下の説明を参照してください。





例

以下の例の場合、metricsample1 というメトリックが変更され、メトリックの特性が次のように変更されます。

v 説明テキストが拡張されます。

v 最大値が 10000 から 250 に変更されます。

v 低範囲から中範囲のしきい値が 30% から 40% に変更されます。

v 中範囲から高範囲のしきい値が 70% から 90% に変更されます。

<methodCall xmlns:metric="http://www.ibm.com/tivoli/netcool/webtop/metrics/7.4.0"><method methodName="metric.modifyMetric"><metric:metric name="metricsample1"displayName="MetricSample1"description="Critical events. Modified by WAAPI. Current value: {0}"units="events"maxValue="250"minValue="0"threshold1="40"threshold2="90"><metric:command type="sql"><metric:text data="select sum(Tally) from alerts.status where Severity=5;"/></metric:command></metric:metric></method></methodCall>

基本モードでメトリックを変更するには、基本モードにおけるメトリックの作成例に示されている <metric:command> エレメントと <metric:text> エレメントと同じフォーマット使用します。

関係要求関係要求は、イベント・ビューアーにおけるイベントの表示を拡張することのできるイベント関係に対して作用します。関係を作成、変更、置換、および削除する機能があります。また、現在定義されている関係のリストを取得することもできます。 WAAPI には関係を処理するための 5 つのメソッドがあります。つまり、関係の作成、関係の作成または置換、関係の変更、関係の削除、および関係リストの取得です。

関係の作成関係を作成するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="relationship.createRelationship">

このメソッドを使用して、イベント・ビューアーで使用する新しい関係を作成します。 <method> エレメントには、1 つ以上の <relationship:relationship> エレメントが入り、それぞれが新しい関係の特性を定義します。


各 <relationship:relationship> エレメントには、<relationship:definition> エレメントの 1 つのインスタンスが入ります。さらに、<relationship:definition>

エレメントには <relationship:relationshipColumn> エレメントの 1 つのインスタンスが入ります。

v 『<relationship:relationship>』

v 109 ページの『<relationship:definition>』

v 109 ページの『<relationship:relationshipColumn>』


<relationship:relationship>

<relationship:relationship> エレメントは関係の特性を定義します。以下の属性があります。

表 50. <relationship:relationship> エレメントの属性


name 必須関係の固有名を指定します。



description オプション関係のテキスト説明を定義します。これは、Web GUI の関係エディターに表示されます。



descriptionKey オプション定義されているすべての関係の中で、対象の説明属性を固有に識別するキー。この属性を省略すると、システムによって固有キーが自動生成されます。


デフォルト値: システム生成値。

displayName 必須関係エディターに表示されるメトリックの名前。



displayNameKey オプション定義されているすべての関係の中で、対象の displayName 属性を固有に識別するキー。この属性を省略して、システムに固有キーを自動生成させることができます。しかし、この属性を含めるとアプリケーションのグローバリゼーションを実装する上で役立ちます。その場合、この値が各種言語のローカライズ・バージョンの表示名を識別します。




表 50. <relationship:relationship> エレメントの属性 (続き)


dataSources オプションこの関係に基づいてグループ化するイベントを提供するデータ・ソースの名前。複数のデータ・ソースを指定する場合、コンマ区切りリストを使用します。



各 <relationship:relationship> エレメントには、<relationship:definition> エレメントの 1 つのインスタンスが入ります。

<relationship:definition>

<relationship:definition> エレメントは、ObjectServer 内の 2 つのフィールド間の関係を定義します。以下の属性があります。

表 51. <relationship:definition> エレメントの属性


type 必須関係のタイプを定義します。現時点でこの属性に有効な唯一の値はrelationshipColumn です。


デフォルト値: relationshipColumn

<relationship:definition> エレメントを指定する場合、その中には<relationship:relationshipColumn> エレメントの 1 つのインスタンスが入ります。

<relationship:relationshipColumn>

<relationship:relationshipColumn> エレメントは、イベント関係を構成する 2 つの ObjectServer 列を定義します。以下の属性があります。

表 52. <relationship:relationshipColumn> エレメントの属性


column 必須関係を定義する列を定義します。



keyColumn 必須 column 属性で定義した列のキーとなる列の名前を定義します。




例v 以下の例の場合、次の特性を持つ SummaryRelationship1 という関係が追加され

ます。

– NmosSerial という列を使用します。

– キーは Summary 列です。

<methodCall xmlns:relationship="http://www.ibm.com/tivoli/netcool/webtop/relationships/8.1"><method methodName="relationship.createRelationship"><relationship:relationship name="SummaryRelationship1"displayName="RelationshipSample1"description="An example relationship created with WAAPI."><relationship:definition type="relationshipColumn"><relationship:relationshipColumn column="NmosSerial" keyColumn="Summary"/></relationship:definition></relationship:relationship></method></methodCall>

関係の作成または置換関係を作成または置換するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="relationship.createOrReplaceRelationship">

このメソッドを使用して、既存の関係を置換するか、まだ存在しない場合には新規作成します。<method> エレメントには、1 つ以上の <relationship:relationship>エレメントが入り、それぞれが関係の特性を定義します。各<relationship:relationship> には <relationship:definition> エレメントが 1つ入り、さらにこのエレメントに <relationship:relationshipColumn> エレメントが 1 つ入ります。 <relationship:relationship> エレメントとそのサブエレメントについて詳しくは、 108 ページの『<relationship:relationship>』を参照してください。

以下の例の場合、SummaryRelationship2 という関係が作成または置換されます。

<methodCall xmlns:relationship="http://www.ibm.com/tivoli/netcool/webtop/relationships/8.1"><method methodName="relationship.createOrReplaceRelationship"><relationship:relationship name="SummaryRelationship2"displayName="RelationshipSample1"description="An example relationship created with WAAPI."><relationship:definition type="relationshipColumn"><relationship:relationshipColumn column="ParentSerial" keyColumn="Serial"/></relationship:definition></relationship:relationship></method></methodCall>


関係の削除関係を削除するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="relationship.deleteRelationship">

このメソッドを使用して、既存の関係を削除します。<method> エレメントには、1つ以上の <relationship:relationship> エレメントが入り、それぞれが削除する関係を指定します。<relationship:relationship> エレメントに含めるのは、name 属性だけです。<relationship:relationship> エレメントとそのサブエレメントについて詳しくは、 108 ページの『<relationship:relationship>』を参照してください。

以下の例の場合、SummaryRelationship2 という関係が削除されます。

<methodCall xmlns:relationship="http://www.ibm.com/tivoli/netcool/webtop/relationships/8.1"><method methodName="relationship.deleteRelationship"><relationship:relationship name="SummaryRelationship2"</relationship:relationship></method></methodCall>

関係リストの取得関係リストを取得するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="relationship.getList">

このメソッドを使用して、定義された関係の名前が含まれるリストを取得します。

<methodCall xmlns:relationship="http://www.ibm.com/tivoli/netcool/webtop/relationships/8.1"><method methodName="relationship.getList" /></methodCall>

関係の変更関係を変更するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="relationship.modifyRelationship">

このメソッドを使用して、既存の関係の特性を変更します。 <method> エレメントには、1 つ以上の <relationship:relationship> エレメントが入り、それぞれが既存の関係の新しい特性を定義します。変更する <relationship:relationship> エレメントの属性だけを含めます。属性を省略すると、対応する特性は変更されません。

<relationship:relationship> エレメントには <relationship:definition> エレメントをまったく含めないか、含める場合には 1 つだけ入れます。関係と関連付けられている列を変更する場合だけ、このエレメントを含めてください。<relationship:definition> エレメントを指定する場合には、その中に<relationship:relationshipColumn> エレメントを 1 つ入れます。<relationship:relationship> エレメントとそのサブエレメントについて詳しくは、 108 ページの『<relationship:relationship>』を参照してください。

以下の例の場合、SummaryRelationship1 という関係が変更され、説明が変更されます。


<methodCall xmlns:relationship="http://www.ibm.com/tivoli/netcool/webtop/relationships/8.1"><method methodName="relationship.modifyRelationship"><relationship:relationship name="SummaryRelationship1"description="Relationship based on the Summary field"></relationship:relationship></method></methodCall>

その他の要求各種機能として、Web GUI キャッシュを再同期する機能、クラスターからノードを削除する機能、状況報告を生成する機能、およびサーバーのフィルターとビューを再ロードする機能があります。

WAAPI には、以下の 4 つのその他の機能があります。

v システム状況報告の生成

v フィルターとビューの再ロード

v ロード・バランシング・クラスターからのノードの削除

v Web GUI キャッシュと ObjectServer のデータベースとの再同期

システム状況報告の生成システム状況報告を生成するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="webtopprobe.generateReport">

このメソッドを使用して、Web GUI の状況報告を生成します。生成された報告には、Web GUI の「トラブルシューティングおよびサポート」 > 「TivoliNetcool/OMNIbus Web GUI のシステム情報」機能が生成するのと同じ情報が含まれ、以下のセクションが含まれます。

v Web GUI、ダッシュボード共通インフラストラクチャー (DCI)、および Java ランタイム環境の各バージョン番号

v メモリー使用量統計

v ランタイム・プラットフォーム情報

v 使用するプロトコル

v ObjectServer プロパティーおよび構成データ (キャッシュに関する情報を含みます)

v すべてのシステム・プロパティー (Web GUI への内部プロパティーを含みます)

例<methodCall><method methodName="webtopprobe.generateReport" /></methodCall>


フィルターとビューの再ロードフィルターとビューを再ロードするための <method> エレメントのフォーマットは次のとおりです。

<method methodName="xmldao.reloadFiltersAndViews">

このメソッドを使用して、現在アクティブなフィルターとビューすべてを再ロードするよう Web GUI に強制します。また、このメソッドは、次回のリフレッシュ時にフィルターとビューを更新するよう AEL クライアントに強制します。

例<methodCall><method methodName="xmldao.reloadFiltersAndViews" /></methodCall>

ロード・バランシング・クラスターからのノードの削除クラスターからノードを削除するための <method> エレメントのフォーマットは次のとおりです。

<method methodName="cluster.removeNode">

このメソッドを使用して、ロード・バランシング・クラスターからノードを削除します。このメソッドは、この要求の送信先のノードを削除します。これがクラスター内の最後のノードの場合、このメソッドによりロード・バランシング構成データもすべて削除されます。

注: このメソッドは、他のステップと組み合わせて長い処理の一環として使用します。このコマンドは、ロード・バランシング・クラスターからノードを一時的に削除するに過ぎません。アプリケーション・サーバーを再始動すると、ノードはクラスターに再結合されます。

詳しくは、「Web GUI 管理およびユーザーズ・ガイド」の『ロード・バランシング・クラスターの管理』を参照してください。

例<methodCall><method methodName="cluster.removeNode" /></methodCall>

Web GUI キャッシュと ObjectServer のデータベースとの再同期

Web GUI キャッシュと ObjectServer のデータベースとの再同期するための<method> エレメントのフォーマットは次のとおりです。

<method methodName="osresync.refreshOSCache" />

このメソッドを使用して、Web GUI がそれ自体のキャッシュと ObjectServer のデータベースと再同期するようにします。この機能は、ユーザーの ObjectServer 権限が変更された場合に特に役立ちます。これにより、Web GUI が最新の情報を持って、ユーザーを正しく管理できるようになります。


例<methodCall><method methodName="osresync.refreshOSCache" /></methodCall>


付録 A. WAAPI プロパティーとコマンド行オプション

ここでは、WAAPI クライアントのプロパティーおよびコマンド行オプションについて説明します。

WAAPI クライアントのプロパティー・ファイルは WEBGUI_HOME/waapi/etc/waapi.init にあります。 runwaapi コマンドを実行する場合、デフォルトではこのファイルで指定されているプロパティーが使用されます。

ヒント: 別のプロパティー・ファイルを指定するには、-props オプションを使用します。以下に例を示します。

runwaapi -props WEBGUI_HOME/waapi/etc/test/waapi.init

WAAPI クライアントの実行時に変更される可能性が低いプロパティー値にWAAPI プロパティー・ファイルを使用してください。例えば、WAAPI クライアントのホスト名とポートは変更される傾向がないため、waapi.init ファイルに以下のプロパティーを設定します。

v waapi.host

v waapi.port

WAAPI クライアントを実行する場合、waapi.init ファイル内のこの値の設定を指定変更するには、その設定にコマンド行オプションを使用します。例えば、使用する WAAPI クライアントに別の XML コマンド・ファイルを指定するには、-file

オプションを使用します。

runwaapi -file path_to_file

この場合、path_to_file が waapi.init ファイル内の waapi.file プロパティーを指定変更しています。

WAAPI クライアントのデフォルトのプロパティーと対応するコマンド行オプションを次の表に示します。

表 53. WAAPI プロパティーとコマンド行オプション

プロパティーコマンド行オプション説明

N/A -help WAAPI コマンド行のヘルプ・テキストを表示します。

N/A -outfile string 出力ファイルのパス。

N/A -props string WAAPI プロパティー・ファイルを指定します。デフォルトは waapi.init です。

接続プロパティー:

waapi.host -host string Web GUI サーバーのホスト名。

waapi.port -port integer Web GUI サーバーが稼働している TCP/IPポート。


表 53. WAAPI プロパティーとコマンド行オプション (続き)


waapi.contextpath N/A 中でサーブレットが実行されている WebGUI のサーブレットのビューを含むコンテキスト。

waapi.secureport -secureport integer セキュア・モードのときに Web GUI サーバーが listen する TCP/IP ポート。

HTTPS のデフォルト・ポートは 16316 です。

waapi.user -user string WAAPI ユーザーの名前。このユーザーには、Web GUI の ncw_admin 役割を割り当てる必要がありますが、ObjectServer での役割は必要ありません。

waapi.password -password string ユーザーのパスワード。

waapi.password.

encryption

-passwordEncryptionnone|aes|fips

waapi.init ファイル内のパスワードが暗号化されることを示します。

AES パスワードは ncw_aes_crypt ユーティリティーを使用して暗号化できます。

FIPS パスワードは ncw_fips_encrypt ユーティリティーを使用して暗号化できます。

WAAPI が FIPS 140–2 モードで実行されている場合、aes オプションは使用できません。

waapi.file -file string WAAPI 構成ファイルのパスとファイル名。

waapi.timeoutsecs -timeout integer 非アクティブ・ユーザーのセッションがアクティブのままになる時間。この時間の経過後に、ネットワーク接続は解放され、使用できるようになります。

デフォルトの秒単位の時間は 600 です。

セキュア・モード・プロパティー:




waapi.secure -secureoff|on|fips

セキュア HTTPS 機能と FIPS 140–2 モードを使用可能にします。

off WAAPI では HTTP のみサポートされます (暗号化なし)。

on WAAPI ではセキュア HTTPS がサポートされます。

fips WAAPI では、FIPS 140–2 モードの暗号化で HTTPS が使用されます。

WAAPI が Web GUI とともにバンドルされた JRE または AIX JRE で実行されている場合のみ使用できます。

デフォルトは「off」です。

waapi.ssl.keyStore -keyStorestring SSL 鍵ストアのロケーション。

waapi.ssl.keyStore

Password

-keyStorePasswordstring

鍵ストアのパスワード。

waapi.ssl.key

ManagerType

-keyManagerTypestring

鍵マネージャー・タイプ:

v Web GUI とともにバンドルされているJRE または AIX JRE を使用している場合は、このプロパティーを IbmX509 に設定します。

v バンドルされている JRE または AIX JREを使用していない場合は、このプロパティーを SunX509 に設定します。

デフォルトは IbmX509 です。

waapi.ssl.keyStore

Type

-keyStoreTypestring

鍵ストア・タイプ:

v Web GUI とともにバンドルされているJRE または AIX JRE を使用している場合は、このプロパティーを PKCS12 に設定します。

v バンドルされている JRE または AIX JREを使用していない場合は、このプロパティーは JKS に設定します。

デフォルトは PKCS12 です。

waapi.ssl.trustStore -trustStorestring

SSL トラストストアのロケーション。

waapi.ssl.

trustStorePassword

-trustStorePasswordstring

トラストストアのパスワード。

付録 A. WAAPI プロパティーとコマンド行オプション 117



waapi.ssl.trust

ManagerType

-trustManagerTypestring

鍵マネージャー・タイプ:

v Web GUI とともにバンドルされているJRE または AIX JRE を使用している場合は、このプロパティーを IbmX509 に設定します。

v バンドルされている JRE または AIX JREを使用していない場合は、このプロパティーを SunX509 に設定します。

デフォルトは IbmX509 です。

waapi.ssl.trust

StoreType

-trustStoreTypestring

トラストストア・タイプ:

v Web GUI とともにバンドルされているJRE または AIX JRE を使用している場合は、このプロパティーを PKCS12 に設定します。

v バンドルされている JRE または AIX JREを使用していない場合は、このプロパティーは JKS に設定します。

デフォルトは PKCS12 です。

waapi.fips.security.

key

-fipsSecurityKeystring

セキュリティー・キーが保管されているロケーションを指します。デフォルトは%%/etc/encrypt/vault.key です。

waapi.ssl.protocol.

handler.pkgs

-protocolHandlerstring

SSL プロトコル・ハンドラー・パッケージ。デフォルトはcom.ibm.net.ssl.www2.protocol です。




waapi.ssl.ip.

authentication

-sslIPAuthenticationfalse|true

JVM 1.4 に組み込まれているデフォルトのSSL ホスト名検査装置では、信頼できるホスト・ロケーションとしての IP アドレスの検証を実行できません。

false オプション: デフォルトのホスト名検査装置を使用して、接続資格情報を検査します。

true カスタムのホスト名検査装置を使用して、接続されているホスト名とこの SSL セッションでのピアの名前を比較します。

ピアのホスト名は、完全修飾ホスト名である必要はなく、さらにホスト名である必要も一切ありません。これは、ピアのネットワーク・アドレスのストリング・エンコードを表します。

ホスト名は認証されません。

ホスト IP アドレスを照合する、信頼できる IP アドレスを入力します。

waapi.ssl.default.

check

-defaultSslCheckfalse|true

waapi.ssl.ip.authentication が false に設定されている場合、このプロパティーは、接続先のホスト IP アドレスが、ここで指定された信頼できる IP アドレスと照合されるかどうかを指定します。

false 検証は行われません。

true 検証はデフォルトのホスト名検査装置を使用して行われます。

waapi.trusted.host.ip -trustedHostIPstring, string

waapi.ssl.ip.authentication が true に設定されている場合、このプロパティーは、接続先のホスト IP アドレスを照合する、信頼できる IP アドレスのリストを指定します。注: 複数の IP アドレスはコンマ区切りのリストで指定されます。

ログ・ファイル・プロパティー:

waapi.logfile -logfilestring WAAPI ログ・ファイルとディレクトリーのロケーション。

付録 A. WAAPI プロパティーとコマンド行オプション 119


付録 B. リモート・ホストへの WAAPI クライアントのインストール

Web GUI サーバー上だけでなく、リモート・ホスト上にも WAAPI クライアントをインストールできます。

始める前に

WAAPI クライアント・ファイルをダウンロードするには、ncw_admin 役割が必要です。

このタスクについて

リモート・ホストに WAAPI クライアントをインストールするには、以下のようにします。

手順1. 適切な任意のユーザー ID を使用して Web GUI にログインします。

2. ナビゲーション・ペインで「ようこそ」をクリックし、そして作業域の「WAAPI クライアント情報」をクリックします。

3. WAAPI クライアントをダウンロードします。

v UNIX Linux waapi.tar.gz をクリックします。

v Windows waapi.zip をクリックします。

ファイルを、クライアントをインストールするディレクトリーに保存します。

4. ファイルのインストール先ディレクトリーに移動します。

5. インストール・ファイルを解凍します。

ヒント: UNIX gtar xzvf waapi.tar.gz コマンドを使用するか、またはgunzip waapi.tar.gz コマンドと tar -xvf waapi.tar コマンドを使用します。waapi というサブディレクトリーに以下の構成でファイルがインストールされます。

v waapi/

v waapi/bin

v waapi/etc/

v waapi/etc/default

v waapi/etc/docs

v waapi/etc/samples/

v waapi/log/

v waapi/platform/java/bin

v waapi/platform/java/lib

6. UNIX runwaapi コマンドで実行権限を次のように設定します。


chmod +x waapi/bin/runwaapi

タスクの結果

これでリモート・ホスト上で WAAPI クライアントを使用できます。


付録 C. WAAPI のセキュリティー

WAAPI には、Web GUI サーバーとの通信を確実に保護するのに役立つ多数のセキュリティー機能があります。

どのシステムも管理はセキュリティーに依存します。WAAPI にはセキュリティー機能がいくつか備わっており、これらを利用できます。

v Web GUI サーバーに対するセキュア接続。

Web GUI サーバーとは別のリモート・サーバーで WAAPI クライアントを実行する場合は、FIPS-142 保護の使用の有無にかかわらず、SSL 接続の使用を考慮してください。

v WAAPI パスワードの暗号化。

WAAPI パスワードの暗号化を AES か FIPS-142 のどちらかで行うことができます (接続が FIPS-142 で保護されている場合は後者が必須)。WAAPI クライアントが Web GUI サーバーと一緒にインストールされている場合であっても、またはサーバーとは別にリモートでインストールされている場合であっても、この機能を使用できます。

v waapi.init ファイルの保護

WAAPI クライアントのプロパティー・ファイルには、機密情報が含まれる多数のエントリーが入っています。例えば、WAAPI コマンドを実行するためにWeb GUI サーバーで使用するユーザーのユーザー名とパスワードがあります。そのため、許可された管理者だけがこのファイルを使用できるようにすることは重要です。

WAAPI には、以下のセキュリティー・タスクがあります。

v 『セキュア WAAPI 接続の作成』

v 133 ページの『WAAPI パスワード暗号化の使用可能化』

v 136 ページの『waapi.init プロパティー・ファイルの保護』

セキュア WAAPI 接続の作成セキュア WAAPI 通信のために Secure Sockets Layer (SSL) プロトコルを使用するように Web GUI を構成できます (サーバーのみの認証またはサーバーとクライアントの認証のいずれかを使用)。オプションで、FIPS 140-2 モードを使用可能にできます。

始める前に

このセクションの各シナリオでは、waapi.ssl.trustStorePassword が暗号化されている必要があります。詳しくは、Web GUI パスワードの暗号化を参照してください。



Web GUI に対して、以下の WAAPI 接続モードを構成できます。

SSL 使用不可WAAPI クライアントは、標準 HTTP を介して Web GUI に接続します。このモードでは、追加の構成は不要です。

SSL 使用可能、サーバーのみの認証 (FIPS 140–2 未使用)WAAPI クライアントは、サーバーのみの認証を使用した HTTPS を介してWeb GUI に接続しますが、FIPS 140–2 モードではありません。

SSL 使用可能、サーバーとクライアントの認証 (FIPS 140–2 未使用)WAAPI クライアントは、サーバーとクライアントの認証を使用したHTTPS を介して Web GUI に接続しますが、FIPS 140–2 モードではありません。

SSL 使用可能、サーバーのみの認証 (FIPS 140–2 使用)WAAPI クライアントは、サーバーのみの認証を使用した FIPS 140–2 モードの HTTPS を介して Web GUI に接続します。

SSL 使用可能、サーバーとクライアントの認証 (FIPS 140–2 使用)WAAPI クライアントは、サーバーとクライアントの認証を使用した FIPS140–2 モードの HTTPS を介して Web GUI に接続します。

WAAPI SSL 接続 (サーバーのみの認証) の作成WAAPI と、(FIPS 140–2 が無効の) Dashboard Application Services Hub 内にデプロイされた Web GUI との間で、セキュアなサーバー認証接続を作成するには、WAAPI トラストストアおよび waapi.init ファイルで Dashboard ApplicationServices Hub を参照する必要があります。


WAAPI と Web GUI の間のセキュアなサーバー認証接続を作成するには、以下のようにします。

手順1. Dashboard Application Services Hub GUI を使用して、デフォルトのトラス

トストア署名者証明書を抽出します。

a. 「コンソール設定」 > 「WebSphere 管理コンソール」をクリックしてから、「WebSphere 管理コンソールの起動」をクリックします。

b. 「セキュリティー」 > 「SSL 証明書および鍵管理」 > 「鍵ストアと証明書」 > 「NodeDefaultKeyStore」 > 「個人証明書」の順にクリックします。

c. デフォルト (別名) のトラストストア証明書を選択し、「抽出」をクリックします。

d. 名前を入力します (例えば、/example/tipcert.arm)。

e. 「Base64 でエンコードされた ASCII データ」を選択し、「OK」をクリックします。

2. Dashboard Application Services Hub の Ikeyman ユーティリティーを使用して、新しい証明書を WAAPI トラストストアに追加します。


a. JazzSM_WAS_Profile/bin に移動し、Ikeyman を始動します。

b. 「KeyDatabaseFile」 > 「新規」をクリックし、鍵データベース・タイプとして「PKCS」を選択します。

c. トラストストア名を入力します (例えば、/example/waapiTruststore.p12)。

d. デフォルトのパスワードである WebAS を入力し、「OK」をクリックします。

e. ドロップダウン・リストから「署名者証明書」を選択し、「追加」をクリックします。

f. 署名者証明書 (この例では /example/tipcert.arm) をポイントし、「OK」をクリックします。署名者証明書の CN (共通名) 値をメモします。

3. waapi.init ファイルを編集します。

a. WEBGUI_HOME/waapi/etc/waapi.init を開き、WAAPI Secure Modes セクションに移動します。

b. waapi.secure:on を設定します。

c. waapi.host のホスト名が、署名者証明書の CN (共通名) 値と同じであることを確認します。

d. トラストストア名を指定します (この例では /example/waapiTruststore.p12)。

e. パスワード WebAS を入力します。

次のタスク

WAAPI SSL 接続が正しく設定されたかどうかテストするために、WAAPI の例を実行します。

WAAPI SSL 接続の作成 (クライアント/サーバー認証)WAAPI と、(FIPS 140–2 が無効の) Dashboard Application Services Hub 内にデプロイされた Web GUI との間で、セキュアなクライアント/サーバー認証接続を作成するには、WAAPI トラストストアで Dashboard Application Services Hubを参照し、Dashboard Application Services Hub トラストストアで WAAPI を参照します。その後、WAAPI で SSL 認証を使用可能に設定し、WAAPI 鍵ストア証明書をブラウザーのトラストストアに追加します。最後に、Dashboard ApplicationServices Hub でクライアント認証を使用可能に設定します。




b. 「セキュリティー」>「SSL 証明書および鍵管理」>「鍵ストアと証明書」>「NodeDefaultKeyStore」>「個人証明書」の順にクリックします。


d. 名前を入力します (例えば、/example/tipcert.arm)。


付録 C. WAAPI のセキュリティー 125



b. 「KeyDatabaseFile」>「新規」をクリックし、鍵データベース・タイプとして「PKCS」を選択します。

c. トラストストア名を指定します (例えば、/example/waapiTruststore.p12)。




3. Dashboard Application Services Hub の Ikeyman ユーティリティーを使用して、自己署名の個人鍵ストア証明書を WAAPI 鍵ストアから抽出します。

a. JazzSM_Home/bin に移動し、Ikeyman を始動します。


c. 鍵ストア名を指定します (例えば、waapiKeystore.p12)。


e. ドロップダウン・リストから「個人証明書」を選択し、「新規自己署名」をクリックします。

f. 鍵のラベルを入力し (例えば、WAAPI_cert)、必要に応じて他のフィールドに入力し、「OK」をクリックします。

g. 新しい鍵ストア証明書を選択し (この例では、WAAPI_cert)、「証明書の抽出」をクリックします。

h. 「Base64 でエンコードされた ASCII データ」を選択します。

i. 証明書のファイル名を入力し (例えば、WAAPI_cert.arm)、ロケーションを定義し (この例では /example/)、「OK」をクリックします。

4. Dashboard Application Services Hub GUI を使用して、新しい WAAPI 鍵ストア証明書を Dashboard Application Services Hub トラストストアに追加します。

a. 「設定」 > 「WebSphere 管理コンソール」をクリックし、「WebSphere管理コンソールの起動」をクリックします。

b. 「セキュリティー」>「SSL 証明書および鍵管理」>「鍵ストアと証明書」>「NodeDefaultTrustStore」>「署名者証明書」の順にクリックします。

c. 「追加」をクリックし、WAAPI_cert の別名を入力します (この例の場合)。

d. 先ほど生成した「WAAPI_cert」をポイントし、「OK」、「保管」の順にクリックします。

5. ブラウザーのセキュリティー管理機能を使用して、新しい鍵ストア証明書をブラウザーのトラストストアに追加します。警告: この手順を完了しないと、次の手順でクライアント認証を使用可能に設定した後、Dashboard Application Services Hub にアクセスできません。


6. Dashboard Application Services Hub GUI を使用して、クライアント認証を使用可能に設定します。

a. 「設定」 > 「WebSphere 管理コンソール」をクリックし、「WebSphere管理コンソールの起動」をクリックします。

b. 「セキュリティー」>「SSL 証明書および鍵管理」>「SSL 構成」>「NodeDefaultSSLSettings」>「保護の品質 (QoP) 設定」の順にクリックします。

c. 一般プロパティー>「クライアント認証」ドロップダウン・リストから「必須」を選択します。

d. 「OK」、「保管」の順にクリックします。



b. waapi.secure:on を設定します。


d. 鍵ストア名を指定します (この例では /example/waapiKeystore.p12)。

e. トラストストア名を指定します (この例では /example/waapiTruststore.p12)。

f. パスワードの WebAS を入力します。

注: Windows Windows システムで鍵ストアおよびトラストストアのロケーションを入力するときは、パスの分離文字として二重の円記号 (¥¥) を使用してください。円記号 (¥) 1 つの場合、エスケープ文字として解釈されます。例えば、トラストストアを指定する場合は、¥¥example¥¥waapiTruststore.p12 を使用します。

次のタスク


FIPS 140–2 が有効の WAAPI SSL 接続 (サーバーのみの認証)の作成

WAAPI と、FIPS 140–2 モードが有効の Dashboard Application Services Hub 内にデプロイされた Web GUI との間で、セキュアなサーバー認証接続を作成するには、WAAPI トラストストアおよび waapi.init ファイルで Dashboard ApplicationServices Hub を参照する必要があります。その後、Dashboard ApplicationServices Hub で FIPS 140–2 を使用可能に設定する必要があります。


Web GUI に FIPS 140–2 を設定するときに、Dashboard Application ServicesHub で FIPS 140–2 を既に使用可能に設定した場合は、手順 4 を実行する必要はありません。







d. 名前を設定します (例えば、/example/tipcert.arm)。











b. waapi.secure:fips を設定します。



e. パスワードの WebAS を入力します。

4. Dashboard Application Services Hub サーバーで FIPS 140–2 を使用可能に設定します。

a. WEBGUI_HOME/java/jre/lib/security/java.security を開きます。

b. プロバイダーとそれらの優先順位のリストで、security.provider:<x>=com.ibm.crypto.fips.provider.IBMJCEFIPS のコメントを外します。

c. <x> 変数を 1 に置き換え、以降のセキュリティー・プロバイダーの数値を変更します。

d. Dashboard Application Services Hub GUI を使用して、FIPS 140–2 を使用可能に設定します。


「セキュリティー」>「SSL 証明書および鍵管理」をクリックし、「構成設定」で「FIPS」チェック・ボックスを選択し、「適用」をクリックします。

e. Dashboard Application Services Hub サーバーを再始動します。

例

次のタスク


FIPS 140–2 が有効の WAAPI SSL 接続 (クライアント/サーバー認証) の作成

WAAPI と、FIPS 140–2 モードが有効の Dashboard Application Services Hub 内にデプロイされた Web GUI との間で、セキュアなクライアント/サーバー認証接続を作成するには、WAAPI トラストストアで Dashboard Application ServicesHub を参照し、Dashboard Application Services Hubトラストストアで WAAPIを参照します。その後、WAAPI で FIPS 140–2 認証を使用可能に設定し、WAAPI鍵ストア証明書をブラウザーのトラストストアに追加します。最後に、DashboardApplication Services Hub でクライアント認証と FIPS 140–2 を使用可能に設定します。


Web GUI に FIPS 140–2 を設定するときに、Dashboard Application ServicesHub で FIPS 140–2 を既に使用可能に設定した場合は、手順 8 を実行する必要はありません。






d. 名前を設定します (例えば、/example/tipcert.arm)。



a. JazzSM_Home/bin に移動し、Ikeyman を始動します。







3. Dashboard Application Services Hub の Ikeyman ユーティリティーを使用して、自己署名の個人鍵ストア証明書を WAAPI 鍵ストアから抽出します。



c. 鍵ストア名を指定します (例えば、waapiKeystore.p12)。


e. ドロップダウン・リストから「個人証明書」を選択し、「新規自己署名」をクリックします。

f. 鍵のラベルを入力し (例えば、WAAPI_cert)、必要に応じて他のフィールドに入力し、「OK」をクリックします。

g. 新しい鍵ストア証明書を選択し (この例では、WAAPI_cert)、「証明書の抽出」をクリックします。

h. 「Base64 でエンコードされた ASCII データ」を選択します。

i. 証明書のファイル名を入力し (例えば、WAAPI_cert.arm)、ロケーションを定義し (この例では /example/)、「OK」をクリックします。

4. Dashboard Application Services Hub GUI を使用し、新しい鍵ストア証明書を Dashboard Application Services Hub トラストストアに追加します。

a. 「セキュリティー」>「SSL 証明書および鍵管理」>「鍵ストアと証明書」>「NodeDefaultTrustStore」>「署名者証明書」の順にクリックします。

b. 「追加」をクリックし、WAAPI_cert の別名を入力します (この例の場合)。

c. 先ほど生成した「WAAPI_cert」をポイントし、「OK」、「保管」の順にクリックします。

5. ブラウザーのセキュリティー管理機能を使用して、新しい鍵ストア証明書をブラウザーのトラストストアに追加します。警告: この手順を完了しないと、次の手順でクライアント認証を使用可能に設定した後、Dashboard Application Services Hub にアクセスできません。

6. Dashboard Application Services Hub GUI を使用して、クライアント認証を使用可能に設定します。

a. 「セキュリティー」>「SSL 証明書および鍵管理」>「SSL 構成」>「NodeDefaultSSLSettings」>「保護の品質 (QoP) 設定」の順にクリックします。

b. 一般プロパティー>「クライアント認証」ドロップダウン・リストから「必須」を選択します。

c. 「OK」、「保管」の順にクリックします。




b. waapi.secure:fips を設定します。



e. パスワードの WebAS を入力します。

8. Dashboard Application Services Hub サーバーで FIPS 140–2 を使用可能に設定します。

a. WEBGUI_HOME/java/jre/lib/security/java.security を開きます。

b. プロバイダーとそれらの優先順位のリストで、security.provider:<x>=com.ibm.crypto.fips.provider.IBMJCEFIPS のコメントを外します。

c. <x> 変数を 1 に置き換え、以降のセキュリティー・プロバイダーの数値を変更します。

d. Dashboard Application Services Hub GUI を使用して、FIPS 140–2 を使用可能に設定します。「セキュリティー」>「SSL 証明書および鍵管理」をクリックし、「構成設定」で「FIPS」チェック・ボックスを選択し、「適用」をクリックします。

e. Dashboard Application Services Hub サーバーを再始動します。

次のタスク


WAAPI クライアントでの SP800-131a 移行モードの設定ご使用の環境で Web GUI Administration API (WAAPI) を使用して Web GUIサーバーをリモート側で管理している場合、WAAPI クライアントで移行モードを有効にするには、追加の構成が必要です。構成のレベルは、FIPS 140-2 レベルからSP800-131 レベルの暗号化に移行するかどうかによって異なります。

FIPS 140-2 レベルの暗号化から移行していて、既に WAAPI トラストストアがある場合、必要な構成は、WAAPI 初期設定ファイルで SP800-131 を適用するだけです。まだ WAAPI トラストストアがない場合 (例えば、現在 FIPS 140-2 レベルの暗号化を使用していない場合)、証明書を更新する必要があります。次に、WAAPIトラストストアを作成して、新しい証明書で更新します。

手順

既に既存の証明書が入った WAAPI トラストストアがある場合は、次のステップのみを実行します。残りのステップはスキップしてください。

1. WAAPI ホストで、waapi.init ファイルを次のように編集します。

a. waapi.secure プロパティーの値を "transition" に変更します。

b. waapi.host プロパティーに、ステップ 5g の CN 属性と同じ値が指定されていることを確認します。


更新用の証明書を作成して、WAAPI トラストストアを作成し、そのトラストストアを更新する必要がある場合は、以下のステップも実行します。

2. 管理コンソールにログインし、「セキュリティー」 > 「SSL 証明書および鍵管理」をクリックします。次に「関連項目」の下で「鍵ストアと証明書」をクリックします。

3. 「NodeDefaultKeyStore」をクリックし、「個人証明書」をクリックして「デフォルト」を選択します。

4. 「抽出」をクリックします。「証明書の抽出」ページの「証明書ファイル名」フィールドに、WEBGUI_HOME/etc/encrypt/tipcert.arm を入力します。次に、変更内容を保存し、Dashboard Application Services Hub からログアウトします。

5. FIPS 140-2 暗号化に以前使用された WAAPI トラストストアを削除します。例えば、webgui_home/etc/encrypt/waapiTruststore.p12 です。

6. JazzSM_HOME/bin に移動し、ご使用のオペレーティング・システムの ikeymanコマンドを実行します。トラストストアを作成して、Dashboard ApplicationServices Hub から署名者証明書をロードし、WAAPI クライアントがDashboard Application Services Hub 証明書を信頼するようにします。

a. 「KeyDatabaseFile」 > 「新規」をクリックし、鍵データベース・タイプとして「PKSC12」を選択します。

b. ファイル名 WEBGUI_HOME/etc/encrypt/waapiTruststore.p12 を入力します。

c. パスワードを指定します。

d. 「署名者証明書」をクリックしてから、「追加」をクリックします。

e. パス WEBGUI_HOME/etc/encrypt およびファイル tipcert.arm を入力します。

f. ラベルとして tipcert を入力します。

g. 証明書を表示し、CN 属性が抽出済みの署名者証明書と同じであることを確認します。

次のタスク

WAAPI クライアントが稼働することをテストするために、WAAPI bin ディレクトリーに移動し、例えば次のようなサンプル・コマンドを実行します。

runwaapi -props ../etc/waapi.init -file ../etc/samples/list_filter.xml

コマンドが実行され、予想された出力を提供することを確認します。

WAAPI クライアントでの SP800-131 厳密モードの設定WAAPI クライアントで SP800-131 暗号化を適用するには、waapi.init ファイルを編集して、waapi.secure プロパティーの値を "sp800-131" に変更します。

手順1. 管理コンソールにログインし、「セキュリティー」 > 「SSL 証明書および鍵管

理」をクリックします。次に「関連項目」の下で「鍵ストアと証明書」をクリックします。

2. 「NodeDefaultKeyStore」をクリックし、「個人証明書」をクリックして「デフォルト」を選択します。


3. 「抽出」をクリックします。「証明書の抽出」ページの「証明書ファイル名」フィールドに、WEBGUI_HOME/etc/encrypt/tipcert.arm を入力します。次に、変更内容を保存し、Dashboard Application Services Hub からログアウトします。

4. FIPS 140-2 暗号化に以前使用された WAAPI トラストストアを削除します。例えば、WEBGUI_HOME/etc/encrypt/waapiTruststore.p12 です。

5. JazzSM_HOME/bin に移動し、ご使用のオペレーティング・システムの ikeymanコマンドを実行します。トラストストアを作成して、Dashboard ApplicationServices Hub から署名者証明書をロードし、WAAPI クライアントがDashboard Application Services Hub 証明書を信頼するようにします。

a. 「KeyDatabaseFile」 > 「新規」をクリックし、鍵データベース・タイプとして「PKSC12」を選択します。

b. ファイル名 WEBGUI_HOME/etc/encrypt/waapiTruststore.p12 を入力します。

c. パスワードを指定します。

d. 「署名者証明書」をクリックしてから、「追加」をクリックします。

e. パス WEBGUI_HOME/etc/encrypt およびファイル tipcert.arm を入力します。

f. ラベルとして tipcert を入力します。

g. 証明書を表示し、CN 属性が抽出済みの署名者証明書と同じであることを確認します。

6. WAAPI ホストで、waapi.init ファイルを次のように編集します。

a. waapi.secure プロパティーの値を "sp800-131" に変更します。

b. waapi.host プロパティーに、ステップ 5g の CN 属性と同じ値が指定されていることを確認します。

WAAPI パスワード暗号化の使用可能化waapi.init ファイルの WAAPI パスワードを暗号化フォーマットで保管することを選択できます。


非 SSL 接続および SSL 接続のパスワードの暗号化には AES 暗号化を使用しますが、FIPS 140-2 接続の暗号化には FIPS 140–2 モード暗号化を使用します。暗号化タイプ、および各タイプを使用するためのツールは以下のとおりです。

非 SSL (HTTP) 接続パスワードは、ncw_aes_crypt ツールを使用して AES で暗号化できます。

SSL (HTTPS) 接続パスワードは、ncw_aes_crypt ツールを使用して AES で暗号化できます。

SSL (HTTPS) 接続 (FIPS 140–2 使用可能)パスワードは、ncw_fips_crypt ツールを使用して暗号化できます。

WAAPI のパスワードは、WEBGUI_HOME/waapi/bin の ncw_fips_crypt スクリプトを使用して暗号化する必要があります。このスクリプトは、


waapi_install_dir/etc/encrypt のボールト鍵を使用します。それがまだ存在しない場合は、スクリプトの最初の実行時に vault.key ファイルが自動的に生成されます。

AES を使用した WAAPI パスワードの暗号化非 SSL 接続および SSL 接続の WAAPI パスワードを暗号化するには、ncw_aes_crypt ツールを使用します。Dashboard Application Services Hub と同じサーバーにインストールされている、または別のサーバーにインストールされている WAAPI クライアントの WAAPI パスワードの暗号化を構成できます。

始める前に

FIPS 140–2 モードが使用可能に設定されていない場合にのみ、AES パスワード暗号化を使用できます。


デフォルトのトラストストアのパスワードは、WebAS です。

暗号化されたパスワードを入力する必要のある waap.init ファイルのロケーションは、WAAPI クライアントがインストールされているかどうかによって異なります。 WAAPI クライアントが Dashboard Application Services Hub と同じサーバー上にインストールされている場合、このファイルは、WEBGUI_HOME/waapi/etc/

waapi.init にあります。 WAAPI クライアントが Dashboard ApplicationServices Hub とは別のサーバー上にインストールされている場合、このファイルは、waapi_install_dir/etc/waapi.init にあります。

手順1. WAAPI パスワードを暗号化します。

a. WEBGUI_HOME/waapi/bin/ncw_aes_crypt を実行します。

b. Dashboard Application Services Hub トラストストアのデフォルトのパスワードである WebAS を入力します。暗号化されたパスワードが生成されます。

c. 暗号化されたパスワードをコピーします。

2. 暗号化されたパスワードを追加します。

a. waapi.init ファイルを開きます。

b. waapi.password.encryption プロパティーを aes に設定します。

c. waapi.ssl.trustStorePassword プロパティーを、ステップ 1 で暗号化したパスワードに設定します。

3. 以下のプロパティーについて、ステップ 2b からステップ 2c までを繰り返します。

v waapi.password

v waapi.ssl.keyStorePassword


FIPS 140–2 モードの暗号化を使用した WAAPI パスワードの暗号化

FIPS 140–2 モードで非 SSL 接続および SSL 接続の WAAPI パスワードを暗号化するには、ncw_fips_crypt ツールを使用します。WAAPI クライアントがDashboard Application Services Hub と同じサーバーにインストールされている場合も、または別のサーバーにインストールされている場合も、WAAPI パスワードの暗号化を構成できます。

始める前に

FIPS 140–2 モードが使用可能に設定されている場合、FIPS 140–2 モードのパスワード暗号化のみを使用できます。ncw_fips_crypt ツールを使用するには、IBM®

JRE がインストールされている必要があります。


デフォルトのトラストストアのパスワードは、WebAS です。

使用するデフォルトの WAAPI ボールト (秘密) 鍵は、WEBGUI_HOME/waapi/etc/

encrypt/vault.key にあります。ボールト鍵は、ncw_fips_crypt ツールを初めて使用すると自動的に生成され、waapi_install_dir/etc/encrypt/vault.key ファイルに保管されます。

暗号化されたパスワードを入力する必要のある waap.init ファイルのロケーションは、WAAPI クライアントがインストールされているかどうかによって異なります。 WAAPI クライアントが Dashboard Application Services Hub と同じサーバー上にインストールされている場合、このファイルは、WEBGUI_HOME/waapi/etc/

waapi.init にあります。 WAAPI クライアントが Dashboard ApplicationServices Hub とは別のサーバー上にインストールされている場合、このファイルは、waapi_install_dir/etc/waapi.init にあります。

手順1. WAAPI パスワードを暗号化します。

a. 以下のコマンドを入力しますWEBGUI_HOME/waapi/bin/ncw_fips_crypt –password WebAS -key

WEBGUI_HOME/waapi/etc/encrypt/vault.key

デフォルトのボールト鍵を使用する場合、key パラメーターは省略します。暗号化されたパスワードが生成されます。

b. 暗号化されたパスワードをコピーします。

2. 暗号化されたパスワードを追加します。

a. waapi.init ファイルを開きます。

b. waapi.password.encryption プロパティーを fips に設定します。

c. waapi.ssl.trustStorePassword プロパティーを、ステップ 1 で生成されたパスワードに設定します。

3. 以下のプロパティーについて、ステップ 2b からステップ 2c までを繰り返します。

v waapi.password


v waapi.ssl.keyStorePassword

次のタスク

新規ボールト鍵を生成するには、-genkey パラメーターを使用します。WEBGUI_HOME/waapi/bin/ncw_fips_crypt –genkey <locationofvaultkeyfile> のコマンドを入力します。コマンドの実行が完了したら、新規ボールト鍵ファイルをwaapi_install_dir/etc/encrypt/ ディレクトリーにコピーします。

waapi.init プロパティー・ファイルの保護waapi.init プロパティー・ファイルを無許可ユーザーのアクセスから保護します。

手順

オペレーティング・システムの機能を使用して、waapi.init ファイルへのアクセス権限を設定します。Web GUI サーバーの許可された管理者だけがこのファイルにアクセスできるようにします。これは、このファイルに Web GUI 管理者のユーザー名とパスワードが含まれている場合には特に重要です。


特記事項

本書は米国 IBM が提供する製品およびサービスについて作成したものです。

本書に記載の製品、サービス、または機能が日本においては提供されていない場合があります。日本で利用可能な製品、サービス、および機能については、日本 IBMの営業担当員にお尋ねください。本書で IBM 製品、プログラム、またはサービスに言及していても、その IBM 製品、プログラム、またはサービスのみが使用可能であることを意味するものではありません。これらに代えて、IBM の知的所有権を侵害することのない、機能的に同等の製品、プログラム、またはサービスを使用することができます。ただし、IBM 以外の製品とプログラムの操作またはサービスの評価および検証は、お客様の責任で行っていただきます。

IBM は、本書に記載されている内容に関して特許権 (特許出願中のものを含む) を保有している場合があります。本書の提供は、お客様にこれらの特許権について実施権を許諾することを意味するものではありません。実施権についてのお問い合わせは、書面にて下記宛先にお送りください。

〒103-8510東京都中央区日本橋箱崎町19番21号日本アイ・ビー・エム株式会社法務・知的財産知的財産権ライセンス渉外

以下の保証は、国または地域の法律に沿わない場合は、適用されません。 IBM およびその直接または間接の子会社は、本書を特定物として現存するままの状態で提供し、商品性の保証、特定目的適合性の保証および法律上の瑕疵担保責任を含むすべての明示もしくは黙示の保証責任を負わないものとします。国または地域によっては、法律の強行規定により、保証責任の制限が禁じられる場合、強行規定の制限を受けるものとします。

この情報には、技術的に不適切な記述や誤植を含む場合があります。本書は定期的に見直され、必要な変更は本書の次版に組み込まれます。 IBM は予告なしに、随時、この文書に記載されている製品またはプログラムに対して、改良または変更を行うことがあります。

本書において IBM 以外の Web サイトに言及している場合がありますが、便宜のため記載しただけであり、決してそれらの Web サイトを推奨するものではありません。それらの Web サイトにある資料は、この IBM 製品の資料の一部ではありません。それらの Web サイトは、お客様の責任でご使用ください。

IBM は、お客様が提供するいかなる情報も、お客様に対してなんら義務も負うことのない、自ら適切と信ずる方法で、使用もしくは配布することができるものとします。


本プログラムのライセンス保持者で、(i) 独自に作成したプログラムとその他のプログラム (本プログラムを含む) との間での情報交換、および (ii) 交換された情報の相互利用を可能にすることを目的として、本プログラムに関する情報を必要とする方は、下記に連絡してください。

IBM Corporation958/NH04IBM Centre, St Leonards601 Pacific HwySt Leonards, NSW, 2069Australia

IBM Corporation896471/H128B76 Upper GroundLondon SE1 9PZUnited Kingdom

IBM CorporationJBFA/SOM1294 Route 100Somers, NY, 10589-0100United States of America

本プログラムに関する上記の情報は、適切な使用条件の下で使用することができますが、有償の場合もあります。

本書で説明されているライセンス・プログラムまたはその他のライセンス資料は、IBM 所定のプログラム契約の契約条項、IBM プログラムのご使用条件、またはそれと同等の条項に基づいて、IBM より提供されます。

この文書に含まれるいかなるパフォーマンス・データも、管理環境下で決定されたものです。そのため、他の操作環境で得られた結果は、異なる可能性があります。一部の測定が、開発レベルのシステムで行われた可能性がありますが、その測定値が、一般に利用可能なシステムのものと同じである保証はありません。さらに、一部の測定値が、外挿による推定値である可能性があります。実際の結果は、異なる可能性があります。お客様は、お客様の特定の環境に適したデータを確かめる必要があります。

IBM 以外の製品に関する情報は、その製品の供給者、出版物、もしくはその他の公に利用可能なソースから入手したものです。IBM は、それらの製品のテストは行っておりません。したがって、他社製品に関する実行性、互換性、またはその他の要求については確証できません。 IBM 以外の製品の性能に関する質問は、それらの製品の供給者にお願いします。

IBM の将来の方向または意向に関する記述については、予告なしに変更または撤回される場合があり、単に目標を示しているものです。

表示されている IBM の価格は IBM が小売り価格として提示しているもので、現行価格であり、通知なしに変更されるものです。卸価格は、異なる場合があります。


本書はプランニング目的としてのみ記述されています。記述内容は製品が使用可能になる前に変更になる場合があります。

本書には、日常の業務処理で用いられるデータや報告書の例が含まれています。より具体性を与えるために、それらの例には、個人、企業、ブランド、あるいは製品などの名前が含まれている場合があります。これらの名称はすべて架空のものであり、名称や住所が類似する企業が実在しているとしても、それは偶然にすぎません。

著作権使用許諾:

本書には、様々なオペレーティング・プラットフォームでのプログラミング手法を例示するサンプル・アプリケーション・プログラムがソース言語で掲載されています。お客様は、サンプル・プログラムが書かれているオペレーティング・システムのアプリケーション・プログラミング・インターフェースに準拠したアプリケーション・プログラムの開発、使用、販売、配布を目的として、いかなる形式においても、IBM に対価を支払うことなくこれを複製し、改変し、配布することができます。このサンプル・プログラムは、あらゆる条件下における完全なテストを経ていません。従って IBM は、これらのサンプル・プログラムについて信頼性、利便性もしくは機能性があることをほのめかしたり、保証することはできません。

本製品の一部には Daniel Veillard により開発されたソフトウェアが含まれています。

v libxml2-2.7.8

libxml2-2.7.8 ソフトウェアは、以下の使用条件に従って配布されます。© Copyright 1998-2003 Daniel Veillard.All Rights Reserved. 以下に定める条件に従い、本ソフトウェアおよび関連文書ファイル (以下「ソフトウェア」といいます。) の複製を取得する人に対して、本ソフトウェアの使用、複製、変更、結合、掲載、頒布、サブライセンスまたはソフトウェアの複製を販売する権利を含め、制限なく取り扱う権利を無償で許可し、また、当該ソフトウェアが提供される人にも、この権利が与えられます。上記の著作権表示およびこの許可通知が、この「ソフトウェア」のすべての複製または重要部分に記載されていなければなりません。ソフトウェアは、特定物として現存するままの状態で提供され、第三者の権利の不侵害の保証、商品性の保証、特定目的適合性の保証および法律上の瑕疵担保責任を含む、すべての明示もしくは黙示の保証責任または保証条件を負わないものとします。 DANIEL VEILLARD は、債務不履行、不法行為その他請求原因を問わず、そのソフトウェアの使用、その他取扱に起因または関連する、請求、損害賠償その他のいかなる責任についても、何等責任を負わないものとします。この通知に記されているもの、および事前の書面による承認がある場合を除き、Daniel Veillard の名前を、このソフトウェアの広告、または販売、使用、取引の促進のためにご使用になることはできません。

この情報をソフトコピーでご覧になっている場合は、写真やカラーの図表は表示されない場合があります。

特記事項 139

商標IBM、IBM ロゴおよび ibm.com は、世界の多くの国で登録された InternationalBusiness Machines Corporation の商標です。他の製品名およびサービス名等は、それぞれ IBM または各社の商標である場合があります。現時点での IBM の商標リストについては、http://www.ibm.com/legal/copytrade.shtml をご覧ください。

Adobe、Adobe ロゴ、PostScript、PostScript ロゴは、Adobe SystemsIncorporated の米国およびその他の国における登録商標または商標です。

Java およびすべての Java 関連の商標およびロゴは Oracle やその関連会社の米国およびその他の国における商標または登録商標です。

Linux は、Linus Torvalds の米国およびその他の国における登録商標です。

Microsoft、Windows、Windows NT、および Windows ロゴは、MicrosoftCorporation の米国およびその他の国における商標です。

UNIX は The Open Group の米国およびその他の国における登録商標です。


索引

日本語, 数字, 英字, 特殊文字の順に配列されています。なお, 濁音と半濁音は清音と同等に扱われています。

［ア行］アクセシビリティー viiエレメント

<filterCollection> 96<icon> 45<menu> 62<metric:metric> 100<relationship:relationship> 107<resources> 56<resource> 56<separator> 62<supermenu> 62<tool:access> 66<tool:cgiurl> 66<tool:cmdline> 66<tool:criterion> 66<tool:equals> 66<tool:fieldlist> 66<tool:journal> 66<tool:osfield> 66<tool:script> 66<tool:security> 66<tool:sql> 66<tool:tool> 66<user> 16

オンライン資料 v

［カ行］環境変数、記法 viii関係要求 107

削除 111作成または置換 110変更 111list 111

規則、書体 viiiクライアント/サーバー

セキュリティー 125FIPS 140-2 129

研修

Tivoli 技術研修を参照 vii研修、Tivoli 技術 vii

コマンド

runwaapiコマンド行オプション 115

［サ行］サポート情報 vii書体の規則 viii資料 vセキュリティー 123

パスワードの暗号化 4, 133AES 134FIPS 140-2 135

FIPS 140-2クライアント/サーバー 129サーバー・サイド 127

WAAPI概要 4, 123クライアント/サーバー 125サーバー・サイド 124

その他の要求 112キャッシュの再同期 113クラスターからのノードの削除 113システム状況報告 112フィルターとビューの再ロード 113

［タ行］ツール要求 66

削除 75作成 66作成または置換 74変更 75list 75

通信 3読者 vトラストストア

WAAPI署名者証明書 124, 125, 127, 129

［ナ行］認証

クライアント/サーバー 125FIPS 140-2 129

サーバーのみ 124FIPS 140-2 127

［ハ行］パスワード

暗号化 4, 133AES 134FIPS 140–2 135

比較

WAAPI と Web GUI の手順 3ビュー要求 26


ファイル

waapi.init 115, 124, 125, 127, 129,134, 135, 136

ファイル要求 58ディレクトリーの再帰的削除 61ディレクトリーの削除 61ディレクトリーの追加 58ファイルの削除 60ファイルの作成または置換 60ファイルの追加 59

フィルター要求 88削除 93作成または置換 93追加 88デフォルト・ビューの設定 95変更 94list 94

フィルター・コレクション要求 96削除 98作成 96作成または置換 97ビューの設定 100フィルターの削除 98フィルターの追加 97変更 99list 99

プロンプト要求 76削除 84作成または置換 77変更 85list 84

文書タイプ定義 13変数、記法 viii


［マ行］マップ要求 34


マップ・ビジュアル要求

削除 55追加 54追加または置換 54変更 55

マニュアル vメトリック要求 100

削除 106作成 100, 107作成または置換 105変更 106list 106

メニュー要求 61削除 64作成 62作成または置換 64変更 65list 65

［ヤ行］ユーザー要求 15

変更 15保守 15list 26

ユーティリティー

ncw_aes_crypt 134ncw_fips_crypt 135

［ラ行］リソース要求 56

削除 57作成または置換 57追加 56list 58

リモート・ホスト

インストール

WAAPI クライアント 121ロード・バランシング

ノードの削除 113

CCGI 要求 85

作成または置換 86登録 85

CGI 要求 (続き)

登録抹消 87変更 87

DDTD

参照：文書タイプ定義

FFIPS 140-2

クライアント/サーバー 129サーバーのみ 127

Rrequest 11

関係 107構造 11その他 112ツール 66ファイル 58フィルター・コレクション 96プロンプト 76メニュー 61リソース 56CGI 85filter 88map 34metric 100user 15view 26

Sserver

セキュリティー 124FIPS 140-2 127

SSLパスワードの暗号化

AES 134

TTivoli 技術研修 viiTivoli ソフトウェア情報センター v

WWAAPI

インストール

リモート・ホスト 121コマンド行オプション 115

WAAPI (続き)

サーバーとの通信 3使用 7セキュリティー 123

概要 4, 123トラストストア

署名者証明書 124, 125, 127, 129パスワードの暗号化 4, 133

AES 134FIPS 140–2 135

プロパティー 115, 136Web GUI との比較 3

WAAPI 要求 11エレメントの順序 13関係 107構造 11コメント 13その他 112大/小文字の区別 13ツール 66特性 13内容と値の制約事項 13ファイル 58フィルター・コレクション 96プロンプト 76文書タイプ定義 13メニュー 61リソース 56ルート・エレメント 11CGI 85filter 88map 34metric 100user 15view 26XML 宣言 11

［特殊文字］<filterCollection> 96<icon> 45<menu> 62<metric:metric> 100<relationship:relationship> 107<resources> 56<resource> 56<separator> 62<supermenu> 62<tool:access> 66<tool:cgiurl> 66<tool:cmdline> 66<tool:criterion> 66<tool:equals> 66<tool:fieldlist> 66<tool:journal> 66<tool:osfield> 66


<tool:script> 66<tool:security> 66<tool:sql> 66<tool:tool> 66<user> 16

索引 143


IBM®

Printed in the Republic of Ireland

SC43-0819-10

Documents

IBM Tivoli Netcool/OMNIbusnWeb GUI Administration …“の資料の内容 IBM Tivoli Netcool/OMNIbus Web GUI は、 Web ベース・アプリケーションで あり、 1 つ以上のデータ・ソースからのネットワーク・イベントを処理し、そのイ

IBM Tivoli Netcool/OMNIbusnWeb GUI Administration …“の資料の内容 IBM Tivoli Netcool/OMNIbus Web GUI は、 Web ベース・アプリケーションであり、 1 つ以上のデータ・ソースからのネットワーク・イベントを処理し、そのイ