Brug Show-Command og Get-Help i PowerShell

  • 10 minutter

Cmdlet'en Show-Command åbner et vindue, der enten viser en liste over kommandoer eller en bestemt kommandos parametre. Dette vindue er det samme, der vises, når du vælger indstillingen Viskommandovindue i ISE.

Hvis du vil have vist parametrene for en bestemt kommando, skal du angive navnet på kommandoen som værdien for parameteren -Name. Hvis du f.eks. vil åbne Viskommandovindue med den kommando, der bruges til at hente en Active Directory-bruger, skal du angive følgende kommando i konsollen og derefter trykke på Enter:

Show-Command –Name Get-ADUser

Parameteren – navn er positionsparameter, så følgende kommando giver det samme resultat:

Show-Command Get-ADUser

Hvis du vælger indstillingen Viskommandovindue i ISE, og markøren er inden for eller umiddelbart ud for et kommandonavn i konsollen eller scriptruden, er resultaterne de samme.

Seddel

I disse eksempler er Show-Command den kommando, du faktisk kører, men Get-ADUser er navnet på den kommando, du vil gennemse i dialogboksen.

I Viskommandovinduevises hvert parametersæt for den angivne kommando under en separat fane. Det gør det visuelt klart, at du ikke kan blande og matche parametre mellem sæt.

Når du har angivet værdier for alle påkrævede parametre, kan du køre kommandoen med det samme ved at vælge Kør i vinduet Vis-kommandoer. Du kan også kopiere den til Udklipsholder ved at vælge Kopiér. Fra Udklipsholder kan du indsætte kommandoen i konsollen, så du kan gennemse den korrekte kommandolinjesyntaks uden at køre kommandoen.

Bemærk, at Show-Command- også viser Windows PowerShell-almindelige parametre, som er et sæt parametre, som Windows PowerShell føjer til alle kommandoer for at levere et foruddefineret sæt kernefunktioner. Du får mere at vide om mange af de almindelige parametre i kommende moduler. Men hvis du vil vide mere om dem nu, skal du køre hjælpe med at about_common_parameters i Windows PowerShell og gennemse resultaterne.

Brug af Get-Help

Windows PowerShell indeholder omfattende hjælp i produktet til kommandoer. Du kan få adgang til denne hjælp ved hjælp af kommandoen Get-Help. Get-Help- viser alt Hjælp-indhold på skærmen og lader dig rulle gennem det. Du kan også bruge funktionen Hjælp eller aliasset Man, som er knyttet til kommandoen Get-Help. Alle tre returnerer stort set de samme resultater. Disse resultater omfatter en kort og lang beskrivelse af cmdlet'en, syntaksen, eventuelle yderligere bemærkninger fra hjælpforfatteren og links til relaterede cmdlet'er eller yderligere oplysninger online. Kommandoerne hjælpe og Man med at vise indhold i konsollen én side ad gangen. ISE viser hele Hjælp-indholdet.

Hvis du f.eks. vil have vist hjælpoplysningerne for Get-ChildItem-cmdlet'en, skal du angive følgende kommando i konsollen og derefter trykke på Enter:

Get-Help Get-ChildItem

Get-Help parametre

Kommandoen Get-Help accepterer parametre, der giver dig mulighed for at finde flere oplysninger ud over de oplysninger, der vises som standard. En almindelig årsag til at søge yderligere hjælp er at identificere brugseksempler for en kommando. Windows PowerShell-kommandoer omfatter ofte mange sådanne eksempler. Hvis du f.eks. kører kommandoen Get-Help Stop-Process –eksempler,, vises eksempler på brug af Stop-proces--cmdlet'en.

Parameteren -Full indeholder detaljerede oplysninger om en cmdlet, herunder:

  • En beskrivelse af hver parameter.
  • Om hver parameter har en standardværdi (selvom disse oplysninger ikke dokumenteres konsekvent på tværs af alle kommandoer).
  • Angiver, om en parameter er obligatorisk.
  • Angiver, om en parameter kan acceptere en værdi på en bestemt placering (i hvilket tilfælde positionsnummeret, der starter fra 1), eller om du skal angive parameternavnet (i hvilket tilfælde med navnet vises).
  • Angiver, om en parameter accepterer pipelineinput og i så fald hvordan.

Andre parametre for Get-Help- omfatter:

  • -ShowWindow. Viser Hjælp-emnet i et separat vindue, hvilket gør det meget nemmere at få adgang til Hjælp, mens du angiver kommandoer.
  • -Online. Viser onlineversionen af Hjælp-emnet (typisk de mest up-to-datooplysninger) i et browservindue.
  • -Parameter ParameterName. Viser beskrivelsen af en navngivet parameter.
  • - kategori. Viser kun hjælp til visse kategorier af kommandoer, f.eks. cmdlet'er og funktioner.

Brug Get-Help til at finde kommandoer

Kommandoen Get-Help kan være meget nyttig til at finde kommandoer. Den accepterer jokertegn (*, ?), især jokertegnet stjerne (*). Når du beder om hjælp og bruger jokertegn med et delvist kommandonavn, viser Windows PowerShell en liste over matchende emner i Hjælp.

Ved hjælp af de oplysninger, du lærte tidligere om cmdlet'ers verbum-navneordsstruktur, kan du bruge Get-Help- som et værktøj til at finde cmdlet'er, selvom du ikke kender deres navne. Hvis du f.eks. vil have alle de cmdlet'er, der fungerer på processer, kan du angive kommandoen Get-Help *proces* i konsollen og derefter trykke på Enter. Resultaterne svarer til dem, der returneres af kommandoen Get-Command *process*, bortset fra at Get-Help- viser en synopsis. Denne oversigt er en kort beskrivelse, der hjælper dig med at identificere den ønskede kommando.

Nogle gange kan du angive en søgning med jokertegn, der ikke svarer til et kommandonavn. Hvis du f.eks. kører Get-Help *bip*, kan du ikke finde nogen kommandoer, der har bip i deres navn. Når der ikke findes nogen resultater, udfører Hjælpesystemet en fuldtekstsøgning af tilgængelige kommandobeskrivelser og -synopses. Denne søgning finder alle Hjælp-filer, der indeholder bip. Hvis der kun er en enkelt fil med et match, viser Hjælp-systemet indholdet i stedet for at vise en liste med ét element. Hvis der er tale om søgeordet bip, returnerer Get-Help- en liste over to emner: Set-PSReadlineOption, en cmdlet og about_Special_Characters, som er et konceptuelt Hjælp-emne.