about_Updatable_Help

Artikel
10/20/2023

Korte beschrijving

Beschrijft het helpsysteem dat kan worden bijgewerkt in PowerShell.

Lange beschrijving

PowerShell biedt verschillende manieren om toegang te krijgen tot de meest recente Help-onderwerpen voor PowerShell-cmdlets en -concepten.

Het Help-systeem Updatable, geïntroduceerd in PowerShell 3.0, is ontworpen om ervoor te zorgen dat u altijd de nieuwste Help-onderwerpen op uw lokale computer hebt, zodat u ze op de opdrachtregel kunt lezen. Het maakt het eenvoudig om Help-bestanden te downloaden en te installeren en ze bij te werken wanneer nieuwere Help-bestanden beschikbaar komen.

Als u bijgewerkte help wilt bieden voor meerdere computers in een onderneming en voor computers die geen toegang hebben tot internet, kunt u help-bestanden downloaden naar een bestandssysteemmap of bestandsshare en vervolgens de Help-bestanden installeren vanuit de bestandsshare.

In PowerShell 4.0 blijft de eigenschap HelpInfoUri behouden via externe communicatie van Windows PowerShell, waarmee u kunt Save-Help werken voor modules die op een externe computer zijn geïnstalleerd, maar die niet noodzakelijkerwijs op de lokale computer zijn geïnstalleerd. U kunt een PSModuleInfo-object opslaan op schijf of verwisselbare media (zoals een USB-station) door uit te voeren Export-Clixml op een computer die geen internettoegang heeft, het PSModuleInfo-object te importeren op een computer die wel internettoegang heeft en vervolgens wordt uitgevoerd Save-Help op het PSModuleInfo-object . De opgeslagen help kan worden gekopieerd naar de externe, niet-verbonden computer met behulp van verwisselbare media en vervolgens geïnstalleerd door uit te voeren Update-Help. Met deze verbeteringen in Save-Help de functionaliteit kunt u hulp installeren op computers die geen enkele vorm van netwerktoegang hebben. Zie Help bijwerken vanuit een bestandsshare in dit onderwerp voor een voorbeeld van het gebruik van de nieuwe Save-Help functionaliteit.

Bijwerkbare Help biedt ook ondersteuning voor onlinetoegang tot de nieuwste Help-onderwerpen en basishulp voor cmdlets, zelfs als er geen Help-bestanden op de computer zijn.

PowerShell wordt niet geleverd met Help-bestanden. U kunt de Help-functie Updatable gebruiken om de Help-bestanden te installeren voor alle opdrachten die standaard zijn opgenomen in PowerShell en voor alle Windows-modules.

Help-cmdlets die kunnen worden bijgewerkt

Update-Help: Downloadt de nieuwste Help-bestanden van internet of een bestandsshare en installeert ze op de lokale computer.
Save-Help: Downloadt de nieuwste Help-bestanden van internet en slaat deze op in een bestandssysteemmap of bestandsshare. Als u de Help-bestanden op computers wilt installeren, gebruikt u Update-Help.
Get-Help: Geeft Help-onderwerpen weer op de opdrachtregel. Hiermee krijgt u hulp van de Help-bestanden op de computer. Geeft automatisch gegenereerde help weer voor cmdlets en functies die geen Help-bestanden hebben. Hiermee opent u online Help-onderwerpen voor cmdlets, functies, scripts en werkstromen in uw standaardbrowser.

Automatisch gegenereerde Help: Help zonder Help-bestanden

Als u niet beschikt over het Help-bestand voor een cmdlet, functie of werkstroom op de computer, geeft de Get-Help cmdlet automatisch gegenereerde Help weer en wordt u gevraagd om de Help-bestanden te downloaden of online te lezen.

Automatisch gegenereerde Help bevat syntaxis en aliassen, en opmerkingen waarin wordt uitgelegd hoe u de Help-cmdlets updatable kunt gebruiken en toegang wilt krijgen tot de online-Help-onderwerpen.

Met de volgende opdracht krijgt u bijvoorbeeld basishulp voor de Get-Culture cmdlet. De uitvoer toont de Get-Help weergave wanneer er geen Help-bestanden op de computer zijn.

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.

Help-bestanden voor modules

De kleinste eenheid van Help die kan worden bijgewerkt, is hulp voor een module. Module-help bevat hulp voor alle cmdlets, functies, werkstromen, providers, scripts en concepten in een module. U kunt hulp bijwerken voor alle modules die op de computer zijn geïnstalleerd, zelfs als ze niet in de huidige sessie worden geïmporteerd.

U kunt help voor de hele module bijwerken, maar u kunt geen hulp bijwerken voor afzonderlijke cmdlets.

Gebruik de volgende opdrachtindeling om de module te vinden die een bepaalde cmdlet bevat:

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

Als u bijvoorbeeld de module wilt zoeken die de Set-ExecutionPolicy cmdlet bevat, typt u:

(Get-Command Set-ExecutionPolicy).ModuleName

Als u hulp voor een bepaalde module wilt bijwerken, typt u:

Update-Help -Module <ModuleName>

Als u bijvoorbeeld help wilt bijwerken voor de module die de cmdlet Set-ExecutionPolicy bevat, typt u:

Update-Help -Module Microsoft.PowerShell.Security

Machtigingen voor help die kan worden bijgewerkt

Als u hulp wilt bijwerken voor de modules in de map $pshome/Modules, moet u lid zijn van de groep Administrators op de computer.

Als u geen lid bent van de groep Administrators, kunt u geen hulp bijwerken voor deze modules; maar als u internettoegang hebt, kunt u online help bekijken.

Voor het bijwerken van help voor modules in de map $HOME/Documents/PowerShell/Modules of modules in andere submappen van de $HOME map zijn geen speciale machtigingen vereist.

De Update-Help en Save-Help cmdlets hebben een UseDefaultCredentials-parameter die de expliciete referenties van de huidige gebruiker biedt. Deze parameter is ontworpen voor toegang tot beveiligde internetlocaties.

De Update-Help en Save-Help cmdlets hebben ook een referentieparameter waarmee u de opdracht kunt uitvoeren op een externe computer en toegang hebt tot een bestandsshare op een derde computer. De referentieparameter is alleen geldig wanneer u de parameters SourcePath of LiteralPath van Update-Help en de Parameters DestinationPath of LiteralPath van Save-Help.

Help-bestanden installeren en bijwerken

Gebruik de Update-Help cmdlet om Help-bestanden voor de eerste keer te downloaden en te installeren of om de Help-bestanden op uw computer bij te werken.

De Update-Help cmdlet doet al het harde werk voor u, inclusief de volgende taken.

Bepaalt welke modules ondersteuning bieden voor Updatable Help.
Hiermee vindt u de internetlocatie waar elke module de help-bestanden updatable opslaat.
Vergelijkt de Help-bestanden voor elke module op uw computer met de nieuwste Help-bestanden die beschikbaar zijn voor elke module.
Downloadt de nieuwe bestanden van internet.
Pak het Help-bestandspakket uit.
Controleert of de bestanden geldige Help-bestanden zijn.
Installeert de Help-bestanden in de taalspecifieke submap van de modulemap.

Gebruik de Get-Help cmdlet om toegang te krijgen tot de nieuwe Help-onderwerpen. U hoeft PowerShell niet opnieuw op te starten.

Als u help wilt installeren of bijwerken voor alle modules op de computer die ondersteuning biedt voor Help bijwerken, typt u:

Update-Help

Als u help voor bepaalde modules wilt bijwerken, voegt u de moduleparameter van Update-Help. Jokertekens zijn toegestaan in de modulenaam.

Als u bijvoorbeeld help voor de ServerManager-module wilt bijwerken, typt u:

Update-Help -Module ServerManager

Zonder parameters Update-Help werkt u help bij voor alle modules in de sessie en voor alle geïnstalleerde modules die ondersteuning bieden voor Help bijwerken. Als u deze wilt opnemen, moeten modules worden geïnstalleerd in mappen die worden vermeld in de waarde van de omgevingsvariabele PSModulePath. Dit zijn ook modules die worden geretourneerd door een Get-Module -ListAvailable opdracht.

Als de waarde van de moduleparameter (alle) is * , Update-Help probeert u help bij te werken voor alle geïnstalleerde modules, inclusief modules die geen ondersteuning bieden voor Help-update. Met deze opdracht worden meestal veel fouten gegenereerd wanneer de cmdlet modules tegenkomt die geen ondersteuning bieden voor Updatable Help.

Gebruik de Save-Help cmdlet om computers te ondersteunen die niet zijn verbonden met internet of om het bijwerken in een onderneming te beheren of te stroomlijnen. De Save-Help cmdlet downloadt Help-bestanden van internet en slaat deze op in een bestandssysteemmap die u opgeeft.

Save-Help Vergelijkt de Help-bestanden in de opgegeven map met de nieuwste Help-bestanden die beschikbaar zijn voor elke module. Als de map geen Help-bestanden of nieuwere Help-bestanden voor de module beschikbaar is, downloadt de Save-Help cmdlet de nieuwe bestanden van internet. De Help-bestanden worden echter niet uitgetrokken of geïnstalleerd.

Als u de Help-bestanden op een computer wilt installeren of bijwerken vanuit Help-bestanden die zijn opgeslagen in een bestandssysteemmap, gebruikt u de sourcePath-parameter van de Update-Help cmdlet. Met Update-Help de cmdlet worden de nieuwste Help-bestanden geïdentificeerd, uitpakken en gevalideerd en geïnstalleerd in de taalspecifieke submappen van de modulemappen.

Als u bijvoorbeeld hulp wilt opslaan voor alle geïnstalleerde modules in de \\Server\Share map, typt u:

Save-Help -DestinationPath \\Server\Share

Als u vervolgens hulp uit de \\Server\Share map wilt bijwerken, typt u:

Update-Help -SourcePath \\Server\Share

In de volgende voorbeelden ziet u hoe Save-Help u hulp kunt opslaan voor modules die niet op de lokale computer zijn geïnstalleerd. In dit voorbeeld wordt de beheerder uitgevoerd Save-Help om de Help voor de DhcpServer-module op te slaan vanaf een clientcomputer met internetverbinding, zonder de dhcpServer-module of dhcp-serverrol op de lokale computer te installeren.

Optie 1: Voer de opdracht uit Invoke-Command om het PSModuleInfo-object voor de externe module op te halen, sla het op in een variabele $men voer het vervolgens uit Save-Help op het PSModuleInfo-object door de variabele $m op te geven als modulenaam.

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

Optie 2: Open een PSSession die is gericht op de computer waarop de DHCP Server-module wordt uitgevoerd, om het PSModuleInfo-object voor de module op te halen, op te slaan in een variabele $men vervolgens uit te voeren Save-Help op het object dat is opgeslagen in de $m variabele.

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

Optie 3: Open een CIM-sessie, gericht op de computer waarop de DHCP Server-module wordt uitgevoerd, om het PSModuleInfo-object voor de module op te halen, op te slaan in een variabele $men vervolgens uit te voeren Save-Help op het object dat is opgeslagen in de $m variabele.

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

In het volgende voorbeeld installeert de beheerder help voor de DHCP Server-module op een computer die geen netwerktoegang heeft.

Voer eerst uit Export-Clixml om het PSModuleInfo-object te exporteren naar een gedeelde map of naar verwisselbare media.

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

Transporteer vervolgens de verwisselbare media naar een computer met internettoegang en importeer vervolgens het PSModuleInfo-object met Import-Clixml. Voer deze opdracht uit Save-Help om de Help voor het geïmporteerde PSModuleInfo-object van de DHCPServer-module op te slaan.

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

Transporteer ten slotte de verwisselbare media terug naar de computer die geen netwerktoegang heeft en installeer vervolgens de help door uit te voeren Update-Help.

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

Zonder parameters downloadt Save-Help u help voor alle modules in de sessie en voor alle geïnstalleerde modules die ondersteuning bieden voor Updatable Help. Als u wilt opnemen, moeten modules worden geïnstalleerd in mappen die worden vermeld in de waarde van de $env:PSModulePath omgevingsvariabele, op de lokale computer of op een externe computer waarvoor u hulp wilt opslaan. Dit zijn ook modules die worden geretourneerd door een Get-Help -ListAvailable opdracht uit te voeren.

Help-bestanden in verschillende talen bijwerken

Standaard downloaden de Update-Help en Save-Help cmdlets help in de ui-cultuur en taal die is ingesteld voor Windows op de lokale computer. Als Help-bestanden voor de opgegeven modules niet beschikbaar zijn in de lokale UI-cultuur Update-Help en Save-Help de windows-taalterugvalregels gebruiken om de beste ondersteunde taal te vinden.

U kunt echter de UICulture-parameters van de Update-Help en Save-Help cmdlets gebruiken om Help-bestanden te downloaden en te installeren in alle UI-culturen waarin ze beschikbaar zijn.

Als u bijvoorbeeld de nieuwste Help-bestanden wilt opslaan voor alle modules in de sessie in het Japans (ja-Jp) en Frans (fr-FR), typt u:

Save-Help -Path \Server\Share -UICulture ja-jp, fr-fr

Als Help-bestanden voor de modules niet beschikbaar zijn in de talen die u hebt opgegeven, retourneren de Update-Help en Save-Help cmdlets een foutbericht met de talen waarin help voor elke module beschikbaar is, zodat u het alternatief kunt kiezen dat het beste aan uw behoeften voldoet.

Notitie

Momenteel wordt updatebare Help-inhoud alleen gepubliceerd in het Engels (en-US).

Online-Help gebruiken

Als u de Help-bestanden op uw lokale computer niet kunt bijwerken of niet wilt bijwerken, kunt u nog steeds de nieuwste Help-bestanden online downloaden.

Als u het online-Help-onderwerp voor een cmdlet of functie wilt openen, gebruikt u de parameter Online van de Get-Help cmdlet.

Met de volgende opdracht opent u bijvoorbeeld het online-Help-onderwerp voor de Get-Job cmdlet in uw standaardbrowser:

Get-Help Get-Job -Online

Als u online help voor een script wilt krijgen, gebruikt u de parameter Online en het volledige pad naar het script.

De parameter Online werkt niet met Info-onderwerpen. Zie PowerShell over onderwerpen voor PowerShell voor meer informatie over onderwerpen over PowerShell, inclusief Help-onderwerpen over de PowerShell-taal.

Internetdownloads minimaliseren of voorkomen

Gebruik de Save-Help cmdlet om internetdownloads te minimaliseren en help-informatie te bieden die kan worden bijgewerkt voor gebruikers die niet zijn verbonden met internet. Download hulp van internet en sla deze op in een netwerkshare. Maak vervolgens een groepsbeleidsinstelling of geplande taak die een Update-Help opdracht uitvoert op alle computers. Stel de waarde van de parameter SourcePath van de Update-Help cmdlet in op de netwerkshare.

Als u wilt voorkomen dat gebruikers met internettoegang Updatable Help van internet downloaden, gebruikt u het standaardbronpad instellen voor de groepsbeleidsinstelling Update-Help .

Met deze groepsbeleidsinstelling wordt impliciet de sourcePath-parameter toegevoegd, met de locatie van het bestandssysteem die u opgeeft, aan elke Update-Help opdracht op elke betreffende computer. Gebruikers kunnen de parameter SourcePath expliciet gebruiken om een andere locatie voor het bestandssysteem op te geven, maar ze kunnen de SourcePath-parameter niet uitsluiten en help downloaden van internet.

Notitie

Het standaardbronpad voor groepsbeleidsinstelling Update-Help instellen wordt weergegeven onder Computerconfiguratie en Gebruikersconfiguratie. Alleen de beleidsinstelling onder Computerconfiguratie is echter van kracht. De beleidsinstelling onder Gebruikersconfiguratie wordt genegeerd.

Zie about_Group_Policy_Settings voor meer informatie.

Help bijwerken voor niet-standaardmodules

Als u hulp wilt bijwerken of opslaan voor een module die niet wordt geretourneerd door de parameter ListAvailable van de Get-Module cmdlet, importeert u de module in de huidige sessie voordat u een Update-Help of Save-Help opdracht uitvoert. Importeer de module op een externe computer, voordat u de Save-Help opdracht uitvoert, in de huidige sessie of Invoke-Command scriptblok die is verbonden met de externe computer.

Wanneer de module zich in de huidige sessie bevindt, voert u de Update-Help of Save-Help cmdlets zonder parameters uit of gebruikt u de moduleparameter om de modulenaam op te geven.

De moduleparameters van de Update-Help en Save-Help cmdlets accepteren alleen een modulenaam. Ze accepteren het pad naar een modulebestand niet.

Gebruik deze techniek om hulp bij te werken of op te slaan voor een module die niet wordt geretourneerd door de parameter ListAvailable van de Get-Module cmdlet, zoals een module die is geïnstalleerd op een locatie die niet wordt vermeld in de $env:PSModulePath omgevingsvariabele of een module die niet goed is opgemaakt (de modulemap bevat niet ten minste één bestand waarvan de basisnaam hetzelfde is als de mapnaam).

Ondersteuning voor updatable Help

Als u een module maakt, kunt u online Help en Help bijwerken voor uw modules ondersteunen. Zie Ondersteunende Help-informatie en Ondersteunende Online Help voor meer informatie.

Hulp die kan worden bijgewerkt, is niet beschikbaar voor PowerShell-modules of hulp op basis van opmerkingen.

Opmerkingen

De Update-Help en Save-Help cmdlets worden niet ondersteund in Windows Preinstallation Environment (Windows PE).

Delen via