Update-Help

Referenz

Modul:: Microsoft.PowerShell.Core

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]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-Help
      [[-Module] <String[]>]
      [-FullyQualifiedModule <ModuleSpecification[]>]
      [-LiteralPath <String[]>]
      [-Recurse]
      [[-UICulture] <CultureInfo[]>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-Force]
      [-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.

Ohne Parameter werden die Hilfedateien für Module aktualisiert, Update-Help die aktualisierbare Hilfe unterstützen und in der Sitzung geladen oder an einem Speicherort installiert werden, der in der $env:PSModulePathDatei enthalten ist. Weitere Informationen hierzu finden Sie unter about_Updatable_Help.

Update-Help überprüft die Installierte Version der Hilfe. Wenn Update-Help aktualisierte Hilfedateien für ein Modul nicht gefunden werden können, wird sie im Hintergrund fortgesetzt, ohne eine Fehlermeldung anzuzeigen. Verwenden Sie den Parameter Force , um die Versionsüberprüfung zu überspringen. Verwenden Sie den Verbose-Parameter , um Status- und Statusdetails anzuzeigen. Verwenden Sie den Parameter "Module ", um Hilfedateien für ein bestimmtes Modul zu aktualisieren.

Wenn die kulturellen Einstellungen Ihres Betriebssystems für eine Sprache konfiguriert sind, die für aktualisierbare Hilfe nicht verfügbar ist, wird dies im Hintergrund fortgesetzt, Update-Help ohne Hilfe herunterzuladen. Verwenden Sie den UICulture-Parameter , um Hilfedateien in einer unterstützten Sprache herunterzuladen. Die Hilfe ist immer für das en-US Gebietsschema verfügbar.

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-ParameterUpdate-Help, um die aktualisierten Hilfedateien aus der freigegebenen Datei herunterzuladen und auf dem Computer zu installieren.

Das Update-Help Cmdlet wurde in Windows PowerShell 3.0 eingeführt.

Wichtig

Update-Help erfordert Administratorrechte.

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\Moduleseinschließlich der PowerShell Core-Module) herunterzuladen oder zu aktualisieren, starten Sie PowerShell mithilfe der Option "Als Administrator ausführen". Beispiel: Start-Process powershell.exe -Verb RunAs

Sie können Auch Hilfedateien aktualisieren, indem Sie das Menüelement "Windows PowerShell-Hilfe aktualisieren" im Hilfemenü in der integrierten Skriptumgebung (ISE) von Windows PowerShell verwenden.

Das Windows PowerShell-Hilfeelement aktualisieren führt ein Update-Help Cmdlet ohne Parameter aus. Um Hilfe für Module im $PSHOME Verzeichnis zu aktualisieren, starten Sie Windows PowerShell ISE mithilfe der Option "Als Administrator ausführen".

Beispiele

Beispiel 1: Aktualisieren von Hilfedateien für alle Module

Das Update-Help Cmdlet aktualisiert Hilfedateien für installierte Module, die die aktualisierbare Hilfe unterstützen. Die Benutzeroberflächenkultursprache wird im Betriebssystem festgelegt.

Update-Help

Beispiel 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 der Hilfe für ein System, das nicht auf das Gebietsschema "en-US" festgelegt ist

Das Update-Help Cmdlet wurde entwickelt, um Hilfe in mehreren Sprachen herunterzuladen. Wenn jedoch keine Hilfe für die von Ihrem System verwendete Sprache verfügbar ist, schlägt dies im Hintergrund fehl, Update-Help es sei denn, Sie verwenden den UICulture-Parameter .

In diesem Beispiel wird auf einem System ausgeführt, Update-Help das auf das en-GB Gebietsschema festgelegt ist.

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

Die Hilfedateien werden immer für das en-US Gebietsschema veröffentlicht. Führen Sie zum Update-Help Herunterladen der englischen Hilfe den UICulture-Parameter aus, und geben Sie das en-US Gebietsschema an.

Beispiel 4: Automatisches Aktualisieren von Hilfedateien

In diesem Beispiel wird ein geplanter Auftrag erstellt, der die Hilfe für alle Module täglich um 3:00 Uhr aktualisiert.

$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

Das Register-ScheduledJob Cmdlet erstellt einen geplanten Auftrag, der einen Update-Help Befehl ausführt. Der Befehl verwendet den Parameter "Credential ", um mithilfe der Anmeldeinformationen eines Mitglieds der Gruppe "Administratoren" auf dem Computer auszuführen Update-Help . Der Wert des Trigger-Parameters ist ein New-JobTrigger Befehl, der einen Auftragstrigger erstellt, der den Auftrag täglich um 3:00 Uhr startet.

Um den Register-ScheduledJob Befehl auszuführen, starten Sie PowerShell mithilfe der Option "Als Administrator ausführen". PowerShell fordert Sie zum Kennwort des Benutzers auf, der im Parameter "Anmeldeinformationen " angegeben ist. Die Anmeldeinformationen werden mit dem geplanten Auftrag gespeichert. Sie werden nicht aufgefordert, wenn der Auftrag ausgeführt wird.

Mit dem Get-ScheduledJob Cmdlet können Sie den geplanten Auftrag anzeigen, das Set-ScheduledJob Cmdlet verwenden, um ihn zu ändern, und das Unregister-ScheduledJob Cmdlet zum Löschen verwenden. Sie können den geplanten Auftrag auch im Taskplaner im folgenden Pfad anzeigen und verwalten:

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

Beispiel 5: Aktualisieren von Hilfedateien auf mehreren Computern aus einer Dateifreigabe

In diesem Beispiel werden aktualisierte Hilfedateien aus dem Internet heruntergeladen und in einer Dateifreigabe gespeichert. Benutzeranmeldeinformationen sind erforderlich, 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 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 Parameter ComputerName ruft eine Liste von Remotecomputern 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 6: Abrufen einer Liste der aktualisierten Hilfedateien

Die Update-Help Cmdlet-Hilfe für ein angegebenes Modul wird aktualisiert. Das Cmdlet verwendet den allgemeinen Parameter "Verbose common", um die Liste der aktualisierten Hilfedateien anzuzeigen. Mit "Ausführlich" können Sie die Ausgabe für alle Hilfedateien oder Hilfedateien für ein bestimmtes Modul anzeigen.

Ohne den Verbose-Parameter Update-Help werden die Ergebnisse des Befehls nicht angezeigt. Die Ausführliche Parameterausgabe ist hilfreich, um zu überprüfen, ob die Hilfedateien aktualisiert wurden oder ob die neueste Version installiert ist.

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

Beispiel 7: Suchen von Modulen, die die aktualisierbare Hilfe unterstützen

In diesem Beispiel werden Module aufgelistet, die die aktualisierbare Hilfe unterstützen. Der Befehl verwendet die HelpInfoUri-Eigenschaft des Moduls, um Module zu identifizieren, die die aktualisierbare Hilfe unterstützen. Die HelpInfoUri-Eigenschaft enthält eine URL, die beim Ausführen des Update-Help Cmdlets umgeleitet 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 8: Inventur aktualisierte Hilfedateien

In diesem Beispiel erstellt das Skript Get-UpdateHelpVersion.ps1 ein Inventar der aktualisierbaren Hilfedateien für jedes Modul und deren Versionsnummern.

Das Skript identifiziert Module, die die aktualisierbare Hilfe mithilfe der HelpInfoUri-Eigenschaft von Modulen unterstützen. Für Module, die die aktualisierbare Hilfe unterstützen, sucht das Skript nach und analysiert 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.0

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Typ:	SwitchParameter
Aliase:	cf
Position:	Named
Standardwert:	False
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Credential

Gibt Anmeldeinformationen eines Benutzers an, der über die Berechtigung für den Zugriff auf den durch 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 SourcePath-Parameter 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 Zugriff verweigert wird 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 Cmdlet generiertes Get-Credential 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 finden Sie unter "Wie sicher ist SecureString?".

Typ:	PSCredential
Position:	Named
Standardwert:	Current user
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Force

Gibt an, dass dieses Cmdlet nicht der Einschränkung von einmal pro Tag folgt, die Versionsüberprüfung überspringt und Dateien herunterlädt, die den Grenzwert von 1 GB überschreiten.

Ohne diesen Parameter Update-Help wird nur einmal in jedem 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 sind als die vorhandenen Dateien auf dem Computer.

Der Grenzwert für einmal pro Tag schützt die Server, auf denen die Hilfedateien gehostet werden, und macht es praktisch, dass Sie Ihrem PowerShell-Profil einen Update-Help Befehl hinzufügen können, ohne dass die Ressourcenkosten für wiederholte Verbindungen oder Downloads entstehen.

Um Hilfe für ein Modul in mehreren Benutzeroberflächenkulturen ohne den Parameter Force 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

Typ:	SwitchParameter
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-FullyQualifiedModule

Der Wert kann ein Modulname, eine vollständige Modulspezifikation oder ein Pfad zu einer Moduldatei sein.

Wenn der Wert ein Pfad ist, kann der Pfad vollqualifizierte oder relativ sein. Ein relativer Pfad wird relativ zum Skript aufgelöst, das die using-Anweisung enthält.

Wenn es sich bei dem Wert um einen Namen oder eine Modulspezifikation handelt, durchsucht PowerShell den PSModulePath nach dem angegebenen Modul.

Eine Modulspezifikation ist eine Hashtabelle mit den folgenden Schlüsseln.

ModuleName - Erforderlich . Gibt den Modulnamen an.
GUID - Optional Gibt die GUID des Moduls an.
Es ist auch erforderlich , mindestens eine der drei folgenden Tasten anzugeben.
- ModuleVersion - Gibt eine mindestens akzeptable Version des Moduls an.
- MaximumVersion - Gibt die maximal zulässige Version des Moduls an.
- RequiredVersion - Gibt eine genaue, erforderliche Version des Moduls an. Dies kann nicht mit den anderen Versionsschlüsseln verwendet werden.

Sie können den Parameter "FullyQualifiedModule " nicht im selben Befehl wie einen Modulparameter angeben.

Typ:	ModuleSpecification[]
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	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 Save-Help Cmdlet zum Herunterladen von Hilfedateien in ein Verzeichnis verwendet haben.

Sie können ein Verzeichnisobjekt, z. B. von den Get-Item CmdletsGet-ChildItem, an weiterleiten.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.

Typ:	String[]
Aliase:	PSPath
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	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, in der in jeder Zeile ein Modulname aufgeführt wird. 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 jedoch nicht in die aktuelle Sitzung importiert werden. Sie können ein beliebiges Modul in der Sitzung oder ein beliebiges Modul angeben, das an einem Speicherort installiert ist, der in der $env:PSModulePath Umgebungsvariable aufgeführt ist.

Ein Wert von * (allen) Versuchen, Hilfe für alle Module zu aktualisieren, die auf dem Computer installiert sind. Module, die die aktualisierbare Hilfe nicht unterstützen, sind enthalten. Dieser Wert kann Fehler generieren, wenn der Befehl auf Module trifft, die keine aktualisierbare Hilfe 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 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.

Typ:	String[]
Aliase:	Name
Position:	0
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	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.

Typ:	SwitchParameter
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	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 keine Dateinamen- oder Dateinamenerweiterung an. Sie können einen Ordner, z. B. einen ordner aus den Get-Item Cmdlets, Get-ChildItem anleiten.Update-Help

Update-Help Standardmäßig werden aktualisierte Hilfedateien aus dem Internet heruntergeladen. Verwenden Sie SourcePath , wenn Sie das Save-Help Cmdlet zum Herunterladen aktualisierter Hilfedateien in ein Verzeichnis verwendet haben.

Um einen Standardwert für SourcePath anzugeben, wechseln Sie zu "Gruppenrichtlinie", "Computerkonfiguration", und legen Sie den Standardquellpfad für "Update-Help" fest. Diese Gruppenrichtlinieneinstellung verhindert, dass Benutzer Update-Help Hilfedateien aus dem Internet herunterladen. Weitere Informationen finden Sie unter about_Group_Policy_Settings.

Typ:	String[]
Position:	1
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-UICulture

Gibt Werte für die Benutzeroberflächenkultur an, die Update-Help zum Abrufen aktualisierter Hilfedateien verwendet werden. Geben Sie einen oder mehrere Sprachcodes ein, z. B. es-ES, eine Variable, die Kulturobjekte enthält, oder einen Befehl, der Kulturobjekte wie z. B. ein oder Get-UICulture einen Get-Culture Befehl abruft. Wildcardzeichen sind nicht zulässig, und Sie können keinen teilweisen Sprachcode senden, z . B. de.

Ruft standardmäßig Update-Help Hilfedateien im Benutzeroberflächenkultursatz für das Betriebssystem ab. Wenn Sie den UICulture-Parameter angeben, Update-Help wird nur nach Hilfe für die angegebene UI-Kultur gesucht.

Befehle, die den UICulture-Parameter verwenden, sind nur erfolgreich, wenn das Modul Hilfedateien für die angegebene UI-Kultur bereitstellt. Wenn der Befehl fehlschlägt, da die angegebene Benutzeroberflächenkultur nicht unterstützt wird, wird eine Fehlermeldung angezeigt.

Typ:	CultureInfo[]
Position:	2
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-UseDefaultCredentials

Gibt an, dass Update-Help der Befehl, einschließlich des Internetdownloads, mithilfe der Anmeldeinformationen des aktuellen Benutzers ausgeführt wird. Standardmäßig wird der Befehl ohne explizite Anmeldeinformationen ausgeführt.

Dieser Parameter ist nur wirksam, wenn der Webdownload NT LAN Manager (NTLM), Aushandeln oder Kerberos-basierte Authentifizierung verwendet.

Typ:	SwitchParameter
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:	SwitchParameter
Aliase:	wi
Position:	Named
Standardwert:	False
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

Eingaben

DirectoryInfo

Sie können ein Verzeichnispfadobjekt an dieses Cmdlet weiterleiten.

PSModuleInfo

Sie können ein Modulobjekt an dieses Cmdlet weiterleiten.

Ausgaben

None

Dieses Cmdlet gibt keine Ausgabe zurück.

Hinweise

Um Hilfe für die wichtigsten PowerShell-Module zu aktualisieren, die die Befehle enthalten, die mit PowerShell oder einem beliebigen Modul im $PSHOME\Modules Verzeichnis installiert sind, starten Sie PowerShell mit der Option "Als Administrator ausführen".

Nur Mitglieder der Gruppe "Administratoren" auf dem Computer können Hilfe für die wichtigsten PowerShell-Module, die Befehle, die zusammen mit PowerShell installiert sind, 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 finden, das ein bestimmtes Cmdlet enthält, verwenden Sie z. B. die ModuleName-Eigenschaft des Get-Command Cmdlets (Get-Command Update-Help).ModuleName.

Da Hilfedateien im Modulverzeichnis installiert sind, kann das Update-Help Cmdlet 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.

Das Update-Help Cmdlet wurde in Windows PowerShell 3.0 eingeführt. Es funktioniert nicht in früheren Versionen von PowerShell. 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 und Save-Help Cmdlets verwenden die folgenden Ports, um Hilfedateien herunterzuladen: Port 80 für HTTP und Port 443 für HTTPS.

Update-Help unterstützt alle Module und die wichtigsten PowerShell-Snap-Ins. Es werden keine anderen Snap-Ins unterstützt.

Um 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 Update-Help Befehl aus. Führen Sie Update-Help ohne Parameter aus, oder verwenden Sie den Parameter "Module ", um den Modulnamen anzugeben. Der Parameter "Module" der Update-Help Und-Cmdlets 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 Modulen, die Sie erstellen, finden Sie unter Unterstützen der aktualisierbaren Hilfe.

Die Update-Help Und Save-Help Cmdlets werden unter Windows Preinstallation Environment (Windows PE) nicht unterstützt.

Freigeben über

Update-Help

Syntax

Beschreibung

Beispiele

Beispiel 1: Aktualisieren von Hilfedateien für alle Module

Beispiel 2: Aktualisieren von Hilfedateien für angegebene Module

Beispiel 3: Aktualisieren der Hilfe für ein System, das nicht auf das Gebietsschema "en-US" festgelegt ist

Beispiel 4: Automatisches Aktualisieren von Hilfedateien

Beispiel 5: Aktualisieren von Hilfedateien auf mehreren Computern aus einer Dateifreigabe

Beispiel 6: Abrufen einer Liste der aktualisierten Hilfedateien

Beispiel 7: Suchen von Modulen, die die aktualisierbare Hilfe unterstützen

Beispiel 8: Inventur aktualisierte Hilfedateien

Parameter

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

Eingaben

Ausgaben

Hinweise

Zusätzliche Ressourcen

Freigeben über

Update-Help

Syntax

Beschreibung

Beispiele

Beispiel 1: Aktualisieren von Hilfedateien für alle Module

Beispiel 2: Aktualisieren von Hilfedateien für angegebene Module

Beispiel 3: Aktualisieren der Hilfe für ein System, das nicht auf das Gebietsschema "en-US" festgelegt ist

Beispiel 4: Automatisches Aktualisieren von Hilfedateien

Beispiel 5: Aktualisieren von Hilfedateien auf mehreren Computern aus einer Dateifreigabe

Beispiel 6: Abrufen einer Liste der aktualisierten Hilfedateien

Beispiel 7: Suchen von Modulen, die die aktualisierbare Hilfe unterstützen

Beispiel 8: Inventur aktualisierte Hilfedateien

Parameter

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

Eingaben

Ausgaben

Hinweise

Ähnliche Themen

Zusätzliche Ressourcen