Update-Help
Downloadt en installeert de nieuwste Help-bestanden op uw computer.
Syntax
Path (Standaard)
Update-Help
[[-Module] <String[]>]
[[-SourcePath] <String[]>]
[[-UICulture] <CultureInfo[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-Recurse]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LiteralPath
Update-Help
[[-Module] <String[]>]
[[-UICulture] <CultureInfo[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-LiteralPath <String[]>]
[-Recurse]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-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 Get-Help cmdlet 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, Update-Help downloadt u de nieuwste Help-bestanden. De Help-bestanden kunnen worden gedownload en geïnstalleerd vanaf internet of een bestandsshare.
Zonder parameters worden Update-Help de Help-bestanden bijgewerkt 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 voor meer informatie about_Updatable_Help.
Update-Help controleert de versie van de geïnstalleerde Help. Als Update-Help u 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 uitgebreide parameter om status- en voortgangsgegevens te bekijken. Gebruik de moduleparameter om Help-bestanden voor een bepaalde module bij te werken.
U kunt ook gebruikmaken Update-Help van computers die niet zijn verbonden met internet. Gebruik eerst de Save-Helpcmdlet om 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 sourcePath-parameter om Update-Help 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 vereist beheerdersbevoegdheden in PowerShell 6.0 en lager. PowerShell 6.1 en hoger stelt het standaardbereikCurrentUserin op . Vóór PowerShell 6.1 was de scopeparameter niet beschikbaar.
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\Modulesinclusief de PowerShell Core-modules) wilt downloaden of bijwerken, start u PowerShell met behulp van de optie Als administrator uitvoeren. Bijvoorbeeld: Start-Process pwsh.exe -Verb RunAs.
Voorbeelden
Voorbeeld 1: Help-bestanden bijwerken voor alle modules
Met de Update-Help cmdlet worden Help-bestanden bijgewerkt voor geïnstalleerde modules die ondersteuning bieden voor Help-ondersteuning voor updatable. De cultuurtaal van de gebruikersinterface (UI) wordt ingesteld in het besturingssysteem.
Update-Help
Voorbeeld 2: Help-bestanden bijwerken voor opgegeven modules
De Update-Help cmdlet-updates helpen alleen bestanden 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, wordt er een foutbericht weergegeven voor de module en ui-cultuur.
In dit voorbeeld Update-Help wordt uitgevoerd op een systeem dat is ingesteld op de en-GB landinstelling.
Update-Help Microsoft.PowerShell.Utility -Force
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}..
English-US help content is available and can be installed using: Update-Help -UICulture en-US.
De Help-bestanden worden altijd gepubliceerd voor de en-US landinstelling. Als u de Engelse help wilt downloaden, voert Update-Help u de parameter UICulture uit en geeft u de en-US landinstelling op.
Voorbeeld 4: 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 Save-Help de opdracht worden de nieuwste Help-bestanden gedownload voor alle modules die ondersteuning bieden voor Updatable Help.
Met de parameter DestinationPath worden de bestanden opgeslagen in de \\Server01\Share\PSHelp bestandsshare. De referentieparameter geeft een gebruiker op die gemachtigd is om toegang te krijgen tot de bestandsshare.
De Invoke-Command cmdlet voert externe Update-Help opdrachten uit op meerdere computers. De parameter ComputerName haalt een lijst met externe computers op uit het Servers.txt-bestand . De parameter ScriptBlock voert de Update-Help opdracht uit en gebruikt de parameter SourcePath om de bestandsshare op te geven die de bijgewerkte Help-bestanden bevat. De referentieparameter geeft een gebruiker op die toegang heeft tot de bestandsshare en de externe Update-Help opdracht kan uitvoeren.
Voorbeeld 5: 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 Uitgebreid gebruiken om uitvoer weer te geven voor alle Help-bestanden of Help-bestanden voor een specifieke module.
Zonder de uitgebreide parameter Update-Help worden de resultaten van de opdracht niet weergegeven. De uitgebreide parameteruitvoer is handig om te controleren of de Help-bestanden zijn bijgewerkt of of de nieuwste versie is geïnstalleerd.
Update-Help -Module Microsoft.PowerShell.Utility -Verbose
Voorbeeld 6: Modules zoeken die ondersteuning bieden voor Help-ondersteuning voor updatable
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 Updatable Help. 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 7: Bijgewerkte Help-bestanden inventaris
In dit voorbeeld maakt het script Get-UpdateHelpVersion.ps1 een inventaris 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 klasse PSCustomObject 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
Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | False |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | Cf |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Credential
Hiermee geeft u referenties op van een gebruiker die gemachtigd is om toegang te krijgen tot de locatie van het bestandssysteem die is opgegeven door SourcePath. Deze parameter is alleen geldig wanneer de parameter SourcePath of LiteralPath wordt gebruikt in de opdracht.
Met de referentieparameter kunt u opdrachten uitvoeren Update-Help 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.
Note
Zie voor meer informatie over SecureString gegevensbeveiliging Hoe veilig is SecureString?.
Parametereigenschappen
| Type: | PSCredential |
| Default value: | Current user |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | 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 uitgevoerd in elke periode van 24 uur. 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
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | 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.
Parametereigenschappen
| Type: | |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | 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 van de Get-Item of Get-ChildItem cmdlets, Update-Helpnaar .
In tegenstelling tot de waarde van SourcePath wordt de waarde van LiteralPath exact gebruikt zoals deze is getypt. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escape-tekens bevat, zet het dan tussen enkele aanhalingstekens. Enkele aanhalingstekens zorgen ervoor dat PowerShell geen tekens als escapesequenties interpreteert.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | PSPath, LP |
Parametersets
LiteralPath
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | 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 uitvoeren.
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 $Env:PSModulePath omgevingsvariabele.
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 zonder parameters uit.
De moduleparameter van de Update-Help cmdlet 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 Update-Help opdracht uitvoert.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | True |
| DontShow: | False |
| Aliassen: | Name |
Parametersets
(All)
| Position: | 0 |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | False |
-Recurse
Voert een recursieve zoekopdracht uit naar Help-bestanden in de opgegeven map. Deze parameter is alleen geldig wanneer de opdracht gebruikmaakt van de sourcePath-parameter .
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Scope
Hiermee geeft u het systeembereik op waar help wordt bijgewerkt. Updates op het bereik AllUsers vereisen beheerdersbevoegdheden voor Windows systemen. De -Scope parameter is geïntroduceerd in PowerShell Core versie 6.1.
CurrentUser is het standaardbereik voor Help-bestanden in PowerShell 6.1 en hoger.
AllUsers kunnen worden opgegeven om help voor alle gebruikers te installeren of bij te werken. Op Unix-systemen sudo zijn bevoegdheden vereist om hulp bij te werken voor alle gebruikers. Bijvoorbeeld: sudo pwsh -c Update-Help
De acceptabele waarden zijn:
- HuidigeGebruiker
- Allusers
Parametereigenschappen
| Type: | UpdateHelpScope |
| Default value: | CurrentUser |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | False |
-SourcePath
Hiermee geeft u een bestandssysteemmap waarin Update-Help bijgewerkte Help-bestanden worden opgehaald, 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 van de Get-Item of Get-ChildItem cmdlets, Update-Helpnaar .
Downloadt standaard 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 voor SourcePath wilt opgeven, gaat u naar Groepsbeleid, Computerconfiguratie en stelt u het standaardbronpad in voor Update-Help. Met deze groepsbeleidsinstelling voorkomt u dat gebruikers Update-Help Help-bestanden downloaden van internet.
Zie about_Group_Policy_Settingsvoor meer informatie.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | Path |
Parametersets
Path
| Position: | 1 |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-UICulture
Hiermee geeft u de cultuurwaarden van de gebruikersinterface op waarvoor deze cmdlet bijgewerkte Help-bestanden ontvangt. Voer een of meer taalcodes in, zoals es-ESeen variabele die cultuurobjecten bevat of een opdracht waarmee cultuurobjecten worden opgehaald, zoals een Get-Culture of Get-UICulture opdracht. Jokertekens zijn niet toegestaan.
Update-Help Standaard worden help-bestanden in de UI-cultuur ingesteld voor het besturingssysteem of de terugvalcultuur. Als u de parameter UICulture opgeeft, Update-Help zoekt u alleen naar hulp voor de opgegeven taal.
Vanaf PowerShell 7.4 kunt u een gedeeltelijke taalcode gebruiken, zoals en het downloaden van help in het Engels voor elke regio.
Note
Ubuntu 18.04 heeft de standaardinstelling voor landinstellingen C.UTF.8gewijzigd in, wat geen herkende UI-cultuur is.
Update-Help Kan de Help op de achtergrond niet downloaden, tenzij u deze parameter gebruikt met een ondersteunde landinstelling, zoals en-US. Dit kan gebeuren op elk platform dat gebruikmaakt van een niet-ondersteunde waarde.
Parametereigenschappen
| Type: | |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | 2 |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-UseDefaultCredentials
Geeft aan dat Update-Help de opdracht, inclusief het downloaden via internet, wordt uitgevoerd 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.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-WhatIf
Toont wat er zou gebeuren wanneer de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | False |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | Wi |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.
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 uitvoeren als beheerder.
Alleen leden van de groep Administrators op de computer kunnen help bijwerken voor de kernmodules van PowerShell, de opdrachten die samen met PowerShell zijn geïnstalleerd en voor modules in de $PSHOME\Modules map. 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 vinden, gebruikt u bijvoorbeeld de eigenschap ModuleName van de Get-Command cmdlet (Get-Command Update-Help).ModuleName.
Omdat Help-bestanden zijn geïnstalleerd in de modulemap, kan de Update-Help cmdlet alleen een bijgewerkt Help-bestand installeren voor modules die op de computer zijn geïnstalleerd. De Save-Help cmdlet kan echter help 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 zowel Windows PowerShell 2.0 als 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 Update-Help en Save-Help cmdlets 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 $Env:PSModulePath omgevingsvariabele, importeert u de module in de huidige sessie en voert u vervolgens een Update-Help opdracht uit. Voer zonder parameters uit Update-Help of gebruik de moduleparameter om de modulenaam op te geven. De moduleparameter 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 Ondersteunende Help voor updatable Help voor ondersteuning in de modules die u maakt voor instructies voor het ondersteunen van Help-informatie over updatable.
De cmdlets Update-Help en Save-Help worden niet ondersteund in Windows Preinstallation Environment (Windows PE).