Save-Help
Baixa e salva os arquivos de ajuda mais recentes em um diretório do sistema de arquivos.
Sintaxe
Save-Help
[-DestinationPath] <String[]>
[[-Module] <PSModuleInfo[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[<CommonParameters>]Save-Help
-LiteralPath <String[]>
[[-Module] <PSModuleInfo[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[<CommonParameters>]Description
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. Esse recurso permite que você atualize os arquivos de ajuda em computadores que não têm acesso à Internet e facilita a atualização dos arquivos de ajuda em vários computadores.
No Windows PowerShell 3.0, o Save-Help funcionava apenas para módulos instalados no computador local.
Embora fosse possível importar um módulo de um computador remoto ou obter uma referência a um objeto PSModuleInfo
No Windows PowerShell 4.0, a propriedade HelpInfoUri é preservada em relação à comunicação remota do PowerShell, o que permite que save-help funcionem para módulos instalados em computadores remotos.
Também é possível salvar um objeto PSModuleInfo
Para instalar arquivos de ajuda salvos, execute o cmdlet Update-Help. Adicione seu parâmetro SourcePath para especificar a pasta na qual você salvou os arquivos da Ajuda.
Sem parâmetros, um comando
O cmdlet Save-Help verifica a versão de todos os arquivos de ajuda na pasta de destino. Se os arquivos de ajuda mais recentes estiverem disponíveis, esse cmdlet baixará os arquivos de ajuda mais recentes da Internet e os salvará na pasta. O cmdlet Save-Help funciona exatamente como o cmdlet Update-Help, exceto pelo fato de salvar os arquivos do gabinete baixado (.cab), em vez de extrair os arquivos de ajuda dos arquivos do gabinete e instalá-los no computador.
A ajuda salva para cada módulo consiste em um arquivo de ajuda (HelpInfo XML) e um arquivo de gabinete (.cab) para os arquivos de ajuda de cada cultura da interface do usuário. Você não precisa extrair os arquivos de ajuda do arquivo do gabinete. O cmdlet Update-Help extrai os arquivos de ajuda, valida o XML para segurança 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.
Para salvar os arquivos de ajuda para módulos na pasta de instalação do PowerShell ($pshome\Modules), inicie o PowerShell usando a opção Executar como administrador. Você deve ser membro do grupo Administradores no computador para baixar os arquivos de ajuda desses módulos.
Esse cmdlet foi introduzido no Windows PowerShell 3.0.
Exemplos
Exemplo 1: salvar a ajuda para o módulo DhcpServer
# Option 1: Run Invoke-Command to get the PSModuleInfo object for the remote DHCP Server module, save the PSModuleInfo object in the variable $m, and then run Save-Help.
$m = Invoke-Command -ComputerName RemoteServer -ScriptBlock { Get-Module -Name DhcpServer -ListAvailable }
Save-Help -Module $m -DestinationPath "C:\SavedHelp"
# Option 2: Open a PSSession--targeted at the remote computer that is running the DhcpServer module--to get the PSModuleInfo object for the remote module, and then run Save-Help.
$s = New-PSSession -ComputerName "RemoteServer"
$m = Get-Module -PSSession $s -Name "DhcpServer" -ListAvailable
Save-Help -Module $m -DestinationPath "C:\SavedHelp"
# Option 3: Open a CIM session--targeted at the remote computer that is running the DhcpServer module--to get the PSModuleInfo object for the remote module, and then run Save-Help.
$c = New-CimSession -ComputerName "RemoteServer"
$m = Get-Module -CimSession $c -Name "DhcpServer" -ListAvailable
Save-Help -Module $m -DestinationPath "C:\SavedHelp"Este exemplo mostra três maneiras diferentes de usar
Exemplo 2: Instalar ajuda para o módulo DhcpServer
# First, run Export-CliXml to export the PSModuleInfo object to a shared folder or to removable media.
$m = Get-Module -Name "DhcpServer" -ListAvailable
Export-CliXml -Path "E:\UsbFlashDrive\DhcpModule.xml" -InputObject $m
# Next, transport the removable media to a computer that has Internet access, and then import the PSModuleInfo object with Import-CliXml. Run Save-Help to save the Help for the imported DhcpServer module PSModuleInfo object.
$deserialized_m = Import-CliXml "E:\UsbFlashDrive\DhcpModule.xml"
Save-Help -Module $deserialized_m -DestinationPath "E:\UsbFlashDrive\SavedHelp"
# Finally, transport the removable media back to the computer that does not have network access, and then install the help by running Update-Help.
Update-Help -Module DhcpServer -SourcePath "E:\UsbFlashDrive\SavedHelp"Este exemplo mostra como instalar a ajuda salva no Exemplo 1 para o módulo DhcpServer em um computador que não tem acesso à Internet.
Exemplo 3: Salvar ajuda para todos os módulos
Save-Help -DestinationPath "\\Server01\FileShare01"Esse comando baixa os arquivos de ajuda mais recentes para todos os módulos no conjunto de cultura da interface do usuário para Windows no computador local. Ele salva os arquivos de ajuda na pasta \\Server01\Fileshare01.
Exemplo 4: Salvar ajuda para um módulo no computador
Save-Help -Module ServerManager -DestinationPath "\\Server01\FileShare01" -Credential Domain01/Admin01Esse comando baixa os arquivos de ajuda mais recentes para o módulo ServerManager e os salva na pasta \\Server01\Fileshare01.
Quando um módulo é instalado no computador, você pode digitar o nome do módulo como o valor do módulo parâmetro, 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.
Exemplo 5: Salvar ajuda para um módulo em um computador diferente
Invoke-Command -ComputerName Server02 {Get-Module -Name CustomSQL -ListAvailable} | Save-Help -DestinationPath \\Server01\FileShare01 -Credential Domain01\Admin01Esses comandos baixam os arquivos de ajuda mais recentes para o módulo
Como o módulo
Quando um módulo não está instalado no computador, Save-Help precisa do objeto do módulo, que inclui informações sobre o local dos arquivos de ajuda mais recentes.
Exemplo 6: Salvar ajuda para um módulo em vários idiomas
Save-Help -Module Microsoft.PowerShell* -UICulture de-DE, en-US, fr-FR, ja-JP -DestinationPath "D:\Help"Esse comando salva a ajuda para os módulos do PowerShell Core em quatro culturas de interface do usuário diferentes. Os pacotes de idiomas para essas localidades não precisam ser instalados no computador.
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.
Exemplo 7: Salvar ajuda mais de uma vez por dia
Save-Help -Force -DestinationPath "\\Server3\AdminShare\Help"Esse comando salva a ajuda para todos os módulos instalados no computador.
O comando especifica o parâmetro
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.
Parâmetros
-Credential
Especifica uma credencial de usuário. Esse cmdlet executa o comando usando credenciais de um usuário que tem permissão para acessar o local do sistema de arquivos especificado pelo parâmetro DestinationPath. Esse parâmetro é válido somente quando o parâmetro DestinationPath ou literalPath é usado no comando.
Esse parâmetro permite executar comandos Save-Help que usam o parâmetro DestinationPath em computadores remotos. Ao fornecer credenciais explícitas, você pode executar o comando em um computador remoto e acessar um compartilhamento de arquivos em um terceiro computador sem encontrar um erro de acesso negado ou usar a autenticação CredSSP para delegar credenciais.
| Tipo: | PSCredential |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-DestinationPath
Especifica o caminho da pasta na qual os arquivos de ajuda são salvos. Não especifique um nome de arquivo ou uma extensão de nome de arquivo.
| Tipo: | String[] |
| Cargo: | 0 |
| Valor padrão: | None |
| Obrigatório: | True |
| 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, apenas um comando Save-Help para cada módulo é permitido 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 para um módulo são instalados somente quando são mais recentes do que os arquivos no computador.
O limite uma vez por dia protege os servidores que hospedam os arquivos de ajuda e torna prático adicionar um comando Save-Help ao seu perfil do PowerShell.
Para salvar 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: Save-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | False |
| 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.
Isso é descrito na seção Comentários do construtor ModuleSpecification (Hashtable) na biblioteca MSDN.
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 um caminho da pasta de destino. Ao contrário do valor do parâmetro DestinationPath, o valor do parâmetro LiteralPath é usado exatamente como ele é 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: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Module
Especifica os módulos para os quais esse cmdlet baixa ajuda. Insira um ou mais nomes de módulo ou patters de nome em uma lista separada por vírgulas ou em um arquivo que tenha um nome de módulo em cada linha. Caracteres curinga são permitidos. Você também pode canalizar objetos de módulo do cmdlet Get-Module para Save-Help.
Por padrão, o Save-Help baixa ajuda para todos os módulos que dão suporte à Ajuda Atualizável e são instalados no computador local em um local listado na variável de ambiente PSModulePath.
Para salvar a ajuda de módulos que não estão instalados no computador, execute um comando Get-Module em um computador remoto.
Em seguida, encaminhe os objetos de módulo resultantes para o cmdlet
Se o módulo especificado estiver instalado no computador, você poderá inserir o nome do módulo ou um objeto de módulo.
Se o módulo não estiver instalado no computador, você deverá inserir um objeto de módulo, como um retornado pelo cmdlet do
O módulo parâmetro do cmdlet Save-Help não aceita o caminho completo de um arquivo de módulo ou arquivo de manifesto do módulo. Para salvar a ajuda de um módulo que não está em um local PSModulePath, importe o módulo para a sessão atual antes de executar o comando Save-Help.
Um valor de "*" (todos) tenta atualizar a ajuda para todos os módulos instalados no computador. Isso inclui módulos que não dão suporte à Ajuda Atualizável. Esse valor pode gerar erros quando o comando encontrar módulos que não dão suporte à Ajuda Atualizável.
| Tipo: | PSModuleInfo[] |
| Aliases: | Name |
| Cargo: | 1 |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | True |
-UICulture
Especifica os valores de cultura da interface do usuário para os quais esse cmdlet obtém 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. Não especifique um código de idioma parcial, como "de".
Por padrão, de Ajuda de Salvamento obtém arquivos de ajuda na cultura da interface do usuário definida para o Windows ou sua cultura de fallback. Se você especificar o parâmetro UICulture, de Ajuda de Salvamento procurará ajuda apenas para a cultura de interface do usuário especificada, não em nenhuma cultura de fallback.
| Tipo: | CultureInfo[] |
| Cargo: | 2 |
| Valor padrão: | Current UI culture |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-UseDefaultCredentials
Indica que esse cmdlet executa o comando, incluindo o download da Web, com 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 autenticação baseada em NTLM, negociação ou Kerberos.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | False |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
Entradas
Você pode redirecionar um objeto de módulo do cmdlet do
Saídas
None
Esse cmdlet não gera nenhuma saída.
Observações
- Para salvar a ajuda de 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 ajuda (HelpInfo XML) e um arquivo de gabinete (.cab) para os arquivos de ajuda de cada cultura da interface do usuário. Você não precisa extrair os arquivos de ajuda do arquivo do 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 de módulos que não estão instalados no computador. No entanto, como os arquivos de ajuda estão instalados na pasta do módulo, o cmdlet Update-Help pode instalar o arquivo de ajuda atualizado apenas para módulos instalados no computador.
- Se Salvar Ajuda não conseguir encontrar arquivos de ajuda atualizados para um módulo ou não 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 Verbose.
- Os módulos são a menor unidade de ajuda atualizável. Você não pode salvar a ajuda para um cmdlet específico, somente para todos os cmdlets no módulo. Para localizar o módulo que contém um cmdlet específico, use a propriedade ModuleName junto com o cmdlet Get-Command, por exemplo,
(Get-Command \<cmdlet-name\>).ModuleName - de Ajuda de Salvamento dá suporte a todos os módulos e snap-ins do PowerShell Core. Ele não dá suporte a nenhum outro snap-in.
- Os cmdlets de
de Ajuda de Atualização e usam as seguintes portas para baixar arquivos de ajuda: Porta 80 para HTTP e porta 443 para HTTPS. - Os cmdlets de de de de
de Ajuda de Atualização e não têm suporte no Windows PE (Ambiente de Pré-Instalação do Windows).