ローカル PowerShell スクリプトを使用したセルフホステッド統合ランタイムのインストールの自動化

ローカル コンピューター (Resource Manager テンプレートを利用できる Azure VM を除く) でのセルフホステッド統合ランタイムのインストールを自動化するために、ローカル PowerShell スクリプトを使用できます。 この記事では、使用できる 2 つのスクリプトについて説明します。

前提条件

  • ローカル コンピューターで PowerShell を起動します。 スクリプトを実行するには、 [管理者として実行] を選択する必要があります。
  • セルフホステッド統合ランタイム ソフトウェアをダウンロードします。 ダウンロードしたファイルのパスをコピーします。
  • セルフホステッド統合ランタイムを登録するには認証キーも必要です。
  • 手動更新を自動化するには、事前に構成されたセルフホステッド統合ランタイムが必要です。

スクリプトの概要

Note

これらのスクリプトは、セルフホステッド統合ランタイムのドキュメント化されたコマンド ライン ユーティリティを使用して作成されます。 必要に応じて、自動化のニーズに対応するために、これらのスクリプトをカスタマイズできます。 スクリプトはノードごとに適用する必要があるため、高可用性のセットアップ (2 つ以上のノード) の場合は、必ずすべてのノードで実行してください。

  • セットアップを自動化する場合: InstallGatewayOnLocalMachine.ps1 を使用して、新しいセルフホステッド統合ランタイム ノードをインストールして登録します。このスクリプトを使用して、セルフホステッド統合ランタイム ノードをインストールし、それに認証キーを登録できます。 このスクリプトでは、2 つの引数を受け取ります。最初の引数は、ローカルディスク上のセルフホステッド統合ランタイムの場所を指定し、2 番目の引数は、(セルフホステッド IR ノードの登録用の) 認証キーを指定します。

  • 手動更新を自動化する場合:セルフホステッド IR ノードを特定のバージョンまたは最新バージョンの script-update-gateway.ps1 に更新します。これは、自動更新を無効にした場合、または更新をより細かく制御する場合にもサポートされます。 スクリプトを使用して、セルフホステッド統合ランタイム ノードを最新バージョンまたは指定された上位バージョンに更新できます (ダウングレードは機能しません)。 バージョン番号を指定するための引数を受け取ります (例: -version 3.13.6942.1)。 バージョンが指定されていない場合、セルフホステッド IR は常に、ダウンロードで見つかった最新バージョンに更新されます。

    Note

    最後の 3 つのバージョンのみを指定できます。 これは、既存のノードを最新バージョンに更新するために使用するのが理想的です。 これは、登録済みのセルフホステッド IR があることを前提としています

使用例

セットアップを自動化する場合

  1. セルフホステッド IR をダウンロードします。

  2. 上記のダウンロードされた SHIR MSI (インストール ファイル) のパスを指定します。 たとえば、パスが C:\Users\username\Downloads\IntegrationRuntime_4.7.7368.1.msi の場合、次の PowerShell コマンドライン例をこのタスクに使用できます。

    PS C:\windows\system32> C:\Users\username\Desktop\InstallGatewayOnLocalMachine.ps1 -path "C:\Users\username\Downloads\IntegrationRuntime_4.7.7368.1.msi" -authKey "[key]"
    

    Note

    [Key] を認証キーに置き換えて、IR を登録します。 "username" をユーザー名に置き換えます。 スクリプトを実行するときに、"InstallGatewayOnLocalMachine.ps1" ファイルの場所を指定します。 この例では、デスクトップに保存しています。

  3. コンピューターに事前にインストールされたセルフホステッド IR が 1 つある場合は、スクリプトによって自動的にアンインストールされ、新しい IR が構成されます。 次のウィンドウがポップアウトされます: 統合ランタイムの構成

  4. インストールとキーの登録が完了すると、"Succeed to install gateway(ゲートウェイのインストールに成功) " と "Succeed to register gateway(ゲートウェイの登録に成功) " の結果が、ローカルの PowerShell に表示されます。 スクリプト 1 の実行結果

手動更新を自動化する場合

このスクリプトは、最新のセルフホステッド統合ランタイムを更新したり、インストールして登録したりするために使用されます。 スクリプトの実行では、次の手順が実行されます。

  1. 現在のセルフホステッド IR バージョンを確認します
  2. 引数から最新バージョンまたは指定されたバージョンを取得します
  3. 現在のバージョンより新しいバージョンがある場合:
    • セルフホステッド IR msi をダウンロードします
    • これをアップグレードします

次のコマンドライン例に従って、このスクリプトを使用できます。

  • 最新のゲートウェイをダウンロードしてインストールする。

    PS C:\windows\system32> C:\Users\username\Desktop\script-update-gateway.ps1
    
  • 指定されたバージョンのゲートウェイをダウンロードしてインストールする。

    PS C:\windows\system32> C:\Users\username\Desktop\script-update-gateway.ps1 -version 3.13.6942.1
    

    現在のバージョンが既に最新のバージョンである場合は、更新が必要でないことを示した次の結果が表示されます。 [スクリプト 2 の実行結果](media/self-hosted-integration-runtime-automation-scripts/script-2-run-result.png)