Delen via

Get-Help

  • Referentie
Module:
Microsoft.PowerShell.Core

Geeft informatie weer over PowerShell-opdrachten en -concepten.

Syntaxis

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Description

De Get-Help cmdlet geeft informatie weer over PowerShell-concepten en -opdrachten, waaronder cmdlets, functies, CIM-opdrachten (Common Information Model), werkstromen, providers, aliassen en scripts.

Als u hulp wilt krijgen voor een PowerShell-cmdlet, typt u Get-Help gevolgd door de naam van de cmdlet, zoals: Get-Help Get-Process.

Conceptuele Help-artikelen in PowerShell beginnen met about_, zoals about_Comparison_Operators. Als u alle about_ artikelen wilt zien, typt u Get-Help about_*. Als u een bepaald artikel wilt zien, typt u Get-Help about_<article-name>, zoals Get-Help about_Comparison_Operators.

Als u hulp wilt krijgen voor een PowerShell-provider, typt u Get-Help gevolgd door de naam van de provider. Als u bijvoorbeeld hulp wilt krijgen voor de certificaatprovider, typt u Get-Help Certificate.

U kunt ook help of mantypen, waarin één scherm met tekst tegelijk wordt weergegeven. Of <cmdlet-name> -?, die identiek is aan Get-Help, maar werkt alleen voor cmdlets.

Get-Help de Help-inhoud krijgt die wordt weergegeven uit Help-bestanden op uw computer. Zonder de Help-bestanden geeft Get-Help alleen basisinformatie over cmdlets weer. Sommige PowerShell-modules bevatten Help-bestanden. Vanaf PowerShell 3.0 bevatten de modules die worden geleverd met het Windows-besturingssysteem geen Help-bestanden. Als u de Help-bestanden voor een module in PowerShell 3.0 wilt downloaden of bijwerken, gebruikt u de cmdlet Update-Help.

U kunt ook de Help-documenten van PowerShell online bekijken in Microsoft Docs. Als u de onlineversie van een Help-bestand wilt ophalen, gebruikt u de parameter Online, zoals: Get-Help Get-Process -Online. Als u alle PowerShell-documentatie wilt lezen, raadpleegt u de Microsoft Docs PowerShell-documentatie.

Als u Get-Help typt gevolgd door de exacte naam van een Help-artikel of een woord dat uniek is voor een Help-artikel, Get-Help de inhoud van het artikel weergeeft. Als u de exacte naam van een opdrachtalias opgeeft, geeft Get-Help de Help voor de oorspronkelijke opdracht weer. Als u een woord- of woordpatroon invoert dat in verschillende Help-artikeltitels wordt weergegeven, Get-Help een lijst met overeenkomende titels weergeeft. Als u tekst invoert die niet in help-artikeltitels wordt weergegeven, Get-Help een lijst met artikelen met die tekst in de inhoud weergeeft.

Get-Help kunt help-artikelen krijgen voor alle ondersteunde talen en landinstellingen. Get-Help zoekt eerst naar Help-bestanden in de landinstelling voor Windows, vervolgens in de landinstelling van de bovenliggende site, zoals pt voor pt-BRen vervolgens in een landinstelling voor terugval. Vanaf PowerShell 3.0, als Get-Help geen help vindt in de landinstelling voor terugval, zoekt deze naar Help-artikelen in het Engels, en-US, voordat er een foutbericht wordt geretourneerd of automatisch gegenereerde Help wordt weergegeven.

Zie Get-Helpvoor informatie over de symbolen die in het diagram met de opdrachtsyntaxis worden weergegeven. Zie about_Parametersvoor informatie over parameterkenmerken, zoals Vereist en Positie.

Notitie

In PowerShell 3.0 en PowerShell 4.0 kunt Get-Help geen over artikelen in modules vinden, tenzij de module in de huidige sessie wordt geïmporteerd. Dit is een bekend probleem. Als u Artikelen over in een module wilt ophalen, importeert u de module met behulp van de Import-Module-cmdlet of door een cmdlet uit te voeren die is opgenomen in de module.

Voorbeelden

Voorbeeld 1: Algemene Help-informatie over een cmdlet weergeven

In deze voorbeelden worden basisinformatie over de help-informatie over de Format-Table-cmdlet weergegeven.

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> is de eenvoudigste en standaardsyntaxis van Get-Help cmdlet. U kunt de parameter Name weglaten.

De syntaxis <cmdlet-name> -? werkt alleen voor cmdlets.

Voorbeeld 2: Basisinformatie één pagina tegelijk weergeven

In deze voorbeelden worden basisinformatie over de help-informatie over de Format-Table cmdlet één pagina tegelijk weergegeven.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help is een functie die intern Get-Help cmdlet uitvoert en het resultaat één pagina tegelijk weergeeft.

man is een alias voor de functie help.

Get-Help Format-Table verzendt het object omlaag in de pijplijn. Out-Host -Paging de uitvoer van de pijplijn ontvangt en één pagina tegelijk weergeeft. Zie Out-Hostvoor meer informatie.

Voorbeeld 3: Meer informatie weergeven voor een cmdlet

In deze voorbeelden ziet u gedetailleerdere help-informatie over de cmdlet Format-Table.

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

De parameter Gedetailleerde geeft de gedetailleerde weergave van het Help-artikel weer met parameterbeschrijvingen en voorbeelden.

De parameter Full geeft de volledige weergave van het Help-artikel weer met parameterbeschrijvingen, voorbeelden, typen invoer- en uitvoerobjecten en aanvullende opmerkingen.

De parameters Gedetailleerde en Volledige zijn alleen van kracht voor de opdrachten waarop Help-bestanden op de computer zijn geïnstalleerd. De parameters zijn niet effectief voor de Help-artikelen (about_).

Voorbeeld 4: Geselecteerde onderdelen van een cmdlet weergeven met behulp van parameters

In deze voorbeelden worden geselecteerde gedeelten van de help van de Format-Table cmdlet weergegeven.

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

In de parameter Voorbeelden worden de secties NAME en SYNOPSIS en alle voorbeelden weergegeven. U kunt geen voorbeeldnummer opgeven omdat de Voorbeelden parameter een schakelparameter is.

In de parameter parameter worden alleen de beschrijvingen van de opgegeven parameters weergegeven. Als u alleen het jokerteken (*) opgeeft, worden de beschrijvingen van alle parameters weergegeven. Wanneer parameter een parameternaam zoals GroupBy-opgeeft, wordt informatie over die parameter weergegeven.

Deze parameters zijn niet effectief voor de Help-artikelen (about_).

Voorbeeld 5: Onlineversie van Help weergeven

In dit voorbeeld wordt de onlineversie van het Help-artikel voor de Format-Table-cmdlet weergegeven in uw standaardwebbrowser.

Get-Help Format-Table -Online

Voorbeeld 6: Help weergeven over het Help-systeem

De Get-Help cmdlet zonder parameters geeft informatie weer over het PowerShell Help-systeem.

Get-Help

Voorbeeld 7: Beschikbare Help-artikelen weergeven

In dit voorbeeld wordt een lijst weergegeven met alle Help-artikelen die beschikbaar zijn op uw computer.

Get-Help *

Voorbeeld 8: Een lijst met conceptuele artikelen weergeven

In dit voorbeeld wordt een lijst weergegeven met de conceptuele artikelen die zijn opgenomen in PowerShell Help. Al deze artikelen beginnen met de tekens about_. Als u een bepaald Help-bestand wilt weergeven, typt u Get-Help \<about_article-name\>, bijvoorbeeld Get-Help about_Signing.

Alleen de conceptuele artikelen met Help-bestanden die op uw computer zijn geïnstalleerd, worden weergegeven. Zie Help-help-voor informatie over het downloaden en installeren van Help-bestanden in PowerShell 3.0.

Get-Help about_*

Voorbeeld 9: Zoeken naar een woord in de Help voor cmdlets

In dit voorbeeld ziet u hoe u kunt zoeken naar een woord in een Help-artikel over cmdlets.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help gebruikt de parameter Volledige om help-informatie voor Add-Memberop te halen. Het MamlCommandHelpInfo--object wordt verzonden naar de pijplijn. Out-String gebruikt de parameter Stream om het object te converteren naar een tekenreeks. Select-String gebruikt de parameter Pattern om de tekenreeks te zoeken naar Clixml-.

Voorbeeld 10: Een lijst met artikelen weergeven die een woord bevatten

In dit voorbeeld ziet u een lijst met artikelen met het woord externe.

Wanneer u een woord invoert dat niet in een artikeltitel wordt weergegeven, Get-Help een lijst met artikelen met dat woord weergeeft.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Voorbeeld 11: Specifieke help voor de provider weergeven

In dit voorbeeld ziet u twee manieren om de providerspecifieke hulp voor Get-Itemop te halen. Deze opdrachten krijgen hulp bij het gebruik van de Get-Item-cmdlet in het DataCollection- knooppunt van de PowerShell SQL Server-provider.

In het eerste voorbeeld wordt de parameter Get-HelpPath gebruikt om het pad van de SQL Server-provider op te geven. Omdat het pad van de provider is opgegeven, kunt u de opdracht uitvoeren vanaf elke padlocatie.

In het tweede voorbeeld wordt Set-Location gebruikt om naar het pad van de SQL Server-provider te navigeren. Vanaf die locatie is de parameter Path niet nodig voor Get-Help om de providerspecifieke hulp te krijgen.

Get-Help Get-Item -Path SQLSERVER:\DataCollection

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Set-Location SQLSERVER:\DataCollection
SQLSERVER:\DataCollection> Get-Help Get-Item

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Voorbeeld 12: Help voor een script weergeven

In dit voorbeeld krijgt u hulp voor de MyScript.ps1 script. Zie about_Comment_Based_Helpvoor meer informatie over het schrijven van help voor uw functies en scripts.

Get-Help -Name C:\PS-Test\MyScript.ps1

Parameters

-Category

Geeft alleen help weer voor items in de opgegeven categorie en de bijbehorende aliassen. Conceptuele artikelen bevinden zich in de HelpFile categorie.

De acceptabele waarden voor deze parameter zijn als volgt:

  • Alias
  • Cmdlet
  • Aanbieder
  • Algemeen
  • FAQ
  • Glossarium
  • HelpFile
  • ScriptOpdracht
  • Functie
  • Filter
  • ExternalScript
  • Alle
  • DefaultHelp
  • Werkstroom
  • DscResource
  • Klas
  • Configuratie
Type:String[]
Geaccepteerde waarden:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Component

Geeft opdrachten weer met de opgegeven onderdeelwaarde, zoals Exchange. Voer een onderdeelnaam in. Jokertekens zijn toegestaan. Deze parameter heeft geen effect op weergaven van conceptuele help (About_).

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

-Detailed

Voegt parameterbeschrijvingen en voorbeelden toe aan de weergave basishulp. Deze parameter is alleen van kracht wanneer de Help-bestanden op de computer zijn geïnstalleerd. Het heeft geen effect op weergaven van conceptuele hulp (About_).

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

-Examples

Geeft alleen de naam, synopsis en voorbeelden weer. Als u alleen de voorbeelden wilt weergeven, typt u (Get-Help \<cmdlet-name\>).Examples.

Deze parameter is alleen van kracht wanneer de Help-bestanden op de computer zijn geïnstalleerd. Het heeft geen effect op weergaven van conceptuele hulp (About_).

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

-Full

Hiermee wordt het hele Help-artikel voor een cmdlet weergegeven. Volledige bevat parameterbeschrijvingen en kenmerken, voorbeelden, typen invoer- en uitvoerobjecten en aanvullende notities.

Deze parameter is alleen van kracht wanneer de Help-bestanden op de computer zijn geïnstalleerd. Het heeft geen effect op weergaven van conceptuele hulp (About_).

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

-Functionality

Geeft help weer voor items met de opgegeven functionaliteit. Voer de functionaliteit in. Jokertekens zijn toegestaan. Deze parameter heeft geen effect op weergaven van conceptuele help (About_).

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

-Name

Hiermee krijgt u hulp over de opgegeven opdracht of het opgegeven concept. Voer de naam in van een cmdlet, functie, provider, script of werkstroom, zoals Get-Member, een conceptuele artikelnaam, zoals about_Objectsof een alias, zoals ls. Jokertekens zijn toegestaan in cmdlet- en providernamen, maar u kunt geen jokertekens gebruiken om de namen van help- en script-help-artikelen te vinden.

Als u hulp wilt krijgen voor een script dat zich niet in een pad bevindt dat wordt vermeld in de omgevingsvariabele $env:Path, typt u het pad en de bestandsnaam van het script.

Als u de exacte naam van een Help-artikel invoert, Get-Help de inhoud van het artikel weergeeft.

Als u een woord- of woordpatroon invoert dat in verschillende Help-artikeltitels wordt weergegeven, Get-Help een lijst met overeenkomende titels weergeeft.

Als u tekst invoert die niet overeenkomt met help-artikeltitels, Get-Help een lijst met artikelen met die tekst in de inhoud weergeeft.

De namen van conceptuele artikelen, zoals about_Objects, moeten worden ingevoerd in het Engels, zelfs in niet-Engelse versies van PowerShell.

Type:String
Position:0
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:True

-Online

Geeft de onlineversie van een Help-artikel weer in de standaardbrowser. Deze parameter is alleen geldig voor help-artikelen over cmdlets, functies, werkstromen en scripts. U kunt de parameter Online niet gebruiken met Get-Help in een externe sessie.

Zie about_Comment_Based_Helpen Ondersteunende Online Help-en Help voor PowerShell-cmdlets schrijven voor PowerShell-cmdlets voor meer informatie over het ondersteunen van deze functie.

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

-Parameter

Geeft alleen de gedetailleerde beschrijvingen van de opgegeven parameters weer. Jokertekens zijn toegestaan. Deze parameter heeft geen effect op weergaven van conceptuele help (About_).

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

-Path

Hiermee wordt uitgelegd hoe de cmdlet werkt in het opgegeven providerpad. Voer een PowerShell-providerpad in.

Met deze parameter wordt een aangepaste versie van een Help-artikel voor cmdlets opgehaald waarin wordt uitgelegd hoe de cmdlet werkt in het opgegeven PowerShell-providerpad. Deze parameter is alleen van kracht voor hulp bij een provider-cmdlet en alleen wanneer de provider een aangepaste versie van het Help-artikel van de provider-cmdlet in het Help-bestand bevat. Als u deze parameter wilt gebruiken, installeert u het Help-bestand voor de module die de provider bevat.

Als u de help voor aangepaste cmdlets voor een providerpad wilt bekijken, gaat u naar de locatie van het providerpad en voert u een opdracht Get-Help in of gebruikt u de parameter Path van Get-Help om het pad van de provider op te geven. U kunt ook online aangepaste help voor cmdlets vinden in de helpsectie van de provider van de Help-artikelen.

Zie about_Providers voor meer informatie over PowerShell-providers.

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

-Role

Geeft help weer die is aangepast voor de opgegeven gebruikersrol. Voer een rol in. Jokertekens zijn toegestaan.

Voer de rol in die de gebruiker speelt in een organisatie. Sommige cmdlets geven verschillende tekst weer in hun Help-bestanden op basis van de waarde van deze parameter. Deze parameter heeft geen effect op help voor de kern-cmdlets.

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

-ShowWindow

Hiermee wordt het Help-onderwerp weergegeven in een venster voor eenvoudiger lezen. Het venster bevat een zoekfunctie Zoeken en een -instellingen vak waarmee u opties voor de weergave kunt instellen, inclusief opties om alleen geselecteerde secties van een Help-onderwerp weer te geven.

De parameter ShowWindow ondersteunt Help-onderwerpen voor opdrachten (cmdlets, functies, CIM-opdrachten, scripts) en conceptuele Over artikelen. Het biedt geen ondersteuning voor hulp van providers.

Deze parameter is opnieuw geïntroduceerd in PowerShell 7.0.

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

Invoerwaarden

None

U kunt geen objecten in de pijplijn naar Get-Helpverzenden.

Uitvoerwaarden

ExtendedCmdletHelpInfo

Als u Get-Help uitvoert op een opdracht die geen Help-bestand heeft, retourneert Get-Help een ExtendedCmdletHelpInfo-object dat automatisch gegenereerde Help vertegenwoordigt.

String

Als u een conceptueel Help-artikel krijgt, Get-Help het als een tekenreeks retourneert.

MamlCommandHelpInfo

Als u een opdracht met een Help-bestand krijgt, retourneert Get-Help een MamlCommandHelpInfo object.

Notities

PowerShell 3.0 bevat geen Help-bestanden. Als u de Help-bestanden wilt downloaden en installeren die Get-Help leest, gebruikt u de cmdlet Update-Help. U kunt de cmdlet Update-Help gebruiken om Help-bestanden te downloaden en te installeren voor de kernopdrachten die bij PowerShell worden geleverd en voor alle modules die u installeert. U kunt deze ook gebruiken om de Help-bestanden bij te werken, zodat de help op uw computer nooit verouderd is.

U kunt ook de Help-artikelen lezen over de opdrachten die online worden geleverd met PowerShell vanaf Aan de slag met Windows PowerShell.

Get-Help geeft help weer in de landinstelling die is ingesteld voor het Windows-besturingssysteem of in de terugvaltaal voor die landinstelling. Als u geen Help-bestanden voor de primaire of terugvallocatie hebt, gedraagt Get-Help zich alsof er geen Help-bestanden op de computer zijn. Als u hulp wilt krijgen voor een andere landinstelling, gebruikt u Regio en Language in het Configuratiescherm om de instellingen te wijzigen. In Windows 10 of hoger Instellingen, Time & Language.

De volledige weergave van help bevat een tabel met informatie over de parameters. De tabel bevat de volgende velden:

  • Vereist. Geeft aan of de parameter vereist is (waar) of optioneel (onwaar).

  • Positie. Geeft aan of de parameter een naam heeft of positioneel (numeriek). Positionele parameters moeten worden weergegeven op een opgegeven plaats in de opdracht.

  • benoemde geeft aan dat de parameternaam vereist is, maar dat de parameter overal in de opdracht kan worden weergegeven.

  • numerieke geeft aan dat de parameternaam optioneel is, maar wanneer de naam wordt weggelaten, moet de parameter op de plaats staan die is opgegeven door het getal. 2 geeft bijvoorbeeld aan dat wanneer de parameternaam wordt weggelaten, de parameter de tweede of alleen niet-benoemde parameter in de opdracht moet zijn. Wanneer de parameternaam wordt gebruikt, kan de parameter overal in de opdracht worden weergegeven.

  • standaardwaarde. De parameterwaarde of het standaardgedrag dat PowerShell gebruikt als u de parameter niet in de opdracht opneemt.

  • Accepteert pijplijninvoer. Hiermee wordt aangegeven of u objecten via een pijplijn naar de parameter kunt verzenden (waar) of niet (onwaar). Op eigenschapsnaam betekent dat het pijplijnobject een eigenschap moet hebben met dezelfde naam als de parameternaam.

  • accepteert jokertekens. Hiermee wordt aangegeven of de waarde van een parameter jokertekens kan bevatten, zoals een sterretje (*) of vraagteken (?).