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 les composants logiciels enfichables Windows PowerShell inscrits à la session active. Une fois que les composants logiciels enfichables ont été ajoutés, vous pouvez utiliser les applets de commande et les fournisseurs que les composants logiciels enfichables prennent en charge dans la session active.
Pour ajouter le composant logiciel enfichable à toutes les sessions Windows PowerShell futures, ajoutez une commande Add-PSSnapin à votre profil Windows PowerShell. Pour plus d'informations, consultez about_Profiles.
Paramètres
-Name <string[]>
Spécifie le nom du composant logiciel enfichable. (Il s'agit du paramètre Name, et non d'AssemblyName ou de ModuleName.)
Pour rechercher les noms des composants logiciels enfichables inscrits sur votre système, tapez : « get-pssnapin -registered ».
|
Obligatoire ? |
true |
|
Position ? |
1 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByPropertyName) |
|
Accepter les caractères génériques ? |
false |
-PassThru
Retourne un objet qui représente chaque composant logiciel enfichable ajouté. Par défaut, cette applet de commande ne génère aucune sortie.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.
Entrées et sorties
Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.
|
Entrées |
Aucun Vous ne pouvez pas diriger d'objets vers Add-PSSnapin. |
|
Sorties |
Aucun ou System.Management.Automation.PSSnapInInfo Lorsque vous utilisez le paramètre PassThru, Add-PSSnapin retourne un objet PSSnapInInfo qui représente le composant logiciel enfichable. Sinon, cette applet de commande ne génère aucune sortie. |
Remarques
Pour obtenir des informations détaillées sur les composants logiciels enfichables dans Windows PowerShell, consultez about_Pssnapins. Pour plus d'informations sur la création d'un composant logiciel enfichable Windows PowerShell, consultez « Comment créer un composant logiciel enfichable Windows PowerShell » (page éventuellement en anglais) dans la bibliothèque MSDN (Microsoft Developer Network) à l'adresse https://go.microsoft.com/fwlink/?LinkId=144762.
Add-PSSnapin ajoute uniquement le composant logiciel enfichable à 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 tout composant logiciel enfichable Windows PowerShell qui a été inscrit à l'aide de l'utilitaire d'installation Microsoft .NET Framework. Pour plus d'informations, consultez « Comment inscrire des applets de commande, des fournisseurs et des applications hôtes » (page éventuellement en anglais) dans la bibliothèque MSDN à l'adresse https://go.microsoft.com/fwlink/?LinkID=143619.
Pour obtenir la liste des composants logiciels enfichables qui sont inscrits sur votre ordinateur, tapez "Get-PSSnapin -registered".
Avant d'ajouter un composant logiciel enfichable, Add-PSSnapin vérifie la version de ce dernier afin de s'assurer qu'il est compatible avec la version actuelle de Windows PowerShell. Si la version du composant logiciel enfichable n'est pas appropriée, Windows PowerShell signale une erreur.
Exemple 1
C:\PS>add-PSSnapIn Microsoft.Exchange, Microsoft.Windows.AD Description ----------- Cette commande ajoute les composants logiciels enfichables Microsoft Exchange et Active Directory à la session active.
Exemple 2
C:\PS>get-pssnapin -registered | add-pssnapin -passthru Description ----------- Cette commande ajoute tous les composants logiciels enfichables Windows PowerShell inscrits à la session. Elle utilise l'applet de commande Get-PSSnapin avec le paramètre Registered pour obtenir des objets qui représentent chacun des composants logiciels enfichables inscrits. L'opérateur de pipeline (|) passe 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
C:\PS>get-pssnapin
Description
-----------
Cet exemple montre le processus d'inscription d'un composant logiciel enfichable dans votre système, suivi de son ajout à votre session. Il utilise ManagementFeatures, un composant logiciel enfichable fictif implémenté dans un fichier nommé ManagementCmdlets.dll.
La première commande obtient des composants logiciels enfichables qui ont été ajoutés à la session active, y compris ceux qui sont installés en même temps que Windows PowerShell. Dans cet exemple, ManagementFeatures n'est pas retourné. Cela indique qu'il n'a pas été ajouté à la session.
get-pssnapin
La deuxième commande obtient les composants logiciels enfichables qui ont été inscrits sur votre système (y compris ceux qui ont déjà été ajoutés à la session). Les composants logiciels enfichables qui sont installés avec Windows PowerShell n'apparaissent pas dans la liste.
get-pssnapin -registered
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 à l'outil InstallUtil dans le .NET Framework.
set-alias installutil $env:windir\Microsoft.NET\Framework\v2.0.50727\installutil.exe
La quatrième commande utilise l'outil InstallUtil pour inscrire le composant logiciel enfichable. Cette commande spécifie le chemin d'accès à ManagementCmdlets.dll, le nom de fichier ou « nom de module » du composant logiciel enfichable.
installutil C:\Dev\Management\ManagementCmdlets.dll
La cinquième commande est identique à la deuxième. Cette fois-ci, vous l'utilisez pour vérifier que le composant logiciel enfichable ManagementCmdlets est inscrit.
get-pssnapin -registered
La sixième commande utilise l'applet de commande Add-PSSnapin pour ajouter le composant logiciel enfichable ManagementFeatures à la session. Elle spécifie le nom du composant logiciel enfichable, ManagementFeatures, et non celui du fichier.
add-pssnapin ManagementFeatures
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. Elle affiche les éléments qui ont été ajoutés à la session par un composant logiciel enfichable ou un module.
get-command -module ManagementFeatures
Vous pouvez également utiliser la propriété PSSnapin de l'objet que Get-Command retourne pour rechercher le composant logiciel enfichable ou le module dont provient une applet de commande. La huitième commande utilise la notation par points pour rechercher la valeur de la propriété PSSnapin de la commande Set-Alias.
(get-command set-alias).pssnapin
Voir aussi