IoT Edge for Linux on Windows 用の PowerShell 関数

適用対象: IoT Edge 1.4

IoT Edge for Linux on Windows (EFLOW) 仮想マシンのデプロイ、プロビジョニング、状態取得のための PowerShell 関数について説明します。

前提条件

この記事で説明されているコマンドは、AzureEFLOW.psm1 ファイルからのものです。これは、ご使用のシステムの C:\Program Files\WindowsPowerShell\Modules\AzureEFLOW の WindowsPowerShell ディレクトリー内にあります。

PowerShell ディレクトリにAzureEflow フォルダーがない場合は、次の手順を使用して、Azure IoT Edge for Linux on Windows をダウンロードしてインストールします。

1. 管理者特権の PowerShell セッションで、次の各コマンドを実行し、IoT Edge for Linux on Windows をダウンロードします。

   • X64、AMD64

   $msiPath = $([io.Path]::Combine($env:TEMP, 'AzureIoTEdge.msi'))
   $ProgressPreference = 'SilentlyContinue'
   Invoke-WebRequest "https://aka.ms/AzEFLOWMSI_1_4_LTS_X64" -OutFile $msiPath
   

   • ARM64

   $msiPath = $([io.Path]::Combine($env:TEMP, 'AzureIoTEdge.msi'))
   $ProgressPreference = 'SilentlyContinue'
   Invoke-WebRequest "https://aka.ms/AzEFLOWMSI_1_4_LTS_ARM64" -OutFile $msiPath
   

2. IoT Edge for Linux on Windows をデバイスにインストールします。

   Start-Process -Wait msiexec -ArgumentList "/i","$([io.Path]::Combine($env:TEMP, 'AzureIoTEdge.msi'))","/qn"
   

   カスタムのインストールおよび VHDX ディレクトリを指定するには、インストール コマンドに INSTALLDIR="<FULLY_QUALIFIED_PATH>" および VHDXDIR="<FULLY_QUALIFIED_PATH>" パラメーターを追加します。

3. ターゲット デバイスの実行ポリシーを AllSigned 以上に設定します。

   Set-ExecutionPolicy -ExecutionPolicy AllSigned -Force
   

Add-EflowNetwork

Add-EflowNetwork コマンドは、EFLOW 仮想マシンに新しいネットワークを追加します。 このコマンドには 2 つのパラメーターを指定します。

これは、次の 4 つのプロパティを含むオブジェクトを返します。

• 名前
• AllocationMethod
• Cidr
• Type

詳細については、コマンド Get-Help Add-EflowNetwork -full を使用してください。

Add-EflowVmEndpoint

Add-EflowVmEndpoint コマンドは、EFLOW 仮想マシンに新しいネットワーク エンドポイントを追加します。 静的 IP を設定するには、オプション パラメーターを使用します。

これは、次の 4 つのプロパティを含むオブジェクトを返します。

• 名前
• MacAddress
• HealthStatus
• IpConfiguration

詳細については、コマンド Get-Help Add-EflowVmEndpoint -full を使用してください。

Add-EflowVmSharedFolder

Add-EflowVmSharedFolder コマンドを使用すると、1 つ以上の Windows ホスト OS フォルダーを EFLOW 仮想マシンと共有できます。

この JSON 構成ファイルには、次の構造体が必要です。

• sharedFOlderRoot: EFLOW 仮想マシンと共有するすべてのフォルダーを含む Windows ルート フォルダーへのパス。
• hostFolderPath: EFLOW VM と共有するフォルダーの (親ルート フォルダーへの) 相対パス。
• readOnly: 共有フォルダーが EFLOW 仮想マシンから書き込み可能か、読み取り専用かを定義します (値は false または true)。
• targetFolderOnGuest : Windows ホスト OS フォルダーがマウントされている EFLOW 仮想マシン内のフォルダー パス。

[
   {
      "sharedFolderRoot": "<shared-folder-root-windows-path>",
      "sharedFolders": [ 
        { "hostFolderPath": "<path-shared-folder>", 
            "readOnly": "<read-only>", 
            "targetFolderOnGuest": "<linux-mounting-point>" 
        }
      ]
   }
]

詳細については、コマンド Get-Help Add-EflowVmSharedFolder -full を使用してください。

Connect-EflowVm

Connect-EflowVm コマンドでは、SSH を使用して仮想マシンに接続します。 仮想マシンへの SSH 接続が許可されるアカウントは、それを作成したユーザーだけです。

このコマンドは、ホスト デバイスで実行されている PowerShell セッションでのみ機能します。 Windows Admin Center または PowerShell ISE を使用する場合は機能しません。

詳細については、コマンド Get-Help Connect-EflowVm -full を使用してください。

Copy-EflowVmFile

Copy-EflowVmFile コマンドは、SCP を使用して、仮想マシンとの間でファイルをコピーします。 省略可能なパラメーターを使用して、コピー元およびコピー先のファイル パスとコピーの方向を指定します。

ユーザー iotedge-user は、仮想マシン上の元のディレクトリすべてに対する読み取りアクセス許可を持っているか、コピー先ディレクトリすべてに対する書き込みアクセス許可を持っている必要があります。

詳細については、コマンド Get-Help Copy-EflowVMFile -full を使用してください。

Deploy-Eflow

Deploy-Eflow コマンドは、メインのデプロイ方法です。 このデプロイ コマンドによって仮想マシンが作成され、ファイルがプロビジョニングされ、IoT Edge エージェント モジュールがデプロイされます。 どのパラメーターも必須ではありませんが、作成時に仮想マシンの設定を変更するために使用できます。

詳細については、コマンド Get-Help Deploy-Eflow -full を使用してください。

Get-EflowHostConfiguration

Get-EflowHostConfiguration コマンドを実行すると、ホスト構成が返されます。 このコマンドはパラメーターを受け取りません。 これは、次の 4 つのプロパティを含むオブジェクトを返します。

• FreePhysicalMemoryInMB
• NumberOfLogicalProcessors
• DiskInfo
• GpuInfo

詳細については、コマンド Get-Help Get-EflowHostConfiguration -full を使用してください。

Get-EflowLogs

Get-EflowLogs コマンドを実行すると、IoT Edge for Linux on Windows のデプロイとインストールからログが収集され、バンドルされます。 バンドルされたログは、.zip フォルダーの形式で出力されます。

詳細については、コマンド Get-Help Get-EflowLogs -full を使用してください。

Get-EflowNetwork

Get-EflowNetwork コマンドは、EFLOW 仮想マシンに割り当てられたネットワークのリストを返します。 特定のネットワークを取得するには、オプション パラメーターを使用します。

次の 4 つのプロパティを含んだオブジェクトのリストが返されます。

• 名前
• AllocationMethod
• Cidr
• Type

詳細については、コマンド Get-Help Get-EflowNetwork -full を使用してください。

Get-EflowVm

Get-EflowVm コマンドを実行すると、仮想マシンの現在の構成が返されます。 このコマンドはパラメーターを受け取りません。 これは、次の 4 つのプロパティを含むオブジェクトを返します。

• VmConfiguration
• VmPowerState
• EdgeRuntimeVersion
• EdgeRuntimeStatus
• SystemStatistics

読み取り可能なリスト内の特定のプロパティを表示するには、そのプロパティを展開して Get-EflowVM コマンドを実行します。 次に例を示します。

Get-EflowVM | Select -ExpandProperty VmConfiguration | Format-List

詳細については、コマンド Get-Help Get-EflowVm -full を使用してください。

Get-EflowVmAddr

Get-EflowVmAddr コマンドは、仮想マシンの現在の IP と MAC アドレスに対してクエリを実行するために使用されます。 このコマンドは、IP と MAC アドレスが時間の経過と共に変わる場合があるという事実を考慮して存在しています。

追加情報については、Get-Help Get-EflowVmAddr -full コマンドを使用してください。

Get-EflowVmEndpoint

Get-EflowVmEndpoint コマンドは、EFLOW 仮想マシンに割り当てられたネットワーク エンドポイントのリストを返します。 特定のネットワーク エンドポイントを取得するには、オプション パラメーターを使用します。

次の 4 つのプロパティを含んだオブジェクトのリストが返されます。

• 名前
• MacAddress
• HealthStatus
• IpConfiguration

詳細については、コマンド Get-Help Get-EflowVmEndpoint -full を使用してください。

Get-EflowVmFeature

Get-EflowVmFeature コマンドを実行すると、IoT Edge for Linux on Windows の機能の有効化の状態が返されます。

詳細については、コマンド Get-Help Get-EflowVmFeature -full を使用してください。

Get-EflowVmName

Get-EflowVmName コマンドを実行すると、仮想マシンの現在のホスト名が返されます。 このコマンドは、Windows ホスト名が時間の経過と共に変わる場合があるという事実を考慮して存在しています。

詳細については、コマンド Get-Help Get-EflowVmName -full を使用してください。

Get-EflowVmSharedFolder

Get-EflowVmSharedFolder コマンドは、EFLOW 仮想マシンと共有している 1 つ以上の Windows ホスト OS フォルダーに関する情報を返します。

次の 4 つのプロパティを持つオブジェクトのリストが返されます。

• hostFolderPath: EFLOW VM と共有しているフォルダーの (親ルート フォルダーへの) 相対パス。
• readOnly: 共有フォルダーが EFLOW 仮想マシンから書き込み可能か、読み取り専用かを定義します (値は false または true)。
• targetFolderOnGuest: Windows フォルダーがマウントされている EFLOW 仮想マシン内のフォルダー パス。

詳細については、コマンド Get-Help Get-EflowVmSharedFolder -full を使用してください。

Get-EflowVmTelemetryOption

Get-EflowVmTelemetryOption コマンドを実行すると、仮想マシン内のテレメトリ (Optional または Required) の状態が表示されます。

詳細については、コマンド Get-Help Get-EflowVmTelemetryOption -full を使用してください。

Get-EflowVmTpmProvisioningInfo

Get-EflowVmTpmProvisioningInfo コマンドを実行すると、TPM プロビジョニング情報が返されます。 このコマンドはパラメーターを受け取りません。 これは、次の 2 つのプロパティを含むオブジェクトを返します。

• 保証キー
• 登録 ID

詳細については、コマンド Get-Help Get-EflowVmTpmProvisioningInfo -full を使用してください。

Invoke-EflowVmCommand

Invoke-EflowVMCommand コマンドを実行すると、仮想マシン内で Linux コマンドが実行され、出力が返されます。 このコマンドは、有限の出力を返す Linux コマンドに対してのみ機能します。 ユーザー操作が必要、または無期限に実行される Linux コマンドには使用できません。

次の省略可能なパラメーターを使用して、コマンドを事前に指定できます。

詳細については、コマンド Get-Help Invoke-EflowVmCommand -full を使用してください。

Provision-EflowVm

Provision-EflowVm コマンドを実行すると、IoT Edge デバイスのプロビジョニング情報が仮想マシンの IoT Edge の config.yaml ファイルに追加されます。

詳細については、コマンド Get-Help Provision-EflowVm -full を使用してください。

Remove-EflowNetwork

Remove-EflowNetwork コマンドは、EFLOW 仮想マシンにアタッチされている既存のネットワークを削除します。 このコマンドはパラメーターを 1 つ受け取ります。

詳細については、コマンド Get-Help Remove-EflowNetwork -full を使用してください。

Remove-EflowVmEndpoint

Remove-EflowVmEndpoint コマンドは、EFLOW 仮想マシンにアタッチされている既存のネットワーク エンドポイントを削除します。 このコマンドはパラメーターを 1 つ受け取ります。

詳細については、コマンド Get-Help Remove-EflowVmEndpoint -full を使用してください。

Remove-EflowVmSharedFolder

Remove-EflowVmSharedFolder コマンドは、Windows ホスト OS フォルダーと EFLOW 仮想マシンの共有を停止します。 このコマンドには 2 つのパラメーターを指定します。

詳細については、コマンド Get-Help Remove-EflowVmSharedFolder -full を使用してください。

Set-EflowVM

Set-EflowVM コマンドを実行すると、要求されたプロパティで仮想マシンの構成が更新されます。 仮想マシンの特定の構成を定義するには、省略可能なパラメーターを使用します。

詳細については、コマンド Get-Help Set-EflowVM -full を使用してください。

Set-EflowVmDNSServers

Set-EflowVmDNSServers コマンドは、EFLOW 仮想マシン用に DNS サーバーを構成します。

詳細については、コマンド Get-Help Set-EflowVmDNSServers -full を使用してください。

Set-EflowVmFeature

Set-EflowVmFeature コマンドを実行すると、IoT Edge for Linux on Windows の機能の状態が有効または無効になります。

詳細については、コマンド Get-Help Set-EflowVmFeature -full を使用してください。

Set-EflowVmTelemetryOption

Set-EflowVmTelemetryOption コマンドを実行すると、仮想マシン内の省略可能なテレメトリが有効または無効になります。

詳細については、コマンド Get-Help Set-EflowVmTelemetryOption -full を使用してください。

Start-EflowVm

Start-EflowVm コマンドを実行すると、仮想マシンが起動されます。 仮想マシンが既に起動されている場合、何のアクションも実行されません。

詳細については、コマンド Get-Help Start-EflowVm -full を使用してください。

Stop-EflowVm

Stop-EflowVm コマンドを実行すると、仮想マシンが停止されます。 仮想マシンが既に停止されている場合、何のアクションも実行されません。

詳細については、コマンド Get-Help Stop-EflowVm -full を使用してください。

Verify-EflowVm

Verify-EflowVm コマンドは、IoT Edge for Linux on Windows 仮想マシンが作成されたかどうかを確認するための公開された関数です。 これは一般的なパラメーターのみを受け取り、仮想マシンが作成された場合は True を返し、作成されていない場合は False を返します。

詳細については、コマンド Get-Help Verify-EflowVm -full を使用してください。

次のステップ

次の記事で、これらのコマンドを使用して IoT Edge for Linux on Windows をインストールおよびプロビジョニングする方法を確認します。

• Azure IoT Edge for Linux on Windows をインストールする