Compartilhar via

Install-Module

  • Referência
Módulo:
PowershellGet

Baixa um ou mais módulos de um repositório e os instala no computador local.

Syntax

Install-Module
       [-Name] <string[]>
       [-MinimumVersion <version>]
       [-MaximumVersion <version>]
       [-RequiredVersion <version>]
       [-Repository <string[]>]
       [-Scope <string>]
       [-Force]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Install-Module
       [-InputObject] <psobject[]>
       [-Scope <string>]
       [-Force]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

O Install-Module cmdlet obtém um ou mais módulos que atendem aos critérios especificados de um repositório online. O cmdlet verifica se os resultados da pesquisa são módulos válidos e copia as pastas do módulo para o local de instalação. Os módulos instalados não são importados automaticamente após a instalação. Você pode filtrar qual módulo é instalado com base nas versões mínima, máxima e exata dos módulos especificados.

Se o módulo que está sendo instalado tiver o mesmo nome ou versão ou contiver comandos em um módulo existente, as mensagens de aviso serão exibidas. Depois de confirmar que deseja instalar o módulo e substituir os avisos, use o -Force parâmetro . Dependendo das configurações do repositório, talvez seja necessário responder a um prompt para que a instalação do módulo continue.

Esses exemplos usam o Galeria do PowerShell como o único repositório registrado. Get-PSRepository exibe os repositórios registrados. Se você tiver vários repositórios registrados, use o -Repository parâmetro para especificar o nome do repositório.

Exemplos

Exemplo 1: Localizar e instalar um módulo

Este exemplo localiza um módulo no repositório e instala o módulo.

Find-Module -Name PowerShellGet | Install-Module

O Find-Module usa o parâmetro Name para especificar o módulo PowerShellGet . Por padrão, a versão mais recente do módulo é baixada do repositório. O objeto é enviado pelo pipeline para o Install-Module cmdlet . Install-Module instala o módulo para todos os usuários no $env:ProgramFiles\WindowsPowerShell\Modules.

Exemplo 2: Instalar um módulo por nome

Neste exemplo, a versão mais recente do módulo PowerShellGet é instalada.

Install-Module -Name PowerShellGet

O Install-Module usa o parâmetro Name para especificar o módulo PowerShellGet . Por padrão, a versão mais recente do módulo é baixada do repositório e instalada.

Exemplo 3: instalar um módulo usando sua versão mínima

Neste exemplo, a versão mínima do módulo PowerShellGet é instalada. O parâmetro MinimumVersion especifica a versão mais baixa do módulo que deve ser instalada. Se uma versão mais recente do módulo estiver disponível, essa versão será baixada e instalada para todos os usuários.

Install-Module -Name PowerShellGet -MinimumVersion 2.0.1

O Install-Module usa o parâmetro Name para especificar o módulo PowerShellGet . O parâmetro MinimumVersion especifica que a versão 2.0.1 é baixada do repositório e instalada. Como a versão 2.0.4 está disponível, essa versão é baixada e instalada para todos os usuários.

Exemplo 4: Instalar uma versão específica de um módulo

Neste exemplo, uma versão específica do módulo PowerShellGet é instalada.

Install-Module -Name PowerShellGet -RequiredVersion 2.0.0

O Install-Module usa o parâmetro Name para especificar o módulo PowerShellGet . O parâmetro RequiredVersion especifica que a versão 2.0.0 é baixada e instalada para todos os usuários.

Exemplo 5: instalar um módulo somente para o usuário atual

Este exemplo baixa e instala a versão mais recente de um módulo, somente para o usuário atual.

Install-Module -Name PowerShellGet -Scope CurrentUser

O Install-Module usa o parâmetro Name para especificar o módulo PowerShellGet . Install-Module baixa e instala a versão mais recente do PowerShellGet no diretório do usuário atual, $home\Documents\WindowsPowerShell\Modules.

Parâmetros

-Confirm

Solicita a confirmação antes de executar o Install-Module cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Instala um módulo e substitui mensagens de aviso sobre conflitos de instalação do módulo. Se já existir um módulo com o mesmo nome no computador, o Force permitirá que várias versões sejam instaladas. Se houver um módulo existente com o mesmo nome e versão, Force substituirá essa versão.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Usado para entrada de pipeline.

Type:PSObject[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-MaximumVersion

Especifica a versão máxima de um único módulo a ser instalado. Se você quiser instalar vários módulos, não poderá usar MaximumVersion. MaximumVersion e RequiredVersion não podem ser usados no mesmo Install-Module comando.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MinimumVersion

Especifica a versão mínima de um único módulo a ser instalado. Se houver uma versão mais recente do módulo disponível, a versão mais recente será instalada. Se você quiser instalar vários módulos, não poderá usar MinimumVersion. MinimumVersion e RequiredVersion não podem ser usados no mesmo Install-Module comando.

Type:String
Aliases:Version
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Especifica os nomes exatos dos módulos a serem instalados por meio da galeria online. Uma lista separada por vírgulas de nomes de módulo é aceita. O nome do módulo deve corresponder ao nome do módulo no repositório. Use Find-Module para obter uma lista de nomes de módulo.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Repository

Use o parâmetro Repositório para especificar qual repositório é usado para baixar e instalar um módulo. Usado quando vários repositórios são registrados. Especifica o nome de um repositório registrado no Install-Module comando . Para registrar um repositório, use Register-PSRepository. Para exibir repositórios registrados, use Get-PSRepository.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequiredVersion

Especifica a versão exata de um único módulo a ser instalado. Se não houver correspondência no repositório para a versão especificada, um erro será exibido. Se você quiser instalar vários módulos, não poderá usar RequiredVersion. RequiredVersion não pode ser usado no mesmo Install-Module comando que MinimumVersion ou MaximumVersion.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Scope

Especifica o escopo de instalação do módulo. Os valores aceitáveis para esse parâmetro são AllUsers e CurrentUser.

O escopo AllUsers instala módulos em um local acessível a todos os usuários do computador:

$env:ProgramFiles\WindowsPowerShell\Modules

O CurrentUser instala módulos em um local acessível apenas para o usuário atual do computador:

$home\Documents\WindowsPowerShell\Modules

Quando nenhum Escopo é definido, o padrão é definido com base na sessão atual:

  • Para uma sessão elevada do PowerShell, o escopo usa como padrão AllUsers.
  • Para sessões do PowerShell não elevadas no PowerShellGet versões 2.0.0 e superiores, o Escopo é CurrentUser.
  • Para sessões não elevadas do PowerShell no PowerShellGet versões 1.6.7 e anteriores, o Escopo é indefinido e Install-Module falha.
Type:String
Accepted values:AllUsers, CurrentUser
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Mostra o que aconteceria se um Install-Module comando fosse executado. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

PSRepositoryItemInfo

Find-Module cria objetos PSRepositoryItemInfo que podem ser enviados pelo pipeline para Install-Module.

Observações

Install-Module é executado no PowerShell 5.0 ou versões posteriores, no Windows 7 ou windows 2008 R2 e versões posteriores do Windows.

Como prática recomendada de segurança, avalie o código de um módulo antes de executar cmdlets ou funções pela primeira vez. Para impedir a execução de módulos que contêm código mal-intencionado, os módulos instalados não são importados automaticamente após a instalação.

Se o nome do módulo especificado pelo parâmetro Name não existir no repositório, Install-Module retornará um erro.

Para instalar vários módulos, use o parâmetro Name e especifique uma matriz separada por vírgulas de nomes de módulo. Se você especificar vários nomes de módulo, não poderá usar MinimumVersion, MaximumVersion ou RequiredVersion. Find-Module cria objetos PSRepositoryItemInfo que podem ser enviados pelo pipeline para Install-Module. O pipeline é outra maneira de especificar vários módulos a serem instalados em um único comando.

Por padrão, os módulos para o escopo de AllUsers são instalados em $env:ProgramFiles\WindowsPowerShell\Modules. O padrão evita confusão quando você instala recursos de Desired State Configuration do PowerShell (DSC).

Uma instalação de módulo falhará e não poderá ser importada se não tiver um .psm1, .psd1ou .dll com o mesmo nome dentro da pasta. Use o parâmetro Force para instalar o módulo.

Se a versão de um módulo existente corresponder ao nome especificado pelo parâmetro Name e o parâmetro MinimumVersion ou RequiredVersion não for usado, Install-Module continuará silenciosamente, mas não instalará o módulo.

Se a versão de um módulo existente for maior que o valor do parâmetro MinimumVersion ou igual ao valor do parâmetro RequiredVersion , continuará silenciosamente, Install-Module mas não instalará o módulo.

Se o módulo existente não corresponder aos valores especificados pelos parâmetros MinimumVersion ou RequiredVersion , ocorrerá um erro no Install-Module comando . Por exemplo, se a versão do módulo instalado existente for menor que o valor MinimumVersion ou não for igual ao valor RequiredVersion .