Over CommonParameters
KORTE BESCHRIJVING
Beschrijft de parameters die kunnen worden gebruikt met een cmdlet.
LANGE BESCHRIJVING
De algemene parameters zijn een set cmdlet-parameters die u met elke cmdlet kunt gebruiken. Ze worden geïmplementeerd door PowerShell, niet door de cmdlet-ontwikkelaar, en ze zijn automatisch beschikbaar voor elke cmdlet.
U kunt de algemene parameters gebruiken met elke cmdlet, maar ze hebben mogelijk geen invloed op alle cmdlets. Als een cmdlet bijvoorbeeld geen uitgebreide uitvoer genereert, heeft het gebruik van de algemene parameter Uitgebreid geen effect.
De algemene parameters zijn ook beschikbaar voor geavanceerde functies die gebruikmaken van het kenmerk CmdletBinding of het kenmerk Parameter , en voor alle werkstromen.
Verschillende algemene parameters overschrijven de standaardinstellingen of voorkeuren van het systeem die u instelt met behulp van de PowerShell-voorkeursvariabelen. In tegenstelling tot de voorkeursvariabelen zijn de algemene parameters alleen van invloed op de opdrachten waarin ze worden gebruikt.
Naast de algemene parameters bieden veel cmdlets de risicobeperkingsparameters WhatIf en Confirm . Cmdlets die risico's voor het systeem of voor gebruikersgegevens met zich meebrengen, bieden meestal deze parameters.
In de volgende lijst worden de algemene parameters weergegeven. Hun aliassen worden tussen haakjes weergegeven.
- Fouten opsporen (db)
- ErrorAction (ea)
- ErrorVariable (ev)
- InformationAction (infa)
- InformationVariable (iv)
- OutVariable (ov)
- OutBuffer (ob)
- PipelineVariable (hw)
- Uitgebreid (vb)
- WarningAction (wa)
- WaarschuwingVariable (wv)
De risicobeperkingsparameters zijn:
- WhatIf (wi)
- Bevestigen (zie)
Zie about_Preference_Variables voor meer informatie.
ALGEMENE PARAMETERBESCHRIJVINGEN
Fouten opsporen
De alias voor Foutopsporing is db.
Geeft details op programmeerniveau weer over de bewerking die door de opdracht wordt uitgevoerd. Deze parameter werkt alleen wanneer de opdracht een foutopsporingsbericht genereert. Deze parameter werkt bijvoorbeeld wanneer een opdracht de Write-Debug cmdlet bevat.
De parameter Foutopsporing overschrijft de waarde van de $DebugPreference variabele voor de huidige opdracht, waarbij de waarde van $DebugPreference wordt ingesteld op Doorgaan. Omdat de standaardwaarde van de $DebugPreference variabele SilentlyContinue is, worden foutopsporingsberichten niet standaard weergegeven.
-Debug:$true heeft hetzelfde effect als -Debug. Gebruik -Debug:$false om de weergave van foutopsporingsberichten te onderdrukken wanneer $DebugPreferencedit niet de standaardinstelling is.
ErrorAction
De alias voor ErrorAction is ea.
Bepaalt hoe de cmdlet reageert op een niet-afsluitfout van de opdracht.
Deze parameter werkt alleen wanneer de opdracht een niet-afsluitfout genereert, zoals die van de Write-Error cmdlet.
De parameter ErrorAction overschrijft de waarde van de $ErrorActionPreference variabele voor de huidige opdracht. Omdat de standaardwaarde van de $ErrorActionPreference variabele Continue is, worden foutberichten weergegeven en wordt de uitvoering voortgezet, tenzij u de parameter ErrorAction gebruikt.
De parameter ErrorAction heeft geen invloed op het beëindigen van fouten (zoals ontbrekende gegevens, parameters die niet geldig zijn of onvoldoende machtigingen) die verhinderen dat een opdracht wordt voltooid.
-ErrorAction:Continue het foutbericht weergeven en doorgaan met het uitvoeren van de opdracht. Continue is de standaardwaarde.
-ErrorAction:Ignore onderdrukt het foutbericht en gaat door met het uitvoeren van de opdracht. In tegenstelling tot SilentlyContinue voegt Ignore het foutbericht niet toe aan de $Error automatische variabele. De waarde Negeren wordt geïntroduceerd in PowerShell 3.0.
-ErrorAction:Inquire geeft het foutbericht weer en vraagt u om bevestiging voordat u doorgaat met de uitvoering. Deze waarde wordt zelden gebruikt.
-ErrorAction:SilentlyContinue onderdrukt het foutbericht en gaat door met het uitvoeren van de opdracht.
-ErrorAction:Stop geeft het foutbericht weer en stopt met het uitvoeren van de opdracht.
-ErrorAction:Suspend wordt niet ondersteund in PowerShell Core omdat het alleen beschikbaar is voor werkstromen.
Notitie
De parameter ErrorAction overschrijft, maar vervangt de waarde van de $ErrorAction voorkeursvariabele niet wanneer de parameter wordt gebruikt in een opdracht om een script of functie uit te voeren.
ErrorVariable
De alias voor ErrorVariable is ev.
ErrorVariable slaat foutberichten over de opdracht op in de opgegeven variabele en in de $Error automatische variabele. Typ de volgende opdracht voor meer informatie:
Get-Help about_Automatic_Variables
Nieuwe foutberichten overschrijven standaard foutberichten die al zijn opgeslagen in de variabele. Als u het foutbericht wilt toevoegen aan de inhoud van de variabele, typt u een plusteken (+) vóór de naam van de variabele.
Met de volgende opdracht wordt bijvoorbeeld de $a variabele gemaakt en worden eventuele fouten erin opgeslagen:
Get-Process -Id 6 -ErrorVariable a
Met de volgende opdracht worden eventuele foutberichten aan de $a variabele toegevoegd:
Get-Process -Id 2 -ErrorVariable +a
Met de volgende opdracht wordt de inhoud van $aweergegeven:
$a
U kunt deze parameter gebruiken om een variabele te maken die alleen foutberichten van specifieke opdrachten bevat. De $Error automatische variabele bevat foutberichten van alle opdrachten in de sessie. U kunt matrixnotatie gebruiken, zoals $a[0] of $error[1,2] om te verwijzen naar specifieke fouten die zijn opgeslagen in de variabelen.
InformationAction
De alias voor InformationAction is ia.
Geïntroduceerd in PowerShell 5.0. In de opdracht of het script waarin deze wordt gebruikt, overschrijft de algemene parameter InformationAction de waarde van de $InformationPreference voorkeursvariabele, die standaard is ingesteld op SilentlyContinue. Wanneer u Write-Information in een script met InformationAction gebruikt, Write-Information worden waarden weergegeven, afhankelijk van de waarde van de parameter InformationAction . Zie about_Preference_Variables voor meer informatie over$InformationPreference.
-InformationAction:Stop stopt een opdracht of script bij een exemplaar van de Write-Information opdracht.
-InformationAction:Ignore onderdrukt het informatieve bericht en gaat door met het uitvoeren van de opdracht. In tegenstelling tot SilentlyContinue, negeert volledig de informatieve boodschap; Het informatieve bericht wordt niet toegevoegd aan de informatiestroom.
-InformationAction:Inquire geeft het informatieve bericht weer dat u opgeeft in een Write-Information opdracht en vraagt u of u wilt doorgaan.
-InformationAction:Continue geeft het informatieve bericht weer en blijft actief.
-InformationAction:Suspend wordt niet ondersteund in PowerShell Core omdat het alleen beschikbaar is voor werkstromen.
-InformationAction:SilentlyContinue geen effect omdat het informatieve bericht niet (standaard) wordt weergegeven en het script zonder onderbreking wordt voortgezet.
Notitie
De parameter InformationAction overschrijft, maar vervangt de waarde van de $InformationAction voorkeursvariabele niet wanneer de parameter wordt gebruikt in een opdracht om een script of functie uit te voeren.
InformationVariable
De alias voor InformationVariable is iv.
Geïntroduceerd in PowerShell 5.0. In de opdracht of het script waarin deze wordt gebruikt, slaat de algemene parameter InformationVariable in een variabele een tekenreeks op die u opgeeft door de Write-Information opdracht toe te voegen. Write-Information waarden worden weergegeven afhankelijk van de waarde van de algemene parameter InformationAction ; Als u de algemene parameter InformationAction niet toevoegt, Write-Information worden tekenreeksen weergegeven, afhankelijk van de waarde van de $InformationPreference voorkeursvariabele. Zie about_Preference_Variables voor meer informatie over$InformationPreference.
OutBuffer
De alias voor OutBuffer is ob en neemt een System.Int32-waarde op.
Bepaalt het aantal objecten dat in een buffer moet worden verzameld voordat er objecten via de pijplijn worden verzonden. Als u deze parameter weglaat, worden objecten verzonden wanneer ze worden gegenereerd.
Deze resourcebeheerparameter is ontworpen voor geavanceerde gebruikers. Wanneer u deze parameter gebruikt, verzendt PowerShell gegevens naar de volgende cmdlet in batches van OutBuffer + 1.
Het volgende voorbeeld wordt afwisselend weergegeven tussen om blokken te ForEach-Object verwerken die gebruikmaken van de Write-Host cmdlet. De weergave wisselt af in batches van 2 of OutBuffer + 1.
1..4 | ForEach-Object {
Write-Host "$($_): First"; $_
} -OutBuffer 1 | ForEach-Object {
Write-Host "$($_): Second" }
1: First
2: First
1: Second
2: Second
3: First
4: First
3: Second
4: Second
OutVariable
De alias voor OutVariable is ov.
Hiermee worden uitvoerobjecten van de opdracht opgeslagen in de opgegeven variabele, naast het verzenden van de uitvoer via de pijplijn.
Als u de uitvoer aan de variabele wilt toevoegen, typt u een plusteken (+) vóór de naam van de variabele in plaats van uitvoer te vervangen die daar mogelijk al is opgeslagen.
Met de volgende opdracht wordt bijvoorbeeld de $out variabele gemaakt en wordt het procesobject erin opgeslagen:
Get-Process PowerShell -OutVariable out
Met de volgende opdracht wordt het procesobject toegevoegd aan de $out variabele:
Get-Process iexplore -OutVariable +out
Met de volgende opdracht wordt de inhoud van de $out variabele weergegeven:
$out
Notitie
De variabele die wordt gemaakt door de parameter OutVariable is een [System.Collections.ArrayList].
PijplijnVariable
De alias voor PipelineVariable is hw en neemt een tekenreekswaarde op.
PipelineVariable slaat de waarde van het huidige pijplijnelement op als een variabele voor elke benoemde opdracht terwijl deze door de pijplijn loopt.
Geldige waarden zijn tekenreeksen, hetzelfde als voor namen van variabelen.
Hier volgt een voorbeeld van de werking van PipelineVariable . In dit voorbeeld wordt de parameter PipelineVariable toegevoegd aan een Foreach-Object opdracht om de resultaten van de opdracht op te slaan in variabelen. Een bereik van getallen, 1 tot en met 10, wordt doorgesluisd naar de eerste Foreach-Object opdracht, waarvan de resultaten worden opgeslagen in een variabele met de naam Links.
De resultaten van de eerste Foreach-Object opdracht worden doorgesluisd naar een tweede Foreach-Object opdracht, waarmee de objecten worden gefilterd die door de eerste Foreach-Object opdracht worden geretourneerd. De resultaten van de tweede opdracht worden opgeslagen in een variabele met de naam Rechts.
In de derde Foreach-Object opdracht worden de resultaten van de eerste twee Foreach-Object piped-opdrachten, vertegenwoordigd door de variabelen Links en Rechts, verwerkt met behulp van een vermenigvuldigingsoperator. De opdracht instrueert objecten die zijn opgeslagen in de variabelen Links en Rechts om te worden vermenigvuldigd en geeft aan dat de resultaten moeten worden weergegeven als 'Lid van linkerbereik * Rechterbereiklid = product'.
1..10 | Foreach-Object -PipelineVariable Left -Process { $_ } |
Foreach-Object -PV Right -Process { 1..10 } |
Foreach-Object -Process { "$Left * $Right = " + ($Left*$Right) }
1 * 1 = 1
1 * 2 = 2
1 * 3 = 3
1 * 4 = 4
1 * 5 = 5
...
Uitgebreid
De alias voor Uitgebreid is vb.
Geeft gedetailleerde informatie weer over de bewerking die door de opdracht wordt uitgevoerd. Deze informatie lijkt op de informatie in een tracering of in een transactielogboek. Deze parameter werkt alleen wanneer de opdracht een uitgebreid bericht genereert. Deze parameter werkt bijvoorbeeld wanneer een opdracht de Write-Verbose cmdlet bevat.
De parameter Uitgebreid overschrijft de waarde van de $VerbosePreference variabele voor de huidige opdracht. Omdat de standaardwaarde van de $VerbosePreference variabele SilentlyContinue is, worden uitgebreide berichten niet standaard weergegeven.
-Verbose:$true heeft hetzelfde effect als -Verbose
-Verbose:$false onderdrukt de weergave van uitgebreide berichten. Gebruik deze parameter wanneer de waarde van $VerbosePreference niet SilentlyContinue is (de standaardwaarde).
WarningAction
De alias voor WarningAction is wa.
Bepaalt hoe de cmdlet reageert op een waarschuwing van de opdracht. Doorgaan is de standaardwaarde. Deze parameter werkt alleen wanneer de opdracht een waarschuwingsbericht genereert. Deze parameter werkt bijvoorbeeld wanneer een opdracht de Write-Warning cmdlet bevat.
De parameter WarningAction overschrijft de waarde van de $WarningPreference variabele voor de huidige opdracht. Omdat de standaardwaarde van de $WarningPreference variabele Continue is, worden waarschuwingen weergegeven en wordt de uitvoering voortgezet, tenzij u de parameter WarningAction gebruikt.
-WarningAction:Continue geeft de waarschuwingsberichten weer en gaat door met het uitvoeren van de opdracht. Continue is de standaardwaarde.
-WarningAction:Inquire geeft het waarschuwingsbericht weer en vraagt u om bevestiging voordat u doorgaat met de uitvoering. Deze waarde wordt zelden gebruikt.
-WarningAction:SilentlyContinue onderdrukt het waarschuwingsbericht en gaat door met het uitvoeren van de opdracht.
-WarningAction:Stop geeft het waarschuwingsbericht weer en stopt met het uitvoeren van de opdracht.
Notitie
De parameter WarningAction overschrijft, maar vervangt de waarde van de $WarningAction voorkeursvariabele niet wanneer de parameter wordt gebruikt in een opdracht om een script of functie uit te voeren.
WaarschuwingVarieerbaar
De alias voor WarningVariable is wv.
Slaat waarschuwingen over de opdracht op in de opgegeven variabele.
Alle gegenereerde waarschuwingen worden opgeslagen in de variabele, zelfs als de waarschuwingen niet worden weergegeven voor de gebruiker.
Als u de waarschuwingen wilt toevoegen aan de inhoud van de variabele, typt u een plusteken (+) vóór de naam van de variabele in plaats van waarschuwingen te vervangen die daar mogelijk al zijn opgeslagen.
Met de volgende opdracht wordt bijvoorbeeld de $a variabele gemaakt en worden eventuele waarschuwingen hierin opgeslagen:
Get-Process -Id 6 -WarningVariable a
Met de volgende opdracht worden eventuele waarschuwingen toegevoegd aan de $a variabele:
Get-Process -Id 2 -WarningVariable +a
Met de volgende opdracht wordt de inhoud van $aweergegeven:
$a
U kunt deze parameter gebruiken om een variabele te maken die alleen waarschuwingen van specifieke opdrachten bevat. U kunt matrixnotatie gebruiken, zoals $a[0] of $warning[1,2] om te verwijzen naar specifieke waarschuwingen die zijn opgeslagen in de variabele.
Notitie
De parameter WarningVariable legt geen waarschuwingen vast van geneste aanroepen in functies of scripts.
Beschrijvingen van parameters voor risicobeheer
WhatIf
De alias voor WhatIf is wi.
Geeft een bericht weer waarin het effect van de opdracht wordt beschreven, in plaats van de opdracht uit te voeren.
De parameter WhatIf overschrijft de waarde van de $WhatIfPreference variabele voor de huidige opdracht. Omdat de standaardwaarde van de $WhatIfPreference variabele 0 (uitgeschakeld) is, wordt WhatIf-gedrag niet uitgevoerd zonder de whatif-parameter . Typ de volgende opdracht voor meer informatie:
Get-Help about_Preference_Variables
-WhatIf:$true heeft hetzelfde effect als -WhatIf.
-WhatIf:$false onderdrukt het automatische WhatIf-gedrag dat resulteert wanneer de waarde van de $WhatIfPreference variabele 1 is.
De volgende opdracht gebruikt bijvoorbeeld de -WhatIf parameter in een Remove-Item opdracht:
Remove-Item Date.csv -WhatIf
In plaats van het item te verwijderen, vermeldt PowerShell de bewerkingen die het zou uitvoeren en de items die zouden worden beïnvloed. Deze opdracht produceert de volgende uitvoer:
What if: Performing operation "Remove File" on
Target "C:\ps-test\date.csv".
Bevestigen
De alias voor Bevestigen is zie.
U wordt gevraagd om bevestiging voordat u de opdracht uitvoert.
De parameter Confirm overschrijft de waarde van de $ConfirmPreference variabele voor de huidige opdracht. De standaardwaarde is waar. Typ de volgende opdracht voor meer informatie:
Get-Help about_Preference_Variables
-Confirm:$true heeft hetzelfde effect als -Confirm.
-Confirm:$false onderdrukt automatische bevestiging, die optreedt wanneer de waarde van $ConfirmPreference kleiner is dan of gelijk is aan het geschatte risico van de cmdlet.
De volgende opdracht gebruikt bijvoorbeeld de parameter Confirm met een Remove-Item opdracht. Voordat u het item verwijdert, vermeldt PowerShell de bewerkingen die het zou uitvoeren en de items die worden beïnvloed, en vraagt om goedkeuring.
PS C:\ps-test> Remove-Item tmp*.txt -Confirm
Confirm
Are you sure you want to perform this action?
Performing operation "Remove File" on Target " C:\ps-test\tmp1.txt
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend
[?] Help (default is "Y"):
De antwoordopties bevestigen zijn als volgt:
| Antwoord | Resultaat |
|---|---|
| Ja (Y) | Voer de actie uit. |
| Ja op alles (A) | Alle acties uitvoeren en de volgende confirm-query's onderdrukken |
| voor deze opdracht. | |
| Nee (N): | Voer de actie niet uit. |
| Nee op alles (L): | Voer geen acties uit en onderdrukt vervolgens Bevestigen |
| query's voor deze opdracht. | |
| Onderbreken (S): | Onderbreek de opdracht en maak een tijdelijke sessie. |
| Help (?) | Help weergeven voor deze opties. |
Met de optie Onderbreken wordt de opdracht in de wachtstand geplaatst en wordt een tijdelijke geneste sessie gemaakt waarin u kunt werken totdat u klaar bent om de optie Bevestigen te kiezen. De opdrachtprompt voor de geneste sessie heeft twee extra carets (>>) om aan te geven dat het een onderliggende bewerking is van de oorspronkelijke bovenliggende opdracht. U kunt opdrachten en scripts uitvoeren in de geneste sessie. Als u de geneste sessie wilt beëindigen en terug wilt gaan naar de opties bevestigen voor de oorspronkelijke opdracht, typt u 'afsluiten'.
In het volgende voorbeeld wordt de optie Onderbreken (S) gebruikt om een opdracht tijdelijk te stoppen terwijl de gebruiker de Help controleert op een opdrachtparameter. Nadat de benodigde informatie is opgehaald, typt de gebruiker afsluiten om de geneste prompt te beëindigen en selecteert vervolgens het Antwoord Ja (y) op de query Bevestigen.
PS C:\ps-test> New-Item -ItemType File -Name Test.txt -Confirm
Confirm
Are you sure you want to perform this action?
Performing operation "Create File" on Target "Destination:
C:\ps-test\test.txt".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default
is "Y"): s
PS C:\ps-test> Get-Help New-Item -Parameter ItemType
-ItemType <string>
Specifies the provider-specified type of the new item.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
PS C:\ps-test> exit
Confirm
Are you sure you want to perform this action?
Performing operation "Create File" on Target "Destination: C:\ps-test\test
.txt".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (defau
lt is "Y"): y
Directory: C:\ps-test
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 8/27/2010 2:41 PM 0 test.txt
ZOEKWOORDEN
about_Common_Parameters