Update-Help

Referentie

Module:: Microsoft.PowerShell.Core

Downloadt en installeert de nieuwste Help-bestanden op uw computer.

Syntaxis

Update-Help
      [[-Module] <String[]>]
      [-FullyQualifiedModule <ModuleSpecification[]>]
      [[-SourcePath] <String[]>]
      [-Recurse]
      [[-UICulture] <CultureInfo[]>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-Help
      [[-Module] <String[]>]
      [-FullyQualifiedModule <ModuleSpecification[]>]
      [-LiteralPath <String[]>]
      [-Recurse]
      [[-UICulture] <CultureInfo[]>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

De Update-Help cmdlet downloadt de nieuwste Help-bestanden voor PowerShell-modules en installeert deze op uw computer. U hoeft PowerShell niet opnieuw te starten om de wijziging effectief te maken. U kunt de cmdlet Get-Help gebruiken om de nieuwe Help-bestanden onmiddellijk weer te geven.

Update-Help controleert de versie van de Help-bestanden op uw computer. Als u geen Help-bestanden voor een module hebt of als uw Help-bestanden verouderd zijn, downloadt Update-Help de nieuwste Help-bestanden. De Help-bestanden kunnen worden gedownload en geïnstalleerd vanaf internet of een bestandsshare.

Zonder parameters werkt Update-Help de Help-bestanden bij voor modules die ondersteuning bieden voor updatebare Help en worden geladen in de sessie of geïnstalleerd op een locatie die is opgenomen in de $env:PSModulePath. Zie about_Updatable_Helpvoor meer informatie.

Update-Help controleert de versie van de geïnstalleerde Help. Als Update-Help bijgewerkte Help-bestanden voor een module niet kunt vinden, wordt deze op de achtergrond voortgezet zonder een foutbericht weer te geven. Gebruik de parameter Force om de versiecontrole over te slaan. Gebruik de parameter Uitgebreide om de status- en voortgangsgegevens te bekijken. Gebruik de parameter Module om Help-bestanden voor een bepaalde module bij te werken.

Als de culturele instellingen van uw besturingssysteem zijn geconfigureerd voor een taal die niet beschikbaar is voor updatebare hulp, gaat Update-Help op de achtergrond door zonder hulp te downloaden. Gebruik de parameter UICulture om Help-bestanden in een ondersteunde taal te downloaden. Help is altijd beschikbaar voor de en-US landinstelling.

U kunt ook Update-Help gebruiken op computers die niet zijn verbonden met internet. Gebruik eerst de cmdlet Save-Helpom Help-bestanden van internet te downloaden en op te slaan in een gedeelde map die toegankelijk is voor het systeem dat niet is verbonden met internet. Gebruik vervolgens de parameter SourcePath van Update-Help om de bijgewerkte Help-bestanden van de gedeelde bestanden te downloaden en te installeren op de computer.

De cmdlet Update-Help is geïntroduceerd in Windows PowerShell 3.0.

Belangrijk

Update-Help hebt u beheerdersbevoegdheden nodig.

U moet lid zijn van de groep Administrators op de computer om de Help-bestanden voor de PowerShell-kernmodules bij te werken.

Als u de Help-bestanden voor modules in de installatiemap van PowerShell ($PSHOME\Modules) wilt downloaden of bijwerken, inclusief de PowerShell Core-modules, start u PowerShell met behulp van de optie Als administrator uitvoeren als beheerder. Bijvoorbeeld: Start-Process powershell.exe -Verb RunAs.

U kunt help-bestanden ook bijwerken met behulp van het menu-item Windows PowerShell Help bijwerken in het Menu Help in Windows PowerShell Integrated Scripting Environment (ISE).

Met het Help-item Windows PowerShell bijwerken wordt een Update-Help cmdlet zonder parameters uitgevoerd. Als u hulp wilt bijwerken voor modules in de map $PSHOME, start u Windows PowerShell ISE met behulp van de optie Als administrator uitvoeren.

Voorbeelden

Voorbeeld 1: Help-bestanden bijwerken voor alle modules

De Update-Help-cmdlet werkt Help-bestanden bij voor geïnstalleerde modules die ondersteuning bieden voor Updatable Help. De cultuurtaal van de gebruikersinterface (UI) wordt ingesteld in het besturingssysteem.

Update-Help

Voorbeeld 2: Help-bestanden bijwerken voor opgegeven modules

Met de Update-Help cmdlet worden alleen help-bestanden bijgewerkt voor modulenamen die beginnen met Microsoft.PowerShell-.

Update-Help -Module Microsoft.PowerShell*

Voorbeeld 3: Help bijwerken op een systeem dat niet is ingesteld op de en-US landinstelling

De Update-Help cmdlet is ontworpen om help in meerdere talen te downloaden. Als er echter geen hulp beschikbaar is voor de taal die uw systeem gebruikt, mislukt Update-Help op de achtergrond tenzij u de parameter UICulture gebruikt.

In dit voorbeeld wordt Update-Help uitgevoerd op een systeem dat is ingesteld op de landinstelling van en-GB.

Update-Help Microsoft.PowerShell.Utility -Force
Update-Help Microsoft.PowerShell.Utility -Force -UICulture en-GB

Update-Help : Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility'
with UI culture(s) {en-GB} : The specified culture is not supported: en-GB. Specify a
culture from the following list: {en-US}.
At line:1 char:1
+ Update-Help Microsoft.PowerShell.Utility -Force -UICulture en-GB
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [Update-Help], Exception
    + FullyQualifiedErrorId : HelpCultureNotSupported,Microsoft.PowerShell.Commands
   .UpdateHelpCommand

De Help-bestanden worden altijd gepubliceerd voor de en-US landinstelling. Als u de Engelse help wilt downloaden, voert u Update-Help uit met de parameter UICulture en geeft u de en-US landinstelling op.

Voorbeeld 4: Help-bestanden automatisch bijwerken

In dit voorbeeld wordt een geplande taak gemaakt die elke dag om 3:00 uur hulp bijwerkt voor alle modules.

$jobParams = @{
  Name = 'UpdateHelpJob'
  Credential = 'Domain01\User01'
  ScriptBlock = '{Update-Help}'
  Trigger = (New-JobTrigger -Daily -At "3 AM")
}
Register-ScheduledJob @jobParams

Id         Name            JobTriggers     Command                                  Enabled
--         ----            -----------     -------                                  -------
1          UpdateHelpJob   1               Update-Help                              True

Met de Register-ScheduledJob-cmdlet wordt een geplande taak gemaakt waarop een Update-Help-opdracht wordt uitgevoerd. De opdracht gebruikt de parameter Credential om Update-Help uit te voeren met behulp van de referenties van een lid van de groep Administrators op de computer. De waarde van de parameter Trigger is een New-JobTrigger opdracht waarmee een taaktrigger wordt gemaakt die de taak elke dag om 3:00 uur start.

Als u de opdracht Register-ScheduledJob wilt uitvoeren, start u PowerShell met behulp van de optie Als administrator uitvoeren. PowerShell vraagt u om het wachtwoord van de gebruiker die is opgegeven in de parameter Credential. De referenties worden opgeslagen met de geplande taak. U wordt niet gevraagd wanneer de taak wordt uitgevoerd.

U kunt de Get-ScheduledJob-cmdlet gebruiken om de geplande taak weer te geven, de Set-ScheduledJob-cmdlet te gebruiken om deze te wijzigen en de Unregister-ScheduledJob cmdlet gebruiken om deze te verwijderen. U kunt de geplande taak ook weergeven en beheren in Task Scheduler in het volgende pad:

Task Scheduler Library\Microsoft\Windows\PowerShell\ScheduledJobs.

Voorbeeld 5: Help-bestanden op meerdere computers bijwerken vanuit een bestandsshare

In dit voorbeeld worden bijgewerkte Help-bestanden gedownload van internet en opgeslagen in een bestandsshare. Gebruikersreferenties zijn nodig die machtigingen hebben om toegang te krijgen tot de bestandsshare en updates te installeren. Wanneer een bestandsshare wordt gebruikt, is het mogelijk om computers bij te werken die zich achter firewalls bevinden of die niet zijn verbonden met internet.

Save-Help -DestinationPath \\Server01\Share\PSHelp -Credential Domain01\Admin01
Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {
     Update-Help -SourcePath \\Server01\Share\PSHelp -Credential Domain01\Admin01
}

Met de opdracht Save-Help worden de nieuwste Help-bestanden gedownload voor alle modules die ondersteuning bieden voor Updatable Help. De parameter DestinationPath slaat de bestanden op in de \\Server01\Share\PSHelp bestandsshare. De parameter Credential geeft een gebruiker op die gemachtigd is om toegang te krijgen tot de bestandsshare.

De cmdlet Invoke-Command voert externe Update-Help opdrachten uit op meerdere computers. De parameter ComputerName haalt een lijst met externe computers op uit het Servers.txt-bestand. Met de parameter ScriptBlock wordt de opdracht Update-Help uitgevoerd en wordt de parameter SourcePath gebruikt om de bestandsshare op te geven die de bijgewerkte Help-bestanden bevat. De parameter Credential geeft een gebruiker op die toegang heeft tot de bestandsshare en de opdracht externe Update-Help uitvoert.

Voorbeeld 6: Een lijst met bijgewerkte Help-bestanden ophalen

De Update-Help-cmdlet werkt help bij voor een opgegeven module. De cmdlet maakt gebruik van de Uitgebreide algemene parameter om de lijst met Help-bestanden weer te geven die zijn bijgewerkt. U kunt uitgebreide gebruiken om de uitvoer voor alle Help-bestanden of Help-bestanden voor een specifieke module weer te geven.

Zonder de uitgebreide parameter, worden de resultaten van de opdracht niet weergegeven Update-Help. De Uitgebreide parameteruitvoer is handig om te controleren of de Help-bestanden zijn bijgewerkt of als de nieuwste versie is geïnstalleerd.

Update-Help -Module Microsoft.PowerShell.Utility -Verbose

Voorbeeld 7: Modules zoeken die ondersteuning bieden voor Help bij bijwerken

In dit voorbeeld vindt u modules die ondersteuning bieden voor Help-ondersteuning voor updatable. De opdracht maakt gebruik van de eigenschap HelpInfoUri van de module om modules te identificeren die ondersteuning bieden voor Help die kunnen worden bijgewerkt. De eigenschap HelpInfoUri bevat een URL die wordt omgeleid wanneer de Update-Help cmdlet wordt uitgevoerd.

Get-Module -ListAvailable | Where-Object -Property HelpInfoUri

Directory: C:\program files\powershell\6\Modules

ModuleType Version    Name                                PSEdition ExportedCommands
---------- -------    ----                                --------- ----------------
Manifest   6.1.0.0    CimCmdlets                          Core      {Get-CimAssociatedInstance... }
Manifest   1.2.2.0    Microsoft.PowerShell.Archive        Desk      {Compress-Archive... }
Manifest   6.1.0.0    Microsoft.PowerShell.Diagnostics    Core      {Get-WinEvent, New-WinEvent}

    Directory: C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules

ModuleType Version    Name                                PSEdition ExportedCommands
---------- -------    ----                                --------- ----------------
Manifest   2.0.1.0    Appx                                Core,Desk {Add-AppxPackage, ... }
Script     1.0.0.0    AssignedAccess                      Core,Desk {Clear-AssignedAccess, ... }
Manifest   1.0.0.0    BitLocker                           Core,Desk {Unlock-BitLocker, ... }

Voorbeeld 8: Bijgewerkte Help-bestanden inventaris

In dit voorbeeld wordt met het script Get-UpdateHelpVersion.ps1 een inventaris gemaakt van de Help-bestanden die kunnen worden bijgewerkt voor elke module en de bijbehorende versienummers.

Het script identificeert modules die ondersteuning bieden voor Updatable Help met behulp van de eigenschap HelpInfoUri van modules. Voor modules die ondersteuning bieden voor Updatable Help, zoekt en parseert het script het Help-informatiebestand (*helpinfo.xml) om het meest recente versienummer te vinden.

Het script maakt gebruik van de PSCustomObject klasse en een hash-tabel om een aangepast uitvoerobject te maken.

# Get-UpdateHelpVersion.ps1
Param(
    [parameter(Mandatory=$False)]
    [String[]]
    $Module
)
$HelpInfoNamespace = @{helpInfo='http://schemas.microsoft.com/powershell/help/2010/05'}

if ($Module) { $Modules = Get-Module $Module -ListAvailable | where {$_.HelpInfoUri} }
else { $Modules = Get-Module -ListAvailable | where {$_.HelpInfoUri} }

foreach ($mModule in $Modules)
{
    $mDir = $mModule.ModuleBase

    if (Test-Path $mdir\*helpinfo.xml)
    {
        $mName=$mModule.Name
        $mNodes = dir $mdir\*helpinfo.xml -ErrorAction SilentlyContinue |
            Select-Xml -Namespace $HelpInfoNamespace -XPath "//helpInfo:UICulture"
        foreach ($mNode in $mNodes)
        {
            $mCulture=$mNode.Node.UICultureName
            $mVer=$mNode.Node.UICultureVersion

            [PSCustomObject]@{"ModuleName"=$mName; "Culture"=$mCulture; "Version"=$mVer}
        }
    }
}

ModuleName                              Culture                                 Version
----------                              -------                                 -------
ActiveDirectory                         en-US                                   3.0.0.0
ADCSAdministration                      en-US                                   3.0.0.0
ADCSDeployment                          en-US                                   3.0.0.0
ADDSDeployment                          en-US                                   3.0.0.0
ADFS                                    en-US                                   3.0.0.0

Parameters

-Confirm

U wordt gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:	SwitchParameter
Aliassen:	cf
Position:	Named
Default value:	False
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Credential

Hiermee geeft u referenties op van een gebruiker die gemachtigd is voor toegang tot de bestandssysteemlocatie die is opgegeven door SourcePath-. Deze parameter is alleen geldig wanneer de parameter SourcePath of LiteralPath wordt gebruikt in de opdracht.

Met de parameter Credential kunt u Update-Help opdrachten uitvoeren met de parameter SourcePath op externe computers. Door expliciete referenties op te geven, kunt u de opdracht uitvoeren op een externe computer en toegang krijgen tot een bestandsshare op een derde computer zonder een fout met toegang geweigerd of credSSP-verificatie te gebruiken om referenties te delegeren.

Typ een gebruikersnaam, zoals User01 of Domain01\User01, of voer een PSCredential--object in dat is gegenereerd door de Get-Credential-cmdlet. Als u een gebruikersnaam typt, wordt u gevraagd het wachtwoord in te voeren.

Referenties worden opgeslagen in een PSCredential-object en het wachtwoord wordt opgeslagen als een SecureString-.

Notitie

Zie voor meer informatie over SecureString gegevensbeveiliging Hoe veilig is SecureString?.

Type:	PSCredential
Position:	Named
Default value:	Current user
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Force

Geeft aan dat deze cmdlet niet de beperking één keer per dag volgt, versiecontrole overslaat en bestanden downloadt die de limiet van 1 GB overschrijden.

Zonder deze parameter wordt Update-Help slechts één keer in elke periode van 24 uur uitgevoerd. Downloads zijn beperkt tot 1 GB niet-gecomprimeerde inhoud per module en Help-bestanden worden alleen geïnstalleerd wanneer ze nieuwer zijn dan de bestaande bestanden op de computer.

De limiet per dag beveiligt de servers die de Help-bestanden hosten en maakt het praktisch voor u om een Update-Help opdracht toe te voegen aan uw PowerShell-profiel zonder dat de resourcekosten van herhaalde verbindingen of downloads in rekening worden gebracht.

Als u hulp wilt bijwerken voor een module in meerdere UI-culturen zonder de parameter Force, moet u alle UI-culturen in dezelfde opdracht opnemen, zoals:

Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-FullyQualifiedModule

De waarde kan een modulenaam, een volledige modulespecificatie of een pad naar een modulebestand zijn.

Wanneer de waarde een pad is, kan het pad volledig of relatief zijn. Een relatief pad wordt omgezet ten opzichte van het script dat de using-instructie bevat.

Wanneer de waarde een naam of modulespecificatie is, zoekt PowerShell naar de PSModulePath- voor de opgegeven module.

Een modulespecificatie is een hashtabel met de volgende sleutels.

ModuleName - Vereist Geeft de modulenaam op.
GUID - Optionele Geeft de GUID van de module aan.
Het is ook Vereist om ten minste een van de drie onderstaande sleutels op te geven.
- ModuleVersion - Hiermee geeft u een minimaal acceptabele versie van de module op.
- MaximumVersion - Hiermee geeft u de maximaal acceptabele versie van de module.
- RequiredVersion - Hiermee geeft u een exacte, vereiste versie van de module op. Dit kan niet worden gebruikt met de andere versiesleutels.

U kunt de parameter FullyQualifiedModule niet opgeven in dezelfde opdracht als een parameter Module.

Type:	ModuleSpecification[]
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-LiteralPath

Hiermee geeft u de map voor bijgewerkte Help-bestanden in plaats van ze te downloaden van internet. Gebruik deze parameter of SourcePath- als u de Save-Help-cmdlet hebt gebruikt om Help-bestanden naar een map te downloaden.

U kunt een mapobject, zoals uit de Get-Item of Get-ChildItem cmdlets, pijplijnen om te Update-Help.

In tegenstelling tot de waarde van SourcePath, wordt de waarde van LiteralPath- exact gebruikt zoals deze wordt getypt. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escapetekens bevat, plaatst u het tussen enkele aanhalingstekens. Enkele aanhalingstekens geven PowerShell aan dat er geen tekens als escapereeksen moeten worden geïnterpreteerd.

Type:	String[]
Aliassen:	PSPath
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-Module

Updates help voor de opgegeven modules. Voer een of meer modulenamen of naampatronen in een door komma's gescheiden lijst in of geef een bestand op met één modulenaam op elke regel. Jokertekens zijn toegestaan. U kunt pijplijnmodules van de Get-Module cmdlet naar de Update-Help cmdlet.

De modules die u opgeeft, moeten op de computer worden geïnstalleerd, maar ze hoeven niet te worden geïmporteerd in de huidige sessie. U kunt elke module opgeven in de sessie of een module die is geïnstalleerd op een locatie die wordt vermeld in de omgevingsvariabele $env:PSModulePath.

Een waarde van * (alle) pogingen om hulp bij te werken voor alle modules die op de computer zijn geïnstalleerd. Modules die geen ondersteuning bieden voor Updatable Help zijn opgenomen. Deze waarde kan fouten genereren wanneer de opdracht modules tegenkomt die geen ondersteuning bieden voor Updatable Help. Voer in plaats daarvan Update-Help uit zonder parameters.

De parameter module van de cmdlet Update-Help accepteert niet het volledige pad van een modulebestand of modulemanifestbestand. Als u hulp wilt bijwerken voor een module die zich niet op een $env:PSModulePath locatie bevindt, importeert u de module in de huidige sessie voordat u de opdracht Update-Help uitvoert.

Type:	String[]
Aliassen:	Name
Position:	0
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	True

-Recurse

Voert een recursieve zoekopdracht uit naar Help-bestanden in de opgegeven map. Deze parameter is alleen geldig wanneer de opdracht de parameter SourcePath gebruikt.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-SourcePath

Hiermee geeft u een bestandssysteemmap op waarin Update-Help bijgewerkte Help-bestanden krijgt, in plaats van ze te downloaden van internet. Voer het pad van een map in. Geef geen bestandsnaam of bestandsnaamextensie op. U kunt een map, zoals een map uit de Get-Item of Get-ChildItem cmdlets, naar Update-Help.

Standaard downloadt Update-Help bijgewerkte Help-bestanden van internet. Gebruik SourcePath- wanneer u de Save-Help cmdlet hebt gebruikt om bijgewerkte Help-bestanden naar een map te downloaden.

Als u een standaardwaarde wilt opgeven voor SourcePath-, gaat u naar Groepsbeleid, Computerconfiguratieen Het standaardbronpad instellen voorUpdate-Help. Met deze groepsbeleidsinstelling voorkomt u dat gebruikers Update-Help gebruiken om Help-bestanden van internet te downloaden. Zie about_Group_Policy_Settingsvoor meer informatie.

Type:	String[]
Position:	1
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-UICulture

Hiermee geeft u waarden voor ui-cultuur op die Update-Help gebruikt om bijgewerkte Help-bestanden op te halen. Voer een of meer taalcodes in, zoals es-ES, een variabele met cultuurobjecten of een opdracht waarmee cultuurobjecten worden opgehaald, zoals een Get-Culture of Get-UICulture opdracht. Jokertekens zijn niet toegestaan en u kunt geen gedeeltelijke taalcode indienen, zoals de.

Standaard krijgt Update-Help Help-bestanden in de gebruikersinterfacecultuur die is ingesteld voor het besturingssysteem. Als u de parameter UICulture opgeeft, zoekt Update-Help alleen naar hulp voor de opgegeven UI-cultuur.

Opdrachten die gebruikmaken van de parameter UICulture alleen slagen wanneer de module Help-bestanden biedt voor de opgegeven UI-cultuur. Als de opdracht mislukt omdat de opgegeven UI-cultuur niet wordt ondersteund, wordt er een foutbericht weergegeven.

Type:	CultureInfo[]
Position:	2
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-UseDefaultCredentials

Geeft aan dat Update-Help de opdracht uitvoert, inclusief het downloaden via internet, met behulp van de referenties van de huidige gebruiker. De opdracht wordt standaard uitgevoerd zonder expliciete referenties.

Deze parameter is alleen van kracht wanneer de webdownload gebruikmaakt van NT LAN Manager (NTLM), onderhandelt of op Kerberos gebaseerde verificatie.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-WhatIf

Toont wat er zou gebeuren als de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Type:	SwitchParameter
Aliassen:	wi
Position:	Named
Default value:	False
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

Invoerwaarden

DirectoryInfo

U kunt een mappadobject doorsluisen naar deze cmdlet.

PSModuleInfo

U kunt een moduleobject doorsluisen naar deze cmdlet.

Uitvoerwaarden

None

Deze cmdlet retourneert geen uitvoer.

Notities

Als u hulp wilt bijwerken voor de PowerShell-kernmodules, die de opdrachten bevatten die zijn geïnstalleerd met PowerShell of een module in de $PSHOME\Modules-map, start u PowerShell met de optie om als administrator uit te voeren .

Alleen leden van de groep Administrators op de computer kunnen help bijwerken voor de powerShell-kernmodules, de opdrachten die samen met PowerShell zijn geïnstalleerd en voor modules in de map $PSHOME\Modules. Als u niet gemachtigd bent om Help-bestanden bij te werken, kunt u de Help-bestanden online lezen. Bijvoorbeeld Get-Help Update-Help -Online.

Modules zijn de kleinste eenheid van updatable help. U kunt geen help bijwerken voor een bepaalde cmdlet. Als u de module met een bepaalde cmdlet wilt zoeken, gebruikt u de eigenschap ModuleName van de Get-Command-cmdlet, bijvoorbeeld (Get-Command Update-Help).ModuleName.

Omdat Help-bestanden zijn geïnstalleerd in de modulemap, kan de Update-Help cmdlet alleen bijgewerkte Help-bestand installeren voor modules die op de computer zijn geïnstalleerd. De cmdlet Save-Help kan echter hulp opslaan voor modules die niet op de computer zijn geïnstalleerd.

De cmdlet Update-Help is geïntroduceerd in Windows PowerShell 3.0. Het werkt niet in eerdere versies van PowerShell. Gebruik op computers met Windows PowerShell 2.0 en Windows PowerShell 3.0 de cmdlet Update-Help in een Windows PowerShell 3.0-sessie om Help-bestanden te downloaden en bij te werken. De Help-bestanden zijn beschikbaar voor zowel Windows PowerShell 2.0 als Windows PowerShell 3.0.

De cmdlets Update-Help en Save-Help gebruiken de volgende poorten om Help-bestanden te downloaden: Poort 80 voor HTTP en poort 443 voor HTTPS.

Update-Help ondersteunt alle modules en de PowerShell-kernmodules. Het biedt geen ondersteuning voor andere modules.

Als u hulp wilt bijwerken voor een module op een locatie die niet wordt vermeld in de omgevingsvariabele $env:PSModulePath, importeert u de module in de huidige sessie en voert u vervolgens een Update-Help opdracht uit. Voer Update-Help zonder parameters uit of gebruik de parameter Module om de modulenaam op te geven. De module- parameter van de Update-Help en Save-Help cmdlets accepteert niet het volledige pad van een modulebestand of modulemanifestbestand.

Elke module kan ondersteuning bieden voor Updatable Help. Zie Ondersteuning voor Help-ondersteuningvoor instructies voor het ondersteunen van Help-ondersteuning voor updatable Help in de modules die u maakt.

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

Delen via

Update-Help

Syntaxis

Description

Voorbeelden

Voorbeeld 1: Help-bestanden bijwerken voor alle modules

Voorbeeld 2: Help-bestanden bijwerken voor opgegeven modules

Voorbeeld 3: Help bijwerken op een systeem dat niet is ingesteld op de en-US landinstelling

Voorbeeld 4: Help-bestanden automatisch bijwerken

Voorbeeld 5: Help-bestanden op meerdere computers bijwerken vanuit een bestandsshare

Voorbeeld 6: Een lijst met bijgewerkte Help-bestanden ophalen

Voorbeeld 7: Modules zoeken die ondersteuning bieden voor Help bij bijwerken

Voorbeeld 8: Bijgewerkte Help-bestanden inventaris

Parameters

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

Invoerwaarden

Uitvoerwaarden

Notities

Aanvullende resources

Delen via

Update-Help

Syntaxis

Description

Voorbeelden

Voorbeeld 1: Help-bestanden bijwerken voor alle modules

Voorbeeld 2: Help-bestanden bijwerken voor opgegeven modules

Voorbeeld 3: Help bijwerken op een systeem dat niet is ingesteld op de en-US landinstelling

Voorbeeld 4: Help-bestanden automatisch bijwerken

Voorbeeld 5: Help-bestanden op meerdere computers bijwerken vanuit een bestandsshare

Voorbeeld 6: Een lijst met bijgewerkte Help-bestanden ophalen

Voorbeeld 7: Modules zoeken die ondersteuning bieden voor Help bij bijwerken

Voorbeeld 8: Bijgewerkte Help-bestanden inventaris

Parameters

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

Invoerwaarden

Uitvoerwaarden

Notities

Verwante koppelingen

Aanvullende resources