Delen via

about_Updatable_Help

  • Artikel

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 Updatable Help-systeem, 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 deze kunt lezen op de opdrachtregel. Hiermee kunt u eenvoudig Help-bestanden downloaden en installeren en deze bijwerken wanneer er nieuwere Help-bestanden beschikbaar komen.

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

In PowerShell 4.0 blijft de eigenschap HelpInfoUri behouden gedurende Windows PowerShell externe communicatie, waardoor Save-Help modules kunnen worden gebruikt die op een externe computer zijn geïnstalleerd, maar 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 met internettoegang en vervolgens uit te voeren Save-Help op het object PSModuleInfo . De opgeslagen Help kan worden gekopieerd naar de externe, niet-verbonden computer met behulp van verwisselbare media en vervolgens worden geïnstalleerd door uit te voeren Update-Help. Met deze verbeteringen in Save-Help de functionaliteit kunt u Help installeren op computers zonder enige vorm van netwerktoegang. Zie Help bijwerken vanuit een bestandsshare in dit onderwerp voor een voorbeeld van het gebruik van de nieuwe Save-Help functionaliteit.

Bijwerkbare Help ondersteunt ook onlinetoegang tot de nieuwste Help-onderwerpen en basisondersteuning voor cmdlets, zelfs als er geen Help-bestanden op de computer staan.

PowerShell wordt niet geleverd met Help-bestanden. U kunt de functie Bijwerkbare Help 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 deze op de lokale computer.

  • Save-Help: Downloadt de nieuwste Help-bestanden van internet en slaat deze op in een bestandssysteemmap of bestandsshare. Gebruik Update-Helpom de Help-bestanden op computers te installeren.

  • Get-Help: Geeft Help-onderwerpen weer op de opdrachtregel. Krijgt 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 standaard internetbrowser.

Automatisch gegenereerde Help: Help zonder Help-bestanden

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

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

Met de volgende opdracht krijgt u bijvoorbeeld basisondersteuning 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 Bijwerkbare Help is Help voor een module. Module-help bevat hulp voor alle cmdlets, functies, werkstromen, providers, scripts en concepten in een module. U kunt help 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 bijwerken voor de hele module, maar u kunt de Help niet bijwerken voor afzonderlijke cmdlets.

Als u de module wilt vinden die een bepaalde cmdlet bevat, gebruikt u de volgende opdrachtindeling:

(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 de Help 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 hulp die kan worden bijgewerkt

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

Als u geen lid bent van de groep Administrators, kunt u de Help voor deze modules niet bijwerken. maar als u toegang tot internet 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 cmdlets en Save-Help hebben de parameter UseDefaultCredentials die de expliciete referenties van de huidige gebruiker opgeeft. Deze parameter is ontworpen voor toegang tot beveiligde internetlocaties.

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

Help-bestanden installeren en bijwerken

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

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

  • Bepaalt welke modules ondersteuning bieden voor Bijwerkbare Help.
  • Zoekt de internetlocatie waar elke module de Bijwerkbare Help-bestanden opslaat.
  • Vergelijkt de Help-bestanden voor elke module op uw computer met de nieuwste Help-bestanden die beschikbaar zijn voor elke module.
  • Hiermee downloadt u de nieuwe bestanden van internet.
  • Het Help-bestandspakket wordt uitgepakt.
  • Controleert of de bestanden geldige Help-bestanden zijn.
  • Installeert de Help-bestanden in de taalspecifieke submap van de modulemap.

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

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

Update-Help

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

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

Update-Help -Module ServerManager

Zonder parameters helpen Update-Help updates voor alle modules in de sessie en voor alle geïnstalleerde modules die ondersteuning bieden voor Bijwerkbare Help. Modules moeten 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 parameter Module (alle) Update-Help is * , probeert u help bij te werken voor alle geïnstalleerde modules, inclusief modules die geen ondersteuning bieden voor bijwerkbare Help. Deze opdracht genereert meestal veel fouten omdat de cmdlet modules aantreft die geen ondersteuning bieden voor bijwerkbare Help.

Help bijwerken vanaf een bestandsshare

Gebruik de Save-Help cmdlet ter ondersteuning van computers die niet zijn verbonden met internet, of voor het beheren of stroomlijnen van hulp bij het bijwerken in een onderneming. 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 bevat of als er nieuwere Help-bestanden beschikbaar zijn voor de module, downloadt de Save-Help cmdlet de nieuwe bestanden van internet. De Help-bestanden worden echter niet uitpakt 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 parameter SourcePath van de Update-Help cmdlet. De Update-Help cmdlet identificeert de nieuwste Help-bestanden, unwraps en valideert ze, en installeert ze in de taalspecifieke submappen van de modulemappen.

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

Save-Help -DestinationPath \\Server\Share

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

Update-Help -SourcePath \\Server\Share

In de volgende voorbeelden ziet u het gebruik van Save-Help om help op te slaan voor modules die niet op de lokale computer zijn geïnstalleerd. In dit voorbeeld voert de beheerder uit Save-Help om de Help voor de DhcpServer-module op te slaan vanaf een clientcomputer met internetverbinding, zonder de dhcpservermodule of dhcp-serverfunctie op de lokale computer te installeren.

Optie 1: Voer uit Invoke-Command om het object PSModuleInfo voor de externe module op te halen, sla het op in een variabele, $men voer vervolgens uit Save-Help op het object PSModuleInfo door de variabele $m op te geven als de 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 gericht op de computer waarop de DHCP Server-module wordt uitgevoerd, om het PSModuleInfo-object voor de module op te halen, sla het op in een variabele $men voer vervolgens uit 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, sla het op in een variabele $men voer vervolgens uit 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 object PSModuleInfo 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 object PSModuleInfo met Import-Clixml. Voer uit Save-Help om de Help voor het geïmporteerde OBJECT PSModuleInfo van de DhcpServer-module op te slaan.

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

Ten slotte vervoert u de verwisselbare media terug naar de computer die geen netwerktoegang heeft en installeert u 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 bijwerkbare Help. Modules moeten 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 help wilt opslaan. Dit zijn ook modules die worden geretourneerd door het uitvoeren van een Get-Help -ListAvailable opdracht.

Help-bestanden in verschillende talen bijwerken

Standaard downloaden de Update-Help cmdlets en Save-Help 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 gebruikt Save-Help u de windows-taalterugvalregels om de beste ondersteunde taal te vinden.

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

Als u bijvoorbeeld de nieuwste Help-bestanden voor alle modules in de sessie wilt opslaan in het Japans (ja-Jp) en het 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 cmdlets en Save-Help een foutbericht met de talen waarin help voor elke module beschikbaar is, zodat u het alternatief kunt kiezen dat het beste bij uw behoeften past.

Notitie

Op dit moment wordt bijwerkbare Help-inhoud alleen gepubliceerd in het Engels (en-US).

Online-Help gebruiken

Als u de Help-bestanden op uw lokale computer niet kunt 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 standaard internetbrowser:

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 Topics voor informatie over PowerShell, inclusief Help-onderwerpen over de PowerShell-taal.

Internetdownloads minimaliseren of voorkomen

Gebruik de Save-Help cmdlet om internetdownloads te minimaliseren en updatable Help te bieden aan gebruikers die geen verbinding met internet hebben. Download help van internet en sla deze op een netwerkshare op. Maak vervolgens een groepsbeleid instelling of geplande taak waarmee een Update-Help opdracht op alle computers wordt uitgevoerd. Stel de waarde van de SourcePath-parameter van de Update-Help cmdlet in op de netwerkshare.

Als u wilt voorkomen dat gebruikers met internettoegang De updatebare Help downloaden van internet, gebruikt u de instelling Het standaardbronpad instellen voor Update-Help groepsbeleid.

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

Notitie

De groepsbeleidsinstelling Het standaardbronpad instellen voor Update-Help 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 help 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 de Update-Help opdracht of Save-Help uitvoert. Importeer op een externe computer, voordat u de Save-Help opdracht uitvoert, de module in de huidige sessie of Invoke-Command het huidige scriptblok dat is verbonden met de externe computer.

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

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

Gebruik deze techniek om help 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 bieden voor hulp die kan worden bijgewerkt

Als u een module maakt, kunt u ondersteuning bieden voor online-Help en Bijwerkbare Help voor uw modules. Zie Ondersteuning voor bijwerkbare Help 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 cmdlets en Save-Help worden niet ondersteund in Windows Preinstallation Environment (Windows PE).

Zie ook