IBM Netcool/OMNIbus WebGUI 8.1へのFix Pack適用方法

## 1. はじめに
IBM Netcool/OMNIbus WebGUI（以下WebGUI）は、IBMのイベント管理製品であるNetcool/OMNIbusに集積されたイベントデータをグラフィカルに表示するWebアプリケーションです。
2024年時点でのWebGUIの現行バージョンは8.1で、現在も3～4ヶ月毎に新しいFixPackがリリースされていますが、WebGUIは複数のIBM製品を前提とするソフトウェアであり、WebGUIにFixPackを適用する際は前提製品にもFixPackを適用する必要があります。
そのため、WebGUIへのFixPackの適用作業は他製品に比べてやや複雑になることから、適用の手順をまとめてみました。




## 2. WebGUIと前提製品
WebGUIは以下のソフトウェアから構成されています。

**本体**
|製品/コンポーネント名  |本記事で使用する略称  |導入ディレクトリ（デフォルト）  |
|---|---|---|
|IBM Tivoli Netcool WebGUI  |WebGUI  | /opt/IBM/netcool/gui/ |

**前提ソフトウェア**
|製品/コンポーネント名  |本記事で使用する略称  |導入ディレクトリ（デフォルト）  |
|---|---|---|
|IBM WebSphere Application Server  |WAS  | /opt/IBM/WebSphere/AppServer/ |
|IBM SDK, Java Technology Edition  |SDK  | /opt/IBM/WebSphere/AppServer/ |
|Jazz for Service Management extension for IBM WebSphere  |Jazz extention  | /opt/IBM/WebSphere/AppServer/ |
|IBM Dashboard Application Services Hub  |DASH  | /opt/IBM/JazzSM/ |

導入済み製品とバージョンは IBM Installation Managerのコマンドにて確認できます。

```
/opt/IBM/InstallationManager/eclipse/tools/imcl listInstalledPackages -long
```
出力例
```
/opt/IBM/WebSphere/AppServer : com.ibm.java.jdk.v8_8.0.8005.20230425_1032 : IBM SDK, Java Technology Edition, Version 8 : 8.0.8.5
/opt/IBM/WebSphere/AppServer : com.ibm.tivoli.tacct.psc.install.was.security.extension_1.1.1000.20231116-1043 : Jazz for Service Management extension for IBM WebSphere 9.0 : 1.1.3.20
/opt/IBM/WebSphere/AppServer : com.ibm.websphere.BASE.v90_9.0.5016.20230609_0954 : IBM WebSphere Application Server  : 9.0.5.16
/opt/IBM/JazzSM : com.ibm.tivoli.tacct.psc.tip.install_3.1.3100.20231116-1043 : IBM Dashboard Application Services Hub : 3.1.3.20
/opt/IBM/netcool/gui : com.ibm.tivoli.netcool.omnibus.webgui_8.1.34.202403051348 : IBM Tivoli Netcool/OMNIbus Web GUI : 8.1.0.33
```


## 3. FixPack適用前の準備作業

### 3.1. 適用するFixPackレベルの選択

まずはWebGUIに適用するFixPackレベルを決めます。
入手可能なFixPackは下記のサイト等で確認できますが、基本的には最新のものでよいと思います。
執筆時点（2024年8月）ではFixPack35（8.1.0.35）までリリースされているようです。


https://www.ibm.com/support/pages/node/6839165

<br>
次に前提ソフトウェア（WAS、SDK、DASH、Jazz extention）のFixPackレベルを決めます。

WebGUIはFixPackレベルによってサポートするWAS、Jazz（DASH）のFixPackレベルが定められており、その情報は下記リンク先（製品マニュアル）の**表3**にまとめられています。


https://www.ibm.com/docs/ja/netcoolomnibus/8.1?topic=upgrade-web-gui-installation-prerequisites

例えば WebGUIにFixPack34を適用する場合、先述の表に従うとWASとJazz（DASH）のFixPackレベルの組み合わせは以下2パターンのいずれかにする必要があります。

- パターン1（サポートされる最小レベル）
    - WAS 9.0.5.17（FixPack17） or 8.5.5.24（FixPack24）
    - Jazz extension 1.1.3.20（FixPack20）
    - DASH 3.1.3.20（FixPack20）
- パターン2（サポートされる最大レベル）
    - WAS 9.0.5.18（FixPack18） or 8.5.5.25（FixPack25）
    - Jazz extension 1.1.3.21（FixPack21）
    - DASH 3.1.3.21（FixPack21）

:::note info
WASについては導入済みのバージョン（9.0.5.x or 8.5.5.x）によってFixPackレベルが異なるのでご注意ください（以後は 9.0.5.xベースで話を進めます）
:::

残るSDKのFixPackレベルですが、WASのFixPackレベルで決まります。
WASの各FixPackレベルに対応したバージョンは下記リンクにて確認できます。
例えばWAS（9.0.5.x）にFixPack18を適用する場合、対応するSDKは SR8FP15（8.0.8.15）ということがわかります。

https://www.ibm.com/support/pages/node/317689


### 3.2. FixPackの入手

各製品に適用するFixPackレベルが決定したら、FixPackの導入イメージをFix Centralから入手します。

https://www.ibm.com/support/fixcentral

なお、DASHとJazz extention は Jazz for Service Management（Jazz）という製品に含まれるコンポーネントなので導入イメージは同じものになります。


### 3.3. Readmeファイルの確認

各FixPackの導入イメージに含まれるReadmeファイルの内容を必ず確認してください。
適用時における条件や考慮点の他に、FixPackのレベルによっては通常の適用手順とは異なったり、追加で必要な作業の必要性について記載されている可能性があります。



### 3.4. IBM Installation Managerの更新
FixPackの適用にはIBM Installation Manager（IM）を使用しますが、IMのバージョンは一定以上である必要があります。
各FixPackのReadmeファイルに必要とするIMのバージョン情報が記載されているはずなので、前提に満たない場合は事前にIMのバージョンアップを行ってください。
IMの最新版は先述のFix Centralから入手できます。



### 3.5. バックアップの取得
FixPackの適用が失敗した場合に備えて、作業前にバックアップ取得を必ず行ってください。
サーバーのシステムバックアップを推奨しますが、WebGUIを停止した状態で以下のディレクトリを丸ごとアーカイブ（tar.gz, zip等）しておくのでもよいかと思います。

- /opt/IBM/WebSphere/AppServer/
- /opt/IBM/JazzSM/
- /opt/IBM/netcool/gui/
- /opt/IBM/InstallationManager/
- /opt/IBM/IBMIMShared/
- /var/ibm/InstallationManager/

:::note info
- 後半の3つはInstallation Manager関連のディレクトリです。
- 記載のディレクトリはrootで導入した場合のデフォルト値です。導入時のユーザーや設定によっては異なる場合があるので必ず自身の環境を確認してください。
:::


## 4. FixPackの適用
### 4.1. 適用順

FixPackの適用は、WebGUIのプロセスを停止した状態で以下の順で実施します。

1. WAS & SDK
1. Jazz extention
1. DASH
1. WebGUI

:::note info
WASとSDKは同時に適用が可能です。
:::


### 4.2. 適用手順の例
ここでは、以下の組み合わせでFixPackを適用した際の手順を紹介します。
サーバーのOSはRHEL 9.3です。

| 製品/コンポーネント名  | 適用前バージョン  | 適用するFixPack | FixPack導入イメージのファイル名 |
|---|---|---|---|
| WAS  | FP16（9.0.5.16） |FP18（9.0.5.18）|9.0.5-WS-WAS-FP018.zip
| SDK  | FP5（8.0.8.5） | FP15（8.0.8.15） |ibm-java-sdk-8.0-8.15-linux-x64-installmgr.zip
| Jazz extention | FP20（1.1.3.20） | FP21（1.1.3.21） |1.1.3-TIV-JazzSM-multi-FP021.codesigned.zip
| DASH  | FP20（3.1.3.20） | FP21（3.1.3.21） |同上（同一ファイル）
| WebGUI  | FP33（8.1.0.33） | FP34（8.1.0.34） |OMNIbus-v8.1.0-WebGUI-FP34-IM-Extensions-linux64-UpdatePack.codesigned.zip


なお、詳細な手順を書くと非常に長くなってしまうため一部の手順は簡略化・省略していますのでご了承ください。
また、以降の手順はあくまで上記の組み合わせにおけるものであり、今後もこの手順で適用できる保証はありませんので、テスト環境等で必ず適用手順を確認するようにしてください。

#### 4.2.1. WAS ＆ SDKへのFixPack適用

作業用ディレクトリをそれぞれ作成し、ダウンロードしたWAS, SDKのFixPackイメージを配置＆展開します。
（ここでは/work/fixpack/was/、/work/fixpack/sdk/というディレクトリを使用します）

```
cd /work/fixpack/was/
unzip 9.0.5-WS-WAS-FP018.zip

cd /work/fixpack/sdk/
unzip ibm-java-sdk-8.0-8.15-linux-x64-installmgr.zip
```

IMを起動します（今回はコンソールモードで行います）。
```
/opt/IBM/InstallationManager/eclipse/tools/imcl -c
```

IM起動後にプリファレンスメニューを選択し、以下の2ファイルをリポジトリに追加してください。
- /work/fixpack/was/repository.config
- /work/fixpack/sdk/repository.config

その後、IMのメインメニューに戻り、「2. Update」から対話式にてFixPackの適用（アップデート）を進めます。
途中、アップデート対象を選択するメニューになるので、以下のような画面が表示されたら「IBM WebSphere Application Server V9.0」を選択してください。

```
=====> IBM Installation Manager> Update

Select a package group to update:
     1. [ ] IBM Netcool Core Components
     2. [ ] IBM WebSphere Application Server V9.0     <=== これを選択
     3. [ ] Jazz for Service Management のコア・サービス
     4. [ ] IBM Netcool GUI Components

Other Options:
     U. Update All

     C. Cancel
-----> [C] 2
```

以下の画面ではそのまま N（Next）を入力して次へ進みます。
```
=====> IBM Installation Manager> Update> Packages

Package group:  IBM WebSphere Application Server V9.0

Update packages:
     1-. [X] IBM WebSphere Application Server  9.0.5.16
       2. [X] Version 9.0.5.18
     3-. [X] IBM SDK, Java Technology Edition, Version 8 8.0.8.5
       4. [X] Version 8.0.8.15
     5. [ ] Jazz for Service Management extension for IBM WebSphere 9.0 1.1.3.20

Other Options:
     A. Show All
     R. Select Recommended

     B. Back,      N. Next,      C. Cancel
-----> [N] N
```

以後はデフォルト値のままウィザードを進めればOKです。
FixPackの適用が完了したらメインメニューに戻り、一旦IMを終了します。



#### 4.2.2. Jazz extentionへのFixPack適用

作業用ディレクトリを作成し、ダウンロードしたJazz for Service Management のFixPackイメージを展開します（ここでは/work/fixpack/jazz/というディレクトリを使用します）。

なお、Jazz for Service ManagementのFP21の導入イメージは二重にアーカイブされており、2回展開する必要がありました。

```
cd /work/fixpack/jazz/
unzip unzip 1.1.3-TIV-JazzSM-multi-FP021.codesigned.zip
unzip unzip 1.1.3-TIV-JazzSM-multi-FP021.zip
```

Jazz extentionのFixPackの適用もIMを使用しますが、**サイレントモードのみ対応している**ため下記コマンドにて適用を行います。
```
cd /opt/IBM/InstallationManager/eclipse/tools
./imcl -updateAll -repositories /work/fixpack/jazz/JazzSMFPRepository/disk1/ -installationDirectory
```

<br/>
下記のメッセージが出力されれば適用は成功です。

```
Updated to com.ibm.tivoli.tacct.psc.install.was.security.extension_1.1.1000.20240209-1017 in the /opt/IBM/WebSphere/AppServer directory.
```

#### 4.2.3. DASHへのFixPack適用

FixPackのイメージは先程のJazz extentionのアップデートの際に展開済みです。

DASHへのFixPack適用は、**応答ファイルを使用したサイレントモードのみ対応**しています。
まずは応答ファイルを作成するために、IMをコンソールモードで起動します。
```
/opt/IBM/InstallationManager/eclipse/tools/imcl -c
```

IM起動後、プリファレンスから以下のディレクトリをリポジトリに追加してください。
- /work/fixpack/jazz/JazzSMFPRepository/disk1/


次にIMのメインメニューに戻り、「2. Update」から対話式にてFixPackの適用（アップデート）を進めます。
途中のアップデート対象を選択する画面では「Jazz for Service Management のコア・サービス」を選択してください。

```
=====> IBM Installation Manager> Update

Select a package group to update:
     1. [ ] IBM Netcool Core Components
     2. [ ] IBM WebSphere Application Server V9.0
     3. [ ] Jazz for Service Management のコア・サービス     <=== これを選択
     4. [ ] IBM Netcool GUI Components

Other Options:
     U. Update All

     C. Cancel
-----> [C] 3
```

以下の画面ではそのまま N（Next）を入力して次へ進みます。
```
=====> IBM Installation Manager> Update> Packages

Package group:  Jazz for Service Management のコア・サービス

Update packages:
     1-. [X] IBM Dashboard Application Services Hub 3.1.3.20
       2. [X] Version 3.1.3.21

Other Options:
     A. Show All
     R. Select Recommended

     B. Back,      N. Next,      C. Cancel
-----> [N] N
```

その後はしばらくデフォルト値にてウィザードを進めていき、以下の画面になったら**応答ファイルを作成するオプション（G）を指定してください**。

```
=====> IBM Installation Manager> Update> Packages> Licenses> Features> Summary

Target Location:
  Shared Resources Directory :  /opt/IBM/IBMIMShared
Update packages:
     1-. Jazz for Service Management のコア・サービス (/opt/IBM/JazzSM)
       2-. IBM Dashboard Application Services Hub 3.1.3.20
         3-. Features to install:
           4. Installation
           5. Configuration

Options:
     G. Generate an Update Response File

     B. Back,      U. Update,      C. Cancel
-----> [U] G　 <== "G"を入力
```

すると応答ファイルの出力先を求められるので、任意のファイル名をフルパスで入力します。
```
=====> IBM Installation Manager> Update> Packages> Licenses> Features>
  Summary> Save response file

Enter a directory path and a file name to generate the response file. Use .xml as the file extension. If a file name is specified without a full directory path, the response file is saved to /home/tivadmin. To skip the generation of a response file, press Enter.
-----> /work/fixpack/jazz/dash_fp_response.xml  　 <==ファイル名をフルパスで入力


=====> IBM Installation Manager> Save response file

Response file was generated successfully: /work/fixpack/jazz/dash_fp_response.xml

     O. OK
-----> [O] O
```


再びサマリー画面に戻るので、**導入をキャンセル（C）** します。

```
=====> IBM Installation Manager> Update> Packages> Licenses> Features> Summary

Target Location:
  Shared Resources Directory :  /opt/IBM/IBMIMShared
Update packages:
     1-. Jazz for Service Management のコア・サービス (/opt/IBM/JazzSM)
       2-. IBM Dashboard Application Services Hub 3.1.3.20
         3-. Features to install:
           4. Installation
           5. Configuration

Options:
     G. Generate an Update Response File

     B. Back,      U. Update,      C. Cancel
-----> [U] C　 <== "C"を入力
```

その後、メインメニューに戻ってからIMを終了してください。


応答ファイルが作成されたことを確認します。
```
# ls-l /work/fixpack/jazz/dash_fp_response.xml
-rw------- 1 root root 2470 Jun  6 22:54 /work/fixpack/jazz/dash_fp_response.xml
```

次に応答ファイルの編集を行います。

```
vi /work/fixpack/jazz/dash_fp_response.xml
```
ファイルの編集箇所は以下の2点です。
1. WASプロファイルの新規作成オプションの無効化
    `true` を `false` に変更してください。
1. smadminのパスワード情報
    パスワード情報の行は記載が無いので上記例の記述に倣って行ごと新規追加し、`value`には**暗号化したsmadminのパスワード**を記述します。
    パスワード文字列の暗号化はIMの暗号化ツールを使用します。
    ```
    cd /opt/IBM/InstallationManager/eclipse/tools
    ./imutilsc encryptString <パスワード>
    XXXXXXXXXXXXXX   　　　　　　　　　　　　　<= 暗号化された文字列が出力される
    ```

<br>
応答ファイルの内容は以下のようになります。

```dash_fp_response.xml
<?xml version='1.0' encoding='UTF-8'?>
<agent-input>
  <variables>
    <variable name='sharedLocation' value='/opt/IBM/IBMIMShared'/>
  </variables>
  <server>
    <repository location='/work/fixpack/was'/>
    <repository location='/work/fixpack/sdk'/>
    <repository location='/work/fixpack/jazz/JazzSMFPRepository/disk1/'/>
  </server>
  <profile id='Jazz for Service Management のコア・サービス' installLocation='/opt/IBM/JazzSM'>
    <data key='cic.selector.arch' value='x86_64'/>
    <data key='user.ORB_LISTENER_ADDRESS' value='16320'/>
    <data key='user.IPC_CONNECTOR_ADDRESS' value='16314'/>
    <data key='user.CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS' value='16323'/>
    <data key='user.BOOTSTRAP_ADDRESS' value='16312'/>
    <data key='user.WC_adminhost_secure' value='16316'/>
    <data key='user.WC_defaulthost_secure' value='16311'/>
    <data key='user.CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS' value='16322'/>
    <data key='user.REST_NOTIFICATION_PORT' value='16324'/>
    <data key='user.SOAP_CONNECTOR_ADDRESS' value='16313'/>
    <data key='user.WC_defaulthost' value='16310'/>
    <data key='user.SAS_SSL_SERVERAUTH_LISTENER_ADDRESS' value='16321'/>
    <data key='user.WC_adminhost' value='16315'/>
    <data key='user.DCS_UNICAST_ADDRESS' value='16318'/>
    <data key='user.TIP_CONTEXT_ROOT' value='/ibm/console'/>
    <data key='user.WAS_HOME' value='/opt/IBM/WebSphere/AppServer'/>
    <data key='user.CREATE_NEW_WAS_PROFILE' value='false'/>               ※編集箇所１※
    <data key='user.WAS_PROFILE_PATH' value='/opt/IBM/JazzSM/profile'/>
    <data key='user.WAS_PROFILE_NAME' value='JazzSMProfile'/>
    <data key='user.WAS_HOST_NAME' value='web'/>
    <data key='user.WAS_SERVER_NAME' value='server1'/>
    <data key='user.WAS_NODE' value='JazzSMNode01'/>
    <data key='user.WAS_USER_NAME' value='smadmin'/>
    <data key='user.WAS_PASSWORD' value='<smadminパスワードの暗号化文字列>'/>　　※編集箇所２※
    <data key='user.WAS_CELL' value='JazzSMNode01Cell'/>
  </profile>
  <install>
    <!-- IBM Dashboard Application Services Hub 3.1.3.21 -->
    <offering profile='Jazz for Service Management のコア・サービス' id='com.ibm.tivoli.tacct.psc.tip.install' version='3.1.3100.20240209-1017' features='com.ibm.tivoli.tacct.psc.install.server.feature.tip.install,com.ibm.tivoli.tacct.psc.install.server.feature.tip.config'/>
  </install>
  <preference name='com.ibm.cic.common.core.preferences.eclipseCache' value='${sharedLocation}'/>
  <preference name='offering.service.repositories.areUsed' value='false'/>
</agent-input>

```



<br>
後は下記コマンドにてサイレントアップデートを実行すればFixPackの適用は完了です。

```
cd /opt/IBM/InstallationManager/eclipse/tools
./imcl -acceptLicense -showProgress input /work/fixpack/jazz/dash_fp_response.xml -log update_response.log
```




#### 4.2.4. WebGUIへのFixPack適用


最後のWebGUIのFixPack適用は**プロセスが起動した状態**で実施します。
DASHへのFixPackの適用後の時点ではWebGUIのプロセスは自動的に起動しているので、手動による起動は不要です。

作業用ディレクトリを作成し、ダウンロードしたWebGUIのFixPackイメージを展開します。
（ここでは/work/fixpack/gui/というディレクトリを使用します）

なお、WebGUIのFP34の導入イメージも二重にアーカイブされており、2回展開する必要がありました。
```
cd /work/fixpack/gui/
unzip OMNIbus-v8.1.0-WebGUI-FP34-IM-Extensions-linux64-UpdatePack.codesigned.zip
unzip OMNIbus-v8.1.0-WebGUI-FP34-IM-Extensions-linux64-UpdatePack.zip
```

IMをコンソールモードで起動します。
```
/opt/IBM/InstallationManager/eclipse/tools/imcl -c
```

IM起動後、プリファレンスから以下のディレクトリをリポジトリに追加してください。
- /work/fixpack/gui/OMNIbusWebGUIRepository/composite/

その後、IMのメインメニューに戻り、「2. Update」から対話式にてFixPackの適用（アップデート）を進めます。
途中のアップデート対象を選択する画面では「IBM Netcool GUI Components」を選択してください。

```
=====> IBM Installation Manager> Update

Select a package group to update:
     1. [ ] IBM Netcool Core Components
     2. [ ] IBM WebSphere Application Server V9.0
     3. [ ] Jazz for Service Management のコア・サービス
     4. [ ] IBM Netcool GUI Components     <=== これを選択

Other Options:
     U. Update All

     C. Cancel
-----> [C] 4
```

その後、しばらくはデフォルト値にてウィザードを進めます。
途中のWASのプロファイル情報を入力する画面（下記）では、smadminのパスワード情報が必要になるので"5"を入力し、続いてパスワードを入力します。
```

=====> IBM Installation Manager> Update> Packages> Licenses> Features>
  Configurations

---- Common Configurations> WebSphere Application Server and Jazz for Service Management properties

    Installation Directory Details
  WebSphere Application Server:  /opt/IBM/WebSphere/AppServer
  Jazz for Service Management UI:  /opt/IBM/JazzSM/ui


    Profile Details
  Server name                :  server1
  User name                  :  smadmin
  Password                   :


Other Options:
     1. Edit the WebSphere Application Server root directory
     2. Edit the Jazz for Service Management UI root directory
     3. Edit the server name
     4. Edit the user name
     5. Edit the password


     B. Back,      R. Return to Configurations Menu,      C. Cancel
-----> [R] 5　　     <=== "5"を選択

=====> IBM Installation Manager> Update> Packages> Licenses> Features>
  Configurations> Password

Edit the password
-----> *********    <=== smadminのパスワードを入力

```

以後はデフォルト値のままウィザードを進めればOKです。


#### 4.2.5. 適用後の確認

IMのコマンドにて正常にFixPackを適用できていることを確認します。

```
/opt/IBM/InstallationManager/eclipse/tools/imcl listInstalledPackages -long
```
出力例
```
/opt/IBM/WebSphere/AppServer : com.ibm.java.jdk.v8_8.0.8015.20231031_0036 : IBM SDK, Java Technology Edition, Version 8 : 8.0.8.15
/opt/IBM/WebSphere/AppServer : com.ibm.tivoli.tacct.psc.install.was.security.extension_1.1.1000.20240209-1017 : Jazz for Service Management extension for IBM WebSphere 9.0 : 1.1.3.21
/opt/IBM/WebSphere/AppServer : com.ibm.websphere.BASE.v90_9.0.5018.20231113_1345 : IBM WebSphere Application Server  : 9.0.5.18
/opt/IBM/JazzSM : com.ibm.tivoli.tacct.psc.tip.install_3.1.3100.20240209-1017 : IBM Dashboard Application Services Hub : 3.1.3.21
/opt/IBM/netcool/gui : com.ibm.tivoli.netcool.omnibus.webgui_8.1.33.202311291304 : IBM Tivoli Netcool/OMNIbus Web GUI : 8.1.0.34
```

最後のWebGUIへのFixPack適用が正常に完了していればWebGUIのプロセスは既に起動状態ですので、後はブラウザーからWebGUIにアクセスして諸々の動作確認を行います。


## 5. まとめ
手順が複雑なNetcool/OMNIbus WebGUI 8.1へのFixPackの適用方法についてまとめました。