メインコンテンツへスキップ

WindowsでのLink Agentの使用

Eva Ferreira
  • 更新

Windowsインストーラーのlink-agent.msiは、mabl Link Agentを、再起動のたびに誰もサインインしていなくても自動的に開始されるWindowsサービスとしてインストールします。インストーラーには独自のJavaランタイムが含まれており、インストール中にトンネルとプロキシの設定を尋ねます。この記事では、WindowsにLink Agentをインストールする方法、後から設定を変更する方法、ダイアログなしでインストールする方法、および以前のインストールから移行する方法について説明します。

開始する前に

  • "Link Agent" のAPIキー。APIキーは、ワークスペースの所有者がmablアプリのSettings > APIsで作成します。
  • マシンの管理者権限。
  • 64ビット (x86-64) 版のWindows。システムとネットワークの要件の詳細については、Link Agentの要件を参照してください。

ステップ1: インストーラーのダウンロード

mablアプリのネットワークページ (ワークスペース > ネットワーク) からWindowsインストーラーをダウンロードします。

ステップ2: インストーラーの実行

link-agent.msiを実行し、ダイアログに従います。

  1. Application folder: プログラムファイルのインストール先を選択します。デフォルトはC:\Program Files\mabl\Link Agentです。
  2. Configuration and data folder: エージェントが設定、ログ、アップデートを保存する場所を選択します。デフォルトはC:\ProgramData\mabl\link-agentです。空き容量に余裕があり、パスにスペースを含まない場所を選択してください。
  3. Tunnels: エージェントがサービスを提供するトンネルごとに、トンネル名とAPIキーを入力します。行を追加するには、Add another tunnelをクリックします。トンネル名は、英小文字、数字、ハイフンから成る24文字以内の名前です。
  4. Proxy: エージェントがインターネットに到達する方法を選択します。
    • Automatic: Windows自体が使用するプロキシ設定に従います。PACスクリプトが設定されている場合は、それも含まれます。
    • Manual: プロキシのアドレスとポート、プロキシを経由するトラフィック、必要に応じてクレデンシャル、および直接接続する宛先を入力します。
    • PAC: プロキシ自動設定スクリプトのURLを入力します。
    • None: 常に直接接続します。マシンにプロキシが設定されていて、エージェントにはそのプロキシを使用させない場合に選択します。
    • Do not change the proxy configuration: 設定ファイルの現在の内容をそのまま残します。
  5. Starting the agent: インストーラーの完了時にエージェントを開始するには、Start the mabl Link Agent service nowを選択したままにします。このダイアログには、設定ファイルとログファイルの場所も表示されます。

トンネル名とAPIキーをまだ用意していない場合は、Skip guided configurationを選択します。トンネルがないとエージェントは起動できないため、後から設定ファイルにトンネルを追加するか、インストーラーをもう一度実行してトンネルを入力してください。

プロキシの選択肢の詳細については、mabl Linkトラフィックのフォワードプロキシを参照してください。

サービスが開始されたら、mablアプリのネットワークページ (ワークスペース > ネットワーク) に移動します。開始から1～2分以内に、Link Agentが [リンクエージェント] テーブルに [接続済み] のステータスで表示されます。

ステータスが接続済みのLink Agent

エージェントが表示されない場合は、mabl Linkの問題のトラブルシューティングを参照してください。

エージェントのファイルの保存場所

デフォルトのフォルダーを使用した場合、エージェントは次の場所を使用します。

項目 場所
設定ファイル C:\ProgramData\mabl\link-agent\config\config.yaml
ログ C:\ProgramData\mabl\link-agent\logs
Windowsサービス mabl Link Agent

エクスプローラーでは、C:\ProgramDataはデフォルトで非表示になっています。開くには、パスをアドレスバーに貼り付けてください。

設定の変更

Link Agentは設定ファイルを監視し、実行中に変更を適用するため、ファイルを編集した後にサービスを再起動する必要はありません。この方法で、トンネルの追加や削除、プロキシ設定の変更、接続フィルターの追加を行えます。

トンネルとプロキシの設定をもう一度入力するには、インストーラーを再度実行します。エージェントがすでにインストールされているマシンでは、次の選択肢が表示されます。

  • Install this version: インストール済みのバージョンを、このインストーラーのバージョンに置き換えます。
  • Change configuration: Tunnels and API keys、Proxy configuration、またはその両方を選択し、初回インストール時と同じ質問に回答します。設定ファイルのその他の内容は保持されますが、コメントは保持されません。
  • Open configuration folderとOpen log folder
  • Uninstall: サービスを削除します。設定とログはそのまま残ります。

アップデート

インストールされたエージェントは、自動的に最新の状態に保たれます。各アップデートは実行中のバージョンの隣にインストールされ、エージェントは新しいバージョンで再起動します。以前のバージョンは保持されるため、ロールバックできます。Link Agentのメンテナンスとアップデートを参照してください。

ダイアログなしでのインストール

スクリプトによるインストールや、Microsoft Intuneなどのデバイス管理ツールでのインストールのために、インストーラーが尋ねるすべての回答をコマンドラインで指定することもできます。管理者として開いたコマンドプロンプトからmsiexecを実行します。

msiexec /i link-agent.msi /qn TUNNELNAME1={tunnel-name} APIKEY1={api-key} PROXYCHOICE=auto STARTSERVICE=1
プロパティ 値
TUNNELNAME1 / APIKEY1 … TUNNELNAME10 / APIKEY10 トンネル名とそのAPIキー。最大10個のトンネルを指定できます
TUNNELS 番号付きのペアの代わりに、セミコロンで区切った{name}={api-key}のペアとして、任意の数のトンネルを指定します
PROXYCHOICE auto、manual、pac、none、またはkeep (デフォルト。プロキシ設定を変更しません)
PROXYMODE PROXYCHOICE=manualの場合: mabl (デフォルト)、all、またはupstream
PROXYHOST、PROXYPORT PROXYCHOICE=manualの場合: プロキシのアドレスとポート
PACURL PROXYCHOICE=pacの場合: PACスクリプトのURL
PROXYUSER、PROXYPASSWORD プロキシに認証が必要な場合のクレデンシャル
PROXYEXCLUSIONS PROXYCHOICE=manualの場合: 直接接続する宛先のコンマ区切りリスト
STARTSERVICE インストールの完了時にサービスを開始するには1
INSTALLFOLDER アプリケーションフォルダー
DATAFOLDER 設定とデータのフォルダー。スペースを含めることはできません。

サイレントインストールでは、STARTSERVICE=1を指定しない限りサービスは開始されません。

コマンドライン上のシークレット

msiexecの実行中、マシン上の他のユーザーやプロセスからそのコマンドラインが見える状態になります。これには、コマンドラインに含まれるAPIキーやプロキシのパスワードも含まれます。インストーラーは、これらの値を自身のログには記録しません。この露出が懸念される場合は、トンネルなしでインストールし、その後設定ファイルにトンネルを追加してmabl Link Agentサービスを開始してください。

以前のインストールからの移行

Windowsインストーラーが提供される前は、Link Agentはzipアーカイブから、コマンドプロンプトで実行するか、NSSMなどのツールで設定したサービスとして実行していました。これらのインストールはいずれもインストーラーに置き換えることができ、既存の設定を引き続き使用できます。

ステップ1: 古いエージェントの停止

新しいエージェントと並行して実行されないように、古いエージェントを停止します。

  • コマンドプロンプトから実行している場合: Ctrl-Cを押すか、コマンドプロンプトを閉じます。
  • NSSMサービスとして実行している場合: NSSMサービスの削除の説明に従って、サービスを停止して削除します。
  • スケジュールされたタスクなど、その他の方法で実行している場合: エージェントを停止し、再起動後に再び起動しないよう、エージェントを起動している仕組みを無効にします。

ステップ2: インストールと設定の移行

link-agent.msiを実行し、次のいずれかの方法でトンネルを移行します。古いエージェントの起動方法を確認するには、実行したコマンド、またはサービスが実行するラッパースクリプト (C:\mabl\link-agent-wrapper.batなど) を確認してください。

  • 設定ファイルを再利用する。 古いエージェントを設定ファイルで起動していた場合、この方法ではトンネルだけでなく、ファイル内のすべての設定が保持されます。

    1. インストーラーがトンネルを尋ねたら、Skip guided configurationを選択し、インストールを完了します。
    2. 既存の設定ファイルをC:\ProgramData\mabl\link-agent\config\config.yaml、または選択したデータフォルダー内のconfig\config.yamlに上書きコピーします。
    3. Servicesから、または管理者として開いたコマンドプロンプトでsc start MablLinkAgentを実行して、サービスを開始します。ガイド付き設定を使用しない場合、インストーラーはサービスを開始しません。

    設定ファイルがJSON形式の場合は、管理者として開いたコマンドプロンプトからmsiexec /i link-agent.msi CONFIGFILE=config.jsonでインストーラーを実行し、代わりにファイルをconfig\config.jsonにコピーします。

  • トンネルを再入力する。 古いエージェントを設定ファイルではなく、コマンドラインのAPIキーとトンネル名 (-aと-n、または--api-keyと--name) で起動していた場合や、提供するトンネルが少ない場合は、インストーラーで同じトンネル名とAPIキーを入力し、同じプロキシ設定を選択します。インストーラーは完了時にサービスを開始します。

ステップ3: 確認とクリーンアップ

ワークスペース > ネットワークでエージェントが接続されていることを確認します。その後、古いLink Agentのフォルダーと、エージェントの起動に使用していたラッパースクリプトを削除します。

NSSMサービスの削除

管理者として開いたコマンドプロンプトから、古いサービスを停止して削除します。NSSMで付けたサービス名を使用してください。以前のセットアップ手順ではLinkAgentです。

nssm stop LinkAgent
nssm remove LinkAgent confirm

zipアーカイブからの実行

試用する場合など、サービスをインストールせずにzipアーカイブからLink Agentを実行することもできます。アーカイブから実行するには、マシンにJava 11以降が必要です。ワークスペース > ネットワークからzipアーカイブをダウンロードして展開し、コマンドプロンプトからエージェントを実行します。

powershell.exe -NoP -NonI -Command "Expand-Archive link-agent.zip"
bin\link-agent --api-key {your-api-key} --name {tunnel-name}

エージェントは、コマンドプロンプトを閉じるかCtrl-Cを押すまで実行されます。サインアウト後も実行を続けるエージェントには、Windowsインストーラーを使用してください。

次のステップ

Link Agentがインストールされて実行されたら、mabl Link経由で実行するようにテストを設定します。

関連記事