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

The first command gets snap-ins that have been added to the current session that include the snap-ins that are installed with Windows PowerShell. In this example, ManagementFeatures is not returned. This indicates that it has not been added to the session.
PS C:\> Get-PSSnapin

The second command gets snap-ins that have been registered on your system, which includes those that have already been added to the session. It does not include the snap-ins that are installed with Windows PowerShell. In this case, the command does not return any snap-ins. This indicates that the ManagementFeatures snapin has not been registered on the system.
PS C:\> Get-PSSnapin -Registered

The third command creates an alias, installutil, for the path of the InstallUtil tool in .NET Framework.
PS C:\> Set-Alias installutil $env:windir\Microsoft.NET\Framework\v2.0.50727\installutil.exe

The fourth command uses the InstallUtil tool to register the snap-in. The command specifies the path of ManagementCmdlets.dll, the file name or module name of the snap-in.
PS C:\> installutil C:\Dev\Management\ManagementCmdlets.dll

The fifth command is the same as the second command. This time, you use it to verify that the ManagementCmdlets snap-in is registered.
PS C:\> Get-PSSnapin -Registered

The sixth command uses the **Add-PSSnapin** cmdlet to add the ManagementFeatures snap-in to the session. It specifies the name of the snap-in, ManagementFeatures, not the file name.
PS C:\> add-pssnapin ManagementFeatures

To verify that the snap-in is added to the session, the seventh command uses the *Module* parameter of the Get-Command cmdlet. It displays the items that were added to the session by a snap-in or module.
PS C:\> Get-Command -Module ManagementFeatures

You can also use the **PSSnapin** property of the object that the **Get-Command** cmdlet returns to find the snap-in or module in which a cmdlet originated. The eighth command uses dot notation to find the value of the PSSnapin property of the Set-Alias cmdlet.
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:False

-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

  • À 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 dans la bibliothèque MSDN.

  • Pour plus d’informations sur les composants logiciels enfichables, consultez about_PSSnapins et How to Create a Windows PowerShell Snap-in in the MSDN library.

  • 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 dans la bibliothèque MSDN.

  • 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.