Partilhar via


Install-Module

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

Sintaxe

NameParameterSet (Predefinição)

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

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 está 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, 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 a 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 cmdlet Install-Module. Install-Module Instala o módulo para todos os usuários no $env:ProgramFiles\WindowsPowerShell\Modules.

Exemplo 2: Instalar um módulo pelo nome

Neste exemplo, a versão mais recente do módulo PowerShellGet está 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 está instalada. O parâmetro MinimumVersion especifica a versão mais baixa do módulo que deve ser instalado. 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 está 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 PowerShellEntre no diretório do usuário atual, $home\Documents\WindowsPowerShell\Modules.

Parâmetros

-Confirm

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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 permite a instalação de várias versões. Se houver um módulo existente com o mesmo nome e versão, Force substituirá essa versão.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-InputObject

Usado para entrada de pipeline.

Propriedades dos parâmetros

Tipo:

PSObject[]

Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

InputObject
Position:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-MaximumVersion

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

NameParameterSet
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos: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, você não pode usar MinimumVersion. MinimumVersion e RequiredVersion não podem ser usados no mesmo Install-Module comando.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Versão

Conjuntos de parâmetros

NameParameterSet
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Name

Especifica os nomes exatos dos módulos a serem instalados a partir da galeria online. Uma lista separada por vírgulas de nomes de módulos é 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ódulos.

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

NameParameterSet
Position:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Repository

Use o parâmetro Repository 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.

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

NameParameterSet
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

NameParameterSet
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Scope

Especifica o escopo de instalação do módulo. Os valores aceitáveis para este 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 ao 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 do PowerShell com privilégios elevados, o padrão Scope é AllUsers.
  • Para sessões do PowerShell não elevadas no PowerShellGet versões 2.0.0 e superiores, o Escopo é CurrentUser.
  • Para sessões do PowerShell não elevadas no PowerShellGet versões 1.6.7 e anteriores, o escopo é indefinido e Install-Module falha.

Propriedades dos parâmetros

Tipo:String
Default value:None
Valores aceites:AllUsers, CurrentUser
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-WhatIf

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSRepositoryItemInfo

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

Notas

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 quaisquer cmdlets ou funções pela primeira vez. Para evitar a execução de módulos que contenham 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ódulos. 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 para instalar em um único comando.

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

Uma instalação de módulo falha e não pode ser importada se não tiver um .psm1, .psd1, ou .dll do 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 os parâmetros MinimumVersion ou RequiredVersion não forem usados, continuará silenciosamente, Install-Module 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á Install-Module um erro no comando. Por exemplo, se a versão do módulo instalado existente for inferior ao valor MinimumVersion ou não igual ao valor RequiredVersion .