Install-Module

Syntaxe

Install-Module
       [-Name] <String[]>
       [-MinimumVersion <String>]
       [-MaximumVersion <String>]
       [-RequiredVersion <String>]
       [-Repository <String[]>]
       [-Credential <PSCredential>]
       [-Scope <String>]
       [-Proxy <Uri>]
       [-ProxyCredential <PSCredential>]
       [-AllowClobber]
       [-SkipPublisherCheck]
       [-Force]
       [-AllowPrerelease]
       [-AcceptLicense]
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Install-Module
       [-InputObject] <PSObject[]>
       [-Credential <PSCredential>]
       [-Scope <String>]
       [-Proxy <Uri>]
       [-ProxyCredential <PSCredential>]
       [-AllowClobber]
       [-SkipPublisherCheck]
       [-Force]
       [-AcceptLicense]
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

L’applet de commande Install-Module obtient un ou plusieurs modules qui répondent aux critères spécifiés à partir d’un référentiel en ligne. L’applet de commande vérifie que les résultats de la recherche sont des modules valides et copie les dossiers de modules à l’emplacement d’installation. Les modules installés ne sont pas automatiquement importés après l’installation. Vous pouvez filtrer le module installé en fonction des versions minimales, maximales et exactes des modules spécifiés.

Il s’agit d’une applet de commande proxy pour l’applet de commande Get-InstalledPSResource dans Microsoft.PowerShell.PSResourceGet. Pour plus d’informations, consultez install-PSResource.

Exemples

Exemple 1 : Rechercher et installer un module

Cet exemple recherche un module dans le référentiel et installe le module.

Find-Module -Name PowerShellGet | Install-Module

Le utilise le paramètre Name pour spécifier le module PowerShellGet . Par défaut, la version la plus récente du module est téléchargée à partir du référentiel. L’objet est envoyé vers le bas du pipeline à l’applet de commande Install-Module. Install-Module installe le module pour tous les utilisateurs dans $env:ProgramFiles\PowerShell\Modules.

Exemple 2 : Installer un module par nom

Dans cet exemple, la version la plus récente du module PowerShellGet est installée.

Install-Module -Name PowerShellGet

Le utilise le paramètre Name pour spécifier le module PowerShellGet . Par défaut, la version la plus récente du module est téléchargée à partir du référentiel et installée.

Exemple 3 : Installer un module à l’aide de sa version minimale

Dans cet exemple, la version minimale du module PowerShellGet est installée. Le paramètre MinimumVersion spécifie la version la plus basse du module qui doit être installée. Si une version plus récente du module est disponible, cette version est téléchargée et installée pour tous les utilisateurs.

Install-Module -Name PowerShellGet -MinimumVersion 2.0.1

Le utilise le paramètre Name pour spécifier le module PowerShellGet . Le paramètre MinimumVersion spécifie que la version 2.0.1 est téléchargée à partir du référentiel et installée. Étant donné que la version 2.0.4 est disponible, cette version est téléchargée et installée pour tous les utilisateurs.

Exemple 4 : Installer une version spécifique d’un module

Dans cet exemple, une version spécifique du module PowerShellGet est installée.

Install-Module -Name PowerShellGet -RequiredVersion 2.0.0

Le utilise le paramètre Name pour spécifier le module PowerShellGet . Le paramètre RequiredVersion spécifie que la version 2.0.0 est téléchargée et installée pour tous les utilisateurs.

Exemple 5 : Installer un module uniquement pour l’utilisateur actuel

Cet exemple télécharge et installe la version la plus récente d’un module, uniquement pour l’utilisateur actuel.

Install-Module -Name PowerShellGet -Scope CurrentUser

Le utilise le paramètre Name pour spécifier le module PowerShellGet . Install-Module télécharge et installe la dernière version de PowerShellGet dans le répertoire de l’utilisateur actuel, $HOME\Documents\PowerShell\Modules.

Exemple 6 : Installer la dernière version préliminaire d’un module

Cet exemple montre comment installer la dernière version d’un module lorsque cette version est une version préliminaire. L’installation d’une version préliminaire nécessite le paramètre AllowPrerelease.

Install-Module -Name Microsoft.PowerShell.Crescendo -AllowPrerelease

Cette méthode vous permet d’obtenir la dernière version disponible. Si la dernière version n’est pas une préversion, vous obtenez la dernière version stable du module.

Exemple 7 : Installer une version préliminaire spécifique d’un module

Cet exemple montre comment installer une version préliminaire spécifique d’un module. L’applet de commande Find-Module peut être utilisée pour rechercher des versions préliminaires des modules dans PowerShell Gallery.

Les versions préliminaires ont un format de <version_number>-<prerelease_label>.

Find-Module PSReadLine -AllVersions -AllowPrerelease | Select-Object -First 5

Version        Name             Repository       Description
-------        ----             ----------       -----------
2.2.6          PSReadLine       PSGallery        Great command line editing in the PowerS…
2.2.5          PSReadLine       PSGallery        Great command line editing in the PowerS…
2.2.4-beta1    PSReadLine       PSGallery        Great command line editing in the PowerS…
2.2.3          PSReadLine       PSGallery        Great command line editing in the PowerS…
2.2.2          PSReadLine       PSGallery        Great command line editing in the PowerS…

Install-Module -Name PSReadLine -RequiredVersion 2.2.4-beta1 -AllowPrerelease

Utilisez la version affichée dans PowerShell Gallery pour la valeur du paramètre RequiredVersion.

Paramètres

-AcceptLicense

-AllowClobber

-AllowPrerelease

-Confirm

-Credential

-Force

-InputObject

-MaximumVersion

-MinimumVersion

-Name

-PassThru

-Proxy

-ProxyCredential

-Repository

-RequiredVersion

-Scope

-SkipPublisherCheck

-WhatIf

Entrées

PSRepositoryItemInfo

Find-Module crée objets PSRepositoryItemInfo qui peuvent être envoyés vers le bas du pipeline vers Install-Module.

String[]

PSObject[]

String

PSCredential

Uri

Sorties

Microsoft.PowerShell.Commands.PSRepositoryItemInfo

Lorsque vous utilisez le paramètre passThru , génère un objet PSRepositoryItemInfo pour le module. Il s’agit des mêmes informations que celles que vous obtenez à partir de l’applet de commande Find-Module.

Notes

PowerShell inclut les alias suivants pour Install-Module:

• Toutes les plateformes :
  • inmo

Install-Module s’exécute sur PowerShell 5.0 ou versions ultérieures, sur Windows 7 ou Windows 2008 R2 et versions ultérieures de Windows.

En guise de bonne pratique de sécurité, évaluez le code d’un module avant d’exécuter des applets de commande ou des fonctions pour la première fois. Pour empêcher l’exécution de modules contenant du code malveillant, les modules installés ne sont pas automatiquement importés après l’installation.

Si le nom du module spécifié par le paramètre Name n’existe pas dans le référentiel, retourne une erreur.

Pour installer plusieurs modules, utilisez le paramètre Name et spécifiez un tableau séparé par des virgules de noms de modules. Si vous spécifiez plusieurs noms de module, vous ne pouvez pas utiliser minimumVersion, MaximumVersionou RequiredVersion. Find-Module crée objets PSRepositoryItemInfo qui peuvent être envoyés vers le bas du pipeline vers Install-Module. Le pipeline est un autre moyen de spécifier plusieurs modules à installer dans une seule commande.

Par défaut, les modules pour l’étendue de AllUsers sont installés dans $env:ProgramFiles\PowerShell\Modules. La valeur par défaut empêche toute confusion lorsque vous installez des ressources DSC (Desired State Configuration) PowerShell.

Une installation de module échoue et ne peut pas être importée si elle n’a pas de .psm1, .psd1ou .dll du même nom dans le dossier. Utilisez le paramètre Forcer pour installer le module.

Si la version d’un module existant correspond au nom spécifié par le paramètre Name , et que le paramètre MinimumVersion ou RequiredVersion ne sont pas utilisés, continue silencieusement, mais n’installe pas le module.

Si la version d’un module existant est supérieure à la valeur du paramètre MinimumVersion ou égale à la valeur du paramètre RequiredVersion , continue silencieusement, mais n’installe pas le module.

Si le module existant ne correspond pas aux valeurs spécifiées par l'MinimumVersion ou paramètres RequiredVersion, une erreur se produit dans la commande Install-Module. Par exemple, si la version du module installé existant est inférieure à la valeur MinimumVersion ou non égale à la valeur RequiredVersion.

Install-Module installe également tous les modules dépendants spécifiés comme requis par l’éditeur de module. L’éditeur répertorie les modules requis et leurs versions dans le manifeste du module.

Liens associés

• Find-Module
• Get-PSRepository
• Import-Module
• Publish-Module
• Register-PSRepository
• Uninstall-Module
• Update-Module
• about_Module