Get-Help Kommando: Syntax, Parametrar, Exempel
Bläddra bland inläggsämnen
- Introduktion
- Powershell Get-Help Kommandosyntax
- Powershell Get-Help parametrar
- Exempel på Powershell Get-Help
- Powershell Get-Help Exempel 1: Grundläggande Powershell Hjälp
- Powershell Get-Help Exempel 2: Detaljerad och fullständig Powershell-hjälp
- Powershell Get-Help Exempel 3: Online Powershell Hjälp
- Powershell Get-Help Exempel 4: Kategori Powershell Hjälp
- Powershell Get-Help Exempel 5: Få exempel på en Cmdlet
- Slutsats
- Andra användbara guider
- Ytterligare resurser och referenser
Introduktion
Vet du inte hur man använder en PowerShell-cmdlet? PowerShell Get-Help cmdlet ger dig information om alla powerShell-kommandon.
I den här guiden kommer du att lära dig hur du använder PowerShell Get-Help cmdlet. Dess syntax, parametrar och några exempel.
Powershell Get-Help Kommandosyntax
Den förenklade syntaxen för Powershell Get-Help är:
|_+_| Vissa parametrar för Powershell Get-Help cmdleten visas inte ovan. Jag listade bara parametrar som du behöver för dagligt bruk. Get-Help-cmdleten kan tillhandahålla PowerShell-hjälpinformation för cmdlets, funktioner, CIM-kommandon, arbetsflöden, leverantörer, alias och skript.
Powershell Get-Help parametrar
Tabellen nedan listar parametrarna som visas i det sista avsnittet och vad de betyder. Den innehåller också exempel. För detaljerade exempel, se Exemplen längre fram i guiden.
| S/N | Parameter | Menande | Powershell Get-Help Exempel |
| ett | namn | Anger namnet på cmdleten, funktionen, skriptet, arbetsflödet, leverantören eller aliaset | Get-Help -Name Get-Command |
| två | Parameter | Används för att ange en parameter för den cmdlet du behöver få hjälp för | Get-Help -Name Get-Command -Parameter Name |
| 3 | Exempel | Denna parameter kräver inget ingångsvärde. Om det anges kommer Get-Help att returnera exempel för cmdleten | Get-Help -Name Get-Command -Exempel |
| 4 | Kategori | Visar endast hjälp för objekt i den angivna kategorin och deras alias. Några accepterade värden: Alias, Cmdlet, etc | Få-hjälp -Kategorialias |
| 5 | Full | Visar hela hjälpämnet för en cmdlet, inklusive parametrar, attribut och exempel | Få-hjälp Get-Command -Full |
| 6 | Detaljerad | Lägger till parameterbeskrivningar och exempel till den grundläggande hjälpdisplayen. | Få-hjälp Få-kommando - Detaljerad |
| 7 | Uppkopplad | Öppnar onlineversionen av ett hjälpämne i standardwebbläsaren | Få-hjälp Get-Command -Online |
Exempel på Powershell Get-Help
Här är några exempel på PowerShell Get-Help cmdlet. I det här avsnittet kommer jag att använda Get-Help för att få information om Get-Command-cmdleten.
Powershell Get-Help Exempel 1: Grundläggande Powershell Hjälp
För att få den grundläggande hjälpinformationen om Get-Command-cmdleten, kör kommandot nedan:
har internet men kan inte ansluta till ånga|_+_|
I det här exemplet är cmdleten Hämta-kommando . Observera att jag inte inkluderade parametern -Name. Det behöver inte ingå. Här är resultatet av kommandot i PowerShell.
Kommandot återkom SYNOPSIS (beskrivning av cmdleten), dess SYNTAX (hur man använder cmdleten) och dess BESKRIVNING (detaljerad information om cmdleten).
Powershell Get-Help Exempel 2: Detaljerad och fullständig Powershell-hjälp
För att visa mer detaljerad information om en cmdlet, inkludera helt enkelt Detaljerad parameter. Här är det modifierade exemplet.
|_+_|När du inkluderar Detaljerad parameter, Get-Help lägger till parameterbeskrivningar och exempel till den grundläggande PowerShell-hjälpinformationen.
Det mesta av informationen visas inte i föregående bild.Dessutom, om du vill visa den fullständiga hjälpinformationen om cmdleten, använd Full parameter.
Här är ett exempel på kommando:
|_+_|
Powershell Get-Help Exempel 3: Online Powershell Hjälp
Om du vill att Get-Help ska öppna onlinehjälpen för cmdleten, använd Uppkopplad parameter. Get-Help öppnar hjälpinformationen för cmdleten med din standardwebbläsare.
Här är kommandot för att visa onlineinformationen för Get-Command-cmdleten.
|_+_|Här är resultatet. Öppnad i Chrome (min standardwebbläsare):
Powershell Get-Help Exempel 4: Kategori Powershell Hjälp
Kommandot Get-Help har en parameter som kallas Kategori . Du kan använda detta för att få hjälpinformation om någon av följande kategorier:
Alias, Cmdlet, Provider, General, FAQ, Ordlista, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class and Configuration
En mycket användbar tillämpning av detta är att visa en fullständig lista över alias för alla PowerShell-cmdlets i din dator.
Här är kommandot:
|_+_|Och resultatet...
Att använda cmdlet-alias förkortar ditt skript. Nästa gång du skriptar kan du få aliasen för cmdlets med kommandot ovan.I ett annat exempel, för att returnera ALLA cmdlets i din dator, använd kommandot nedan:
|_+_|Om du behöver specifika cmdlets kan du använda Where-Object-cmdleten för att returnera dem.
Som ett exempel, för att returnera kommandon som börjar med orden Vad , använd kommandot nedan
|_+_|Detta kommer att returnera cmdletarna nära det jag vill ha. Se resultaten nedan:
Powershell Get-Help Exempel 5: Få exempel på en Cmdlet
En av fördelarna med Powershell Get-Help-kommandot är att det kan ge dig exempel på hur du använder en cmdlet.
För att visa exempel på hur man använder Get-Command, använd kommandot nedan:
|_+_|Kommandot visar alla tillgängliga exempel:
Slutsats
Jag hoppas att den här guiden förenklade hur du använder Powershell Get-Help åt dig. Viktigast av allt, jag hoppas att du har hittat en eller två saker du behöver för att skriva ditt nästa PowerShell-skript.
Om du har några frågor eller kommentarer, använd formuläret Lämna ett svar i slutet av denna sida. Du kan också dela din personliga erfarenhet av PowerShell.
För att lära dig mer om powershell, besök vår PowerShell-sida. Du kan också söka i PowerShell för att lista alla våra PowerShell-guider.
Andra användbara guider
- 18 mest användbara Powershell-kommandon för Windows-administratörer
- Hur man schemalägger ett PowerShell-skript för att köras automatiskt på en Windows-server
