Agrega uno o más complementos de Windows PowerShell a la sesión actual.
Sintaxis
Add-PSSnapin [-Name] <string[]> [-PassThru] [<CommonParameters>]
Descripción
El cmdlet Add-PSSnapin agrega complementos registrados de Windows PowerShell a la sesión actual. Una vez agregados los complementos, puede usar los cmdlets y proveedores que los complementos admiten en la sesión actual.
Para agregar el complemento a todas las sesiones futuras de Windows PowerShell, agregue un comando Add-PSSnapin al perfil de Windows PowerShell. Para obtener más información, vea about_Profiles.
Parámetros
-Name <string[]>
Especifica el nombre del complemento. (Se trata de Name, no AssemblyName ni ModuleName).
Para buscar los nombres de los complementos registrados en el sistema, escriba "Get-PSSnapin -registered".
|
¿Requerido? |
true |
|
¿Posición? |
1 |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
true (ByPropertyName) |
|
¿Aceptar caracteres comodín? |
false |
-PassThru
Devuelve un objeto que representa cada complemento agregado. De forma predeterminada, este cmdlet no genera resultados.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, vea about_Commonparameters.
Entradas y salidas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet. El tipo devuelto es el tipo de los objetos que el cmdlet devuelve.
|
Entradas |
Ninguno No se pueden canalizar objetos a Add-PSSnapin. |
|
Salidas |
Ninguno o System.Management.Automation.PSSnapInInfo Cuando se utiliza el parámetro PassThru, Add-PSSnapin devuelve un objeto PSSnapInInfo que representa el complemento. En caso contrario, este cmdlet no genera resultados. |
Notas
Para obtener información detallada acerca de los complementos de Windows PowerShell, vea about_Pssnapins. Para obtener información sobre cómo crear un complemento de Windows PowerShell, vea el artículo acerca de cómo crear complementos de Windows PowerShell en MSDN (Microsoft Developer Network) Library en https://go.microsoft.com/fwlink/?LinkId=144762.
Add-PSSnapin agrega el complemento solamente a la sesión actual. Para agregar el complemento a todas las sesiones de Windows PowerShell, agréguelo al perfil de Windows PowerShell. Para obtener más información, vea about_Profiles.
Puede agregar cualquier complemento de Windows PowerShell registrado mediante la utilidad de instalación de Microsoft .NET Framework. Para obtener más información, vea el tema referente al registro de cmdlets, proveedores y aplicaciones host en MSDN (Microsoft Developer Network) Library, en https://go.microsoft.com/fwlink/?LinkID=143619.
Para obtener una lista de los complementos registrados en el equipo, escriba "Get-PSSnapin -registered".
Antes de agregar un complemento, Add-PSSnapin comprueba la versión del mismo para ver si es compatible con la versión actual de Windows PowerShell. Si la versión del complemento no es válida, Windows PowerShell generará un mensaje de error.
Ejemplo 1
C:\PS>add-PSSnapIn Microsoft.Exchange, Microsoft.Windows.AD Descripción ----------- Este comando agrega los complementos Microsoft Exchange y Active Directory a la sesión actual.
Ejemplo 2
C:\PS>get-pssnapin -registered | add-pssnapin -passthru Descripción ----------- Este 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 los objetos que representan cada uno de los complementos agregados.
Ejemplo 3
C:\PS>get-pssnapin
Descripción
-----------
En este ejemplo se muestra el proceso de registrar un complemento en el sistema y agregarlo después a la sesión. Utiliza ManagementFeatures, un complemento ficticio implementado en un archivo denominado ManagementCmdlets.dll.
El primer comando obtiene los complementos que se han agregado a la sesión actual, incluidos los complementos que se instalan con Windows PowerShell. En este ejemplo, no se devuelve ManagementFeatures. Esto indica que no se ha agregado a la sesión.
get-pssnapin
El segundo comando obtiene los complementos que se han registrado en el sistema (incluidos los que ya se han agregado a la sesión). No incluye los complementos que se instalan con Windows PowerShell.
get-pssnapin -registered
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 a la herramienta InstallUtil en .NET Framework.
set-alias installutil $env:windir\Microsoft.NET\Framework\v2.0.50727\installutil.exe
El cuarto comando utiliza la herramienta InstallUtil para registrar el complemento. El comando especifica la ruta de acceso a ManagementCmdlets.dll, nombre de archivo o "nombre de módulo" del complemento.
installutil C:\Dev\Management\ManagementCmdlets.dll
El quinto comando es igual que el segundo. Esta vez, se utiliza para comprobar que el complemento ManagementCmdlets se ha registrado.
get-pssnapin -registered
El sexto comando usa el cmdlet Add-PSSnapin para agregar el complemento ManagementFeatures a la sesión. Especifica el nombre del complemento, ManagementFeatures, no el nombre de archivo.
add-pssnapin ManagementFeatures
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.
get-command -module ManagementFeatures
También se puede utilizar la propiedad PSSnapin del objeto que Get-Command devuelve para buscar el complemento o módulo en que se origina un cmdlet. El octavo comando utiliza la notación de puntos para buscar el valor de la propiedad PSSnapin del comando Set-Alias.
(get-command set-alias).pssnapin
Vea también