Install-Module
Descarga uno o varios módulos de un repositorio e los instala en el equipo local.
Sintaxis
NameParameterSet (valor predeterminado)
Install-Module
[-Name] <string[]>
[-MinimumVersion <version>]
[-MaximumVersion <version>]
[-RequiredVersion <version>]
[-Repository <string[]>]
[-Scope <string>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObject
Install-Module
[-InputObject] <psobject[]>
[-Scope <string>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
El Install-Module cmdlet obtiene uno o varios módulos que cumplen los criterios especificados de un repositorio en línea. El cmdlet comprueba que los resultados de búsqueda son módulos válidos y copia las carpetas de módulo en la ubicación de instalación. Los módulos instalados no se importan automáticamente después de la instalación.
Puede filtrar qué módulo se instala en función de las versiones mínimas, máximas y exactas de los módulos especificados.
Si el módulo que se va a instalar tiene el mismo nombre o versión, o contiene comandos en un módulo existente, se muestran los mensajes de advertencia. Después de confirmar que desea instalar el módulo y anular las advertencias, utilice el -Force parámetro. En función de la configuración del repositorio, es posible que tenga que responder a una solicitud de instalación del módulo para continuar.
En estos ejemplos se usa la Galería de PowerShell como único repositorio registrado.
Get-PSRepository muestra los repositorios registrados. Si tiene varios repositorios registrados, use el parámetro para especificar el -Repository nombre del repositorio.
Ejemplos
Ejemplo 1: Buscar e instalar un módulo
En este ejemplo se busca un módulo en el repositorio y se instala el módulo.
Find-Module -Name PowerShellGet | Install-Module
Find-Module usa el parámetro Name para especificar el módulo PowerShellGet. De forma predeterminada, la versión más reciente del módulo se descarga del repositorio. El objeto se envía a la canalización al cmdlet Install-Module.
Install-Module instala el módulo para todos los usuarios de $env:ProgramFiles\WindowsPowerShell\Modules.
Ejemplo 2: Instalación de un módulo por nombre
En este ejemplo, se instala la versión más reciente del módulo PowerShellGet .
Install-Module -Name PowerShellGet
Install-Module usa el parámetro Name para especificar el módulo PowerShellGet. De forma predeterminada, la versión más reciente del módulo se descarga del repositorio y se instala.
Ejemplo 3: Instalación de un módulo con su versión mínima
En este ejemplo, se instala la versión mínima del módulo PowerShellGet . El parámetro MinimumVersion especifica la versión más baja del módulo que se debe instalar. Si hay disponible una versión más reciente del módulo, esa versión se descarga e instala para todos los usuarios.
Install-Module -Name PowerShellGet -MinimumVersion 2.0.1
Install-Module usa el parámetro Name para especificar el módulo PowerShellGet. El parámetro MinimumVersion especifica que la versión 2.0.1 se descarga del repositorio y se instala. Dado que la versión 2.0.4 está disponible, esa versión se descarga e instala para todos los usuarios.
Ejemplo 4: Instalación de una versión específica de un módulo
En este ejemplo, se instala una versión específica del módulo PowerShellGet .
Install-Module -Name PowerShellGet -RequiredVersion 2.0.0
Install-Module usa el parámetro Name para especificar el módulo PowerShellGet. El parámetro RequiredVersion especifica que la versión 2.0.0 se descarga e instala para todos los usuarios.
Ejemplo 5: Instalar un módulo solo para el usuario actual
En este ejemplo se descarga e instala la versión más reciente de un módulo, solo para el usuario actual.
Install-Module -Name PowerShellGet -Scope CurrentUser
Install-Module usa el parámetro Name para especificar el módulo PowerShellGet.
Install-Module descarga e instala la versión más reciente de PowerShellGet en el directorio del usuario actual, $home\Documents\WindowsPowerShell\Modules.
Parámetros
-Confirm
Le pide confirmación antes de ejecutar el cmdlet Install-Module.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | cf |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Force
Instala un módulo e invalida los mensajes de advertencia sobre los conflictos de instalación del módulo. Si ya existe un módulo con el mismo nombre en el equipo, Force permite instalar varias versiones. Si hay un módulo existente con el mismo nombre y versión, Force sobrescribe esa versión.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-InputObject
Se usa para la entrada de canalización.
Propiedades de parámetro
| Tipo: | PSObject[] |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
InputObject
| Posición: | 0 |
| Obligatorio: | True |
| Valor de la canalización: | True |
| Valor de la canalización por nombre de propiedad: | True |
| Valor de los argumentos restantes: | False |
-MaximumVersion
Especifica la versión máxima de un único módulo que se va a instalar. Si desea instalar varios módulos, no puede usar MaximumVersion.
MaximumVersion y RequiredVersion no se pueden usar en el mismo Install-Module comando.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
NameParameterSet
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | True |
| Valor de los argumentos restantes: | False |
-MinimumVersion
Especifica la versión mínima de un único módulo que se va a instalar. Si hay una versión más reciente del módulo disponible, se instala la versión más reciente. Si desea instalar varios módulos, no puede usar MinimumVersion.
MinimumVersion y RequiredVersion no se pueden usar en el mismo Install-Module comando.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | Versión |
Conjuntos de parámetros
NameParameterSet
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | True |
| Valor de los argumentos restantes: | False |
-Name
Especifica los nombres exactos de los módulos que se van a instalar desde la galería en línea. Se acepta una lista separada por comas de nombres de módulo. El nombre del módulo debe coincidir con el nombre del módulo en el repositorio. Use Find-Module para obtener una lista de nombres de módulo.
Propiedades de parámetro
| Tipo: | String[] |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
NameParameterSet
| Posición: | 0 |
| Obligatorio: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | True |
| Valor de los argumentos restantes: | False |
-Repository
Utilice el parámetro Repository para especificar qué repositorio se utiliza para descargar e instalar un módulo. Se usa cuando se registran varios repositorios. Especifica el nombre de un repositorio registrado en el Install-Module comando . Para registrar un repositorio, use Register-PSRepository.
Para mostrar repositorios registrados, use Get-PSRepository.
Propiedades de parámetro
| Tipo: | String[] |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
NameParameterSet
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-RequiredVersion
Especifica la versión exacta de un único módulo que se va a instalar. Si no hay ninguna coincidencia en el repositorio para la versión especificada, se muestra un error. Si desea instalar varios módulos, no puede usar RequiredVersion.
RequiredVersion no se puede usar en el mismo Install-Module comando que MinimumVersion o MaximumVersion.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
NameParameterSet
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | True |
| Valor de los argumentos restantes: | False |
-Scope
Especifica el ámbito de instalación del módulo. Los valores aceptables para este parámetro son AllUsers y CurrentUser.
El ámbito AllUsers instala módulos en una ubicación a la que puedan acceder todos los usuarios del equipo:
$env:ProgramFiles\WindowsPowerShell\Modules
CurrentUser instala módulos en una ubicación a la que solo puede acceder el usuario actual del equipo:
$home\Documents\WindowsPowerShell\Modules
Cuando no se define ningún ámbito , el valor predeterminado se establece en función de la sesión actual:
- En el caso de una sesión de PowerShell con privilegios elevados, el valor predeterminado de Scope es AllUsers.
- En el caso de las sesiones de PowerShell sin privilegios elevados en las versiones 2.0.0 y posteriores de PowerShellGet , el ámbito es CurrentUser.
- En el caso de las sesiones de PowerShell sin privilegios elevados en PowerShellGet versiones 1.6.7 y anteriores, Scope no está definido y
Install-Moduleproduce un error.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Valores aceptados: | AllUsers, CurrentUser |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-WhatIf
Muestra lo que sucedería si se ejecutase un Install-Module comando. El cmdlet no se ejecuta.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | Wi |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
CommonParameters
Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.
Entradas
PSRepositoryItemInfo
Find-Module crea objetos PSRepositoryItemInfo que se pueden enviar por la canalización a Install-Module.
Notas
Install-Module se ejecuta en PowerShell 5.0 o versiones posteriores, en Windows 7 o Windows 2008 R2 y versiones posteriores de Windows.
Como procedimiento recomendado de seguridad, evalúe el código de un módulo antes de ejecutar los cmdlets o funciones por primera vez. Para evitar la ejecución de módulos que contengan código malintencionado, los módulos instalados no se importan automáticamente después de la instalación.
Si el nombre del módulo especificado por el parámetro Name no existe en el repositorio, Install-Module devuelve un error.
Para instalar varios módulos, use el parámetro Name y especifique una matriz separada por comas de nombres de módulo. Si especifica varios nombres de módulo, no puede usar MinimumVersion, MaximumVersion o RequiredVersion.
Find-Module crea objetos PSRepositoryItemInfo que se pueden enviar por la canalización a Install-Module. La canalización es otra manera de especificar varios módulos que se van a instalar en un solo comando.
De forma predeterminada, los módulos para el ámbito de AllUsers se instalan en $env:ProgramFiles\WindowsPowerShell\Modules. El valor predeterminado impide confusiones al instalar recursos de Desired State Configuration (DSC) de PowerShell.
La instalación de un módulo falla y no se puede importar si no tiene un .psm1, .psd1, o .dll del mismo nombre dentro de la carpeta. Use el parámetro Force para instalar el módulo.
Si la versión de un módulo existente coincide con el nombre especificado por el parámetro Name y no se utilizan los parámetros MinimumVersion o RequiredVersion , continúa de forma silenciosa, Install-Module pero no instala el módulo.
Si la versión de un módulo existente es mayor que el valor del parámetro MinimumVersion , o igual que el valor del parámetro RequiredVersion , continúa silenciosamente, Install-Module pero no instala el módulo.
Si el módulo existente no coincide con los valores especificados por los parámetros MinimumVersion o RequiredVersion , se produce un error en el Install-Module comando. Por ejemplo, si la versión del módulo instalado existente es inferior al valor MinimumVersion o no es igual al valor RequiredVersion .