Installing Data Enricher (classic)

概要

CollectorがNexthink Cloudインスタンスに送信する情報を補完するために、データエンリッチャーをWindowsサーバーにインストールします（リリースノートの対応バージョンおよび適切なハードウェア要件を参照）。データエンリッチャーは、企業ネットワーク内のActive DirectoryとDNSサーバーの両方、およびNexthink Cloudインスタンスにアクセス可能である必要があります。

次のドキュメントはData Enricher V1.2.0に適用されます。

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

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

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

2. Microsoft管理コンソールからActive Directory Users and Computersを起動します。

3. 左側のナビゲーションペインで、ドメインツリーを展開し、Managed Service Accountsを右クリックして新しいユーザーを選択します。

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

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

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

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

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

データエンリッチャーはWindowsサービスとして動作するため、アカウントのポリシーをサービスとしてログオンできるように設定します：

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

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

3. 右側のペインで、Log on as a serviceを右クリックします。

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

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

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

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

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

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

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

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

2. 製品ダウンロードからデータエンリッチャーインストーラーをダウンロードします（このページの右上にあるリンクをたどります）。

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

   • ユーザーアカウント制御ダイアログで、アプリがデバイスに変更を加えることを許可するか尋ねられたら、はいをクリックします。

   • Visual C++ 再頒布可能更新プログラムをインストールするか尋ねられた場合、はいをクリックします。

4. サービスアカウント設定ダイアログで、前のセクションで作成した専用ADアカウントの資格情報を入力します：

   • Domain\User: ドメイン名を入力し、続いてバックスラッシュとユーザー名を入力します。

   • パスワード: 指定されたユーザーのパスワードを入力します。

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

   

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

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

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

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

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

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

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

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

   1. Windowsキーを押します。

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

   3. Enterを押します

   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のEnrichment APIへのゲートウェイのアドレス:

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

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

現在、Enrichment APIは、以下の地域で利用可能です：

ヨーロッパ

中東

アジア太平洋

アメリカ

• 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属性のcomma-separated valuesリスト。

• 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サーバーを指定した場合、データエンリッチャーはリスト上の最初のサーバーから宛先のFQDNを取得し、宛先のIPアドレスを正常に解決した場合にのみ使用します。 現在、データエンリッチャーはIPv4アドレスのみ解決し、IPアドレスごとに1つのFQDNのみ取得します（1つのアドレスに対する複数のドメイン名はサポートされていません）。

• サーバー: DNSサーバーのcomma-separated valuesリスト。

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

• max_perc_dns_server_errors: 現在の検索から除外される前に、各DNSサーバーに対して許容されるエラーの最大割合（解決すべき宛先の総数に対する割合）。 デフォルトは35（35%を表す）。

共通の構成パラメータ

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

• partial_refresh_enabled: True または False で、サービスが既に更新されたものに対して情報が不足しているオブジェクトのみを処理するかどうかを示します。 Nexthink に新しく追加されたオブジェクトのみ（AD/DNS 情報が不足しているもの）処理されます。 デフォルトでは True です。

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

• full_refresh_enabled: True または False で、サービスがすべての可能なデータを処理するかどうかを示します。 完全更新の間、Nexthink のすべての対象オブジェクトが処理されます（ただし、Nexthink 内の情報と異なる情報を持つもののみが更新されます）。 デフォルトでは False です。これは時間とパフォーマンスの観点でより負荷が大きいためです。 厳密に必要な場合にのみ有効にしてください。

• full_refresh_time: 完全更新は、Nexthink および関心のあるサーバー（AD または DNS）にとって負荷が大きくなる可能性があります。 そのため、この更新は毎日または毎週しか実行できません。 また、この種の更新は、_データ収集_の前または_Engine のクリーンアップとメンテナンス_の夜間作業の後に実行することをお勧めします。

  • 週次更新を設定するには、フォーマット _Day HH:MM_で曜日と時間を指定してください。 曜日の値には、Mon、Tue、Wed、Thu、Fri、Sat、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 を参照してください。
# 特にこのファイルに関して詳細情報を得ることができます。

# Nexthink Cloud エンドポイントにデータを送信および取得します。
# 例: endpoint = https://agora.[region].nexthink.cloud
endpoint = https://<host>

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

# プロキシの構成。
proxy_enabled = False
# 例: proxy_server = http://proxy.nexthink.com:3128
proxy_server = <schema>://<host>:<port>
# 基本認証または認証なしのみがサポートされています。可能なオプション:
# - なし
# - 基本
proxy_auth_type = なし
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 パラメーターで設定された時刻にすべての Engine ユーザー情報を更新します。
# 注意! これは非常に重い負荷のジョブになる可能性がありますので、実行時間を適切に設定してください。
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

# 除外する ActiveDirectory 属性のコンマ区切りリスト。
# 利用可能なオプション（対応する Nexthink Finder の名前を括弧内に示します）:
# - distinguishedName（Distinguished name）
# - sAMAccountName（名前）
# - title（職務）
# - department（部）
# - displayName（表示名）
# - l（都市名）
# - c（国コード）
# - ou（組織単位名）
# - physicalDeliveryOfficeName（所在地）
# 例: 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 内のユーザー名は [e-mail] と表示されます。）
# 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 パラメーターで設定された時刻にすべての Engine 宛先情報を更新します。
# 注意! これは非常に重い負荷のジョブになる可能性がありますので、実行時間を適切に設定してください。
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