Partager via

Add-PSSnapin

  • Référence
Module:
Microsoft.PowerShell.Core

Ajoute un ou plusieurs composants logiciels enfichables Windows PowerShell à la session active.

Syntaxe

Add-PSSnapin
   [-Name] <String[]>
   [-PassThru]
   [<CommonParameters>]

Description

L’applet de commande Add-PSSnapin ajoute des composants logiciels enfichables Windows PowerShell inscrits à la session active. Une fois les composants logiciels enfichables ajoutés, vous pouvez utiliser les applets de commande et les fournisseurs pris en charge par les composants logiciels enfichables dans la session active.

Pour ajouter le composant logiciel enfichable à toutes les futures sessions Windows PowerShell, ajoutez une commande Add-PSSnapin à votre profil Windows PowerShell. Pour plus d’informations, consultez about_Profiles.

À compter de Windows PowerShell 3.0, les commandes principales incluses dans Windows PowerShell sont empaquetées dans les modules. L’exception est Microsoft.PowerShell.Core, qui est un composant logiciel enfichable (PSSnapin). Par défaut, seul le composant logiciel enfichable Microsoft.PowerShell.Core est ajouté à la session. Les modules sont importés automatiquement lors de la première utilisation et vous pouvez utiliser l’applet de commande Import-Module pour les importer.

Exemples

Exemple 1 : Ajouter des composants logiciels enfichables

PS C:\> Add-PSSnapIn -Name Microsoft.Exchange, Microsoft.Windows.AD

Cette commande ajoute les composants logiciels enfichables Microsoft Exchange et Active Directory à la session active.

Exemple 2 : Ajouter tous les composants logiciels enfichables inscrits

PS C:\> Get-PSSnapin -Registered | Add-PSSnapin -PassThru

Cette commande ajoute tous les composants logiciels enfichables Windows PowerShell inscrits à la session. Il utilise l’applet de commande Get-PSSnapin avec le paramètre Registered pour obtenir des objets représentant chacun des composants logiciels enfichables inscrits. L’opérateur de pipeline (|) transmet le résultat à Add-PSSnapin, qui les ajoute à la session. Le paramètre PassThru retourne des objets qui représentent chacun des composants logiciels enfichables ajoutés.

Exemple 3 : Inscrire un composant logiciel enfichable et l’ajouter

La première commande obtient des composants logiciels enfichables qui ont été ajoutés à la session active qui incluent les composants logiciels enfichables installés avec Windows PowerShell. Dans cet exemple, ManagementFeatures n’est pas retourné. Cela indique qu’il n’a pas été ajouté à la session.

La deuxième commande obtient des composants logiciels enfichables inscrits sur votre système, qui incluent ceux qui ont déjà été ajoutés à la session. Il n’inclut pas les composants logiciels enfichables installés avec Windows PowerShell. Dans ce cas, la commande ne retourne aucun composant logiciel enfichable. Cela indique que le composant logiciel enfichable ManagementFeatures n’a pas été inscrit sur le système.

La troisième commande crée un alias, installutil, pour le chemin d’accès de l’outil InstallUtil dans .NET Framework.

La quatrième commande utilise l’outil InstallUtil pour inscrire le composant logiciel enfichable. La commande spécifie le chemin d’accès de ManagementCmdlets.dll, le nom du nom de fichier ou du module du composant logiciel enfichable.

La cinquième commande est la même que la deuxième commande. Cette fois, vous l’utilisez pour vérifier que le composant logiciel enfichable ManagementCmdlets est inscrit.

La sixième commande utilise l’applet de commande Add-PSSnapin pour ajouter le composant logiciel enfichable ManagementFeatures à la session. Il spécifie le nom du composant logiciel enfichable, ManagementFeatures, et non le nom du fichier.

Pour vérifier que le composant logiciel enfichable est ajouté à la session, la septième commande utilise le paramètre module de l’applet de commande Get-Command. Il affiche les éléments qui ont été ajoutés à la session par un composant logiciel enfichable ou un module.

Vous pouvez également utiliser la propriété PSSnapin de l’objet retourné par l’applet de commande Get-Command pour rechercher le composant logiciel enfichable ou le module dans lequel une applet de commande provient. La huitième commande utilise la notation par points pour rechercher la valeur de la propriété PSSnapin de l’applet de commande Set-Alias.

PS C:\> Get-PSSnapin
PS C:\> Get-PSSnapin -Registered
PS C:\> Set-Alias installutil $env:windir\Microsoft.NET\Framework\v2.0.50727\installutil.exe
PS C:\> installutil C:\Dev\Management\ManagementCmdlets.dll
PS C:\> Get-PSSnapin -Registered
PS C:\> add-pssnapin ManagementFeatures
PS C:\> Get-Command -Module ManagementFeatures
PS C:\> (Get-Command Set-Alias).pssnapin

Cet exemple illustre le processus d’inscription d’un composant logiciel enfichable sur votre système, puis de l’ajouter à votre session. Il utilise ManagementFeatures, un composant logiciel enfichable fictif implémenté dans un fichier nommé ManagementCmdlets.dll.

Paramètres

-Name

Spécifie le nom du composant logiciel enfichable. Il s’agit du nom, et non de l’AssemblyName ou du nom de module. Les caractères génériques sont autorisés.

Pour rechercher les noms des composants logiciels enfichables inscrits sur votre système, tapez Get-PSSnapin -Registered.

Type:String[]
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:True

-PassThru

Indique que cette applet de commande retourne un objet qui représente chaque composant logiciel enfichable ajouté. Par défaut, cette applet de commande ne génère aucune sortie.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

None

Vous ne pouvez pas diriger les objets vers cette applet de commande.

Sorties

None or System.Management.Automation.PSSnapInInfo

Cette applet de commande renvoie un objet PSSnapInInfo qui représente le composant logiciel enfichable si vous spécifiez le paramètre PassThru. Sinon, cette applet de commande ne génère aucune sortie.

Notes

Windows PowerShell inclut les alias suivants pour Add-PSSnapin:

  • asnp

À compter de Windows PowerShell 3.0, les commandes principales installées avec Windows PowerShell sont empaquetées dans les modules. Dans Windows PowerShell 2.0 et dans les programmes hôtes qui créent des sessions de style plus ancien dans les versions ultérieures de Windows PowerShell, les commandes principales sont empaquetées dans les composants logiciels enfichables (PSSnapins). L’exception est Microsoft.PowerShell.Core, qui est toujours un composant logiciel enfichable. En outre, les sessions à distance, telles que celles démarrées par l’applet de commande New-PSSession, sont des sessions de style plus ancien qui incluent des composants logiciels enfichables principaux.

Pour plus d’informations sur la méthode CreateDefault2 qui crée des sessions de style plus récent avec des modules principaux, consultez méthode CreateDefault2.

Pour plus d’informations sur les composants logiciels enfichables, consultez about_PSSnapins et Comment créer un composant logiciel enfichable Windows PowerShell.

Add-PSSnapin ajoute le composant logiciel enfichable uniquement à la session active. Pour ajouter le composant logiciel enfichable à toutes les sessions Windows PowerShell, ajoutez-le à votre profil Windows PowerShell. Pour plus d’informations, consultez about_Profiles.

Vous pouvez ajouter n’importe quel composant logiciel enfichable inscrit à l’aide de l’utilitaire d’installation de Microsoft .NET Framework. Pour plus d’informations, consultez Comment inscrire des applets de commande, des fournisseurs et des applications hôtes.

Pour obtenir la liste des composants logiciels enfichables inscrits sur votre ordinateur, tapez Get-PSSnapin -Registered.

Avant d’ajouter un composant logiciel enfichable, Add-PSSnapin vérifie la version du composant logiciel enfichable pour vérifier qu’elle est compatible avec la version actuelle de Windows PowerShell. Si le composant logiciel enfichable échoue à la vérification de la version, Windows PowerShell signale une erreur.