Update-Help
Lädt die neuesten Hilfedateien auf den Computer herunter und installiert sie.
Syntax
Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[[-SourcePath] <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-LiteralPath <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Beschreibung
Das Update-Help Cmdlet lädt die neuesten Hilfedateien für PowerShell-Module herunter und installiert sie auf Ihrem Computer. Sie müssen PowerShell nicht neu starten, um die Änderung wirksam zu machen. Sie können das Get-Help Cmdlet verwenden, um die neuen Hilfedateien sofort anzuzeigen.
Update-Help überprüft die Version der Hilfedateien auf Ihrem Computer. Wenn Sie keine Hilfedateien für ein Modul haben oder Ihre Hilfedateien veraltet sind, Update-Help laden Sie die neuesten Hilfedateien herunter. Die Hilfedateien können aus dem Internet oder einer Dateifreigabe heruntergeladen und installiert werden.
Aktualisiert ohne Parameter Update-Help die Hilfedateien für Module in der Sitzung und für alle installierten Module, die aktualisierbare Hilfe unterstützen. Module, die installiert, aber nicht in der aktuellen Sitzung geladen werden, sind enthalten. PowerShell-Module werden an einem Speicherort gespeichert, der in der Umgebungsvariablen $env:PSModulePath aufgeführt ist. Weitere Informationen hierzu finden Sie unter about_Updatable_Help.
Sie können den Parameter Module verwenden, um Hilfedateien für ein bestimmtes Modul zu aktualisieren. Verwenden Sie den UICulture-Parameter , um Hilfedateien in mehreren Sprachen und Gebietsschemas herunterzuladen.
Sie können auch auf Computern verwenden Update-Help , die nicht mit dem Internet verbunden sind. Verwenden Sie zunächst das Save-HelpCmdlet, um Hilfedateien aus dem Internet herunterzuladen und in einem freigegebenen Ordner zu speichern, auf den das System zugreifen kann, das nicht mit dem Internet verbunden ist. Verwenden Sie dann den SourcePath-Parameter von, Update-Help um die aktualisierten Hilfedateien von der freigegebenen herunterzuladen und auf dem Computer zu installieren.
Sie können Hilfeupdates automatisieren, indem Sie das Update-Help Cmdlet Zu Ihrem PowerShell-Profil hinzufügen. Wird standardmäßig Update-Help nur einmal pro Tag auf jedem Computer ausgeführt. Um den Grenzwert von einmal täglich zu überschreiben, verwenden Sie den Force-Parameter.
Das Update-Help Cmdlet wurde in Windows PowerShell 3.0 eingeführt.
Wichtig
Update-Help erfordert Administratorrechte in PowerShell 6.0 und niedriger.
PowerShell 6.1 und höher legen den Standardbereich auf fest CurrentUser.
Vor PowerShell 6.1 war der Parameter Scope nicht verfügbar.
Sie müssen Mitglied der Gruppe Administratoren auf dem Computer sein, um die Hilfedateien für die Wichtigsten PowerShell-Module zu aktualisieren.
Um die Hilfedateien für Module im PowerShell-Installationsverzeichnis ($PSHOME\Modules), einschließlich der PowerShell Core-Module, herunterzuladen oder zu aktualisieren, starten Sie PowerShell mithilfe der Option Als Administrator ausführen .
Beispiel: Start-Process pwsh.exe -Verb RunAs.
Beispiele
Beispiel 1: Aktualisieren von Hilfedateien für alle Module
Das Update-Help Cmdlet aktualisiert Hilfedateien für installierte Module, die aktualisierbare Hilfe unterstützen. Die Kultursprache der Benutzeroberfläche (UI) wird im Betriebssystem festgelegt.
Update-HelpBeispiel 2: Aktualisieren von Hilfedateien für angegebene Module
Das Update-Help Cmdlet aktualisiert Hilfedateien nur für Modulnamen, die mit Microsoft.PowerShell beginnen.
Update-Help -Module Microsoft.PowerShell*Beispiel 3: Aktualisieren von Hilfedateien für verschiedene Sprachen
Das Update-Help Cmdlet aktualisiert die Hilfedateien für Japanisch (ja-JP) und Englisch (en-US) für alle Module.
Wenn ein Modul keine Hilfedateien für eine angegebene Benutzeroberflächenkultur bereitstellt, wird eine Fehlermeldung für das Modul und die Benutzeroberflächenkultur angezeigt. In diesem Beispiel gibt die Fehlermeldung an, dass die ja-JP-Hilfedateien für das Modul Microsoft.PowerShell.Utility nicht gefunden wurden.
Update-Help -UICulture ja-JP, en-US
Update-Help : Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility' with UI culture(s) {ja-JP}
No UI culture was found that matches the following pattern: ja-JP.Beispiel 4: Aktualisieren von Hilfedateien auf mehreren Computern aus einer Dateifreigabe
In diesem Beispiel werden aktualisierte Hilfedateien aus dem Internet heruntergeladen und in einer Dateifreigabe gespeichert. Es werden Benutzeranmeldeinformationen benötigt, die über Berechtigungen für den Zugriff auf die Dateifreigabe und die Installation von Updates verfügen. Wenn eine Dateifreigabe verwendet wird, ist es möglich, Computer zu aktualisieren, die sich hinter Firewalls befinden oder nicht mit dem Internet verbunden sind.
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
}Der Save-Help Befehl lädt die neuesten Hilfedateien für alle Module herunter, die aktualisierbare Hilfe unterstützen.
Der Parameter DestinationPath speichert die Dateien in der \\Server01\Share\PSHelp Dateifreigabe. Der Parameter Credential gibt einen Benutzer an, der über die Berechtigung für den Zugriff auf die Dateifreigabe verfügt.
Das Invoke-Command Cmdlet führt Remotebefehle Update-Help auf mehreren Computern aus. Der ComputerName-Parameter ruft eine Liste der Remotecomputer aus der Servers.txt-Datei ab. Der ScriptBlock-Parameter führt den Update-Help Befehl aus und verwendet den SourcePath-Parameter , um die Dateifreigabe anzugeben, die die aktualisierten Hilfedateien enthält. Der Parameter Credential gibt einen Benutzer an, der auf die Dateifreigabe zugreifen und den Remotebefehl Update-Help ausführen kann.
Beispiel 5: Abrufen einer Liste aktualisierter Hilfedateien
Das Update-Help Cmdlet aktualisiert die Hilfe für ein angegebenes Modul. Das Cmdlet verwendet den allgemeinen Parameter Verbose , um die Liste der aktualisierten Hilfedateien anzuzeigen. Sie können Ausführlich verwenden, um die Ausgabe für alle Hilfedateien oder Hilfedateien für ein bestimmtes Modul anzuzeigen.
Ohne den Verbose-ParameterUpdate-Help werden die Ergebnisse des Befehls nicht angezeigt. Die Ausgabe des Verbose-Parameters ist nützlich, um zu überprüfen, ob die Hilfedateien aktualisiert wurden oder ob die neueste Version installiert ist.
Update-Help -Module Microsoft.PowerShell.Utility -VerboseBeispiel 6: Suchen nach Modulen, die aktualisierbare Hilfe unterstützen
In diesem Beispiel werden Module aufgelistet, die aktualisierbare Hilfe unterstützen. Der Befehl verwendet die HelpInfoUri-Eigenschaft des Moduls, um Module zu identifizieren, die aktualisierbare Hilfe unterstützen. Die HelpInfoUri-Eigenschaft enthält eine Adresse, die umgeleitet wird, wenn das Update-Help Cmdlet ausgeführt wird.
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, ... }Beispiel 7: Inventur aktualisierte Hilfedateien
In diesem Beispiel erstellt das Skript Get-UpdateHelpVersion.ps1 eine Inventur der aktualisierbaren Hilfedateien für jedes Modul und deren Versionsnummern.
Das Skript identifiziert Module, die aktualisierbare Hilfe unterstützen, indem die HelpInfoUri-Eigenschaft von Modulen verwendet wird. Bei Modulen, die aktualisierbare Hilfe unterstützen, sucht und analysiert das Skript die Hilfeinformationsdatei (*helpinfo.xml), um die neueste Versionsnummer zu finden.
Das Skript verwendet die PSCustomObject-Klasse und eine Hashtabelle, um ein benutzerdefiniertes Ausgabeobjekt zu erstellen.
# 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.0Parameter
-Confirm
Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Gibt Die Anmeldeinformationen eines Benutzers an, der über die Berechtigung für den Zugriff auf den von SourcePath angegebenen Dateisystemspeicherort verfügt. Dieser Parameter ist nur gültig, wenn der SourcePath- oder LiteralPath-Parameter im Befehl verwendet wird.
Mit dem Parameter Credential können Sie Befehle mit dem Parameter SourcePath auf Remotecomputern ausführenUpdate-Help. Indem Sie explizite Anmeldeinformationen angeben, können Sie den Befehl auf einem Remotecomputer ausführen und auf eine Dateifreigabe auf einem dritten Computer zugreifen, ohne dass ein Zugriffsfehler auftritt oder die CredSSP-Authentifizierung zum Delegieren von Anmeldeinformationen verwendet wird.
Geben Sie einen Benutzernamen ein, z. B. User01 oder Domain01\User01, oder geben Sie ein vom Get-Credential Cmdlet generiertes PSCredential-Objekt ein. Wenn Sie einen Benutzernamen eingeben, werden Sie aufgefordert, das Kennwort einzugeben.
Anmeldeinformationen werden in einem PSCredential-Objekt gespeichert, und das Kennwort wird als SecureString gespeichert.
Hinweis
Weitere Informationen zum Schutz von SecureString-Daten finden Sie unter Wie sicher ist SecureString?.
| Type: | PSCredential |
| Position: | Named |
| Default value: | Current user |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Gibt an, dass dieses Cmdlet die Einmal-pro-Tag-Beschränkung nicht befolgt, die Versionsprüfung überspringt und Dateien herunterlädt, die den Grenzwert von 1 GB überschreiten.
Ohne diesen Parameter Update-Help wird nur einmal pro 24-Stunden-Zeitraum ausgeführt. Downloads sind auf 1 GB nicht komprimierter Inhalte pro Modul beschränkt, und Hilfedateien werden nur installiert, wenn sie neuer als die vorhandenen Dateien auf dem Computer sind.
Der Grenzwert für einmal pro Tag schützt die Server, die die Hilfedateien hosten, und macht es für Sie praktisch, Ihrem PowerShell-Profil einen Update-Help Befehl hinzuzufügen, ohne die Ressourcenkosten für wiederholte Verbindungen oder Downloads zu verursacht.
Um die Hilfe für ein Modul in mehreren Benutzeroberflächenkulturen ohne den Force-Parameter zu aktualisieren, schließen Sie alle Benutzeroberflächenkulturen in denselben Befehl ein, z. B.:
Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FullyQualifiedModule
Gibt Module mit Namen an, die in Form von ModuleSpecification-Objekten angegeben werden. Diese Module werden im Abschnitt Hinweise des ModuleSpecification-Konstruktors (Hashtable) beschrieben.
Der Parameter FullyQualifiedModule akzeptiert beispielsweise einen Modulnamen, der im folgenden Format angegeben ist:
@{ModuleName = "modulename"; ModuleVersion = "version_number"}
oder
@{ModuleName = "modulename"; ModuleVersion = "version_number"; Guid = "GUID"}.
ModuleName und ModuleVersion sind erforderlich, aber Guid ist optional.
Sie können den Parameter FullyQualifiedModule nicht im gleichen Befehl wie einen Module-Parameter angeben.
| Type: | ModuleSpecification[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LiteralPath
Gibt den Ordner für aktualisierte Hilfedateien an, anstatt sie aus dem Internet herunterzuladen. Verwenden Sie diesen Parameter oder SourcePath , wenn Sie das Cmdlet zum Herunterladen von Save-Help Hilfedateien in ein Verzeichnis verwendet haben.
Sie können ein Verzeichnisobjekt, z. B. über das Get-Item Cmdlet oder Get-ChildItem , an pipelineen Update-Help.
Im Gegensatz zum Wert von SourcePath wird der Wert von LiteralPath genau so verwendet, wie er eingegeben wird. Es werden keine Zeichen als Platzhalter interpretiert. Wenn der Pfad Escapezeichen enthält, müssen Sie ihn in einfache Anführungszeichen einschließen. Einfache Anführungszeichen weisen PowerShell an, keine Zeichen als Escapesequenzen zu interpretieren.
| Type: | String[] |
| Aliases: | PSPath, LP |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Module
Aktualisiert die Hilfe für die angegebenen Module. Geben Sie einen oder mehrere Modulnamen oder Namensmuster in eine durch Trennzeichen getrennte Liste ein, oder geben Sie eine Datei an, die einen Modulnamen in jeder Zeile auflistet. Platzhalterzeichen sind zulässig. Sie können Module vom Get-Module Cmdlet an das Update-Help Cmdlet weiterleiten.
Die von Ihnen angegebenen Module müssen auf dem Computer installiert sein, müssen aber nicht in die aktuelle Sitzung importiert werden. Sie können jedes Modul in der Sitzung oder ein beliebiges Modul angeben, das an einem In der Umgebungsvariablen $env:PSModulePath aufgeführten Speicherort installiert ist.
Der Wert ( * all) versucht, die Hilfe für alle Module zu aktualisieren, die auf dem Computer installiert sind.
Module, die keine aktualisierbare Hilfe unterstützen, sind enthalten. Dieser Wert kann Fehler generieren, wenn der Befehl auf Module trifft, die die aktualisierbare Hilfe nicht unterstützen. Führen Sie stattdessen ohne Parameter aus Update-Help .
Der Parameter Module des Update-Help Cmdlets akzeptiert nicht den vollständigen Pfad einer Moduldatei oder Modulmanifestdatei. Um die Hilfe für ein Modul zu aktualisieren, das sich nicht an einem $env:PSModulePath Speicherort befindet, importieren Sie das Modul in die aktuelle Sitzung, bevor Sie den Update-Help Befehl ausführen.
| Type: | String[] |
| Aliases: | Name |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-Recurse
Führt eine rekursive Suche nach Hilfedateien im angegebenen Verzeichnis aus. Dieser Parameter ist nur gültig, wenn der Befehl den SourcePath-Parameter verwendet.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Scope
Gibt den Systembereich an, in dem die Hilfe aktualisiert wird. Updates im Bereich AllUsers erfordern Administratorrechte auf Windows-Systemen. Der -Scope Parameter wurde in PowerShell Core Version 6.1 eingeführt.
CurrentUser ist der Standardbereich für Hilfedateien in PowerShell 6.1 und höher. AllUsers kann angegeben werden, um die Hilfe für alle Benutzer zu installieren oder zu aktualisieren. Unter Unix-Systemen sudo sind Berechtigungen erforderlich, um die Hilfe für alle Benutzer zu aktualisieren. Beispiel: sudo pwsh -c Update-Help
Gültige Werte sind:
- CurrentUser
- AllUsers
| Type: | UpdateHelpScope |
| Position: | Named |
| Default value: | CurrentUser |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SourcePath
Gibt einen Dateisystemordner an, in dem Update-Help aktualisierte Hilfedateien abgerufen werden, anstatt sie aus dem Internet herunterzuladen. Geben Sie den Pfad eines Ordners ein. Geben Sie keinen Dateinamen oder eine Dateinamenerweiterung an. Sie können einen Ordner, z. B. einen ordner aus den Get-Item Cmdlets oder Get-ChildItem , an pipelineen Update-Help.
Standardmäßig Update-Help werden aktualisierte Hilfedateien aus dem Internet heruntergeladen. Verwenden Sie SourcePath , wenn Sie das Save-Help Cmdlet verwendet haben, um aktualisierte Hilfedateien in ein Verzeichnis herunterzuladen.
Um einen Standardwert für SourcePath anzugeben, wechseln Sie zu Gruppenrichtlinie, Computerkonfiguration und Festlegen des Standardquellpfads für Update-Help. Diese Gruppenrichtlinie Einstellung verhindert, dass Benutzer Update-Help Hilfedateien aus dem Internet herunterladen können.
Weitere Informationen finden Sie unter about_Group_Policy_Settings.
| Type: | String[] |
| Aliases: | Path |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UICulture
Gibt Benutzeroberflächenkulturwerte an, die Update-Help verwendet, um aktualisierte Hilfedateien abzurufen. Geben Sie einen oder mehrere Sprachcodes ein, z. B. es-ES, eine Variable, die Kulturobjekte enthält, oder einen Befehl, der Kulturobjekte abruft, z. B. einen Get-Culture - oder Get-UICulture -Befehl. Wildcardzeichen sind nicht zulässig, und Sie können keinen teilsprachischen Code übermitteln, z. B. de.
Ruft standardmäßig Hilfedateien in der benutzeroberflächenspezifischen Kultur ab, Update-Help die für das Betriebssystem festgelegt ist. Wenn Sie den UICulture-Parameter angeben, Update-Help sucht nur nach Hilfe für die angegebene Benutzeroberflächenkultur.
Hinweis
Ubuntu 18.04 hat die Standardeinstellung für das Gebietsschema in C.UTF.8geändert, was keine anerkannte Benutzeroberflächenkultur ist. Update-Help Die Hilfe kann nicht automatisch heruntergeladen werden, es sei denn, Sie verwenden diesen Parameter mit einem unterstützten Gebietsschema wie en-US. Dies kann auf jeder Plattform auftreten, die einen nicht unterstützten Wert verwendet.
Befehle, die den UICulture-Parameter verwenden, werden nur dann erfolgreich ausgeführt, wenn das Modul Hilfedateien für die angegebene Benutzeroberflächenkultur bereitstellt. Wenn der Befehl fehlschlägt, weil die angegebene Benutzeroberflächenkultur nicht unterstützt wird, wird eine Fehlermeldung angezeigt.
| Type: | CultureInfo[] |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseDefaultCredentials
Gibt an, dass Update-Help den Befehl, einschließlich des Internetdownloads, mit den Anmeldeinformationen des aktuellen Benutzers ausführt. Standardmäßig wird der Befehl ohne explizite Anmeldeinformationen ausgeführt.
Dieser Parameter ist nur wirksam, wenn der Webdownload NT LAN Manager (NTLM), Negotiate oder Kerberos-basierte Authentifizierung verwendet.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Eingaben
Sie können einen Verzeichnispfad an übergeben Update-Help.
Sie können ein Modulobjekt aus dem Get-Module Cmdlet an übergeben Update-Help.
Ausgaben
None
Update-Help generiert keine Ausgabe.
Hinweise
Starten Sie PowerShell mit der Option Als Administrator ausführen, um die Hilfe für die wichtigsten PowerShell-Module zu aktualisieren, die die Befehle enthalten, die $PSHOME\Modules mit PowerShell oder einem beliebigen Modul im Verzeichnis installiert sind.
Nur Mitglieder der Gruppe Administratoren auf dem Computer können Hilfe für die PowerShell-Kernmodule, die Befehle, die zusammen mit PowerShell installiert werden, und für Module im $PSHOME\Modules Ordner aktualisieren. Wenn Sie nicht über die Berechtigung zum Aktualisieren von Hilfedateien verfügen, können Sie die Hilfedateien online lesen. Beispiel: Get-Help Update-Help -Online.
Module sind die kleinste Einheit der aktualisierbaren Hilfe. Sie können die Hilfe für ein bestimmtes Cmdlet nicht aktualisieren. Um das Modul zu suchen, das ein bestimmtes Cmdlet enthält, verwenden Sie die ModuleName-Eigenschaft des Get-Command Cmdlets (Get-Command Update-Help).ModuleName, z. B. .
Da Hilfedateien im Modulverzeichnis installiert sind, kann das Cmdlet die Update-Help aktualisierte Hilfedatei nur für Module installieren, die auf dem Computer installiert sind. Das Save-Help Cmdlet kann jedoch Hilfe für Module speichern, die nicht auf dem Computer installiert sind.
Wenn Update-Help aktualisierte Hilfedateien für ein Modul nicht gefunden werden oder keine aktualisierte Hilfe in der angegebenen Sprache gefunden werden kann, wird der Vorgang automatisch fortgesetzt, ohne dass eine Fehlermeldung angezeigt wird. Verwenden Sie zum Anzeigen des Status und der Fortschrittsdetails den Verbose-Parameter.
Das Update-Help Cmdlet wurde in Windows PowerShell 3.0 eingeführt. In früheren Versionen von PowerShell funktioniert dies nicht. Verwenden Sie auf Computern mit Windows PowerShell 2.0 und Windows PowerShell 3.0 das Update-Help Cmdlet in einer Windows PowerShell 3.0-Sitzung, um Hilfedateien herunterzuladen und zu aktualisieren. Die Hilfedateien sind sowohl für Windows PowerShell 2.0 als auch für Windows PowerShell 3.0 verfügbar.
Die Update-Help Cmdlets und Save-Help verwenden die folgenden Ports zum Herunterladen von Hilfedateien: Port 80 für HTTP und Port 443 für HTTPS.
Update-Help unterstützt alle Module und die wichtigsten PowerShell-Snap-Ins. Andere Snap-Ins werden nicht unterstützt.
Um die Hilfe für ein Modul an einem Speicherort zu aktualisieren, der nicht in der $env:PSModulePath Umgebungsvariablen aufgeführt ist, importieren Sie das Modul in die aktuelle Sitzung, und führen Sie dann einen Befehl aus Update-Help . Führen Sie ohne Parameter aus Update-Help , oder verwenden Sie den Parameter Module , um den Modulnamen anzugeben. Der Module-Parameter der Update-Help Cmdlets und Save-Help akzeptiert nicht den vollständigen Pfad einer Moduldatei oder Modulmanifestdatei.
Jedes Modul kann die aktualisierbare Hilfe unterstützen. Anweisungen zur Unterstützung der aktualisierbaren Hilfe in den von Ihnen erstellten Modulen finden Sie unter Unterstützung der aktualisierbaren Hilfe.
Die Update-Help Cmdlets und Save-Help werden in Windows Preinstallation Environment (Windows PE) nicht unterstützt.