データエンリチャーのインストール (クラシック)

概要

コレクターがNexthink Cloudインスタンスに送信する情報を補完するために、データエンリッチャーをWindows Serverにインストールします（リリースノートでの互換バージョンおよび適切なハードウェア要件を参照）。このサーバーは、企業内のActive DirectoryおよびDNSサーバーの両方、そしてNexthink Cloudインスタンスへのアクセスが必要です。

以下のドキュメントは、データエンリッチャー V1.2.0に適用されます。

データエンリッチャーの専用ADアカウントを作成

新しいADアカウントを作成するには:

1. 管理者権限を持つユーザーとして選択したWindows Serverにログインします。

2. Microsoft管理コンソールからActive Directoryユーザーとコンピュータを起動します。

3. 左側のナビゲーションペインでドメインツリーを展開し、管理サービスアカウントを右クリックして新しいユーザーを選択します。

   1. ユーザーの名前、姓、およびユーザーログオン名を入力します。

   2. 次へをクリックします。

   3. パスワードを入力し、パスワード確認で再入力します。

   4. 次へをクリックします。

4. 終了をクリックします。

データエンリッチャーがWindowsサービスとして動作するため、アカウントのポリシーをサービスとしてログオンするように設定してください:

1. 管理ツールから、ローカルセキュリティポリシーを開きます。

2. ローカルポリシーを展開し、ユーザー権利割当をクリックします。

3. 右側のペインで、サービスとしてログオンを右クリックします。

4. メニューからプロパティを選択します。

5. 新しいユーザーを追加するためにユーザーまたはグループの追加... ボタンをクリックします。

   1. ユーザーまたはグループの選択ダイアログで、先ほど作成した専用ADアカウントを選択します。

   2. OKをクリックします。

6. サービスとしてログオンのプロパティダイアログでOKをクリックして変更を保存します。

データエンリッチャーをインストール

データエンリッチャーの新規インストール手順です。 現在旧バージョンのデータエンリッチャーを実行している場合は、次のセクションでアップグレードの手順を参照してください。

1. 管理者権限を持つユーザーとしてWindows Serverにログインします。

2. 製品ダウンロードからデータエンリッチャーのインストーラーをダウンロードします（このページの右上隅のリンクを確認してください）。

3. インストーラーファイルをダブルクリックして実行します。

   • ユーザーアカウント制御ダイアログがデバイスに変更を許可するか尋ねる場合、はいをクリックします。

   • Visual C++再配布可能なアップデートのインストールを求めるダイアログが表示された場合、はいをクリックします。

4. サービスアカウントの設定ダイアログで、先ほど作成した専用ADアカウントの資格情報を入力します:

   • ドメイン\ユーザー: ドメインの名前を入力し、バックスラッシュとユーザー名に続けてください。

   • パスワード: 専用ユーザーのパスワードを入力します。

5. 次へをクリックします。

   

   • ユーザー資格情報が無効な場合、エラーメッセージが表示されます。 OKをクリックし、資格情報を修正します。

6. インストールの準備完了ダイアログで、インストールをクリックします。 別のダイアログがインストールの進行状況を示します。

7. 最後のダイアログで、設定完了後にデータエンリッチャーの構成ファイルを編集するために 'config' フォルダーを開く のオプションをオンにします。

8. 終了をクリックします。

データエンリッチャーのアップグレード

既存のデータエンリッチャーのインストールをアップグレードし、初回インストール時に提供された専用アカウントと資格情報を再利用するには:

1. 管理者権限を持つユーザーとしてWindows Serverにログインします。

2. データエンリッチャーサービスを停止します。

   1. Windowsキーを押します。

   2. サービスと入力してサービスアプリを探します。

   3. エンターを押します。

   4. サービスのリストでNexthink Data Enricherエントリを右クリックします。

   5. コンテキストメニューから停止を選択します。

3. 製品ダウンロードからデータエンリッチャーのインストーラーをダウンロードします（このページの右上隅のリンクを確認してください）。

4. インストーラーファイルをダブルクリックして実行します。

   • ユーザーアカウント制御ダイアログがデバイスに変更を許可するか尋ねる場合、はいをクリックします。

   • Visual C++再配布可能なアップデートのインストールを求めるダイアログが表示された場合、はいをクリックします。

   • 同じまたはそれ以降のバージョンのデータエンリッチャーが既にインストールされている場合、アップグレードプロセスが中断されます。

   • 前述のようにデータエンリッチャーサービスの停止に失敗した場合、アップグレードプロセスが中断されます。

5. データエンリッチャーの現在のバージョンとアップグレードバージョンの両方が表示され、アップグレードの確認を求めるダイアログで、はいをクリックします。

6. インストールの準備完了ダイアログで、インストールをクリックします。 別のダイアログがインストールの進行状況を示します。

7. 最後のダイアログで、設定完了後にデータエンリッチャーの構成ファイルを編集するために 'config' フォルダーを開く のオプションをオンにします。

8. 終了をクリックします。 以前の構成ファイルのバックアップはnxdataenricher_bak_<yyyyMMdd_hhmmss>として保存されます。

構成ファイルの編集

データエンリッチャーのセットアップを完了するには、その関連する構成ファイル内のパラメータに適切な値を提供します。 構成ファイルは次の場所にあります：

C:\ProgramData\Nexthink\nxdataenricher\

太字の項目のすべてのパラメータについて、値を入力する必要があります。 リスト内の他の項目はデフォルトのままにしても問題ありません。

全般の構成

general.confの一般構成ファイルは、データエンリッチャーのログファイルの形式と場所、およびNexthink Cloudへの接続パラメータを設定します。 したがって、2つのセクションに分かれています：

GENERAL このセクションは、ログのメカニズムに関するパラメータを保持しています。

• log_file: ログファイルのフルパス。 パスの区切り文字としてスラッシュを使用し、次のデフォルト値を使用します： /ProgramData/Nexthink/nxdataenricher/log/nxdataenricher.log。

• log_level: ロガーの詳細度。 デフォルトは INFO です。

• log_format: ロガーによって表示される文字列のフォーマット。

NEXTHINKCLOUD このセクションでは、Nexthink Cloudへの接続方法の詳細を示します。

• endpoint: Nexthink CloudのエンリッチメントAPIへのゲートウェイのアドレス：

https://agora.<region>.nexthink.cloud``https://agora.<region>.nexthink.cloud

<region>は、オンボーディング時に組織に割り当てられたNexthink Cloudプラットフォームの地域と一致する必要があります。

現在、エンリッチメントAPIは以下の地域で利用可能です：

eu

meta

pac

us

• oauth_client_id: 組織のクライアント識別子。 Nexthinkサポートに連絡して、この情報をリクエストしてください。 データエンリッチャーは、以下のクライアントシークレットと組み合わせてクライアントIDを使用し、Nexthink Cloudからアクセストークンを取得します。 データエンリッチャーの起動時に暗号化。

• oauth_client_secret: 組織のクライアントシークレット。 Nexthinkサポートに連絡して、この情報をリクエストしてください。 データエンリッチャーの起動時に暗号化。

• proxy_enabled: Nexthink Cloudに接続する際にプロキシを使用するか否か。 デフォルトは False です。

• proxy_server: 使用中のプロキシのURL。 スキーマ、ホスト、およびポートを記載。 例: https://proxy.example.org:8301

• proxy_auth_type: 必要な認証の種類。 サポートされる値は以下の通りです：

  • Basic はHTTP基本認証用

  • None（デフォルト）は認証なしにプロキシに接続します。

• proxy_user: プロキシ認証のユーザー名。 認証が必要ない場合は空白にしてください。

• proxy_password: プロキシ認証用のパスワード。 認証が必要ない場合は空白にしてください。 データエンリッチャーの起動時に暗号化。

• verify_cert: データエンリッチャーがNexthink Cloudに接続する際に証明書を検証するか否か。 デフォルトは True です。

• update_batch_size: Nexthink Cloudに処理を依頼する最大バッチ数です。 デフォルトは 10000。

ADの構成

AD構成ファイルenricher_nxad.confには、Active DirectoryサーバーとのデータエンリッチャーのLDAP接続の詳細が含まれています。

• excluded_attributes: データエンリッチャーが取得しないAD属性のカンマ区切りの値リスト。

• search_batch_size: AD内の情報を検索するバッチあたりのエントリーの数です。

データエンリッチャーが照会する必要がある各ADサーバーに対して、次のパラメーターを繰り返して指定します。 複数のADサーバーを指定した場合、データエンリッチャーは最初に有効な応答を返したサーバーからユーザーに関する情報を取得します。 それぞれのサーバーを識別するために、文字 X を数字に置き換えます：

• server_adX.name: サーバーの名前。

• server_adX.address: ADサーバーのIPまたはFQDN。

• server_adX.port: 通信に使用されるポート。

• server_adX.use_ssl: SSLを使用するかどうか。

• server_adX.bind_dn: ユーザーの識別名。

• server_adX.password: サーバーに接続するためのパスワード。 データエンリッチャーの起動時に暗号化。

• server_adX.base_dn: ADツリーを検索する開始点。 組織単位でなければなりません。

• server_adX.scope: 検索範囲。 可能な値は3つあります

  • base: ベースDNのエントリーのみ検索。

  • onelevel: ベースDNの下の1レベルのエントリーを検索。ただし、ベースDNやその下位レベルのノードは含まない。

  • サブツリー: ベースDNおよびその下のすべてのレベルのエントリーを検索。

DNSの構成

DNS構成ファイルenricher_nxdns.conf は、データエンリッチャーが宛先のFQDNを取得するために逆引きDNSルックアップを発行するDNSサーバーのリストを保持します。 複数のDNSサーバーを指定した場合、データエンリッチャーは宛先のIPアドレスを正常に解決する最初のサーバーから宛先のFQDNを取得します。 現在、データエンリッチャーはIPv4アドレスのみを解決し、IPアドレスあたり1つのFQDNのみを取得します（アドレスごとの複数のドメイン名はサポートされていません）。

• サーバー: DNSサーバーのカンマ区切りの値リスト。

• max_dns_server_timeout: サーバーからの応答を待つ最大時間（秒）。 デフォルトは0.5（0.5秒）。

• max_perc_dns_server_errors: 現在の検索からDNSサーバーを除外する前に、解決する宛先の総数に対して許容されるエラーの最大パーセンテージ。 デフォルトは35（35％を表します）。

共通の構成パラメータ

それぞれのサービスの構成ファイルには、データエンリッチャーが取得した情報を部分的または完全にリフレッシュする方法を示すパラメータのセットが含まれています。

• partial_refresh_enabled: 真または偽。サービスが既に更新されたものに関して情報が欠落しているオブジェクトだけを処理するかどうかを示します。 Nexthinkに新たに追加されたオブジェクト（したがってAD/DNS情報を欠く）だけが処理されます。 デフォルトでは真です。

• partial_refresh_frequency: 部分的な更新の頻度（分）です。 60分未満の値に設定することは推奨されません。 デフォルトでは60です。

• full_refresh_enabled: 真または偽。サービスが全ての可能なデータを処理するかどうかを示します。 完全な更新時には、Nexthinkで関心のある全てのオブジェクトが処理されます（ただし、Nexthinkと異なる情報を持っているもののみ更新されます）。 デフォルトでは偽。この更新は時間やパフォーマンスの面でより負担が大きいためです。 必要に応じてのみアクティベートしてください。

• full_refresh_time: 完全な更新は、Nexthinkと関心のあるサーバー（ADまたはDNS）の両方にとってより負担となる可能性があります。 したがって、この更新を実行できるのは、毎日または毎週のみです。 さらに、この種の更新は、_データ収集_前や_エンジンクリーンアップとメンテナンス_ナイトリータスクの後に実行することが推奨されます。

  • 毎週の更新を設定するには、_Day HH:MM_形式で曜日と時間を指定してください。 曜日の可能な値は以下です：Mon, Tue, Wed, Thu, Fri, Sat, and Sun (大文字小文字を区別しません)。 デフォルトは_Mon 23:30_です。

  • 毎日の更新を設定するには、_HH:MM_形式で時間だけを指定し、曜日を省略してください。

データエンリッチャサービスの設定と起動

設定が完了したら、データエンリッチャサービスを開始します。

1. WinKeyを押します。

2. サービスと入力して、Enterを押してサービスアプリを開きます。

3. サービスNexthink Data Enricherを右クリックします。

4. コンテキストメニューからプロパティを選択します。

5. オプション: ログタブで、事前に作成された専用ADアカウントがあることを確認します。

6. オプション: 回復タブで、サービス障害時にWindowsがどのように反応するかを指定します。

7. 一般タブで、サービスを開始するために開始ボタンをクリックします。

   
8. オプション: 一般タブで、スタートアップの種類を自動に設定してコンピュータの起動時にサービスを自動的に開始します。

データエンリッチャの複数インスタンスを同時に実行しないでください。

機密データの暗号化

サービスを開始すると、設定ファイルが機密データを保護するために変更されます。 次のパラメータはWindowsデータ保護を使用して暗号化されます。

一般設定ファイルでは：

• oauth_client_id

• oauth_client_secret

• proxy_password

AD設定ファイルでは：

• server_adX.bind_password

ファイルサンプル

一般設定ファイル

データエンリッチャ用のサンプル一般設定ファイル general.conf

[GENERAL]
# ログファイルのパスと名前。
# デフォルト: /ProgramData/Nexthink/nxdataenricher/log/nxdataenricher.log
log_file = /ProgramData/Nexthink/nxdataenricher/log/nxdataenricher.log

# 希望するログレベルを設定します。生産環境では"info"値を設定することが強く推奨されます。
# 利用可能なオプション：
# - CRITICAL
# - ERROR
# - WARNING
# - INFO
# - DEBUG
# ログレベルに関する詳細情報はhttps://docs.python.org/3.7/library/logging.html#levels
# デフォルト: INFO
log_level = INFO

# ログフォーマットを設定します。
# デフォルト: %(asctime)s %(process)s %(levelname)s %(filename)s:%(lineno)d [-] %(message)s
log_format = %(asctime)s %(process)s %(levelname)s %(filename)s:%(lineno)d [-] %(message)s

[NEXTHINKCLOUD]
# 詳細情報を取得するにはhttps://doc.nexthink.com/Documentation/Nexthink/latest/InstallationAndConfiguration/InstallingtheDataEnricher<br>をご参照ください。
# データエンリッチャインストールプロセスに関する情報は、特にこのファイルについての情報も含めて参照できます。

# Nexthinkにデータを送信し、また受信するためのNexthink Cloudエンドポイント。
# 例: endpoint = https://agora.[region].nexthink.cloud
endpoint = https://<host>

# クライアントIDは、クライアントシークレットと共にトークンを取得するために使用されます。
oauth_client_id = <oauth_client_id>

# クライアントシークレットは、クライアントIDと共にトークンを取得するために使用されます。
oauth_client_secret = <oauth_client_secret>

# プロキシ設定。
proxy_enabled = False

# 例: proxy_server = http://proxy.nexthink.com:3128
proxy_server = <schema>://<host>:<port>

# サポートされているのは基本認証または認証なしのみ。利用可能なオプション：
# - None
# - Basic
proxy_auth_type = None

proxy_user =
proxy_password =

# Nexthink Cloudで自己署名証明書を確認するためにサービスを許可します。
# Falseの場合、自己署名証明書または不正な証明書は確認されません。
# Trueの場合、自己署名証明書または不正な証明書は確認されます。
# デフォルト: True
verify_cert = True

# 一つのリクエストでNexthinkに更新される最大数のエントリーです。
update_batch_size = 10000

AD設定ファイル

データエンリッチャ用のサンプル設定ファイル enricher_nxad.conf

[NXAD]
partial_refresh_enabled = True
partial_refresh_frequency = 60

# 完全な更新機能を有効化/無効化します。
# 有効にすると、full_refresh_timeパラメーターで設定された時間にエンジンユーザー情報全てを更新します。
# 注意！これは非常に高負荷のジョブとなる可能性があるため、実行時間を適切に設定してください。
full_refresh_enabled = False

# デイリーまたはウィークリーで更新を設定することができます。
# デイリーの完全更新の場合は、例として24時間形式で地元の時刻のみを入力します。23:30。
# ウィークリーの完全更新の場合は、例として指定された曜日に加えて時間を追加します。例えば: Sat 23:30。
# 利用可能な値は以下です：Mon, Tue, Wed, Thu, Fri, Sat and Sun。
# 例：
# 日次の完全更新午前3:17
# full_refresh_time = 3:17
# 毎週金曜日午後4:55の完全更新
# full_refresh_time = Fri 16:55
full_refresh_time = Mon 23:30

# 除外するActiveDirectory属性をコンマで区切ったリスト。
# 利用可能なオプション（対応するNexthink Finderの名称を括弧内に記載）：
# - distinguishedName (Distinguished name)
# - sAMAccountName (Name)
# - title (Job title)
# - department (Department)
# - displayName (Full name)
# - l (Locality name)
# - c (Country code)
# - ou (Organizational unit name)
# - physicalDeliveryOfficeName (Location)
# 例: excluded_attributes = title, department
excluded_attributes =

# ADでの検索バッチのサイズ。
search_batch_size = 1000

# サーバー構成:
# フォーマット“server_<x>.<property> = <value>”を使用。<x> を番号に置き換え、<property> にその名前を置き、<value> に希望するものを置きます。以下の例のように必要なだけサーバーを構成できます。
#
# server_1.name: string (サーバーの汎用名。例: "nexthink.ch"。Finderではユーザー名が[email protected]のように表示されます。)
# server_1.address: string (サーバーのIPv4またはFQDNアドレス)
# server_1.port: int (サーバーポート。通常389が使用されます)
# server_1.bind_dn: string (バインドDNアカウント。例: "CN=user,CN=users,DC=company,DC=local")
# server_1.bind_password: string (バインドDNアカウントパスワード)
# server_1.base_dn: string (ディレクトリ検索の開始点。例: "DC=company,DC=local")
# server_1.scope: string (次のいずれかの値: base, onelevel, subtree)

server_ad1.name = <name>
server_ad1.address = <ip_or_fqdn>
server_ad1.port = <port>
server_ad1.use_ssl = <True/False>
server_ad1.bind_dn = <CN=user,CN=Users,DC=company,DC=local>
server_ad1.bind_password = <pass>
server_ad1.base_dn = <DC=company,DC=local>
server_ad1.scope = <base/onelevel/subtree>

DNS設定ファイル

データエンリッチャ用のサンプル設定ファイル enricher_nxad.conf

[NXDNS]
partial_refresh_enabled = True
partial_refresh_frequency = 60

# 完全な更新機能を有効化/無効化します。
# 有効にすると、full_refresh_timeパラメーターで設定された時間に検索エンジンの全ての宛先情報を更新します。
# 注意！これは非常に高負荷のジョブとなる可能性があるため、実行時間を適切に設定してください。
full_refresh_enabled = False

# デイリーまたはウィークリーで更新を設定することができます。
# デイリーの完全更新の場合は、例として24時間形式で地元の時刻のみを入力します。23:30。
# ウィークリーの完全更新の場合は、例として指定された曜日に加えて時間を追加します。例えば: Sat 23:30。
# 利用可能な値は以下です：Mon, Tue, Wed, Thu, Fri, Sat, Sun。
# 例：
# 日次の完全更新午前3:17
# full_refresh_time = 3:17
# 毎週金曜日午後4:55の完全更新
# full_refresh_time = Fri 16:55
full_refresh_time = Mon 23:30

# DNSサーバーのカンマ区切りリスト。
# 例: servers = 8.8.8.8, 8.8.4.4
servers = <server1>,<server2>

# 各DNSサーバーのタイムアウト(秒)
max_dns_server_timeout = 0.5

# 総宛先数に対する許容DNSサーバーエラーの割合
max_perc_dns_server_errors = 35