Funções do PowerShell para o Azure IoT Edge para Linux no Windows

Aplica-se a: IoT Edge 1.5 IoT Edge 1.4

Entenda as funções do PowerShell que implantam, provisionam e obtêm o status de sua máquina virtual IoT Edge para Linux no Windows (EFLOW).

Pré-requisitos

Os comandos descritos neste artigo são do AzureEFLOW.psm1 arquivo, que pode ser encontrado em seu sistema em seu WindowsPowerShell diretório em C:\Program Files\WindowsPowerShell\Modules\AzureEFLOW.

Se você não tiver a pasta AzureEflow em seu diretório do PowerShell, use as seguintes etapas para baixar e instalar o Azure IoT Edge para Linux no Windows:

1. Em uma sessão do PowerShell com privilégios elevados, execute cada um dos comandos a seguir para baixar o IoT Edge para Linux no 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. Instale o IoT Edge para Linux no Windows no seu dispositivo.

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

   Você pode especificar a instalação personalizada e diretórios VHDX adicionando INSTALLDIR="<FULLY_QUALIFIED_PATH>" parâmetros e VHDXDIR="<FULLY_QUALIFIED_PATH>" ao comando install.

3. Defina a política de execução no dispositivo de destino como pelo menos AllSigned.

   Set-ExecutionPolicy -ExecutionPolicy AllSigned -Force
   

Add-EflowNetwork

O comando Add-EflowNetwork adiciona uma nova rede à máquina virtual EFLOW. Este comando precisa de dois parâmetros.

Ele retorna um objeto que contém quatro propriedades:

• Nome
• Método de atribuição
• Cidr
• Type

Para obter mais informações, use o comando Get-Help Add-EflowNetwork -full.

Add-EflowVmEndpoint

O comando Add-EflowVmEndpoint adiciona um novo ponto de extremidade de rede à máquina virtual EFLOW. Use os parâmetros opcionais para definir um IP estático.

Ele retorna um objeto que contém quatro propriedades:

• Nome
• MacEndereço
• HealthStatus
• Configuração de Ip

Para obter mais informações, use o comando Get-Help Add-EflowVmEndpoint -full.

Add-EflowVmSharedFolder

O comando Add-EflowVmSharedFolder permite compartilhar uma ou mais pastas do sistema operacional host do Windows com a máquina virtual EFLOW.

O arquivo de configuração JSON deve ter a seguinte estrutura:

• sharedFOlderRoot : Caminho para a pasta raiz do Windows que contém todas as pastas a serem compartilhadas com a máquina virtual EFLOW.
• hostFolderPath: Caminho relativo (para a pasta raiz pai) da pasta a ser compartilhada com a VM EFLOW.
• readOnly: Define se a pasta compartilhada é gravável ou somente leitura da máquina virtual EFLOW - Valores: false ou true.
• targetFolderOnGuest : Caminho da pasta dentro da máquina virtual EFLOW onde a pasta do sistema operacional host do Windows está montada.

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

Para obter mais informações, use o comando Get-Help Add-EflowVmSharedFolder -full.

Connect-EflowVm

O comando Connect-EflowVm se conecta à máquina virtual usando SSH. A única conta permitida para SSH para a máquina virtual é o usuário que a criou.

Este comando só funciona em uma sessão do PowerShell em execução no dispositivo host. Ele não funcionará ao usar o Windows Admin Center ou o PowerShell ISE.

Para obter mais informações, use o comando Get-Help Connect-EflowVm -full.

Copy-EflowVmFile

O comando Copy-EflowVmFile copia o arquivo de ou para a máquina virtual usando SCP. Use os parâmetros opcionais para especificar os caminhos dos arquivos de origem e destino e a direção da cópia.

O usuário iotedge-user deve ter permissão de leitura para qualquer diretório de origem ou permissão de gravação para qualquer diretório de destino na máquina virtual.

Para obter mais informações, use o comando Get-Help Copy-EflowVMFile -full.

Deploy-Eflow

O comando Deploy-Eflow é o principal método de implantação. O comando deployment cria a máquina virtual, provisiona arquivos e implanta o módulo do agente do IoT Edge. Embora nenhum dos parâmetros seja necessário, eles podem ser usados para modificar as configurações da máquina virtual durante a criação.

Para obter mais informações, use o comando Get-Help Deploy-Eflow -full.

Get-EflowHostConfiguration

O comando Get-EflowHostConfiguration retorna a configuração do host. Este comando não usa parâmetros. Ele retorna um objeto que contém quatro propriedades:

• FreePhysicalMemoryInMB
• NumberOfLogicalProcessors
• DiskInfo
• GpuInfo

Para obter mais informações, use o comando Get-Help Get-EflowHostConfiguration -full.

Get-EflowLogs

O comando Get-EflowLogs coleta e agrupa logs do IoT Edge para Linux na implantação e instalação do Windows. Ele produz os logs agrupados na forma de uma .zip pasta.

Para obter mais informações, use o comando Get-Help Get-EflowLogs -full.

Get-EflowNetwork

O comando Get-EflowNetwork retorna uma lista das redes atribuídas à máquina virtual EFLOW. Use o parâmetro opcional para obter uma rede específica.

Ele retorna uma lista de objetos que contém quatro propriedades:

• Nome
• Método de atribuição
• Cidr
• Type

Para obter mais informações, use o comando Get-Help Get-EflowNetwork -full.

Get-EflowVm

O comando Get-EflowVm retorna a configuração atual da máquina virtual. Este comando não usa parâmetros. Ele retorna um objeto que contém quatro propriedades:

• VmConfiguration
• VmPowerState
• EdgeRuntimeVersion
• EdgeRuntimeStatus
• Estatísticas do Sistema

Para exibir uma propriedade específica em uma lista legível, execute o Get-EflowVM comando com a propriedade expandida. Por exemplo:

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

Para obter mais informações, use o comando Get-Help Get-EflowVm -full.

Get-EflowVmAddr

O comando Get-EflowVmAddr é usado para consultar o endereço IP e MAC atual da máquina virtual. Este comando existe para explicar o fato de que o endereço IP e MAC pode mudar ao longo do tempo.

Para obter informações adicionais, use o comando Get-Help Get-EflowVmAddr -full.

Get-EflowVmEndpoint

O comando Get-EflowVmEndpoint retorna uma lista dos pontos de extremidade de rede atribuídos à máquina virtual EFLOW. Use o parâmetro opcional para obter um ponto de extremidade de rede específico.

Ele retorna uma lista de objetos que contém quatro propriedades:

• Nome
• MacEndereço
• HealthStatus
• Configuração de Ip

Para obter mais informações, use o comando Get-Help Get-EflowVmEndpoint -full.

Get-EflowVmFeature

O comando Get-EflowVmFeature retorna o status da ativação dos recursos do IoT Edge para Linux no Windows.

Para obter mais informações, use o comando Get-Help Get-EflowVmFeature -full.

Get-EflowVmName

O comando Get-EflowVmName retorna o nome de host atual da máquina virtual. Este comando existe para explicar o fato de que o nome de host do Windows pode mudar ao longo do tempo.

Para obter mais informações, use o comando Get-Help Get-EflowVmName -full.

Get-EflowVmSharedFolder

O comando Get-EflowVmSharedFolder retorna as informações sobre uma ou mais pastas do sistema operacional host do Windows compartilhadas com a máquina virtual EFLOW.

Ele retorna uma lista de objetos que contém três propriedades:

• hostFolderPath: caminho relativo (para a pasta raiz pai) da pasta compartilhada com a VM EFLOW.
• readOnly: Define se a pasta compartilhada é gravável ou somente leitura da máquina virtual EFLOW - Valores: false ou true.
• targetFolderOnGuest: Caminho da pasta dentro da máquina virtual EFLOW onde a pasta do Windows está montada.

Para obter mais informações, use o comando Get-Help Get-EflowVmSharedFolder -full.

Get-EflowVmTelemetryOption

O comando Get-EflowVmTelemetryOption exibe o status da telemetria ( Opcional ou Necessária) dentro da máquina virtual.

Para obter mais informações, use o comando Get-Help Get-EflowVmTelemetryOption -full.

Get-EflowVmTpmProvisioningInfo

O comando Get-EflowVmTpmProvisioningInfo retorna as informações de provisionamento do TPM. Este comando não usa parâmetros. Ele retorna um objeto que contém duas propriedades:

• Chave de Endossamento
• ID de Registo

Para obter mais informações, use o comando Get-Help Get-EflowVmTpmProvisioningInfo -full.

Invoke-EflowVmCommand

O comando Invoke-EflowVMCommand executa um comando Linux dentro da máquina virtual e retorna a saída. Este comando só funciona para comandos Linux que retornam uma saída finita. Ele não pode ser usado para comandos Linux que exigem interação do usuário ou que são executados indefinidamente.

Os seguintes parâmetros opcionais podem ser usados para especificar o comando com antecedência.

Para obter mais informações, use o comando Get-Help Invoke-EflowVmCommand -full.

Provisão-EflowVm

O comando Provision-EflowVm adiciona as informações de provisionamento do dispositivo IoT Edge ao arquivo IoT Edge config.yaml da máquina virtual.

Para obter mais informações, use o comando Get-Help Provision-EflowVm -full.

Remove-EflowNetwork

O comando Remove-EflowNetwork remove uma rede existente conectada à máquina virtual EFLOW. Este comando usa um parâmetro.

Para obter mais informações, use o comando Get-Help Remove-EflowNetwork -full.

Remove-EflowVmEndpoint

O comando Remove-EflowVmEndpoint remove um ponto de extremidade de rede existente conectado à máquina virtual EFLOW. Este comando usa um parâmetro.

Para obter mais informações, use o comando Get-Help Remove-EflowVmEndpoint -full.

Remove-EflowVmSharedFolder

O comando Remove-EflowVmSharedFolder para de compartilhar a pasta do sistema operacional host do Windows com a máquina virtual EFLOW. Este comando precisa de dois parâmetros.

Para obter mais informações, use o comando Get-Help Remove-EflowVmSharedFolder -full.

Set-EflowVM

O comando Set-EflowVM atualiza a configuração da máquina virtual com as propriedades solicitadas. Use os parâmetros opcionais para definir uma configuração específica para a máquina virtual.

Para obter mais informações, use o comando Get-Help Set-EflowVM -full.

Set-EflowVmDNSServers

O comando Set-EflowVmDNSServers configura os servidores DNS para a máquina virtual EFLOW.

Para obter mais informações, use o comando Get-Help Set-EflowVmDNSServers -full.

Set-EflowVmFeature

O comando Set-EflowVmFeature habilita ou desabilita o status dos recursos do IoT Edge para Linux no Windows.

Para obter mais informações, use o comando Get-Help Set-EflowVmFeature -full.

Set-EflowVmTelemetryOption

O comando Set-EflowVmTelemetryOption habilita ou desabilita a telemetria opcional dentro da máquina virtual.

Para obter mais informações, use o comando Get-Help Set-EflowVmTelemetryOption -full.

Start-EflowVm

O comando Start-EflowVm inicia a máquina virtual. Se a máquina virtual já tiver sido iniciada, nenhuma ação será executada.

Para obter mais informações, use o comando Get-Help Start-EflowVm -full.

Parar-EflowVm

O comando Stop-EflowVm para a máquina virtual. Se a máquina virtual já estiver parada, nenhuma ação será executada.

Para obter mais informações, use o comando Get-Help Stop-EflowVm -full.

Verificar-EflowVm

O comando Verify-EflowVm é uma função exposta que verifica se o IoT Edge para Linux na máquina virtual Windows foi criado. Ele usa apenas parâmetros comuns e retorna True se a máquina virtual foi criada e False se não.

Para obter mais informações, use o comando Get-Help Verify-EflowVm -full.

Próximos passos

Saiba como usar esses comandos para instalar e provisionar o IoT Edge para Linux no Windows no seguinte artigo:

• Instalar o Azure IoT Edge para Linux no Windows