Save-Help

O cmdlet Save-Help baixa os arquivos de ajuda mais recentes para módulos do PowerShell e os salva em um diretório que você especificar. Esta funcionalidade permite-lhe atualizar os ficheiros de ajuda em computadores que não têm acesso à Internet e facilita a atualização dos ficheiros de ajuda em vários computadores. Este cmdlet foi introduzido no Windows PowerShell 3.0.

A partir do Windows PowerShell 4.0, você pode usar Save-Help para baixar arquivos de ajuda para módulos instalados em computadores remotos. Também é possível salvar um objeto PSModuleInfo usando Export-Clixml em um computador que não tenha acesso à Internet, importar o objeto em um computador que tenha acesso à Internet e, em seguida, executar Save-Help no objeto PSModuleInfo. Depois de ter a ajuda salva, você pode copiá-lo para o computador remoto e instalá-lo executando Update-Help. Esse processo pode ser usado para instalar a ajuda em computadores que não têm nenhum tipo de acesso à rede.

Sem parâmetros, um comando Save-Help baixa a ajuda mais recente para todos os módulos da sessão e para módulos instalados no computador em um local listado na variável de ambiente PSModulePath. Esta ação ignora módulos que não suportam Ajuda Atualizável sem aviso.

O cmdlet Save-Help verifica a versão de todos os arquivos de ajuda na pasta de destino. Se estiverem disponíveis ficheiros de ajuda mais recentes, este cmdlet transfere os ficheiros de ajuda mais recentes da Internet e, em seguida, guarda-os na pasta. O cmdlet Save-Help funciona exatamente como o cmdlet Update-Help, exceto que ele salva o conteúdo baixado, em vez de extrair os arquivos de ajuda e instalá-los no computador.

A ajuda salva para cada módulo consiste em um arquivo de informações de ajuda (HelpInfo XML) e um gabinete ou arquivo ZIP (.cab ou .zip) para os arquivos de ajuda em cada idioma. No Windows, o comando baixa os arquivos de gabinete. No Linux e macOS, o comando baixa arquivos ZIP.

Para salvar os arquivos de ajuda dos módulos na pasta de instalação do PowerShell ($PSHOME\Modules), inicie o PowerShell usando a opção Executar como administrador. Tem de ser membro do grupo Administradores no computador para transferir os ficheiros de ajuda para estes módulos.

Para instalar arquivos de ajuda salvos, execute Update-Help com o parâmetro SourcePath para especificar a pasta que contém os arquivos de Ajuda salvos. Update-Help extrai os arquivos de ajuda do arquivo morto e os instala no local apropriado.

Este exemplo mostra três maneiras diferentes de usar Save-Help para salvar a ajuda para o módulo DhcpServer de um computador cliente conectado à Internet, sem instalar o módulo DhcpServer ou a função Servidor DHCP no computador local.

# Option 1:
# 1. Run Invoke-Command to get the PSModuleInfo object for the DhcpServer module,
# 2. Save-Help on the PSModuleInfo object to save the help files to a folder on
#    the local computer.

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


# Option 2:
# 1. Open a PSSession to the remote computer that's running the DhcpServer module
# 2. Get the PSModuleInfo object from the remote computer
# 3. Save-Help on the PSModuleInfo object

$session = New-PSSession -ComputerName "RemoteServer"
$mod = Get-Module -PSSession $session -Name "DhcpServer" -ListAvailable
Save-Help -Module $mod -DestinationPath C:\SavedHelp


# Option 3:
# 1. Open a CimSession to the remote computer that's running the DhcpServer module
# 2. Get the PSModuleInfo object from the remote computer
# 3. Save-Help on the PSModuleInfo object
$cimsession = New-CimSession -ComputerName "RemoteServer"
$mod = Get-Module -CimSession $cimsession -Name "DhcpServer" -ListAvailable
Save-Help -Module $mod -DestinationPath "C:\SavedHelp"

Este exemplo mostra como instalar a ajuda para um computador que não está conectado à rede. Neste exemplo, o primeiro computador não está conectado a uma rede acessível. Os arquivos devem ser copiados para ele usando mídia removível. O segundo computador está conectado à internet e pode baixar os arquivos de ajuda.

# On the first computer, get the PSModuleInfo object for the module and save it to
# removable media.

Get-Module -Name "DhcpServer" -ListAvailable |
    Export-CliXml -Path E:\UsbFlashDrive\DhcpModule.xml

# Move the removable media to a computer that has internet access, and then import the
# PSModuleInfo object. Run Save-Help on the imported PSModuleInfo object and save the help
# files to the removable media.

$moduleInfo = Import-CliXml E:\UsbFlashDrive\DhcpModule.xml
Save-Help -Module $moduleInfo -DestinationPath E:\UsbFlashDrive\SavedHelp

# Finally, move the removable media back to the first computer and install the help.

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

Este comando transfere os ficheiros de ajuda mais recentes para todos os módulos no computador local. Ele salva os arquivos de ajuda na pasta \\Server01\Fileshare01.

Save-Help -DestinationPath \\Server01\FileShare01

Este comando transfere os ficheiros de ajuda mais recentes para o módulo ServerManager e, em seguida, guarda-os na pasta \\Server01\Fileshare01.

$saveHelpSplat = @{
    Module = 'ServerManager'
    DestinationPath = '\\Server01\FileShare01'
    Credential = 'Domain01/Admin01'
}
Save-Help @saveHelpSplat

Quando um módulo é instalado no computador, você pode digitar o nome do módulo como o valor do parâmetro Module, mesmo que o módulo não seja importado para a sessão atual.

O comando usa o parâmetro Credential para fornecer as credenciais de um usuário que tem permissão para gravar no compartilhamento de arquivos.

Esses comandos baixam os arquivos de ajuda mais recentes para o módulo CustomSQL do e os salvam na pasta \\Server01\Fileshare01.

Invoke-Command -ComputerName Server02 { Get-Module -Name CustomSQL -ListAvailable } |
    Save-Help -DestinationPath \\Server01\FileShare01 -Credential Domain01\Admin01

Como o módulo CustomSQL não está instalado no computador, a sequência inclui um comando Invoke-Command que obtém o objeto module para o módulo CustomSQL do computador Server02 e, em seguida, canaliza o objeto module para o cmdlet Save-Help.

Quando um módulo não está instalado no computador, Save-Help precisa do objeto module, que inclui informações sobre o local dos arquivos de ajuda mais recentes.

Este comando salva a ajuda para os módulos principais do PowerShell em quatro culturas de interface do usuário diferentes. Os pacotes de idiomas para essas localidades não precisam ser instalados no computador.

$saveHelpSplat = @{
    Module = 'Microsoft.PowerShell*'
    UICulture = 'de-DE', 'en-US', 'fr-FR', 'ja-JP'
    DestinationPath = "D:\Help"
}
Save-Help @saveHelpSplat

Save-Help pode baixar arquivos de ajuda para módulos em diferentes culturas de interface do usuário somente quando o proprietário do módulo disponibiliza os arquivos traduzidos na Internet.

Este comando salva a ajuda de todos os módulos instalados no computador. O comando especifica o parâmetro Force para substituir a regra que impede que o cmdlet Save-Help baixe a ajuda mais de uma vez em cada período de 24 horas.

Save-Help -Force -DestinationPath \\Server3\AdminShare\Help

O parâmetro Force também substitui a restrição de 1 GB e contorna a verificação de versão. Portanto, você pode baixar arquivos mesmo que a versão não seja posterior à versão na pasta de destino.

O comando usa o cmdlet Save-Help para baixar e salvar os arquivos de ajuda na pasta especificada. O parâmetro Force é necessário quando você precisa executar um comando Save-Help mais de uma vez por dia.

PSModuleInfo

Você pode canalizar um objeto de módulo para este cmdlet.

None

Este cmdlet não retorna nenhuma saída.

• Para salvar a ajuda para módulos na pasta $PSHOME\Modules, inicie o PowerShell usando a opção Executar como administrador. Somente os membros do grupo Administradores no computador podem baixar a ajuda para módulos na pasta $PSHOME\Modules.
• A ajuda salva para cada módulo consiste em um arquivo de informações de ajuda (HelpInfo XML) e um arquivo de gabinete (.cab) para os arquivos de ajuda de cada cultura da interface do usuário. Não é necessário extrair os arquivos de ajuda do arquivo de gabinete. O cmdlet Update-Help extrai os arquivos de ajuda, valida o XML e instala os arquivos de ajuda e o arquivo de informações de ajuda em uma subpasta específica do idioma da pasta do módulo.
• O cmdlet Save-Help pode salvar a ajuda para módulos que não estão instalados no computador. No entanto, como os arquivos de ajuda são instalados na pasta module, o cmdlet Update-Help pode instalar o arquivo de ajuda atualizado somente para módulos instalados no computador.
• Se Save-Help não conseguir encontrar arquivos de ajuda atualizados para um módulo ou não conseguir encontrar arquivos de ajuda atualizados no idioma especificado, ele continuará silenciosamente sem exibir uma mensagem de erro. Para ver quais arquivos foram salvos pelo comando, especifique o parâmetro detalhado.
• Os módulos são a menor unidade de ajuda atualizável. Não é possível salvar a ajuda para um cmdlet específico, apenas para todos os cmdlets no módulo. Para localizar o módulo que contém um cmdlet específico, use a propriedade ModuleName juntamente com o cmdlet Get-Command, por exemplo, (Get-Command \<cmdlet-name\>).ModuleName
• Save-Help suporta todos os módulos e os snap-ins principais do PowerShell. Não suporta quaisquer outros snap-ins.
• 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.
• Os cmdlets Update-Help e Save-Help não são suportados no Ambiente de Pré-instalação do Windows (Windows PE).