about_Modules

Descrição breve

Explica como instalar, importar e usar módulos do PowerShell.

Descrição longa

Um módulo é um pacote que contém membros do PowerShell, como cmdlets, provedores, funções, fluxos de trabalho, variáveis e aliases.

As pessoas que escrevem comandos podem usar módulos para organizar seus comandos e compartilhá-los com outras pessoas. As pessoas que recebem módulos podem adicionar os comandos nos módulos às sessões do PowerShell e usá-los como os comandos internos.

Este tópico explica como usar módulos do PowerShell. Para obter informações sobre como escrever módulos do PowerShell, consulte Escrever um módulo do PowerShell.

O que é um módulo?

Um módulo é um pacote que contém membros do PowerShell, como cmdlets, provedores, funções, fluxos de trabalho, variáveis e aliases. Os membros desse pacote podem ser implementados em um script do PowerShell, em uma DLL compilada ou em uma combinação de ambos. Esses arquivos geralmente são agrupados em um único diretório. Para obter mais informações, consulte Noções básicas sobre um módulo Windows PowerShell na documentação do SDK.

Módulo de carregamento automático

A partir do PowerShell 3.0, o PowerShell importa módulos automaticamente na primeira vez que você executa qualquer comando em um módulo instalado. Agora você pode usar os comandos em um módulo sem qualquer configuração de instalação ou perfil; portanto, não é necessário gerenciar módulos depois de instalá-los em seu computador.

Os comandos em um módulo também são mais fáceis de localizar. O Get-Command cmdlet agora obtém todos os comandos em todos os módulos instalados, mesmo que eles ainda não estejam na sessão. Você pode encontrar um comando e usá-lo sem importar a necessidade de importar o módulo primeiro.

Cada um dos exemplos a seguir faz com que o módulo CimCmdlets, que contém Get-CimInstance, seja importado para sua sessão.

  • Executar o Comando

    Get-CimInstance Win32_OperatingSystem
    
  • Obter o comando

    Get-Command Get-CimInstance
    
  • Obter ajuda para o comando

    Get-Help Get-CimInstance
    

Get-Command comandos que incluem um caractere curinga (*) são considerados para descoberta, não usam e não importam módulos.

Somente os módulos armazenados no local especificado pela variável de ambiente PSModulePath são importados automaticamente. Os módulos em outros locais devem ser importados executando o Import-Module cmdlet.

Além disso, os comandos que usam provedores do PowerShell não importam automaticamente um módulo. Por exemplo, se você usar um comando que exija o WSMan: unidade, como o Get-PSSessionConfiguration cmdlet, talvez seja necessário executar o Import-Module cmdlet para importar o módulo Microsoft.WSMan.Management que inclui a WSMan: unidade.

Você ainda pode executar o Import-Module comando para importar um módulo e usar a $PSModuleAutoloadingPreference variável para habilitar, desabilitar e configurar a importação automática de módulos. Para obter mais informações, consulte about_Preference_Variables.

Como usar um módulo

Para usar um módulo, execute as seguintes tarefas:

  1. Instale o módulo. (Isso é geralmente feito para você.)
  2. Localize os comandos que o módulo adicionou.
  3. Use os comandos que o módulo adicionou.

Este tópico explica como executar essas tarefas. Ele também inclui outras informações úteis sobre o gerenciamento de módulos.

Como instalar um módulo

Se você receber um módulo como uma pasta com arquivos nele, precisará instalá-lo no computador antes de usá-lo no PowerShell.

A maioria dos módulos é instalada por você. O PowerShell vem com vários módulos pré-instalados, às vezes chamados de módulos principais . Em computadores baseados no Windows, se os recursos incluídos no sistema operacional tiverem cmdlets para gerenciá-los, esses módulos serão pré-instalados. Quando você instala um recurso do Windows usando, por exemplo, o Assistente para Adicionar Funções e Recursos no Gerenciador do Servidor ou a caixa de diálogo Ativar ou desativar recursos do Windows em Painel de Controle, todos os módulos do PowerShell que fazem parte do recurso serão instalados. Muitos outros módulos têm um instalador ou um programa de Instalação que instala o módulo.

Use o seguinte comando para criar um diretório Modules para o usuário atual:

New-Item -Type Directory -Path $HOME\Documents\PowerShell\Modules

Copie a pasta de módulo inteira para o diretório Modules. Você pode usar qualquer método para copiar a pasta, incluindo o Windows Explorer e Cmd.exe, bem como o PowerShell. No PowerShell, use o Copy-Item cmdlet. Por exemplo, para copiar a pasta MyModule do C:\ps-test\MyModule diretório Módulos, digite:

Copy-Item -Path C:\ps-test\MyModule -Destination `
    $HOME\Documents\PowerShell\Modules

Você pode instalar um módulo em qualquer local, mas instalar os módulos em um local padrão de módulo torna-os mais fáceis de gerenciar. Para obter mais informações sobre os locais padrão do módulo, consulte a seção Módulo e DSC Resource Locations e PSModulePath .

Como localizar módulos instalados

Para localizar os módulos que são instalados em um local de módulo padrão, mas ainda não foram importados para a sessão, digite:

Get-Module -ListAvailable

Para localizar os módulos que já foram importados para sua sessão, no prompt do PowerShell, digite:

Get-Module

Para obter mais informações sobre o Get-Module cmdlet, consulte Get-Module.

Como localizar os comandos em um módulo

Use o Get-Command cmdlet para localizar todos os comandos disponíveis. Você pode usar os parâmetros do Get-Command cmdlet para filtrar comandos como por módulo, nome e substantivo.

Para localizar todos os comandos em um módulo, digite:

Get-Command -Module <module-name>

Por exemplo, para localizar os comandos no módulo BitsTransfer, digite:

Get-Command -Module BitsTransfer

Para obter mais informações sobre o Get-Command cmdlet, consulte Get-Command.

Como obter ajuda para os comandos em um módulo

Se o módulo contiver arquivos de Ajuda para os comandos exportados, o Get-Help cmdlet exibirá os tópicos da Ajuda. Use o mesmo Get-Help formato de comando que você usaria para obter ajuda para qualquer comando no PowerShell.

A partir do PowerShell 3.0, você pode baixar arquivos de Ajuda para um módulo e baixar atualizações nos arquivos de Ajuda para que eles nunca fiquem obsoletos.

Para obter ajuda para os comandos em um módulo, digite:

Get-Help <command-name>

Para obter ajuda online para o comando em um módulo, digite:

Get-Help <command-name> -Online

Para baixar e instalar os arquivos de ajuda para os comandos em um módulo, digite:

Update-Help -Module <module-name>

Para obter mais informações, consulte Get-Help e Update-Help.

Como importar um módulo

Você pode precisar importar um módulo ou importar um arquivo de módulo. A importação é necessária quando um módulo não é instalado nos locais especificados pela variável $env:PSModulePathde ambiente PSModulePath, ou o módulo consiste em arquivo, como um arquivo .dll ou .psm1, em vez de um módulo típico que é entregue como uma pasta.

Você também pode optar por importar um módulo para que possa usar os parâmetros do Import-Module comando, como o parâmetro Prefixo, que adiciona um prefixo distinto aos nomes de substantivos de todos os comandos importados ou ao parâmetro NoClobber , o que impede que o módulo adicione comandos que ocultariam ou substituiriam comandos existentes na sessão.

Para importar módulos, use o Import-Module cmdlet.

Para importar os módulos em um local de PSModulePath para a sessão atual, use o seguinte formato de comando.

Import-Module <module-name>

Por exemplo, o comando a seguir importa o módulo BitsTransfer para a sessão atual.

Import-Module BitsTransfer

Para importar um módulo que não está em um local padrão de módulo, use o caminho totalmente qualificado para a pasta de módulo no comando.

Por exemplo, para adicionar o módulo TestCmdlets no C:\ps-test diretório à sessão, digite:

Import-Module C:\ps-test\TestCmdlets

Para importar um arquivo de módulo que não está contido em uma pasta de módulo, use o caminho totalmente qualificado para o arquivo de módulo no comando.

Por exemplo, para adicionar o módulo TestCmdlets.dll no C:\ps-test diretório à sessão, digite:

Import-Module C:\ps-test\TestCmdlets.dll

Para obter mais informações sobre como adicionar módulos à sessão, consulte Import-Module.

Como importar um módulo para cada sessão

O Import-Module comando importa módulos para sua sessão atual do PowerShell. Para importar um módulo para cada sessão do PowerShell iniciada, adicione o Import-Module comando ao seu perfil do PowerShell.

Para obter mais informações sobre perfis, consulte about_Profiles.

Como remover um módulo

Quando você remove um módulo, os comandos que o módulo adicionou são excluídos da sessão.

Para remover um módulo da sessão, use o seguinte formato de comando.

Remove-Module <module-name>

Por exemplo, o comando a seguir remove o módulo BitsTransfer da sessão atual.

Remove-Module BitsTransfer

Remover um módulo inverte a operação de importação de um módulo. Remover um módulo não desinstala o módulo. Para obter mais informações, consulte Remove-Module.

Locais de recursos de módulo e DSC e PSModulePath

A $env:PSModulePath variável de ambiente contém uma lista de locais de pasta que são pesquisados para localizar módulos e recursos.

Por padrão, os locais efetivos atribuídos $env:PSModulePath são:

  • Locais em todo o sistema: $PSHOME\Modules

    Essas pastas contêm módulos que são fornecidos com o Windows e o PowerShell.

    Os recursos DSC incluídos no PowerShell são armazenados na $PSHOME\Modules\PSDesiredStateConfiguration\DSCResources pasta.

  • Módulos específicos do usuário: são módulos instalados pelo usuário no escopo do usuário. Install-Module tem um parâmetro Scope que permite especificar se o módulo está instalado para o usuário atual ou para todos os usuários. Para obter mais informações, consulte Install-Module.

    O local do CurrentUser específico do usuário no Windows é a PowerShell\Modules pasta localizada na localização documentos em seu perfil de usuário. O caminho específico desse local varia de acordo com a versão do Windows e se você está usando ou não o redirecionamento de pasta. O Microsoft OneDrive também pode alterar o local da pasta Documentos .

    Por padrão, em Windows 10 e superior, esse local é $HOME\Documents\PowerShell\Modules. No Linux ou no Mac, o local do CurrentUser é $HOME/.local/share/powershell/Modules.

    Observação

    Você pode verificar o local da pasta Documentos usando o seguinte comando: [Environment]::GetFolderPath('MyDocuments').

  • O local dos AllUsers está $env:PROGRAMFILES\PowerShell\Modules no Windows. No Linux ou no Mac, os módulos são armazenados em /usr/local/share/powershell/Modules.

Observação

Para adicionar ou alterar arquivos no diretório, inicie o $env:Windir\System32 PowerShell com a opção Executar como administrador .

Você pode alterar os locais padrão do módulo em seu sistema alterando o valor da variável de ambiente PSModulePath. $Env:PSModulePath A variável de ambiente PSModulePath é modelada na variável de ambiente Path e tem o mesmo formato.

Para exibir os locais padrão de módulo, digite:

$Env:PSModulePath

Para adicionar um local padrão de módulo, use o seguinte formato de comando.

$Env:PSModulePath = $Env:PSModulePath + ";<path>"

O ponto e vírgula (;) no comando separa o novo caminho do caminho que o precede na lista.

Por exemplo, para adicionar o C:\ps-test\Modules diretório, digite:

$Env:PSModulePath + ";C:\ps-test\Modules"

Para adicionar um local de módulo padrão no Linux ou no MacOS, use o seguinte formato de comando:

$Env:PSModulePath += ":<path>"

Por exemplo, para adicionar o /usr/local/Fabrikam/Modules diretório ao valor da variável de ambiente PSModulePath , digite:

$Env:PSModulePath += ":/usr/local/Fabrikam/Modules"

No Linux ou no MacOS, os dois-pontos (:) no comando separam o novo caminho do caminho que o precede na lista.

Quando você adiciona um caminho ao PSModulePath e Get-ModuleImport-Module os comandos incluem módulos nesse caminho.

O valor que você define afeta apenas a sessão atual. Para tornar a alteração persistente, adicione o comando ao seu perfil do PowerShell ou use o Sistema em Painel de Controle para alterar o valor da variável de ambiente PSModulePath no Registro.

Além disso, para tornar a alteração persistente, você também pode usar o método SetEnvironmentVariable da classe System.Environment para adicionar um caminho à variável de ambiente PSModulePath .

Para obter mais informações sobre a variável PSModulePath , consulte about_Environment_Variables.

Módulos e conflitos de nome

Os conflitos de nome ocorrem quando mais de um comando na sessão tem o mesmo nome. Importar um módulo provoca um conflito de nome quando os comandos no módulo têm os mesmos nomes de comandos ou itens na sessão.

Os conflitos de nome podem resultar em comandos sendo ocultados ou substituídos.

Hidden

Um comando é ocultado quando ele não é o comando que é executado quando você digita o nome do comando, mas você pode executá-lo usando outro método, como qualificar o nome do comando com o nome do módulo ou snap-in na qual ele se originou.

Substituído

Um comando é substituído quando você não pode executá-lo porque ele foi substituído por um comando com o mesmo nome. Mesmo quando você remove o módulo que causou o conflito, não é possível executar um comando substituído, a menos que você reinicie a sessão.

Import-Module pode adicionar comandos que ocultam e substituem comandos na sessão atual. Além disso, os comandos na sessão podem ocultar os comandos que o módulo adicionou.

Para detectar conflitos de nome, use o parâmetro All do Get-Command cmdlet. A partir do PowerShell 3.0, Get-Command obtém apenas os comandos executados quando você digita o nome do comando. O parâmetro All obtém todos os comandos com o nome específico na sessão.

Para evitar conflitos de nome, use os parâmetros NoClobber ou Prefix do Import-Module cmdlet. O parâmetro prefixo adiciona um prefixo aos nomes dos comandos importados para que eles sejam exclusivos na sessão. O parâmetro NoClobber não importa nenhum comando que oculte ou substitua os comandos existentes na sessão.

Você também pode usar os parâmetrosImport-Module Alias, Cmdlet, Function e Variable para selecionar apenas os comandos que deseja importar e excluir comandos que causam conflitos de nome em sua sessão.

Os autores do módulo podem evitar conflitos de nome usando a propriedade DefaultCommandPrefix do manifesto do módulo para adicionar um prefixo padrão a todos os nomes de comando. O valor do parâmetro Prefixo tem precedência sobre o valor de DefaultCommandPrefix.

Mesmo se um comando estiver oculto, você poderá executá-lo qualificando o nome de comando com o nome do módulo ou snap-in no qual ele foi originado.

As regras de precedência de comando do PowerShell determinam qual comando é executado quando a sessão inclui comandos com o mesmo nome.

Por exemplo, quando uma sessão inclui uma função e um cmdlet com o mesmo nome, o PowerShell executa a função por padrão. Quando a sessão inclui comandos do mesmo tipo com o mesmo nome, como dois cmdlets com o mesmo nome, por padrão, ela executa o comando adicionado mais recentemente.

Para obter mais informações, incluindo uma explicação das regras de precedência e instruções para executar comandos ocultos, consulte about_Command_Precedence.

Módulos e snap-ins

Você pode adicionar comandos à sessão por meio de módulos e snap-ins. Os módulos podem adicionar todos os tipos de comandos, incluindo cmdlets, provedores e funções e itens, como variáveis, aliases e unidades do PowerShell. Os Snap-ins podem adicionar apenas os cmdlets e provedores.

Antes de remover um módulo ou snap-in da sessão, use os comandos a seguir para determinar quais comandos serão removidos.

Para localizar a origem de um cmdlet em sua sessão, use o seguinte formato de comando:

Get-Command <cmdlet-name> | Format-List -Property verb,noun,pssnapin,module

Por exemplo, para localizar a origem do Get-Date cmdlet, digite:

Get-Command Get-Date | Format-List -Property verb,noun,module

Os comandos exportados por um módulo devem seguir as regras de nomenclatura de comando do PowerShell. Se o módulo que você importar exportar cmdlets ou funções que têm verbos não aprovados em seus nomes, o Import-Module cmdlet exibirá a seguinte mensagem de aviso.

AVISO: Alguns nomes de comando importados incluem verbos não aprovados que podem torná-los menos detectáveis. Use o parâmetro Verbose para obter mais detalhes ou digite Get-Verb para ver a lista de verbos aprovados."

A mensagem é apenas um aviso. O módulo completo ainda é importado, incluindo os comandos não autorizados. Embora a mensagem seja exibida para usuários do módulo, o problema de nomenclatura deve ser corrigido pelo autor do módulo.

Para suprimir a mensagem de aviso, use o parâmetro DisableNameChecking do Import-Module cmdlet.

Módulos internos e snap-ins

No PowerShell 2.0 e em programas host de estilo antigo no PowerShell 3.0 e posteriores, os comandos principais instalados com o PowerShell são empacotados em snap-ins que são adicionados automaticamente a cada sessão do PowerShell.

A partir do PowerShell 3.0, para programas host que implementam a InitialSessionState.CreateDefault2 API de estado de sessão inicial, o snap-in Microsoft.PowerShell.Core é adicionado a cada sessão por padrão. Os módulos são carregados automaticamente no primeiro uso.

Observação

Sessões remotas, incluindo sessões iniciadas usando o New-PSSession cmdlet, são sessões de estilo mais antigo nas quais os comandos internos são empacotados em snap-ins.

Os módulos a seguir (ou snap-ins) são instalados com o PowerShell.

  • CimCmdlets
  • Microsoft.PowerShell.Archive
  • Microsoft.PowerShell.Core
  • Microsoft.PowerShell.Diagnostics
  • Microsoft.PowerShell.Host
  • Microsoft.PowerShell.Management
  • Microsoft.PowerShell.Security
  • Microsoft.PowerShell.Utility
  • Microsoft.WSMan.Management
  • PackageManagement
  • PowerShellGet
  • PSDesiredStateConfiguration
  • PSDiagnostics
  • PSReadline

Eventos do módulo de log

A partir do PowerShell 3.0, você pode gravar eventos de execução para os cmdlets e funções em módulos e snap-ins do PowerShell definindo a propriedade LogPipelineExecutionDetails de módulos e snap-ins como $True. Você também pode usar uma configuração de Política de Grupo, Ativar o Log do Módulo, para habilitar o log do módulo em todas as sessões do PowerShell. Para obter mais informações, consulte os artigos de política de grupo e registro em log.

Confira também