about_PSModulePath

  • Article

Description courte

Cet article décrit l’objectif et l’utilisation de la variable d’environnement $env:PSModulePath .

Description longue

La $env:PSModulePath variable d’environnement contient une liste d’emplacements de dossiers qui sont recherchés pour rechercher des modules et des ressources. PowerShell recherche de manière récursive chaque dossier pour les fichiers de module (.psd1 ou .psm1) de manière récursive.

Install-Module a un paramètre Scope qui vous permet de spécifier si le module est installé pour l’utilisateur actuel ou pour tous les utilisateurs. Pour plus d’informations, consultez Install-Module.

Par défaut, les emplacements effectifs auxquels ils sont affectés $env:PSModulePath sont les suivants :

  • Emplacements à l’échelle du système : ces dossiers contiennent des modules fournis avec PowerShell. Ces modules sont stockés dans le $PSHOME\Modules dossier.

    • Sur Windows, les modules installés dans l’étendue AllUsers sont stockés dans $env:ProgramFiles\WindowsPowerShell\Modules.
    • Sur les systèmes non-Windows, les modules installés dans l’étendue AllUsers sont stockés dans /usr/local/share/powershell/Modules.

  • Modules installés par l’utilisateur : sur Windows, les modules installés dans l’étendue CurrentUser sont généralement stockés dans le $HOME\Documents\WindowsPowerShell\Modules dossier. L’emplacement spécifique du Documents dossier varie selon la version de Windows et lorsque vous utilisez la redirection de dossiers. En outre, Microsoft OneDrive peut modifier l’emplacement de votre Documents dossier. Vous pouvez vérifier l’emplacement de votre Documents dossier à l’aide de la commande suivante : [Environment]::GetFolderPath('MyDocuments').

    Sur les systèmes non Windows, les modules installés dans l’étendue CurrentUser sont stockés dans le $HOME/.local/share/powershell/Modules dossier.

  • Modules spécifiques à l’application : les programmes d’installation peuvent installer des modules dans d’autres répertoires, tels que le Program Files dossier sur Windows. Le package du programme d’installation peut ou non ajouter l’emplacement au $env:PSModulePath.

Construction de PowerShell PSModulePath

La valeur de celle-ci $env:PSModulePath est construite chaque fois que PowerShell démarre. La valeur varie selon la version de PowerShell et la façon dont elle est lancée.

Démarrage de Windows PowerShell

Windows PowerShell utilise la logique suivante pour construire le PSModulePath démarrage :

  • S’il PSModulePath n’existe pas, combinez CurrentUser, AllUsers et les chemins d’accès aux $PSHOME modules
  • S’il PSModulePath existe :
    • Si PSModulePath contient le $PSHOME chemin des modules :
      • Le chemin des modules AllUsers est inséré avant $PSHOME le chemin des modules
    • Autre:
      • Il suffit d’utiliser PSModulePath comme défini puisque l’utilisateur a délibérément supprimé l’emplacement $PSHOME

Le chemin du module CurrentUser est préfixé uniquement si l’étendue $env:PSModulePath utilisateur n’existe pas. Sinon, l’étendue $env:PSModulePath utilisateur est utilisée comme défini.

Démarrage de PowerShell 7

Dans Windows, pour la plupart des variables d’environnement, si la variable définie par l’utilisateur existe, un nouveau processus utilise cette valeur uniquement si une variable de portée machine du même nom existe.

Dans PowerShell 7, PSModulePath est traité comme la façon dont la Path variable d’environnement est traitée sur Windows. Sur Windows, Path il est traité différemment des autres variables d’environnement. Lorsqu’un processus est démarré, Windows combine l’étendue Path utilisateur avec l’étendue Pathde l’ordinateur.

  • Récupérer l’étendue utilisateur PSModulePath
  • Comparer à la variable d’environnement héritée PSModulePath du processus
    • Si la même chose est la même :
      • Ajoutez allUsersPSModulePath à la fin en suivant la sémantique de la variable d’environnement Path
      • Le chemin d’accès Windows System32 provient de l’ordinateur défini PSModulePath et n’a donc pas besoin d’être ajouté explicitement
    • Si elle est différente, traitez comme si l’utilisateur l’a modifié explicitement et n’ajoutez pas AllUsersPSModulePath
  • Préfixe avec l’utilisateur, le système et $PSHOME les chemins d’accès PS7 dans cet ordre
    • Si powershell.config.json contient un utilisateur délimité PSModulePath, utilisez-le au lieu de la valeur par défaut pour l’utilisateur.
    • Si powershell.config.json elle contient une étendue PSModulePathsystème, utilisez-la au lieu de la valeur par défaut pour le système.

Les systèmes Unix n’ont pas de séparation des variables d’environnement utilisateur et système. PSModulePath est hérité et les chemins spécifiques à PS7 sont préfixés s’ils ne sont pas déjà définis.

Démarrage de Windows PowerShell à partir de PowerShell 7

Pour cette discussion, Windows PowerShell signifie à la fois powershell.exe et powershell_ise.exe.

La valeur de celle-ci $env:PSModulePath est copiée avec WinPSModulePath les modifications suivantes :

  • Supprimer PS7 le chemin du module utilisateur
  • Supprimer PS7 le chemin du module système
  • Supprimer PS7 le chemin du $PSHOME module

Les chemins PS7 sont supprimés afin que les modules PS7 ne soient pas chargés dans Windows PowerShell. La WinPSModulePath valeur est utilisée lors du démarrage de Windows PowerShell.

Démarrage de PowerShell 7 à partir de Windows PowerShell

Le démarrage de PowerShell 7 se poursuit en l’état avec l’ajout de chemins d’accès ajoutés par Windows PowerShell. Étant donné que les chemins spécifiques à PS7 sont préfixés, il n’existe aucun problème fonctionnel.

Comportement de recherche de module

PowerShell recherche de manière récursive chaque dossier dans les fichiers de module (.psd1ou.psm1) PSModulePath. Ce modèle de recherche permet à plusieurs versions du même module d’être installées dans différents dossiers. Par exemple :

    Directory: C:\Program Files\WindowsPowerShell\Modules\PowerShellGet

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
d----           8/14/2020  5:56 PM                1.0.0.1
d----           9/13/2019  3:53 PM                2.1.2

Par défaut, PowerShell charge le numéro de version le plus élevé d’un module lorsque plusieurs versions sont trouvées. Pour charger une version spécifique, utilisez Import-Module le paramètre FullyQualifiedName . Pour plus d’informations, voir Import-Module.

Modification de PSModulePath

Dans la plupart des cas, vous devez installer des modules dans les emplacements de module par défaut. Toutefois, vous devrez peut-être modifier la valeur de la variable d’environnement PSModulePath .

Par exemple, pour ajouter temporairement le C:\Program Files\Fabrikam\Modules répertoire à $env:PSModulePath la session active, tapez :

$Env:PSModulePath = $Env:PSModulePath+";C:\Program Files\Fabrikam\Modules"

Le point-virgule (;) dans la commande sépare le nouveau chemin d’accès du chemin qui le précède dans la liste. Sur les plateformes non Windows, le signe deux-points (:) sépare les emplacements de chemin d’accès dans la variable d’environnement.

Modification de PSModulePath dans non-Windows

Pour modifier la valeur de PSModulePath chaque session dans un environnement non-Windows, ajoutez la commande précédente à votre profil PowerShell.

Modification de PSModulePath dans Windows

Pour modifier la valeur de chaque session, modifiez la clé de PSModulePath Registre stockant les PSModulePath valeurs. Les PSModulePath valeurs sont stockées dans le Registre sous forme de chaînes non expirées . Pour éviter d’enregistrer définitivement les PSModulePath valeurs sous forme de chaînes développées , utilisez la méthode GetValue sur la sous-clé et modifiez la valeur directement.

L’exemple suivant ajoute le C:\Program Files\Fabrikam\Modules chemin d’accès à la valeur de la PSModulePath variable d’environnement sans développer les chaînes non développées.

$key = (Get-Item 'HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager').OpenSubKey('Environment', $true)
$path = $key.GetValue('PSModulePath','','DoNotExpandEnvironmentNames')
$path += ';%ProgramFiles%\Fabrikam\Modules'
$key.SetValue('PSModulePath',$path,[Microsoft.Win32.RegistryValueKind]::ExpandString)

Pour ajouter un chemin d’accès au paramètre utilisateur, remplacez le fournisseur de Registre par HKLM:\HKCU:\.

$key = (Get-Item 'HKCU:\').OpenSubKey('Environment', $true)
$path = $key.GetValue('PSModulePath','','DoNotExpandEnvironmentNames')
$path += ';%ProgramFiles%\Fabrikam\Modules'
$key.SetValue('PSModulePath',$path,[Microsoft.Win32.RegistryValueKind]::ExpandString)

Voir aussi