Compartilhar via

about_Updatable_Help

Descrição curta

Descreve o sistema de ajuda atualizável no PowerShell.

Descrição longa

O PowerShell fornece várias maneiras diferentes de acessar os tópicos de ajuda mais atualizados para cmdlets e conceitos do PowerShell.

O sistema de Ajuda Atualizável, introduzido no PowerShell 3.0, foi projetado para garantir que você sempre tenha os tópicos de ajuda mais recentes em seu computador local para que você possa lê-los na linha de comando. Isso facilita o download e a instalação de arquivos de ajuda e atualizá-los sempre que arquivos de ajuda mais recentes estiverem disponíveis.

Para fornecer ajuda atualizada para vários computadores em uma empresa e para computadores que não têm acesso à Internet, a Ajuda Atualizável permite baixar arquivos de ajuda para um diretório de sistema de arquivos ou compartilhamento de arquivos e, em seguida, instalar os arquivos de ajuda do compartilhamento de arquivos.

No PowerShell 4.0, a propriedade HelpInfoUri é preservada na comunicação remota do Windows PowerShell, o que permite que Save-Help funcionem para módulos instalados em um computador remoto, mas não necessariamente instalados no computador local. Você pode salvar um objeto PSModuleInfo em disco ou mídia removível (como uma unidade USB) executando Export-Clixml em um computador que não tem acesso à Internet, importando o objeto PSModuleInfo em um computador que tenha acesso à Internet e executando Save-Help no objeto PSModuleInfo. A ajuda salva pode ser copiada para o computador remoto desconectado usando mídia removível e instalada executando Update-Help. Essas melhorias na funcionalidade Save-Help permitem instalar ajuda em computadores sem qualquer tipo de acesso à rede. Para obter um exemplo de como usar a nova funcionalidade do Save-Help, consulte Como atualizar a ajuda a partir de um compartilhamento de arquivos usando neste tópico.

A Ajuda Atualizável também dá suporte ao acesso online aos tópicos de ajuda mais recentes e ajuda básica para cmdlets, mesmo quando não há arquivos de ajuda no computador.

O PowerShell não vem com arquivos de Ajuda. Você pode usar o recurso ajuda atualizável para instalar os arquivos de ajuda para todos os comandos incluídos por padrão no PowerShell e para todos os módulos do Windows.

Cmdlets de Ajuda atualizáveis

  • Update-Help: baixa os arquivos de ajuda mais recentes da Internet ou de um compartilhamento de arquivos e os instala no computador local.

  • Save-Help: baixa os arquivos de ajuda mais recentes da Internet e os salva em um diretório do sistema de arquivos ou em um compartilhamento de arquivos. Para instalar os arquivos de ajuda em computadores, use Update-Help.

  • Get-Help: exibe tópicos de ajuda na linha de comando. Obtém ajuda dos arquivos de ajuda no computador. Exibe a ajuda gerada automaticamente para cmdlets e funções que não têm arquivos de ajuda. Abre tópicos de ajuda online para cmdlets, funções, scripts e fluxos de trabalho no navegador de internet padrão.

Ajuda gerada automaticamente: Ajuda sem arquivos de ajuda

Se você não tiver o arquivo de ajuda para um cmdlet, função ou fluxo de trabalho no computador, o cmdlet Get-Help exibirá a ajuda gerada automaticamente e solicitará que você baixe os arquivos de ajuda ou leia-os online.

A ajuda gerada automaticamente inclui sintaxe e aliases, e comentários que explicam como usar os cmdlets de Ajuda Atualizável e acessar os tópicos de ajuda disponíveis online.

Por exemplo, o comando a seguir obtém ajuda básica para o cmdlet Get-Culture. A saída mostra a exibição Get-Help quando não há arquivos de ajuda no computador.

Get-Help Get-Culture

NAME
    Get-Culture

SYNTAX
    Get-Culture [<CommonParameters>]

ALIASES
    None

REMARKS
    To get the latest Help content including descriptions and examples
    type: Update-Help.

Arquivos de ajuda para módulos

A menor unidade de ajuda atualizável é a ajuda para um módulo. A ajuda do módulo inclui ajuda para todos os cmdlets, funções, fluxos de trabalho, provedores, scripts e conceitos em um módulo. Você pode atualizar a ajuda para todos os módulos instalados no computador, mesmo que eles não sejam importados para a sessão atual.

Você pode atualizar a ajuda para todo o módulo, mas não é possível atualizar ajuda para cmdlets individuais.

Para localizar o módulo que contém um cmdlet específico, use o seguinte formato de comando:

(Get-Command <cmdlet-name>).ModuleName

Por exemplo, para localizar o módulo que contém o cmdlet Set-ExecutionPolicy, digite:

(Get-Command Set-ExecutionPolicy).ModuleName

Para atualizar a ajuda de um módulo específico, digite:

Update-Help -Module <ModuleName>

Por exemplo, para atualizar a ajuda para o módulo que contém o cmdlet Set-ExecutionPolicy, digite:

Update-Help -Module Microsoft.PowerShell.Security

Permissões para ajuda atualizável

Para atualizar a ajuda dos módulos no diretório $PSHOME/Modules, você deve ser membro do grupo Administradores no computador.

Se você não for membro do grupo Administradores, não poderá atualizar a ajuda para esses módulos; mas se você tiver acesso à Internet, poderá exibir a ajuda online.

Atualizar a ajuda para módulos no diretório $HOME/Documents/PowerShell/Modules ou módulos em outros subdiretórios do diretório $HOME não requer permissões especiais.

Os cmdlets Update-Help e Save-Help têm um parâmetro UseDefaultCredentials que fornece as credenciais explícitas do usuário atual. Esse parâmetro foi projetado para acessar locais seguros da Internet.

Os cmdlets Update-Help e Save-Help também têm um parâmetro credential que permite executar o comando em um computador remoto e acessar um compartilhamento de arquivos em um terceiro computador. O parâmetro Credencial é válido somente quando você usa os parâmetros SourcePath ou LiteralPath de Update-Help e os parâmetros DestinationPath ou LiteralPath de Save-Help.

Como instalar e atualizar arquivos de ajuda

Para baixar e instalar arquivos de ajuda pela primeira vez ou atualizar os arquivos de ajuda em seu computador, use o cmdlet Update-Help.

O cmdlet Update-Help faz todo o trabalho duro para você, incluindo as tarefas a seguir.

  • Determina quais módulos dão suporte à Ajuda Atualizável.
  • Localiza o local da Internet em que cada módulo armazena seus arquivos de Ajuda Atualizáveis.
  • Compara os arquivos de ajuda de cada módulo em seu computador com os arquivos de ajuda mais recentes disponíveis para cada módulo.
  • Baixa os novos arquivos da Internet.
  • Desembrulha o pacote de arquivos de ajuda.
  • Verifica se os arquivos são arquivos de ajuda válidos.
  • Instala os arquivos de ajuda no subdiretório específico do idioma do diretório do módulo.

Para acessar os novos tópicos de ajuda, use o cmdlet Get-Help. Você não precisa reiniciar o PowerShell.

Para instalar ou atualizar a ajuda para todos os módulos no computador que dão suporte à Ajuda Atualizável, digite:

Update-Help

Para atualizar a ajuda para módulos específicos, adicione o parâmetro Módulo de Update-Help. Caracteres curinga são permitidos no nome do módulo.

Por exemplo, para atualizar a ajuda para o módulo ServerManager, digite:

Update-Help -Module ServerManager

Sem parâmetros, Update-Help atualiza a ajuda para todos os módulos na sessão e para todos os módulos instalados que dão suporte à Ajuda Atualizável. Para serem incluídos, os módulos devem ser instalados em diretórios listados no valor da variável de ambiente PSModulePath. Estes também são módulos retornados por um comando Get-Module -ListAvailable.

Se o valor do parâmetro Módulo for * (todos), Update-Help tentará atualizar a ajuda para todos os módulos instalados, incluindo módulos que não dão suporte à Ajuda Atualizável. Esse comando normalmente gera muitos erros, pois o cmdlet encontra módulos que não dão suporte à Ajuda Atualizável.

Como atualizar a ajuda de um compartilhamento de arquivos

Para dar suporte a computadores que não estão conectados à Internet ou para controlar ou simplificar a atualização de ajuda em uma empresa, use o cmdlet Save-Help. O cmdlet Save-Help baixa arquivos de ajuda da Internet e os salva em um diretório do sistema de arquivos que você especificar.

Save-Help compara os arquivos de ajuda no diretório especificado com os arquivos de ajuda mais recentes disponíveis para cada módulo. Se o diretório não tiver arquivos de ajuda ou arquivos de ajuda mais recentes estiverem disponíveis para o módulo, o cmdlet Save-Help baixará os novos arquivos da Internet. No entanto, ele não desembrulha ou instala os arquivos de ajuda.

Para instalar ou atualizar os arquivos de ajuda em um computador de arquivos de ajuda que foram salvos em um diretório do sistema de arquivos, use o parâmetro SourcePath do cmdlet Update-Help. O cmdlet Update-Help identifica os arquivos de ajuda mais recentes, desembrulha e valida e os instala nos subdiretórios específicos do idioma dos diretórios do módulo.

Por exemplo, para salvar a ajuda de todos os módulos instalados no diretório \\Server\Share, digite:

Save-Help -DestinationPath \\Server\Share

Em seguida, para atualizar a ajuda do diretório \\Server\Share, digite:

Update-Help -SourcePath \\Server\Share

Os exemplos a seguir mostram o uso de Save-Help para salvar a ajuda para módulos que não estão instalados no computador local. Neste exemplo, o administrador executa Save-Help para salvar a ajuda do módulo DhcpServer de um computador cliente conectado à Internet, sem instalar o módulo DhcpServer ou a função de servidor DHCP no computador local.

Opção 1: execute Invoke-Command para obter o objeto PSModuleInfo para o módulo remoto, salve-o em uma variável, $me execute Save-Help no objeto PSModuleInfo especificando a variável $m como o nome do módulo.

$invokeCommandSplat = @{
    ComputerName = 'RemoteServer'
    ScriptBlock = { Get-Module -Name DhcpServer -ListAvailable }
}
$m = Invoke-Command @invokeCommandSplat
Save-Help -Module $m -DestinationPath C:\SavedHelp

Opção 2: Abra uma PSSession voltada para o computador que está executando o módulo do Servidor DHCP, para obter o objeto PSModuleInfo do módulo, salvá-lo em uma variável $me então executar Save-Help no objeto que foi salvo na variável $m.

$s = New-PSSession -ComputerName RemoteServer
$m = Get-Module -PSSession $s -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp

Opção 3: abra uma sessão CIM, direcionada ao computador que está executando o módulo servidor DHCP, para obter o objeto PSModuleInfo para o módulo, salvá-lo em uma variável $me, em seguida, executar Save-Help no objeto salvo na variável $m.

$c = New-CimSession -ComputerName RemoteServer
$m = Get-Module -CimSession $c -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp

No exemplo a seguir, o administrador instala a ajuda para o módulo servidor DHCP em um computador que não tem acesso à rede.

Primeiro, execute Export-Clixml para exportar o objeto PSModuleInfo para uma pasta compartilhada ou para mídia removível.

$m = Get-Module -Name DhcpServer -ListAvailable
Export-Clixml -Path E:\UsbDrive\DhcpModule.xml -InputObject $m

Em seguida, transporte a mídia removível para um computador que tenha acesso à Internet e importe o objeto PSModuleInfo com Import-Clixml. Execute Save-Help para salvar a Ajuda para o módulo DhcpServer importado, objeto PSModuleInfo.

$deserialized_m = Import-Clixml E:\UsbDrive\DhcpModule.xml
Save-Help -Module $deserialized_m -DestinationPath E:\UsbDrive\SavedHelp

Por fim, transporte a mídia removível de volta para o computador que não tem acesso à rede e instale a ajuda executando Update-Help.

Update-Help -Module DhcpServer -SourcePath E:\UsbDrive\SavedHelp

Sem parâmetros, Save-Help baixa ajuda para todos os módulos na sessão e para todos os módulos instalados que dão suporte à Ajuda Atualizável. Para serem incluídos, os módulos devem ser instalados em diretórios listados no valor da variável de ambiente $Env:PSModulePath, no computador local ou em um computador remoto para o qual você deseja salvar a ajuda. Estes também são módulos que são retornados executando um comando Get-Help -ListAvailable.

Como atualizar arquivos de ajuda em diferentes idiomas

Por padrão, os cmdlets Update-Help e Save-Help baixam a ajuda na cultura e no idioma da interface do usuário definidos para o Windows no computador local. Se os arquivos de ajuda para os módulos especificados não estiverem disponíveis na cultura da interface do usuário local, Update-Help e Save-Help usam as regras de fallback de idioma do Windows para localizar o idioma compatível mais adequado.

No entanto, você pode usar os parâmetros UICulture dos cmdlets Update-Help e Save-Help para baixar e instalar arquivos de ajuda em todas as culturas de interface do usuário nas quais eles estão disponíveis.

Por exemplo, para salvar os arquivos de ajuda mais recentes para todos os módulos na sessão em japonês (ja-JP) e francês (fr-FR), digite:

Save-Help -Path \Server\Share -UICulture ja-JP, fr-FR

Se os arquivos de ajuda para os módulos não estiverem disponíveis nos idiomas especificados, os cmdlets Update-Help e Save-Help retornarão uma mensagem de erro que lista os idiomas nos quais a ajuda para cada módulo está disponível para que você possa escolher a alternativa que melhor atenda às suas necessidades.

Nota

Atualmente, o conteúdo da Ajuda Atualizável só é publicado em inglês (en-US).

Como usar a ajuda online

Se você não puder ou optar por não atualizar os arquivos de ajuda em seu computador local, ainda poderá obter os arquivos de ajuda mais recentes online.

Para abrir o tópico de ajuda online para qualquer cmdlet ou função, use o parâmetro Online do cmdlet Get-Help.

Por exemplo, o seguinte comando abre o tópico de ajuda online do cmdlet Get-Job no navegador da Internet padrão:

Get-Help Get-Job -Online

Para obter ajuda online para um script, use o parâmetro Online e o caminho completo para o script.

O parâmetro Online não funciona com tópicos "Sobre". Para ver os tópicos sobre o PowerShell, incluindo tópicos de ajuda sobre a linguagem PowerShell, consulte Tópicos Sobre o PowerShell.

Como minimizar ou impedir downloads na Internet

Para minimizar os downloads da Internet e fornecer ajuda atualizável aos usuários que não estão conectados à Internet, use o cmdlet Save-Help. Baixe a ajuda da Internet e salve-a em um compartilhamento de rede. Em seguida, crie uma configuração de Política de Grupo ou um trabalho agendado que execute um comando Update-Help em todos os computadores. Defina o valor do parâmetro SourcePath do cmdlet Update-Help para o compartilhamento de rede.

Para impedir que os usuários que têm acesso à Internet baixem a Ajuda Atualizável da Internet, use a configuração de Política de Grupo Definir o caminho de origem padrão para o Update-Help.

Essa configuração de Política de Grupo adiciona implicitamente o parâmetro SourcePath, com o local do sistema de arquivos que você especificar, a cada comando Update-Help em cada computador afetado. Os usuários podem usar o parâmetro SourcePath explicitamente para especificar um local de sistema de arquivos diferente, mas não podem excluir o parâmetro SourcePath e baixar a ajuda da Internet.

Nota

A configuração de política de grupo Definir o caminho de origem padrão para o Update-Help aparece em Configuração do Computador e Configuração do Usuário. No entanto, somente a configuração de política em Configuração do computador é efetiva. A configuração de política em Configuração do usuário é ignorada.

Confira mais informações em about_Group_Policy_Settings.

Como atualizar a ajuda para módulos não padrão

Para atualizar ou salvar a ajuda de um módulo que não é retornado pelo parâmetro ListAvailable do cmdlet Get-Module, importe o módulo para a sessão atual antes de executar um comando Update-Help ou Save-Help. Em um computador remoto, antes de executar o Save-Help comando, importe o módulo para a Sessão atual ou Invoke-Command o scriptblock, que está conectado ao computador remoto.

Quando o módulo estiver na sessão atual, execute os cmdlets Update-Help ou Save-Help sem parâmetros ou use o parâmetro módulo para especificar o nome do módulo.

Os parâmetros do módulo dos cmdlets Update-Help e Save-Help aceitam apenas um nome de módulo. Elas não aceitam o caminho para um arquivo de módulo.

Use essa técnica para atualizar ou salvar a ajuda de qualquer módulo que não seja retornado pelo parâmetro ListAvailable do cmdlet Get-Module, como um módulo instalado em um local que não está listado na variável de ambiente $Env:PSModulePath ou um módulo não bem formado (o diretório do módulo não contém pelo menos um arquivo cujo nome base é o mesmo que o nome do diretório).

Como dar suporte à Ajuda Atualizável

Se você criar um módulo, poderá dar suporte à ajuda online e à Ajuda Atualizável para seus módulos. Para obter mais informações, consulte Suporte à Ajuda Atualizável e Suporte à Ajuda Online.

A ajuda atualizável não está disponível para os snap-ins do PowerShell ou para a ajuda baseada em comentários.

Observações

Os cmdlets Update-Help e Save-Help não têm suporte no Windows PE (Ambiente de Pré-Instalação do Windows).

Consulte também

  • Last updated on