适用于 Windows 上的 Linux IoT Edge的 PowerShell 函数

applies to： IoT Edge 1.5

了解部署、预配和获取 Windows 上 Linux IoT Edge（EFLOW）虚拟机的 PowerShell 函数。

先决条件

本文所述的命令来自 AzureEFLOW.psm1 文件，该文件位于系统中 WindowsPowerShell目录中的 C:\Program Files\WindowsPowerShell\Modules\AzureEFLOW 下。

如果没有 PowerShell 目录中的 AzureEflow 文件夹，请使用以下步骤下载并安装适用于 Windows 上的 Linux Azure IoT Edge：

1. 在提升的 PowerShell 会话中，运行以下命令，下载适用于 Windows 上的 Linux IoT Edge。

   • X64/AMD64

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

   • ARM64

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

2. 在设备上在 Windows 上安装适用于 Linux 的IoT Edge。

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

   通过向安装命令中添加 INSTALLDIR="<FULLY_QUALIFIED_PATH>" 和 VHDXDIR="<FULLY_QUALIFIED_PATH>" 参数，可以指定自定义安装和 VHDX 目录。

3. 在目标设备上将执行策略设置为至少 AllSigned。

   Set-ExecutionPolicy -ExecutionPolicy AllSigned -Force
   

Add-EflowNetwork

Add-EflowNetwork 命令将新网络添加到 EFLOW 虚拟机。 该命令采用两个参数。

它将返回一个包含四个属性的对象：

• 名称
• AllocationMethod
• Cidr
• 类型

有关详细信息，请参阅命令 Get-Help Add-EflowNetwork -full。

Add-EflowVmEndpoint

Add-EflowVmEndpoint 命令将新的网络终结点添加到 EFLOW 虚拟机。 使用可选参数设置静态 IP。

它将返回一个包含四个属性的对象：

• 名称
• MacAddress
• HealthStatus
• IpConfiguration

有关详细信息，请参阅命令 Get-Help Add-EflowVmEndpoint -full。

Add-EflowVmSharedFolder

Add-EflowVmSharedFolder 命令允许与 EFLOW 虚拟机共享一个或多个 Windows 主机 OS 文件夹。

JSON 配置文件必须具有以下结构：

• sharedFolderRoot：Windows 根文件夹的路径，其中包含要与 EFLOW 虚拟机共享的所有文件夹。
• 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 命令可返回主机配置。 此命令无参数。 它将返回一个包含四个属性的对象：

• FreePhysicalMemoryInMB
• NumberOfLogicalProcessors
• DiskInfo
• GpuInfo

有关详细信息，请参阅命令 Get-Help Get-EflowHostConfiguration -full。

Get-EflowLogs

Get-EflowLogs 命令从 Windows 部署和安装上的 Linux IoT Edge中收集和捆绑日志。 它以 .zip 文件夹的形式输出捆绑的日志。

有关详细信息，请参阅命令 Get-Help Get-EflowLogs -full。

Get-EflowNetwork

Get-EflowNetwork 命令返回分配给 EFLOW 虚拟机的网络列表。 使用可选参数获取特定网络。

它返回对象的列表，其中包含四个属性：

• 名称
• AllocationMethod
• Cidr
• 类型

有关详细信息，请参阅命令 Get-Help Get-EflowNetwork -full。

Get-EflowVm

Get-EflowVm 命令用于返回虚拟机的当前配置。 此命令无参数。 它将返回一个包含四个属性的对象：

• 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 虚拟机的网络列表。 使用可选参数获取特定网络终结点。

它返回对象的列表，其中包含四个属性：

• 名称
• MacAddress
• HealthStatus
• IpConfiguration

有关详细信息，请参阅命令 Get-Help Get-EflowVmEndpoint -full。

Get-EflowVmFeature

Get-EflowVmFeature 命令返回在 Windows 上为 Linux 启用IoT Edge的状态。

有关详细信息，请参阅命令 Get-Help Get-EflowVmFeature -full。

Get-EflowVmName

Get-EflowVmName 命令可返回虚拟机的当前主机名。 此命令用于应对 Windows 主机名可能会随时间而改变的情况。

有关详细信息，请参阅命令 Get-Help Get-EflowVmName -full。

Get-EflowVmSharedFolder

Get-EflowVmSharedFolder 命令返回有关与 EFLOW 虚拟机共享的一个或多个 Windows 主机 OS 文件夹的信息。

它返回对象列表，其中包含三个属性：

• hostFolderPath：与 EFLOW VM 共享的文件夹的相对路径（到父根文件夹）。
• readOnly：定义共享文件夹是可从 EFLOW 虚拟机写入还是只读 - 值：false 或 true。
• targetFolderOnGuest：安装 Windows 文件夹的 EFLOW 虚拟机内的文件夹路径。

有关详细信息，请参阅命令 Get-Help Get-EflowVmSharedFolder -full。

Get-EflowVmTelemetryOption

Get-EflowVmTelemetryOption 命令可显示虚拟机内遥测的状态（“可选”或“必选”） 。

有关详细信息，请参阅命令 Get-Help Get-EflowVmTelemetryOption -full。

Get-EflowVmTpmProvisioningInfo

Get-EflowVmTpmProvisioningInfo 命令可返回 TPM 预配信息。 此命令无参数。 它将返回一个包含两个属性的对象：

• 认可密钥
• 注册 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.toml 文件中。

有关详细信息，请参阅命令 Get-Help Provision-EflowVm -full。

Remove-EflowNetwork

Remove-EflowNetwork 命令删除附加到 EFLOW 虚拟机的现有网络。 此命令获取一个参数。

有关详细信息，请参阅命令 Get-Help Remove-EflowNetwork -full。

Remove-EflowVmEndpoint

Remove-EflowVmEndpoint 命令删除附加到 EFLOW 虚拟机的现有网络终结点。 此命令获取一个参数。

有关详细信息，请参阅命令 Get-Help Remove-EflowVmEndpoint -full。

Remove-EflowVmSharedFolder

Remove-EflowVmSharedFolder 命令停止将 Windows 主机 OS 文件夹共享给 EFLOW 虚拟机。 该命令采用两个参数。

有关详细信息，请参阅命令 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 命令启用或禁用 Windows 上的 Linux IoT Edge 状态。

有关详细信息，请参阅命令 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 命令是一个公开的函数，用于检查是否已在 Windows 虚拟机上为 Linux 创建IoT Edge。 该命令只使用常用参数，如果虚拟机已创建，它将返回 True，否则返回 False。

有关详细信息，请参阅命令 Get-Help Verify-EflowVm -full。

后续步骤

以下文章介绍如何使用以下命令在 Windows 上安装和预配适用于 Linux 的 IoT Edge：

• 适用于 Windows 上的 Linux 的 install Azure IoT Edge