Fonctions PowerShell pour IoT Edge pour Linux sur Windows

S’applique à : IoT Edge 1.4

Découvrez les fonctions PowerShell qui déploient, approvisionnent et obtiennent l’état de votre IoT Edge pour Linux sur une machine virtuelle Windows (EFLOW).

Prérequis

Les commandes décrites dans cet article proviennent du fichier AzureEFLOW.psm1, qui se trouve sur votre système dans votre répertoire WindowsPowerShell sous C:\Program Files\WindowsPowerShell\Modules\AzureEFLOW.

Si vous n’avez pas le dossier AzureEflow dans votre répertoire PowerShell, suivez les étapes ci-dessous pour télécharger et installer Azure IoT Edge pour Linux sur Windows :

1. Dans une session PowerShell avec élévation de privilèges, exécutez chacune des commandes suivantes pour télécharger IoT Edge pour Linux sur 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. Installez IoT Edge pour Linux sur Windows sur votre appareil.

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

   Vous pouvez spécifier des répertoires d’installation et VHDX personnalisés en ajoutant les paramètres INSTALLDIR="<FULLY_QUALIFIED_PATH>" and VHDXDIR="<FULLY_QUALIFIED_PATH>"à la commande d’installation.

3. Définissez la stratégie d’exécution sur l’appareil cible sur au moins AllSigned.

   Set-ExecutionPolicy -ExecutionPolicy AllSigned -Force
   

Add-EflowNetwork

La commande Add-EflowNetwork ajoute un nouveau réseau à la machine virtuelle EFLOW. Cette commande accepte deux paramètres.

Elle retourne un objet qui contient quatre propriétés :

• Nom
• AllocationMethod
• Cidr
• Type

Pour plus d'informations, utilisez la commande Get-Help Add-EflowNetwork -full.

Add-EflowVmEndpoint

La commande Add-EflowVmEndpoint ajoute un nouveau point de terminaison réseau à la machine virtuelle EFLOW. Utilisez les paramètres facultatifs pour définir une adresse IP statique.

Elle retourne un objet qui contient quatre propriétés :

• Nom
• MacAddress
• HealthStatus
• IpConfiguration

Pour plus d'informations, utilisez la commande Get-Help Add-EflowVmEndpoint -full.

Add-EflowVmSharedFolder

La commande Add-EflowVmSharedFolder permet de partager un ou plusieurs dossiers de système d’exploitation hôte Windows avec la machine virtuelle EFLOW.

Le fichier de configuration JSON doit présenter la structure suivante :

• sharedFolderRoot : chemin du dossier racine Windows contenant tous les dossiers à partager avec la machine virtuelle EFLOW.
• hostFolderPath : chemin relatif (vers le dossier racine parent) du dossier à partager avec la machine virtuelle EFLOW.
• readOnly : définit si le dossier partagé est accessible en écriture ou en lecture seule sur la machine virtuelle EFLOW (valeurs : false et true).
• targetFolderOnGuest : chemin du dossier à l’intérieur de la machine virtuelle EFLOW où le dossier du système d’exploitation hôte Windows est monté.

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

Pour plus d'informations, utilisez la commande Get-Help Add-EflowVmSharedFolder -full.

Connect-EflowVm

La commande Connect-EflowVm se connecte à la machine virtuelle via SSH. Le seul compte autorisé à accéder via SSH à la machine virtuelle est celui de l’utilisateur qui l’a créée.

Cette commande fonctionne uniquement sur une session PowerShell en cours d’exécution sur l’appareil hôte. Elle ne fonctionnera pas lors de l’utilisation du centre d’administration Windows ou de PowerShell ISE.

Pour plus d'informations, utilisez la commande Get-Help Connect-EflowVm -full.

Copy-EflowVmFile

La commande Copy-EflowVmFile copie le fichier vers ou à partir de la machine virtuelle à l’aide de SCP. Utilisez les paramètres facultatifs pour spécifier les chemins d’accès aux fichiers source et de destination, ainsi que la direction de la copie.

L’utilisateur iotedge-user doit disposer de l’autorisation de lecture sur tous les répertoires d’origine ou d’une autorisation d’écriture sur les répertoires de destination de l’ordinateur virtuel.

Pour plus d'informations, utilisez la commande Get-Help Copy-EflowVMFile -full.

Deploy-Eflow

La commande Deploy-Eflow est la principale méthode de déploiement. La commande de déploiement crée la machine virtuelle, approvisionne des fichiers et déploie le module d’agent IoT Edge. Bien qu’aucun des paramètres ne soit obligatoire, ils peuvent être utilisés pour modifier les paramètres de la machine virtuelle pendant sa création.

Pour plus d'informations, utilisez la commande Get-Help Deploy-Eflow -full.

Get-EflowHostConfiguration

La commande Get-EflowHostConfiguration renvoie la configuration de l’hôte. Cette commande n’accepte aucun paramètre. Elle retourne un objet qui contient quatre propriétés :

• FreePhysicalMemoryInMB
• NumberOfLogicalProcessors
• DiskInfo
• GpuInfo

Pour plus d'informations, utilisez la commande Get-Help Get-EflowHostConfiguration -full.

Get-EflowLogs

La commande Get-EflowLogs collecte et regroupe les journaux et les packs ed’IoT Edge pour le déploiement et l’installation de Linux sur Windows. Elle génère les journaux regroupés sous la forme d’un dossier .zip.

Pour plus d'informations, utilisez la commande Get-Help Get-EflowLogs -full.

Get-EflowNetwork

La commande Get-EflowNetwork renvoie une liste des réseaux affectés à la machine virtuelle EFLOW. Utilisez le paramètre facultatif pour obtenir un réseau spécifique.

La commande retourne une liste d’objets qui contient quatre propriétés :

• Nom
• AllocationMethod
• Cidr
• Type

Pour plus d'informations, utilisez la commande Get-Help Get-EflowNetwork -full.

Get-EflowVm

La commande Get-EflowVmrenvoie la configuration actuelle de la machine virtuelle. Cette commande n’accepte aucun paramètre. Elle retourne un objet qui contient quatre propriétés :

• VmConfiguration
• VmPowerState
• EdgeRuntimeVersion
• EdgeRuntimeStatus
• SystemStatistics

Pour afficher une propriété spécifique dans une liste lisible, exécutez la commande Get-EflowVM avec la propriété développée. Par exemple :

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

Pour plus d'informations, utilisez la commande Get-Help Get-EflowVm -full.

Get-EflowVmAddr

La commande Get-EflowVmAddr est utilisée pour interroger les adresses IP et Mac de la machine virtuelle. Cette commande existe afin de tenir compte du fait que les adresses IP et Mac peuvent changer dans le temps.

Pour toute information supplémentaire, utilisez la commande Get-Help Get-EflowVmAddr -full.

Get-EflowVmEndpoint

La commande EflowVmEndpoint renvoie une liste des points de terminaison réseau affectés à la machine virtuelle EFLOW. Utilisez le paramètre facultatif pour obtenir un point de terminaison réseau spécifique.

La commande retourne une liste d’objets qui contient quatre propriétés :

• Nom
• MacAddress
• HealthStatus
• IpConfiguration

Pour plus d'informations, utilisez la commande Get-Help Get-EflowVmEndpoint -full.

Get-EflowVmFeature

La commande Get-EflowVmFeature renvoie l’état de l’activation d’IoT Edge pour les fonctionnalités Linux sur Windows.

Pour plus d'informations, utilisez la commande Get-Help Get-EflowVmFeature -full.

Get-EflowVmName

La commande Get-EflowVmName renvoie le nom d’hôte actuel de la machine virtuelle. Cette commande permet de tenir compte du fait que le nom d’hôte Windows peut changer dans le temps.

Pour plus d'informations, utilisez la commande Get-Help Get-EflowVmName -full.

Get-EflowVmSharedFolder

La commande Get-EflowVmSharedFolder retourne les informations relatives à un ou plusieurs dossiers de système d’exploitation hôte Windows partagés avec la machine virtuelle EFLOW.

La commande retourne une liste d’objets qui contient trois propriétés :

• hostFolderPath : chemin relatif (vers le dossier racine parent) du dossier partagé avec la machine virtuelle EFLOW.
• readOnly : définit si le dossier partagé est accessible en écriture ou en lecture seule sur la machine virtuelle EFLOW (valeurs : false et true).
• targetFolderOnGuest : chemin du dossier à l’intérieur de la machine virtuelle EFLOW où le dossier Windows est monté.

Pour plus d'informations, utilisez la commande Get-Help Get-EflowVmSharedFolder -full.

Get-EflowVmTelemetryOption

La commande Get-EflowVmTelemetryOption affiche l’état de la télémétrie (soitFacultatif soit Requis) au sein de la machine virtuelle.

Pour plus d'informations, utilisez la commande Get-Help Get-EflowVmTelemetryOption -full.

Get-EflowVmTpmProvisioningInfo

La commande Get-EflowVmTpmProvisioningInfo renvoie les informations d’approvisionnement du Module de plateforme sécurisée (TPM). Cette commande n’accepte aucun paramètre. Elle retourne un objet qui contient quatre propriétés :

• EK (Endorsement Key)
• ID d'inscription

Pour plus d'informations, utilisez la commande Get-Help Get-EflowVmTpmProvisioningInfo -full.

Invoke-EflowVmCommand

La commande Invoke-EflowVMCommand exécute une commande Linux dans la machine virtuelle et renvoie le résultat. Cette commande fonctionne uniquement pour les commandes Linux qui retournent une sortie finie. Elle ne peut pas être utilisée pour les commandes Linux qui nécessitent une interaction de l’utilisateur ou qui s’exécutent indéfiniment.

Les paramètres facultatifs suivants peuvent être utilisés pour spécifier la commande à l’avance.

Pour plus d'informations, utilisez la commande Get-Help Invoke-EflowVmCommand -full.

Provision-EflowVm

La commande Provision-EflowVm ajoute les informations d’approvisionnement de votre appareil IoT Edge au fichier config.yaml IoT Edge de la machine virtuelle.

Pour plus d'informations, utilisez la commande Get-Help Provision-EflowVm -full.

Remove-EflowNetwork

La commande Remove-EflowNetwork supprime un réseau existant attaché à la machine virtuelle EFLOW. Cette commande accepte un seul paramètre.

Pour plus d'informations, utilisez la commande Get-Help Remove-EflowNetwork -full.

Remove-EflowVmEndpoint

La commande Remove-EflowNetwork supprime un réseau existant attaché à la machine virtuelle EFLOW. Cette commande accepte un seul paramètre.

Pour plus d'informations, utilisez la commande Get-Help Remove-EflowVmEndpoint -full.

Remove-EflowVmSharedFolder

La commande Remove-EflowVmSharedFolder arrête le partage du dossier du système d’exploitation hôte Windows avec la machine virtuelle EFLOW. Cette commande accepte deux paramètres.

Pour plus d'informations, utilisez la commande Get-Help Remove-EflowVmSharedFolder -full.

Set-EflowVM

La commande Set-EflowVM actualise la configuration de la machine virtuelle avec les propriétés requises. Utilisez les paramètres facultatifs pour définir une configuration spécifique pour la machine virtuelle.

Pour plus d'informations, utilisez la commande Get-Help Set-EflowVM -full.

Set-EflowVmDNSServers

La commande Set-EflowVmDNSServers configure les serveurs DNS de la machine virtuelle EFLOW.

Pour plus d'informations, utilisez la commande Get-Help Set-EflowVmDNSServers -full.

Set-EflowVmFeature

La commande Set-EflowVmFeature active ou désactive l’état d’IoT Edge pour les fonctionnalités Linux sur Windows.

Pour plus d'informations, utilisez la commande Get-Help Set-EflowVmFeature -full.

Set-EflowVmTelemetryOption

La commande Set-EflowVmTelemetryOption active ou désactive la télémétrie facultative au sein de la machine virtuelle.

Pour plus d'informations, utilisez la commande Get-Help Set-EflowVmTelemetryOption -full.

Start-EflowVm

La commande Start-EflowVm démarre la machine virtuelle. Si la machine virtuelle est déjà démarrée, aucune action n’est effectuée.

Pour plus d'informations, utilisez la commande Get-Help Start-EflowVm -full.

Stop-EflowVm

La commande Stop-EflowVm arrête la machine virtuelle. Si la machine virtuelle est déjà arrêtée, aucune action n’est effectuée.

Pour plus d'informations, utilisez la commande Get-Help Stop-EflowVm -full.

Verify-EflowVm

La commande Verify-EflowVm est une fonction exposée pour vérifier si la machine virtuelle IoT Edge pour Linux sur Windows a été créée. Il ne prend que les paramètres courants, et retourne True si la machine virtuelle a été créée et False si ce n’est pas le cas.

Pour plus d'informations, utilisez la commande Get-Help Verify-EflowVm -full.

Étapes suivantes

Découvrez comment utiliser ces commandes pour installer et configurer IoT Edge pour Linux sur Windows dans l’article suivant :

• Installer Azure IoT Edge pour Linux sur Windows