2. OASE管理¶

2.1. はじめに¶

本書では、OASE管理の機能および操作方法について説明します。

2.2. メニュー構成¶

本章では、OASE管理で利用するメニュー構成について説明します。

2.2.1. メニュー/画面一覧¶

OASE管理のメニュー一覧を以下に記述します。

表 2.101 OASE管理メニュー/画面一覧¶
No	メニューグループ	メニュー・画面	説明
1	OASE管理	エージェント	イベント収集対象の情報を管理します。
2	OASE管理	通知テンプレート（共通）	OASEの通知で使用する情報を管理します。

2.3. エージェント概要¶

本章では、エージェント（Exastro OASE Agent）について説明します。

2.3.1. エージェントについて¶

エージェントは、Exastro IT Automation（以下、ITA）とは独立しており、ITA OASEと外部サービスの仲介役として機能します。

エージェントは、対象とする外部サービスのイベント収集設定をITAから取得し、その設定を用いて外部サービスからイベントを取得します。このプロセスを経て、取得したイベントをITAに送信します。

2.4. エージェント利用手順¶

本章では、エージェント（Exastro OASE Agent）の利用手順について説明します。

2.4.1. 作業フロー¶

エージェントを利用するための作業を含めた、OASEの作業フローは以下のとおりです。

エージェント利用のための作業の詳細は次項に記載しています。

作業フロー詳細と参照先
1. イベント収集設定
  
  OASE管理のエージェントメニュー画面から、イベント収集対象サービスに関する設定を登録します。
  
  詳細はエージェントを参照してください。
2. ラベル設定
  
  OASEのラベル作成/ラベル付与メニュー画面から、ラベルを付与するための設定を行います。
  
  詳細はラベル作成およびラベル付与を参照してください。
3. エージェントのインストール・起動
  
  エージェントを起動し、イベント収集を開始します。
  
  詳細はインストールガイド（Docker Compose）を参照してください。
  
  詳細はインストールガイド（Kubernetes）を参照してください。

2.5. 通知テンプレート（共通）概要¶

OASEの通知機能の概要図を以下に示します。

2.6. 通知テンプレート（共通）利用手順¶

OASEの通知機能を利用するために必要な作業フローは以下のとおりです。

各作業の詳細は次項に記載しています。

作業フロー詳細と参照先
1. 通知テンプレート（共通）のメンテナンス（閲覧/更新）
  
  OASE管理の通知テンプレート（共通）メニュー画面から、OASEの通知で使用するテンプレートをメンテナンス（閲覧/更新）できます。
  
  詳細は通知テンプレート（共通）を参照してください。
2. 通知先設定の登録
  
  Exastro システムにオーガナイゼーション管理者でログインし、メニューより通知管理から登録します。
  
  詳細は通知先設定の登録を参照してください。
3. （通知先がメールの方のみ）メール送信サーバの設定
  
  Exastro システムにオーガナイゼーション管理者でログインし、メニューよりメール送信サーバ設定から登録します。
  
  詳細はメール送信サーバの設定を参照してください。

注釈

通知テンプレート（共通）は、変更しなくても利用可能です。

2.7. 機能メニュー操作説明¶

本章では、OASE管理機能のメニュー操作説明について説明します。

2.7.1. メニューについて¶

本節では、OASE管理をインストールした状態で表示されるメニューの操作について記載します。

2.7.2. エージェント¶

OASE管理 ▶ エージェントでは、（エージェントに設定する）イベント収集対象の、接続方式・認証方式・TTL等をメンテナンス（閲覧/登録/更新/廃止）できます。

エージェント※1 画面の入力項目は以下のとおりです。

表 2.102 エージェント画面入力項目一覧¶
項目		説明	入力必須	入力方法	制約事項
イベント収集設定名		任意のイベント収集設定名を入力します。	〇	自動入力	最大長255バイト
接続方式		イベント収集対象への接続方法を選択します。・IMAP パスワード認証	〇	リスト選択	※2
リクエストメソッド		イベント収集対象へのリクエストメソッドを選択します。・IMAP: Plaintext	ー	リスト選択	※2
URL		イベント収集対象の接続先を入力します。・メールサーバの場合はホスト名を入力します。	〇	手動入力	最大長1024バイト
ポート		イベント収集対象のポートを入力します。	ー	手動入力	0～65535
認証情報	プロキシ	イベント収集対象のプロキシURIを入力します。	ー	手動入力	最大長255バイト
	ユーザー名	イベント収集対象へログインするユーザー名を入力します。	ー		最大長255バイト
	パスワード	イベント収集対象へログインするパスワードを入力します。	ー	手動入力	最大長4000バイト
	メールボックス名	イベント収集対象のメールボックス名を入力します。デフォルトでINBOXを参照します。	ー	手動入力	最大長255バイト
TTL		TTL（Time To Live）とは、エージェンが取得したイベントが、ルールの評価対象として扱われる期間（秒）のことです。	ー	手動入力	1～2147483647
備考		自由記述欄です。	ー	手動入力	最大長4000バイト

※1 イベント収集対象への設定です。

※2 接続方式・認証情報・リクエストメソッドについて、必要な組み合わせは以下のとおりです。

接続方式	リクエストメソッド	認証情報
IMAP パスワード認証	・IMAP: Plaintext	・ユーザー名・パスワード

Tip

本バージョン（2.3）で取り扱い可能なメールの文字コードは「UTF-8」のみとなります。

2.7.3. 通知テンプレート（共通）¶

OASE管理 ▶ 通知テンプレート（共通）では、OASEの通知機能で使用するテンプレートをメンテナンス（閲覧/更新）できます。

通知テンプレート（共通）画面の入力項目は以下のとおりです。

項目	説明	入力必須	入力方法	制約事項
テンプレート	通知で使用するテンプレートを編集できます。下記4種類が存在します。・新規.j2 ・既知（判定済み）.j2 ・既知（時間切れ）.j2 ・未知.j2	〇	手動入力	最大長255バイト
備考	自由記述欄です。	ー	手動入力	最大長4000バイト

テンプレートの初期設定値は下記のとおりです。

リスト 2.103 新規.j2¶

 [TITLE]
新規イベントが発生しました。

[BODY]
詳細
　イベント収集設定：{{ labels._exastro_event_collection_settings_id }}
　イベント取得日時：{{ labels._exastro_fetched_time }}
　イベント有効日時：{{ labels._exastro_end_time }}
　イベント種別　　：{{ labels._exastro_type }}

　再評価
　　評価ルール名　　：{{ labels._exastro_rule_name }}
　　利用イベント　　：{{ exastro_events }}

　ラベル：
　  {% for key, value in labels.items() %}
　　・{{ key }}：{{ value }}
　　{% endfor %}

リスト 2.104 既知（判定済）.j2¶

[TITLE]
既知（判定済）イベントが発生しました。

[BODY]
詳細
　イベント収集設定：{{ labels._exastro_event_collection_settings_id }}
　イベント取得日時：{{ labels._exastro_fetched_time }}
　イベント有効日時：{{ labels._exastro_end_time }}
　イベント種別　　：{{ labels._exastro_type }}

　再評価
　　評価ルール名　　：{{ labels._exastro_rule_name }}
　　利用イベント　　：{{ exastro_events }}

　ラベル：
　  {% for key, value in labels.items() %}
　　・{{ key }}：{{ value }}
　　{% endfor %}

リスト 2.105 既知（時間切れ）.j2¶

[TITLE]
既知（時間切れ）イベントが発生しました。

[BODY]
詳細
　イベント収集設定：{{ labels._exastro_event_collection_settings_id }}
　イベント取得日時：{{ labels._exastro_fetched_time }}
　イベント有効日時：{{ labels._exastro_end_time }}
　イベント種別　　：{{ labels._exastro_type }}

　再評価
　　評価ルール名　　：{{ labels._exastro_rule_name }}
　　利用イベント　　：{{ exastro_events }}

　ラベル：
　  {% for key, value in labels.items() %}
　　・{{ key }}：{{ value }}
　　{% endfor %}

リスト 2.106 未知.j2¶

[TITLE]
未知イベントが発生しました。

[BODY]
詳細
　イベント収集設定：{{ labels._exastro_event_collection_settings_id }}
　イベント取得日時：{{ labels._exastro_fetched_time }}
　イベント有効日時：{{ labels._exastro_end_time }}
　イベント種別　　：{{ labels._exastro_type }}

　再評価
　　評価ルール名　　：{{ labels._exastro_rule_name }}
　　利用イベント　　：{{ exastro_events }}

　ラベル：
　  {% for key, value in labels.items() %}
　　・{{ key }}：{{ value }}
　　{% endfor %}

2.8. 付録¶

2.8.1. OASE Agentの処理フローと.envの設定値¶

本項では、以下について示します。
- OASE Agentの処理フロー
- OASE Agentのインストール時、.envに設定した、一部の設定値について

OASE Agent フロー図 — 図 2.71 OASE Agent処理フロー図¶

パラメータ	説明
AGENT_NAME	起動する OASEエージェントの名前および、内部データベースのファイル名として使用されます。
EXASTRO_URL	ITAに対してAPIリクエストをする際に、リクエスト先として使用されます。
EXASTRO_ORGANIZATION_ID	ITAに対してAPIリクエストをする際に、Organizationを識別するために使用されます。
EXASTRO_WORKSPACE_ID	ITAに対してAPIリクエストをする際に、ワークスペースを識別するために使用されます。 EXASTRO_ORGANIZATION_IDで設定したオーガナイゼーションと紐づいたワークスペースである必要があります。
EXASTRO_USERNAME	ITAに対してAPIリクエストをする際に、Basic認証のユーザー名として使用されます。
EXASTRO_PASSWORD	ITAに対してAPIリクエストをする際に、Basic認証のパスワードとして使用されます。
EVENT_COLLECTION_SETTINGS_NAMES	このパラメータで設定されている値から、イベント収集設定をITAから取得し、設定ファイルを生成します。
ITERATION	上記フロー図にて緑色の矢印で示されているループ処理を、このパラメータで設定している数だけ行います。
EXECUTE_INTERVAL	上記フロー図にて緑色の矢印で示されているループ処理の実行間隔です。

2.8.2. イベント収集設定の即時反映について¶

本項では、イベント収集設定を変更した際に、OASE Agentに即時反映させる方法について説明します。

OASE Agentのbashシェルを開始します。

docker exec -it <OASE Agentのコンテナ名> bash

/tmp内の設定ファイル「event_collection_settings.json」を削除します。
```
rm /tmp/event_collection_settings.json
```

Tip

OASE Agentでは、設定ファイル「event_collection_settings.json」が存在しない場合、ITAからイベント収集設定を取得し、設定ファイルを作成します。
設定ファイルを削除することで最新の設定を反映させることができます。
※この操作を行わない場合、前項 で示した「ITERATION」の数だけループする処理が終了するまで、変更後の設定が反映されません。

↑ Page Top