about_Updatable_Help

  • Artikel
  • 12 minuten om te lezen

Korte beschrijving

Beschrijft het helpsysteem dat kan worden gebruikt 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 Dat kan worden gebruikt, 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 vanaf de opdrachtregel kunt lezen. Zo kunt u eenvoudig Help-bestanden downloaden en installeren en deze bijwerken wanneer er 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 met Help die kan worden bijgewerkt Help-bestanden downloaden naar een bestandssysteemmap of bestands share en vervolgens de Help-bestanden van de bestands share installeren.

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

De help die kan worden bijwerkt, biedt ook ondersteuning voor onlinetoegang tot de nieuwste Help-onderwerpen en basishulp voor cmdlets, zelfs wanneer er geen Help-bestanden op de computer zijn.

PowerShell 3.0 wordt niet 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 bijwerkbaar

  • Update-Help: downloadt de nieuwste Help-bestanden van internet of een bestands share en installeert deze op de lokale computer.

  • Save-Help: hiermee downloadt u de nieuwste Help-bestanden van internet en slaat u deze op in een bestandssysteemmap of bestands share. Gebruik om de Help-bestanden op computers te Update-Help 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 standaardinternetbrowser.

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 cmdlet automatisch gegenereerde Help weer en wordt u gevraagd de Help-bestanden te downloaden of online te Get-Help lezen.

Automatisch gegenereerde Help bevat syntaxis en aliassen, en opmerkingen waarin wordt uitgelegd hoe u de Updatable Help-cmdlets kunt gebruiken en toegang kunt 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 de help die kan worden gebruikt, is help voor een module. Module-help bevat hulp voor alle cmdlets, functies, werkstromen, providers, scripts en concepten in een module. U kunt de Help bijwerken voor alle modules die op de computer zijn geïnstalleerd, zelfs als ze niet zijn geïmporteerd in de huidige sessie.

U kunt de Help voor de hele module bijwerken, maar u kunt geen help 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 vinden die de Set-ExecutionPolicy cmdlet bevat, typt u:

(Get-Command Set-ExecutionPolicy).ModuleName

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

Update-Help -Module <ModuleName>

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

Update-Help -Module Microsoft.PowerShell.Security

Machtigingen voor help die kan worden bijwerkt

Als u help wilt bijwerken voor de modules in de map , moet u $pshome/Modules 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 de Help online bekijken.

Voor het bijwerken van de Help voor modules in de map $home/Documents/PowerShell/Modules of modules in andere subdirectory's van de map zijn geen speciale $home machtigingen vereist.

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

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

Help-bestanden installeren en bijwerken

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

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

  • Bepaalt welke modules ondersteuning bieden voor Help die kan worden bijwerkbaar.
  • Zoekt de internetlocatie waar elke module de Help-bestanden kan opslaan die kunnen worden updateerbaar.
  • 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 cmdlet voor toegang tot de Get-Help 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 die kan worden bijgewerkt, typt u:

Update-Help

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

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

Update-Help -Module ServerManager

Zonder parameters, updates help voor alle modules in de sessie en voor alle Update-Help geïnstalleerde modules die ondersteuning bieden voor Help die kan worden bijgewerkt. Modules moeten worden geïnstalleerd in de -directories die worden vermeld in de waarde van de omgevingsvariabele PSModulePath om ze te kunnen toevoegen. Dit zijn ook modules die worden geretourneerd met de opdracht 'Get-Help -ListAvailable'.

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

Help bijwerken vanuit een bestands share

Gebruik de cmdlet om computers te ondersteunen die niet zijn verbonden met internet of om hulp bij het bijwerken in een onderneming te controleren of Save-Help 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 beschikbaar zijn voor de module, downloadt de cmdlet de nieuwe bestanden Save-Help van internet. De Help-bestanden worden echter niet uitpakken 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 cmdlet identificeert de nieuwste Help-bestanden, pakt ze uit en valideert ze en installeert ze in de taalspecifieke subdirecties van de Update-Help moduledirecties.

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 wilt bijwerken vanuit de \\Server\Share map, typt u:

Update-Help -SourcePath \\Server\Share

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

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

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

Optie 2: Open een PSSession die is gericht op de computer met de DHCP Server-module om het PSModuleInfo-object voor de module op te halen, sla het op in een variabele en voer vervolgens uit op het object dat is opgeslagen in de variabele $m Save-Help $m .

$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 met de DHCP Server-module, om het PSModuleInfo-object voor de module op te halen, sla deze op in een variabele en voer vervolgens uit op het object dat is opgeslagen in de variabele $m Save-Help $m .

$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 MODULE DHCP-server 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:\UsbFlashDrive\DhcpModule.xml -InputObject $m

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

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

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

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

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

Help-bestanden bijwerken in verschillende talen

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

U kunt echter de UIBouwparameters van de cmdlets en gebruiken om Help-bestanden te downloaden en installeren in elke ui-cultuur waarin Update-Help Save-Help 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 cmdlets en een foutbericht met een lijst van de talen waarin help voor elke module beschikbaar is, zodat u het alternatief kunt kiezen dat het beste voldoet aan Update-Help Save-Help uw behoeften.

Notitie

Op dit moment wordt Help-inhoud die kan worden bijgewerkt alleen gepubliceerd in het Engels (en-US). Op sommige niet-Windows systemen moet u de parameter UIBouwen gebruiken om de inhoud expliciet aan te en-US vragen.

Online Help gebruiken

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

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 standaardinternetbrowser:

Get-Help Get-Job -Online

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

De online parameter werkt niet met over onderwerpen. Zie PowerShell About Topics (Engelstalig) voor meer informatie over onderwerpen voor PowerShell, inclusief Help-onderwerpen over de PowerShell-taal.

Internetdownloads minimaliseren of voorkomen

Gebruik de cmdlet om internetdownloads te minimaliseren en gebruikers die geen verbinding met internet hebben, te voorzien van een Save-Help bijgewerkte Help. Download de help van internet en sla deze op in een netwerk share. Maak vervolgens een groepsbeleid of geplande taak die een opdracht Update-Help op alle computers wordt uitgevoerd. Stel de waarde van de parameter SourcePath van de Update-Help cmdlet in op de netwerk share.

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

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

Notitie

De instelling Het standaardbronpad instellen voor de groep Update-Help wordt weergegeven onder Computerconfiguratie en Gebruikersconfiguratie. Alleen de beleidsinstelling onder Computerconfiguratie is echter effectief. De beleidsinstelling onder Gebruikersconfiguratie wordt genegeerd.

Zie voor meer informatie about_Group_Policy_Settings.

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 cmdlet, importeert u de module in de huidige sessie voordat u een - of Get-Module Update-Help -opdracht Save-Help gaat uitvoeren. Importeer op een externe computer, voordat u de opdracht uit te voeren, de module in de huidige sessie Save-Help of het huidige scriptblok, dat is verbonden met de externe Invoke-Command computer.

Wanneer de module in de huidige sessie is, moet u de cmdlets of uitvoeren zonder parameters of de Update-Help moduleparameter gebruiken om de Save-Help modulenaam op te geven.

De moduleparameters van Update-Help de Save-Help cmdlets en 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 cmdlet, zoals een module die is geïnstalleerd op een locatie die niet wordt vermeld in de omgevingsvariabele of een module die niet goed is gevormd (de modulemap bevat niet ten minste één bestand waarvan de basisnaam gelijk is aan de Get-Module $env:PSModulePath mapnaam).

Ondersteuning bieden voor help die kan worden bijwerkbaar

Als u een module maakt, kunt u online Help en Bijwerkbare Help voor uw modules ondersteunen. Zie Support Updatable Help and Supporting Online Help in de Microsoft Docs.

Bijwerkbare help die niet beschikbaar is voor PowerShell-module of help op basis van opmerkingen.

Opmerkingen

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

Zie ook

Get-Help

Save-Help

Update-Help