Add-PSSnapin
Agrega uno o más complementos de Windows PowerShell a la sesión actual.
Sintaxis
Add-PSSnapin
[-Name] <String[]>
[-PassThru]
[<CommonParameters>]Description
El Add-PSSnapin cmdlet agrega complementos registrados de Windows PowerShell a la sesión actual. Una vez que se agregan los complementos, los cmdlets y los proveedores admitidos por esos complementos se pueden usar en la sesión actual.
Para agregar el complemento a todas las sesiones futuras de Windows PowerShell, agregue un Add-PSSnapin comando al perfil de Windows PowerShell. Para obtener más información, consulte about_Profiles.
A partir de Windows PowerShell 3.0, los comandos principales incluidos en Windows PowerShell se empaquetan en módulos. La excepción es Microsoft.PowerShell.Core, que es un complemento (PSSnapin). De forma predeterminada, solo se agrega el complemento Microsoft.PowerShell.Core a la sesión. Los módulos se importan automáticamente en el primer uso y puede usar el cmdlet Import-Module para importarlos.
Ejemplos
Ejemplo 1: Agregar complementos
PS C:\> Add-PSSnapIn -Name Microsoft.Exchange, Microsoft.Windows.ADEste comando agrega los complementos de Microsoft Exchange y Active Directory a la sesión actual.
Ejemplo 2: Agregar todos los complementos registrados
PS C:\> Get-PSSnapin -Registered | Add-PSSnapin -PassThruEste comando agrega todos los complementos registrados de Windows PowerShell a la sesión. Usa el cmdlet Get-PSSnapin con el parámetro Registered para obtener objetos que representan cada uno de los complementos registrados. El operador de canalización (|) pasa el resultado a Add-PSSnapin, que los agrega a la sesión. El parámetro PassThru devuelve objetos que representan cada uno de los complementos agregados.
Ejemplo 3: Registrar un complemento y agregarlo
El primer comando obtiene complementos que se han agregado a la sesión actual que incluyen los complementos instalados con Windows PowerShell. En este ejemplo, ManagementFeatures no se devuelve. Esto indica que no se ha agregado a la sesión.
El segundo comando obtiene complementos que se han registrado en el sistema, lo que incluye los que ya se han agregado a la sesión. No incluye los complementos instalados con Windows PowerShell. En este caso, el comando no devuelve ningún complemento. Esto indica que el complemento ManagementFeatures no se ha registrado en el sistema.
El tercer comando crea un alias, installutil, para la ruta de acceso de la herramienta InstallUtil en .NET Framework.
El cuarto comando usa la herramienta InstallUtil para registrar el complemento. El comando especifica la ruta de acceso de ManagementCmdlets.dll, el nombre de archivo o el nombre del módulo del complemento.
El quinto comando es el mismo que el segundo comando. Esta vez, se usa para comprobar que el complemento ManagementCmdlets está registrado.
El sexto comando usa el Add-PSSnapin cmdlet para agregar el complemento ManagementFeatures a la sesión. Especifica el nombre del complemento, ManagementFeatures, no el nombre de archivo.
Para comprobar que el complemento se agrega a la sesión, el séptimo comando usa el parámetro Module del cmdlet Get-Command. Muestra los elementos agregados a la sesión por un complemento o módulo.
También puede usar la propiedad PSSnapin del objeto que devuelve el Get-Command cmdlet para buscar el complemento o el módulo en el que se originó un cmdlet. El octavo comando usa la notación de puntos para encontrar el valor de la propiedad PSSnapin del cmdlet 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).pssnapinEn este ejemplo se muestra el proceso de registrar un complemento en el sistema y de agregarlo luego a la sesión. Usa ManagementFeatures, un complemento ficticio implementado en un archivo denominado ManagementCmdlets.dll.
Parámetros
-Name
Especifica el nombre del complemento. Este es el nombre, no assemblyName o ModuleName. Se permiten los caracteres comodín.
Para buscar los nombres de los complementos registrados en el sistema, escriba Get-PSSnapin -Registered.
| Tipo: | String[] |
| Posición: | 0 |
| Valor predeterminado: | None |
| Requerido: | True |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | True |
-PassThru
Indica que este cmdlet devuelve un objeto que representa cada complemento agregado. De forma predeterminada, este cmdlet no genera ningún resultado.
| Tipo: | SwitchParameter |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
Entradas
None
No se pueden canalizar objetos a este cmdlet.
Salidas
None or System.Management.Automation.PSSnapInInfo
Este cmdlet devuelve un objeto PSSnapInInfo que representa el complemento si especifica el parámetro PassThru . De lo contrario, este cmdlet no genera resultados.
Notas
Windows PowerShell incluye los siguientes alias para Add-PSSnapin:
asnp
A partir de Windows PowerShell 3.0, los comandos principales que se instalan con Windows PowerShell se empaquetan en módulos. En Windows PowerShell 2.0 y en programas host que crean sesiones de estilo anterior en versiones posteriores de Windows PowerShell, los comandos principales se empaquetan en complementos (PSSnapins). La excepción es Microsoft.PowerShell.Core, que siempre es un complemento. Además, las sesiones remotas, como las iniciadas por el cmdlet New-PSSession, son sesiones de estilo anterior que incluyen complementos principales.
Para obtener información sobre el método CreateDefault2 que crea sesiones de estilo más reciente con módulos principales, vea CreateDefault2 Method.
Para obtener más información sobre los complementos, vea about_PSSnapins y Cómo crear un complemento de Windows PowerShell.
Add-PSSnapin agrega el complemento solo a la sesión actual. Para agregarlo a todas las sesiones de Windows PowerShell, agréguelo a su perfil de Windows PowerShell. Para obtener más información, consulte about_Profiles.
Puede agregar cualquier complemento que se haya registrado mediante la utilidad de instalación de Microsoft .NET Framework. Para obtener más información, consulte Registro de cmdlets, proveedores y aplicaciones host.
Para obtener una lista de complementos registrados en el equipo, escriba Get-PSSnapin -Registered.
Antes de agregar un complemento, Add-PSSnapin comprueba la versión del complemento para comprobar que es compatible con la versión actual de Windows PowerShell. Si el complemento no supera la comprobación de versión, Windows PowerShell notifica un error.
