Update-Help
Baixa e instala os arquivos de ajuda mais recentes em seu computador.
Sintaxe
Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[[-SourcePath] <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-LiteralPath <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Update-Help
baixa os arquivos de ajuda mais recentes para módulos do PowerShell e os instala em seu computador. Você não precisa reiniciar o PowerShell para tornar a alteração eficaz. Você pode usar o cmdlet Get-Help
para exibir os novos arquivos de ajuda imediatamente.
Update-Help
verifica a versão dos arquivos de ajuda em seu computador. Se você não tiver arquivos de ajuda para um módulo ou se os arquivos de ajuda estiverem desatualizados, Update-Help
baixará os arquivos de ajuda mais recentes. Os arquivos de ajuda podem ser baixados e instalados da Internet ou de um compartilhamento de arquivos.
Sem parâmetros, Update-Help
atualiza os arquivos de ajuda para módulos na sessão e para todos os módulos instalados que dão suporte à Ajuda Atualizável. Os módulos instalados, mas não carregados na sessão atual, estão incluídos. Os módulos do PowerShell são armazenados em um local listado na variável de ambiente $env:PSModulePath
.
Para obter mais informações, consulte about_Updatable_Help.
Você pode usar o parâmetro Module para atualizar arquivos de ajuda para um módulo específico. Use o parâmetro UICulture para baixar arquivos de ajuda em vários idiomas e localidades.
Você pode usar Update-Help
em computadores que não estão conectados à Internet. Use o cmdlet Save-Help
para baixar arquivos de ajuda da Internet e salvá-los em um local do sistema de arquivos, como uma pasta compartilhada ou um diretório do sistema de arquivos. Em seguida, use o parâmetro SourcePath de Update-Help
para baixar os arquivos de ajuda atualizados de um local do sistema de arquivos e instalá-los no computador.
Você pode automatizar as atualizações de ajuda adicionando o cmdlet Update-Help
ao seu perfil do PowerShell. Por padrão, Update-Help
é executado apenas uma vez por dia em cada computador. Para substituir o limite uma vez por dia, use o parâmetro Force.
O cmdlet Update-Help
foi introduzido no Windows PowerShell 3.0.
Importante
Update-Help
requer privilégios administrativos.
Você deve ser membro do grupo Administradores no computador para atualizar os arquivos de ajuda para os módulos do PowerShell Core.
Para baixar ou atualizar os arquivos de ajuda para módulos no diretório de instalação do PowerShell ($PSHOME\Modules
), incluindo os módulos do PowerShell Core, inicie o PowerShell usando a opção Executar como administrador.
Por exemplo: Start-Process powershell.exe -Verb RunAs
.
Você também pode atualizar arquivos de ajuda usando o item de menu Da Ajuda do Windows PowerShell no menu Ajuda no ISE (Ambiente de Script Integrado) do Windows PowerShell.
O item de Ajuda atualizar o Windows PowerShell executa um cmdlet Update-Help
sem parâmetros.
Para atualizar a ajuda para módulos no diretório $PSHOME
, inicie o ISE do Windows PowerShell usando a opção Executar como administrador.
Exemplos
Exemplo 1: atualizar arquivos de ajuda para todos os módulos
O cmdlet Update-Help
atualiza arquivos de ajuda para módulos instalados que dão suporte à Ajuda Atualizável. A linguagem de cultura da interface do usuário (interface do usuário) é definida no sistema operacional.
Update-Help
Exemplo 2: atualizar arquivos de ajuda para módulos especificados
O cmdlet Update-Help
atualiza os arquivos de ajuda apenas para nomes de módulo que começam com microsoft.PowerShell.
Update-Help -Module Microsoft.PowerShell*
Exemplo 3: atualizar arquivos de ajuda para idiomas diferentes
O cmdlet Update-Help
atualiza os arquivos de ajuda em japonês (ja-JP) e inglês (en-US) para todos os módulos.
Se um módulo não fornecer arquivos de ajuda para uma cultura de interface do usuário especificada, uma mensagem de erro será exibida para o módulo e a cultura da interface do usuário. Neste exemplo, a mensagem de erro indica que os arquivos de ajuda ja-JP não foram encontrados para o módulo Microsoft.PowerShell.Utility.
Update-Help -UICulture ja-JP, en-US
Update-Help : Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility' with UI culture(s) {ja-JP}
No UI culture was found that matches the following pattern: ja-JP.
Exemplo 4: atualizar arquivos de ajuda automaticamente
Este exemplo cria um trabalho agendado que atualiza a ajuda para todos os módulos todos os dias às 3h.
$jobParams = @{
Name = 'UpdateHelpJob'
Credential = 'Domain01\User01'
ScriptBlock = '{Update-Help}'
Trigger = (New-JobTrigger -Daily -At "3 AM")
}
Register-ScheduledJob @jobParams
Id Name JobTriggers Command Enabled
-- ---- ----------- ------- -------
1 UpdateHelpJob 1 Update-Help True
O cmdlet Register-ScheduledJob
cria um trabalho agendado que executa um comando Update-Help
. O comando usa o parâmetro Credential para executar Update-Help
usando as credenciais de um membro do grupo Administradores no computador. O valor do parâmetro Trigger é um comando New-JobTrigger
que cria um gatilho de trabalho que inicia o trabalho todos os dias às 3h.
Para executar o comando Register-ScheduledJob
, inicie o PowerShell usando a opção Executar como administrador. O PowerShell solicita a senha do usuário especificada no parâmetro de Credenciais
Você pode usar o cmdlet Get-ScheduledJob
para exibir o trabalho agendado, usar o cmdlet Set-ScheduledJob
para alterá-lo e usar o cmdlet Unregister-ScheduledJob
para excluí-lo. Você também pode exibir e gerenciar o trabalho agendado no Agendador de Tarefas no seguinte caminho:
Task Scheduler Library\Microsoft\Windows\PowerShell\ScheduledJobs
.
Exemplo 5: atualizar arquivos de ajuda em vários computadores de um compartilhamento de arquivos
Neste exemplo, os arquivos de ajuda atualizados são baixados da Internet e salvos em um compartilhamento de arquivos. Credenciais de usuário são necessárias que tenham permissões para acessar o compartilhamento de arquivos e instalar atualizações. Quando um compartilhamento de arquivos é usado, é possível atualizar computadores que estão por trás de firewalls ou que não estão conectados à Internet.
PS> Save-Help -DestinationPath \\Server01\Share\PSHelp -Credential Domain01\Admin01
PS> Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {
Update-Help -SourcePath \\Server01\Share\PSHelp -Credential Domain01\Admin01
}
O comando Save-Help
baixa os arquivos de ajuda mais recentes para todos os módulos que dão suporte à Ajuda Atualizável.
O parâmetro DestinationPath salva os arquivos no compartilhamento de arquivos \\Server01\Share\PSHelp
. O parâmetro de Credenciais
O cmdlet Invoke-Command
executa comandos de Update-Help
remotos em vários computadores. O parâmetro ComputerName obtém uma lista de computadores remotos do arquivo Servers.txt. O parâmetro ScriptBlock executa o comando Update-Help
e usa o parâmetro SourcePath para especificar o compartilhamento de arquivos que contém os arquivos de ajuda atualizados. O parâmetro de Credenciais
Exemplo 6: Obter uma lista de arquivos de ajuda atualizados
O cmdlet Update-Help
ajuda para um módulo especificado. O cmdlet usa o parâmetro Verbose comum para exibir a lista de arquivos de ajuda que foram atualizados. Você pode usar detalhados para exibir a saída de todos os arquivos de ajuda ou arquivos de ajuda para um módulo específico.
Sem o parâmetro detalhado
Update-Help -Module Microsoft.PowerShell.Utility -Verbose
Exemplo 7: localizar módulos que dão suporte à Ajuda Atualizável
Este exemplo lista os módulos que dão suporte à Ajuda Atualizável. O comando usa a propriedade HelpInfoUri do módulo para identificar módulos que dão suporte à Ajuda Atualizável. A propriedade HelpInfoUri contém um endereço redirecionado quando o cmdlet Update-Help
é executado.
Get-Module -ListAvailable | Where-Object -Property HelpInfoUri
Directory: C:\program files\powershell\6\Modules
ModuleType Version Name PSEdition ExportedCommands
---------- ------- ---- --------- ----------------
Manifest 6.1.0.0 CimCmdlets Core {Get-CimAssociatedInstance... }
Manifest 1.2.2.0 Microsoft.PowerShell.Archive Desk {Compress-Archive... }
Manifest 6.1.0.0 Microsoft.PowerShell.Diagnostics Core {Get-WinEvent, New-WinEvent}
Directory: C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules
ModuleType Version Name PSEdition ExportedCommands
---------- ------- ---- --------- ----------------
Manifest 2.0.1.0 Appx Core,Desk {Add-AppxPackage, ... }
Script 1.0.0.0 AssignedAccess Core,Desk {Clear-AssignedAccess, ... }
Manifest 1.0.0.0 BitLocker Core,Desk {Unlock-BitLocker, ... }
Exemplo 8: Arquivos de ajuda atualizados de inventário
Neste exemplo, o script Get-UpdateHelpVersion.ps1
cria um inventário dos arquivos de Ajuda Atualizáveis para cada módulo e seus números de versão.
O script identifica módulos que dão suporte à Ajuda Atualizável usando a propriedade HelpInfoUri de módulos. Para módulos que dão suporte à Ajuda Atualizável, o script procura e analisa o arquivo de informações de ajuda (*helpinfo.xml) para localizar o número de versão mais recente.
O script usa a classe PSCustomObject
# Get-UpdateHelpVersion.ps1
Param(
[parameter(Mandatory=$False)]
[String[]]
$Module
)
$HelpInfoNamespace = @{helpInfo='https://schemas.microsoft.com/powershell/help/2010/05'}
if ($Module) { $Modules = Get-Module $Module -ListAvailable | where {$_.HelpInfoUri} }
else { $Modules = Get-Module -ListAvailable | where {$_.HelpInfoUri} }
foreach ($mModule in $Modules)
{
$mDir = $mModule.ModuleBase
if (Test-Path $mdir\*helpinfo.xml)
{
$mName=$mModule.Name
$mNodes = dir $mdir\*helpinfo.xml -ErrorAction SilentlyContinue |
Select-Xml -Namespace $HelpInfoNamespace -XPath "//helpInfo:UICulture"
foreach ($mNode in $mNodes)
{
$mCulture=$mNode.Node.UICultureName
$mVer=$mNode.Node.UICultureVersion
[PSCustomObject]@{"ModuleName"=$mName; "Culture"=$mCulture; "Version"=$mVer}
}
}
}
ModuleName Culture Version
---------- ------- -------
ActiveDirectory en-US 3.0.0.0
ADCSAdministration en-US 3.0.0.0
ADCSDeployment en-US 3.0.0.0
ADDSDeployment en-US 3.0.0.0
ADFS en-US 3.0.0.0
Parâmetros
-Confirm
Solicita a confirmação antes de executar o cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Cargo: | Named |
Valor padrão: | False |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Credential
Especifica as credenciais de um usuário que tem permissão para acessar o local do sistema de arquivos especificado pelo SourcePath. Esse parâmetro é válido somente quando o parâmetro SourcePath ou literalPath é usado no comando.
O parâmetro
Tipo: | PSCredential |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Force
Indica que esse cmdlet não segue a limitação de uma vez por dia, ignora a verificação de versão e baixa arquivos que excedem o limite de 1 GB.
Sem esse parâmetro, Update-Help
é executado apenas uma vez em cada período de 24 horas. Os downloads são limitados a 1 GB de conteúdo não compactado por módulo e os arquivos de ajuda só são instalados quando são mais recentes do que os arquivos existentes no computador.
O limite uma vez por dia protege os servidores que hospedam os arquivos de ajuda e torna prático adicionar um comando Update-Help
ao seu perfil do PowerShell sem incorrer no custo de recursos de conexões ou downloads repetidos.
Para atualizar a ajuda de um módulo em várias culturas de interface do usuário sem o parâmetro Force, inclua todas as culturas de interface do usuário no mesmo comando, como:
Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-FullyQualifiedModule
Especifica módulos com nomes especificados na forma de objetos ModuleSpecification. Esses módulos são descritos na seção Comentários do construtor ModuleSpecification (Hashtable).
Por exemplo, o parâmetro FullyQualifiedModule aceita um nome de módulo especificado no formato:
@{ModuleName = "modulename"; ModuleVersion = "version_number"}
ou
@{ModuleName = "modulename"; ModuleVersion = "version_number"; Guid = "GUID"}.
Não é possível especificar o parâmetro
Tipo: | ModuleSpecification[] |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-LiteralPath
Especifica a pasta para arquivos de ajuda atualizados em vez de baixá-los da Internet. Use esse parâmetro ou o SourcePath se você tiver usado o cmdlet Save-Help
para baixar arquivos de ajuda para um diretório.
Você pode fazer pipeline de um objeto de diretório, como dos cmdlets Get-Item
ou Get-ChildItem
, para Update-Help
.
Ao contrário do valor de SourcePath, o valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como caractere curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. As aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.
Tipo: | String[] |
Aliases: | PSPath |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-Module
Ajuda de atualizações para os módulos especificados. Insira um ou mais nomes de módulo ou padrões de nome em uma lista separada por vírgulas ou especifique um arquivo que lista um nome de módulo em cada linha. Caracteres curinga são permitidos. Você pode pipeline módulos do cmdlet Get-Module
para o cmdlet Update-Help
.
Os módulos especificados devem ser instalados no computador, mas eles não precisam ser importados para a sessão atual. Você pode especificar qualquer módulo na sessão ou qualquer módulo instalado em um local listado na variável de ambiente $env:PSModulePath
.
Um valor de *
(todos) tenta atualizar a ajuda para todos os módulos instalados no computador.
Módulos que não dão suporte à Ajuda Atualizável estão incluídos. Esse valor pode gerar erros quando o comando encontrar módulos que não dão suporte à Ajuda Atualizável. Em vez disso, execute Update-Help
sem parâmetros.
O módulo parâmetro do cmdlet Update-Help
não aceita o caminho completo de um arquivo de módulo ou arquivo de manifesto do módulo. Para atualizar a ajuda de um módulo que não está em um local $env:PSModulePath
, importe o módulo para a sessão atual antes de executar o comando Update-Help
.
Tipo: | String[] |
Aliases: | Name |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | True |
-Recurse
Executa uma pesquisa recursiva para arquivos de ajuda no diretório especificado. Esse parâmetro é válido somente quando o comando usa o parâmetro
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-SourcePath
Especifica uma pasta do sistema de arquivos em que Update-Help
obtém arquivos de ajuda atualizados, em vez de baixá-los da Internet. Insira o caminho de uma pasta. Não especifique um nome de arquivo ou uma extensão de nome de arquivo. Você pode fazer o pipeline de uma pasta, como uma dos cmdlets Get-Item
ou Get-ChildItem
, para Update-Help
.
Por padrão, Update-Help
baixa arquivos de ajuda atualizados da Internet. Use SourcePath quando você tiver usado o cmdlet Save-Help
para baixar arquivos de ajuda atualizados para um diretório.
Para especificar um valor padrão para SourcePath, vá para de Política de Grupo, de Configuração do Computador e Definir o caminho de origem padrão para ode Atualização-Ajuda. Essa configuração de Política de Grupo impede que os usuários usem Update-Help
para baixar arquivos de ajuda da Internet.
Para obter mais informações, consulte about_Group_Policy_Settings.
Tipo: | String[] |
Cargo: | 1 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-UICulture
Especifica valores de cultura da interface do usuário que Update-Help
usa para obter arquivos de ajuda atualizados. Insira um ou mais códigos de idioma, como es-ES, uma variável que contém objetos de cultura ou um comando que obtém objetos de cultura, como um comando Get-Culture
ou Get-UICulture
. Caracteres curinga não são permitidos e você não pode enviar um código de idioma parcial, como de.
Por padrão, Update-Help
obtém arquivos de ajuda na cultura da interface do usuário definida para o sistema operacional. Se você especificar o parâmetro UICulture, Update-Help
procurará ajuda apenas para a cultura de interface do usuário especificada.
Os comandos que usam o parâmetro UICulture são bem-sucedidos somente quando o módulo fornece arquivos de ajuda para a cultura de interface do usuário especificada. Se o comando falhar porque não há suporte para a cultura da interface do usuário especificada, uma mensagem de erro será exibida.
Tipo: | CultureInfo[] |
Cargo: | 2 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-UseDefaultCredentials
Indica que Update-Help
executa o comando, incluindo o download da Internet, usando as credenciais do usuário atual. Por padrão, o comando é executado sem credenciais explícitas.
Esse parâmetro só é eficaz quando o download da Web usa o NTLM (NT LAN Manager), a negociação ou a autenticação baseada em Kerberos.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Tipo: | SwitchParameter |
Aliases: | wi |
Cargo: | Named |
Valor padrão: | False |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Entradas
Você pode redirecionar um caminho de diretório para Update-Help
.
Você pode redirecionar um objeto de módulo do cmdlet Get-Module
para Update-Help
.
Saídas
None
Update-Help
não gera nenhuma saída.
Observações
Para atualizar a ajuda para os módulos do PowerShell Core, que contêm os comandos instalados com o PowerShell ou qualquer módulo no diretório $PSHOME\Modules
, inicie o PowerShell com a opção de Executar como administrador.
Somente os membros do grupo Administradores no computador podem atualizar a ajuda para os módulos do PowerShell Core, os comandos instalados junto com o PowerShell e para módulos na pasta $PSHOME\Modules
. Se você não tiver permissão para atualizar arquivos de ajuda, poderá ler os arquivos de ajuda online. Por exemplo, Get-Help Update-Help -Online
.
Os módulos são a menor unidade de ajuda atualizável. Você não pode atualizar a ajuda para um cmdlet específico. Para localizar o módulo que contém um cmdlet específico, use a propriedade ModuleName do cmdlet Get-Command
, por exemplo, (Get-Command Update-Help).ModuleName
.
Como os arquivos de ajuda estão instalados no diretório do módulo, o cmdlet Update-Help
pode instalar o arquivo de ajuda atualizado apenas para módulos instalados no computador. No entanto, o cmdlet Save-Help
pode salvar a ajuda de módulos que não estão instalados no computador.
Se Update-Help
não encontrar arquivos de ajuda atualizados para um módulo ou não encontrar ajuda atualizada no idioma especificado, ele continuará silenciosamente sem exibir uma mensagem de erro. Para ver os detalhes de status e progresso, use o parâmetro detalhado
O cmdlet Update-Help
foi introduzido no Windows PowerShell 3.0. Ele não funciona em versões anteriores do Windows PowerShell. Em computadores que têm o Windows PowerShell 2.0 e o Windows PowerShell 3.0, use o cmdlet Update-Help
em uma sessão do Windows PowerShell 3.0 para baixar e atualizar arquivos de ajuda. Os arquivos de ajuda estão disponíveis para o Windows PowerShell 2.0 e o Windows PowerShell 3.0.
Os cmdlets Update-Help
e Save-Help
usam as seguintes portas para baixar arquivos de ajuda: Porta 80 para HTTP e porta 443 para HTTPS.
Update-Help
dá suporte a todos os módulos e snap-ins do PowerShell Core. Ele não dá suporte a outros snap-ins.
Para atualizar a ajuda de um módulo em um local que não está listado na variável de ambiente $env:PSModulePath
, importe o módulo para a sessão atual e execute um comando Update-Help
. Execute Update-Help
e Save-Help
não aceita o caminho completo de um arquivo de módulo ou arquivo de manifesto do módulo.
Qualquer módulo pode dar suporte à Ajuda Atualizável. Para obter instruções sobre como dar suporte à Ajuda Atualizável nos módulos que você cria, consulte Suporte à ajuda atualizável.
Os cmdlets Update-Help
e Save-Help
não têm suporte no Windows PE (Ambiente de Pré-Instalação do Windows).