3.2.4　ダッシュボードのインポート・エクスポート機能と削除機能の拡充

(a)　概要

ダッシュボード定義のインポートとエクスポートを行うための機能として，次のREST APIを提供しています。これらのREST APIを使用して，ダッシュボード定義の移行やバックアップとリカバリーを行えます。また，取得済みのダッシュボード定義を流用して複製することもできます。

• ダッシュボード定義の取得API（ダッシュボード定義のエクスポート機能）

  REST APIを実行するJP1ユーザーが閲覧できるダッシュボードの定義だけをエクスポートできます。

  ダッシュボード定義の取得APIの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「5.20.1 ダッシュボード定義の取得」を参照してください。

• ダッシュボード定義の追加API（ダッシュボード定義のインポート機能）

  ダッシュボード定義の追加APIの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「5.20.3 ダッシュボード定義の追加」を参照してください。

また，現在定義されているダッシュボード定義の一覧取得と削除を行うための機能として，次のREST APIを提供しています。

• ダッシュボード定義の一覧取得API

  ダッシュボード定義の一覧取得APIの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「5.20.2 ダッシュボード定義の一覧取得」を参照してください。

• ダッシュボード定義の削除API

  ダッシュボード定義の削除APIの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「5.20.4 ダッシュボード定義の削除」を参照してください。

(b)　ユースケース

■構築時のダッシュボード定義の移行

• 開発環境と本番環境で構成（ホスト名を含む）が同じであるため，SIDの編集を行わずに移行する

  ユーザーのシステムが次のどちらかに該当する場合，開発環境のダッシュボード定義を編集せずに本番環境へ移行します。

  • 開発環境と本番環境で構成（ホスト名を含む）とツリーSIDが同一である

  • 移行するダッシュボード定義にツリーSIDが設定されていない

  次の手順でダッシュボード定義を移行できます。

  1. ダッシュボード定義の取得APIを実行して，開発環境のダッシュボード定義（JSON形式のデータ）を取得します。

  2. 取得したダッシュボード定義をパラメーターに指定して，ダッシュボード定義の追加APIで本番環境にダッシュボード定義を追加します。

• 開発環境と本番環境でシステムのホスト名が異なるため，SIDの編集を行って移行する

  移行するダッシュボード定義にツリーSIDが設定されていて，移行前後の環境でSIDが異なっている場合，開発環境のダッシュボード定義のツリーSIDを編集したあとで本番環境に移行します。

  次の手順でダッシュボード定義を移行できます。

  1. ダッシュボード定義の取得APIで開発環境のダッシュボード定義（JSON形式のデータ）を取得します。

  2. 取得したダッシュボード定義のツリーSIDを，テキストエディターなどで，本番環境に合わせて編集します。

  3. 編集したダッシュボード定義をパラメーターに指定して，ダッシュボード定義の追加APIで本番環境にダッシュボード定義を追加します。

■JP1/IM運用中のダッシュボード定義の更新

JP1/IMの運用中にダッシュボード定義の追加や編集を行うとき，本番環境を壊さないために，開発環境でテストして問題ないことを確認してから本番環境に移行する運用をしている場合，ダッシュボード定義の取得，追加，削除のAPIだけで，ダッシュボード定義を更新します。ここでは，開発環境と本番環境で，すでに同じ設定のダッシュボードが定義されているものとします。

次の手順でダッシュボード定義を更新できます。

1. 開発環境でダッシュボード定義を編集し，更新後のダッシュボード定義としてダッシュボード定義の取得APIで取得します。

2. 取得したダッシュボード定義をパラメーターに指定して，ダッシュボード定義の追加APIで本番環境にダッシュボード定義を追加します。

3. 統合オペレーション・ビューアー（GUI）またはダッシュボード定義の一覧取得APIで，本番環境に更新後のダッシュボード定義が正しく追加できたことを確認します。

4. 統合オペレーション・ビューアー（GUI）またはダッシュボード定義の削除APIで，本番環境に残っている更新前のダッシュボード定義のIDを指定して削除することで，ダッシュボード定義を更新できます。

   ダッシュボードがIM管理ノードのツリーSIDに紐づいている場合，古いダッシュボード定義を削除することで，［ダッシュボード］タブに新しいダッシュボード定義が表示されるようになります。

   なお，すでに存在するダッシュボード定義を直接上書きすることはできません。

(a)　概要

管理者用のダッシュボード取得／一覧取得／削除機能^※が有効の場合，JP1資源グループが「*」，かつ，JP1_Console_Admin権限を持つJP1ユーザーでログインしているときは，統合オペレーション・ビューアーまたはREST APIから，すべてのJP1ユーザーのダッシュボード定義の取得，一覧表示（一覧取得），および削除が行えます。なお，ログインしているJP1ユーザー以外のほかのJP1ユーザーが所有するダッシュボード定義を編集したり，公開範囲を変更したりすることはできません。

注※

JP1/IM - Managerを13-11より前のバージョンから13-11以降にバージョンアップした環境で，管理者用のダッシュボード取得／一覧取得／削除機能を使用する場合，管理者用のダッシュボード取得／一覧取得／削除機能を使用するための設定が必要です。

詳細については，マニュアル「JP1/Integrated Management 3 - Manager 画面リファレンス」の「2.4.1(1)(b)［ダッシュボード一覧］ダイアログ」，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「5.24.2 ダッシュボード定義の一覧取得」および「5.20.4 ダッシュボード定義の削除」を参照してください。

また，管理者用のダッシュボード取得／一覧取得／削除機能の有効／無効は，インテリジェント統合管理基盤定義ファイル（imdd.properties）のjp1.imdd.http.adminAllowUserDashboardプロパティ^※で設定します。

注※

JP1/IM - Managerを13-11より前のバージョンから13-11以降にバージョンアップした場合，インテリジェント統合管理基盤定義ファイル（imdd.propertiesファイル）にjp1.imdd.http.adminAllowUserDashboardプロパティが追加されません。この場合，インテリジェント統合管理基盤定義ファイルのモデルファイルから手動でjp1.imdd.http.adminAllowUserDashboardプロパティをコピーしてください。

インテリジェント統合管理基盤定義ファイルの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「インテリジェント統合管理基盤定義ファイル（imdd.properties）」（2. 定義ファイル）を参照してください。

(b)　ユースケース

■ダッシュボード定義単体のバックアップとリカバリー

ダッシュボードを編集するときに誤って削除してしまったなどで，ダッシュボード定義の復旧を行う必要がある場合，運用を止めずに，ダッシュボード定義の取得APIと追加APIで，ダッシュボード定義だけのバックアップとリカバリーを行います。

ここでは，バックアップ時とリカバリー時のIM管理ノードの構成は同じであるとします。

次の手順でダッシュボード定義をバックアップ・リカバリーできます。

1. ダッシュボード定義の取得APIでダッシュボード定義（JSON形式のデータ）のバックアップを取得します。

2. ダッシュボード定義の追加APIでバックアップのダッシュボード定義を追加してリカバリーします。

複数のダッシュボード定義をバックアップ・リカバリーする場合，ダッシュボード定義の一覧取得APIで取得したダッシュボードのIDに対して，一括でダッシュボード定義の取得APIおよび追加APIを実行できるバッチを作成して実行します。

■削除されたJP1ユーザーのダッシュボードの削除

管理者用のダッシュボード取得／一覧取得／削除機能を有効にして，JP1資源グループが「*」，かつ，JP1_Console_Admin権限を持つJP1ユーザーで，削除されたJP1ユーザーが所有するダッシュボード定義を削除します。

次の手順で削除されたダッシュボードを削除できます。

1. JP1資源グループが「*」，かつ，JP1_Console_Admin権限を持つJP1ユーザーで，統合オペレーション・ビューアー（GUI）にログインします。

2. ダッシュボード一覧（削除済みのJP1ユーザーを含むすべてのJP1ユーザーのダッシュボード一覧を表示できます）で，削除済みのJP1ユーザーが所有するダッシュボードを選択し，［削除］ボタンをクリックして削除します。

ほかのJP1ユーザーが所有するダッシュボード定義も削除できます。それ以外の権限のJP1ユーザーでログインしているとき，または，管理者用のダッシュボード取得／一覧取得／削除機能が無効の場合は，ログインしたJP1ユーザーが所有するダッシュボード定義だけを削除できます。