Partager via


Install-Module

Télécharge un ou plusieurs modules à partir d’un référentiel et les installe sur l’ordinateur local.

Syntaxe

NameParameterSet (Par défaut)

Install-Module
    [-Name] <string[]>
    [-MinimumVersion <version>]
    [-MaximumVersion <version>]
    [-RequiredVersion <version>]
    [-Repository <string[]>]
    [-Scope <string>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObject

Install-Module
    [-InputObject] <psobject[]>
    [-Scope <string>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

L’applet Install-Module de commande 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.

Si le module installé a le même nom ou version, ou contient des commandes dans un module existant, les messages d’avertissement sont affichés. Une fois que vous avez confirmé que vous souhaitez installer le module et ignorer les avertissements, utilisez le -Force paramètre. En fonction des paramètres de votre référentiel, vous devrez peut-être répondre à une invite pour que l’installation du module continue.

Ces exemples utilisent PowerShell Gallery comme seul dépôt inscrit. Get-PSRepository affiche les référentiels inscrits. Si vous avez plusieurs référentiels inscrits, utilisez le -Repository paramètre pour spécifier le nom du référentiel.

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

Utilise Find-Module 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 Install-Module de commande. Install-Module installe le module pour tous les utilisateurs dans $env:ProgramFiles\WindowsPowerShell\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

Utilise Install-Module 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

Utilise Install-Module 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

Utilise Install-Module 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

Utilise Install-Module le paramètre Name pour spécifier le module PowerShellGet . Install-Moduletélécharge et installe la dernière version de PowerShellGet dans le répertoire de l’utilisateur actuel. $home\Documents\WindowsPowerShell\Modules

Paramètres

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande Install-Module.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False
Alias:cf

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Force

Installe un module et remplace les messages d’avertissement relatifs aux conflits d’installation du module. Si un module portant le même nom existe déjà sur l’ordinateur, Force autorise l’installation de plusieurs versions. S’il existe un module existant portant le même nom et la même version, Force remplace cette version.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-InputObject

Utilisé pour l’entrée de pipeline.

Propriétés du paramètre

Type:

PSObject[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

InputObject
Position:0
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-MaximumVersion

Spécifie la version maximale d’un seul module à installer. Si vous souhaitez installer plusieurs modules, vous ne pouvez pas utiliser MaximumVersion. MaximumVersion et RequiredVersion ne peuvent pas être utilisés dans la même Install-Module commande.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NameParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-MinimumVersion

Spécifie la version minimale d’un seul module à installer. S’il existe une version plus récente du module disponible, la version la plus récente est installée. Si vous souhaitez installer plusieurs modules, vous ne pouvez pas utiliser MinimumVersion. MinimumVersion et RequiredVersion ne peuvent pas être utilisés dans la même Install-Module commande.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Version

Jeux de paramètres

NameParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Name

Spécifie les noms exacts des modules à installer à partir de la galerie en ligne. Une liste séparée par des virgules des noms de modules est acceptée. Le nom du module doit correspondre au nom du module dans le référentiel. Permet Find-Module d’obtenir la liste des noms de modules.

Propriétés du paramètre

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NameParameterSet
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Repository

Utilisez le paramètre Repository pour spécifier le référentiel utilisé pour télécharger et installer un module. Utilisé lorsque plusieurs référentiels sont inscrits. Spécifie le nom d’un référentiel inscrit dans la Install-Module commande. Pour inscrire un référentiel, utilisez Register-PSRepository. Pour afficher les référentiels inscrits, utilisez Get-PSRepository.

Propriétés du paramètre

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NameParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-RequiredVersion

Spécifie la version exacte d’un seul module à installer. S’il n’existe aucune correspondance dans le référentiel pour la version spécifiée, une erreur s’affiche. Si vous souhaitez installer plusieurs modules, vous ne pouvez pas utiliser RequiredVersion. RequiredVersion ne peut pas être utilisé dans la même Install-Module commande que MinimumVersion ou MaximumVersion.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NameParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Scope

Spécifie l’étendue d’installation du module. Les valeurs acceptables pour ce paramètre sont AllUsers et CurrentUser.

L’étendue AllUsers installe les modules dans un emplacement accessible à tous les utilisateurs de l’ordinateur :

$env:ProgramFiles\WindowsPowerShell\Modules

CurrentUser installe les modules dans un emplacement accessible uniquement à l’utilisateur actuel de l’ordinateur :

$home\Documents\WindowsPowerShell\Modules

Lorsqu’aucun champ d’application n’est défini, la valeur par défaut est définie en fonction de la session en cours :

  • Pour une session PowerShell avec élévation de privilèges, la valeur par défaut de l’étendue est AllUsers.
  • Pour les sessions PowerShell sans élévation de privilèges dans les versions 2.0.0 et ultérieures de PowerShellGet, l’étendue est CurrentUser.
  • Pour les sessions PowerShell non élevées dans PowerShellGet versions 1.6.7 et antérieures, l’étendue n’est pas définie et Install-Module échoue.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Valeurs acceptées:AllUsers, CurrentUser
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-WhatIf

Affiche ce qui se passerait si une Install-Module commande a été exécutée. L’applet de commande ne s’exécute pas.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False
Alias:Wi

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

PSRepositoryItemInfo

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

Notes

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 éviter 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, Install-Module renvoie 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, MaximumVersion ou RequiredVersion. Find-Module crée des objets PSRepositoryItemInfo qui peuvent être envoyés vers le pipeline 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\WindowsPowerShell\Modules. La valeur par défaut empêche toute confusion lorsque vous installez des ressources DSC (Desired State Configuration) PowerShell.

L’installation d’un module échoue et ne peut pas être importée s’il ne contient pas de .psm1, .psd1ou .dll du même nom dans le dossier. Utilisez le paramètre Force pour installer le module.

Si la version d’un module existant correspond au nom spécifié par le paramètre Name et que les paramètres MinimumVersion ou RequiredVersion ne sont pas utilisés, le module continue en mode silencieux, Install-Module mais ne l’installe pas.

Si la version d’un module existant est supérieure à la valeur du paramètre MinimumVersion ou égale à la valeur du paramètre RequiredVersion , le module continue en mode silencieux, Install-Module mais ne l’installe pas.

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