A CommonParameters ismertetése

RÖVID LEÍRÁS

A parancsmagokkal használható paramétereket ismerteti.

HOSSZÚ LEÍRÁS

A gyakori paraméterek olyan parancsmagparaméterek, amelyeket bármely parancsmaggal használhat. Ezeket a PowerShell implementálja, nem a parancsmag fejlesztője, és automatikusan elérhetővé válnak bármely parancsmag számára.

A gyakori paramétereket bármely parancsmaggal használhatja, de előfordulhat, hogy ezek nem minden parancsmagra hatással vannak. Ha például egy parancsmag nem hoz létre részletes kimenetet, a részletes közös paraméter használatának nincs hatása.

A gyakori paraméterek a CmdletBinding attribútumot vagy a Parameter attribútumot használó speciális függvényekben, valamint az összes munkafolyamatban is elérhetők.

Számos gyakori paraméter felülbírálja a PowerShell beállításváltozóival beállított rendszer alapértelmezett beállításait vagy beállításait. A beállítási változókkal ellentétben a gyakori paraméterek csak azokat a parancsokat érintik, amelyekben használják őket.

A gyakori paraméterek mellett számos parancsmag kínálja a WhatIf és a Confirm kockázatcsökkentési paramétereket. A rendszer vagy a felhasználói adatok kockázatával járó parancsmagok általában ezeket a paramétereket kínálják.

Az alábbi lista a gyakori paramétereket jeleníti meg. Az aliasok zárójelben vannak felsorolva.

hibakeresési (db)
Hibaművelet (ea)
ErrorVariable (ev)
InformációAkció (infa)
InformációsVáltozó (iv)
OutVariable (ov)
OutBuffer (ob)
PipelineVariable (pv)
Részletes (vb)
FigyelmeztetőAkció (wa)
WarningVariable (wv)

A kockázatcsökkentési paraméterek a következők:

WhatIf (wi)
Megerősítés (vö.)

További információ a about_Preference_Variablescímű részben található.

KÖZÖS PARAMÉTERLEÍRÁSOK

Hibakeresés

A Debug aliasa db.

A parancs által végrehajtott művelet programozói szintű részleteit jeleníti meg. Ez a paraméter csak akkor működik, ha a parancs hibakeresési üzenetet hoz létre. Ez a paraméter például akkor működik, ha egy parancs tartalmazza a Write-Debug parancsmagot.

A Debug paraméter felülbírálja az $DebugPreference aktuális parancs változójának értékét, és a $DebugPreference értékét a következőre állítja: Continue. Mivel a $DebugPreference változó alapértelmezett értéke SilentlyContinue, a hibakeresési üzenetek alapértelmezés szerint nem jelennek meg.

-Debug:$true ugyanaz a hatása, mint -Debug. A -Debug:$false használatával letilthatja a hibakeresési üzenetek megjelenítését, ha $DebugPreference nem SilentlyContinue, ami az alapértelmezett.

Hibaművelet

Az ErrorAction aliasa ea.

Meghatározza, hogy a parancsmag hogyan reagál a parancs nem végződő hibájára. Ez a paraméter csak akkor működik, ha a parancs nem végzetes hibát generál, például a Write-Error cmdlet esetén.

Az ErrorAction paraméter felülbírálja az aktuális parancs $ErrorActionPreference változójának értékét. Mivel a $ErrorActionPreference változó alapértelmezett értéke Folytatás, hibaüzenetek jelennek meg, és a végrehajtás folytatódik, kivéve, ha a ErrorAction paramétert használja.

Az ErrorAction paraméternek nincs hatása a parancs sikeres befejezését megakadályozó hibák (például hiányzó adatok, érvénytelen paraméterek vagy nem megfelelő engedélyek) megszüntetésére.

-ErrorAction:Continue megjeleníti a hibaüzenetet, és folytatja a parancs végrehajtását. A Continue az alapértelmezett.

-ErrorAction:Ignore letiltja a hibaüzenetet, és folytatja a parancs végrehajtását. Ellentétben SilentlyContinue, Ignore nem adja hozzá a hibaüzenetet az $Error automatikus változóhoz. A Mellőzés érték a PowerShell 3.0-ban van bevezetve.

-ErrorAction:Inquire megjeleníti a hibaüzenetet, és megerősítést kér a végrehajtás folytatása előtt. Ezt az értéket ritkán használják.

-ErrorAction:SilentlyContinue letiltja a hibaüzenetet, és folytatja a parancs végrehajtását.

-ErrorAction:Stop megjeleníti a hibaüzenetet, és leállítja a parancs végrehajtását.

-ErrorAction:Suspend nem támogatott a PowerShell Core, mivel csak munkafolyamatokhoz érhető el.

Megjegyzés:

Az ErrorAction paraméter felülbírálja, de nem helyettesíti a $ErrorAction beállításváltozó értékét, ha a paramétert egy parancsfájlban vagy függvény futtatására használják.

ErrorVariable

Az ErrorVariable aliasa ev.

Az ErrorVariable a parancs hibaüzeneteit a megadott változóban és az $Error automatikus változóban tárolja. További információért írja be a következő parancsot:

Get-Help about_Automatic_Variables

Alapértelmezés szerint az új hibaüzenetek felülírják a változóban már tárolt hibaüzeneteket. Ha a hibaüzenetet hozzá szeretné fűzni a változó tartalmához, írjon be egy pluszjelet (+) a változó neve elé.

A következő parancs például létrehozza a $a változót, majd tárolja benne a hibákat:

Get-Process -Id 6 -ErrorVariable a

Az alábbi parancs minden hibaüzenetet hozzáad a $a változóhoz:

Get-Process -Id 2 -ErrorVariable +a

Az alábbi parancs a $atartalmát jeleníti meg:

$a

Ezzel a paraméterrel olyan változót hozhat létre, amely csak adott parancsok hibaüzeneteit tartalmazza. Az $Error automatikus változó a munkamenet összes parancsából tartalmaz hibaüzeneteket. A változókban tárolt konkrét hibákra tömbjegyzeteket használhat, például $a[0] vagy $error[1,2].

InformációMűvelet

Az InformationAction aliasa ia.

A PowerShell 5.0-ban bevezetett. A parancsban vagy szkriptben, amelyben használják, a InformationAction közös paraméter felülbírálja a $InformationPreference beállítási változó értékét, amely alapértelmezés szerint SilentlyContinue-re van állítva. Ha Write-Informationszkriptben használ, Write-Information értékek jelennek meg az InformationAction paraméter értékétől függően. További információért a $InformationPreference-vel kapcsolatban lásd a about_Preference_Variables-t.

-InformationAction:Stop leállítja a parancsot vagy a szkriptet a Write-Information parancs előfordulásakor.

-InformationAction:Ignore letiltja az információs üzenetet, és folytatja a parancs futtatását. Ellentétben a SilentlyContinuekifejezéssel, a Ignore teljesen figyelmen kívül hagyja az információs üzenetet; nem adja hozzá azt az információs adatfolyamhoz.

-InformationAction:Inquire megjeleníti a Write-Information parancsban megadott tájékoztató üzenetet, majd megkérdezi, hogy folytatja-e.

-InformationAction:Continue megjeleníti az információs üzenetet, és továbbra is fut.

-InformationAction:Suspend nem támogatott a PowerShell Core, mivel csak munkafolyamatokhoz érhető el.

-InformationAction:SilentlyContinue nincs hatása, mivel az információs üzenet nem jelenik meg (alapértelmezett), és a szkript megszakítás nélkül folytatódik.

Megjegyzés:

Az InformationAction paraméter felülbírálja, de nem helyettesíti a $InformationAction beállításváltozó értékét, ha a paramétert egy parancsfájlban vagy függvény futtatására használják.

Információs változó

Az InformationVariable aliasa iv.

A PowerShell 5.0-ban bevezetett. A használt parancson vagy szkriptben a InformationVariable közös paraméter egy változóban tárol egy sztringet, amelyet a Write-Information parancs hozzáadásával adhat meg. Write-Information az értékek az InformationAction közös paraméter értékétől függően jelennek meg; ha nem adja hozzá az InformationAction közös paramétert, Write-Information a sztringek a beállításváltozó értékétől $InformationPreference függően jelennek meg. További információért a $InformationPreference-vel kapcsolatban lásd a about_Preference_Variables-t.

OutBuffer

Az OutBuffer aliasa ob , és egy System.Int32 értéket vesz fel.

Meghatározza, hogy hány objektum halmozódjon fel egy pufferben, mielőtt a folyamaton keresztül bármilyen objektumot elküldenének. Ha kihagyja ezt a paramétert, az objektumok a létrehozásukkor lesznek elküldve.

Ez az erőforrás-kezelési paraméter speciális felhasználók számára lett kialakítva. Ha ezt a paramétert használja, a PowerShell adatokat csoportokban küld a következő parancsmagnak OutBuffer + 1.

A következő példa felváltva jeleníti meg a ForEach-Object folyamatblokkokat, amelyek a Write-Host parancsmagot használják. A megjelenítés 2 vagy OutBuffer + 1kötegekben váltakozik.

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

Az OutVariable aliasa ov.

A kimeneti objektumokat a parancsból tárolja a megadott változóban, a kimenetnek a folyamat mentén történő elküldése mellett.

Ha hozzá szeretné adni a kimenetet a változóhoz, ahelyett, hogy lecserélné a már ott tárolt kimenetet, írjon be egy pluszjelet (+) a változó neve elé.

A következő parancs például létrehozza a $out változót, és tárolja benne a folyamatobjektumot:

Get-Process PowerShell -OutVariable out

A következő parancs hozzáadja a folyamatobjektumot a $out változóhoz:

Get-Process iexplore -OutVariable +out

Az alábbi parancs a $out változó tartalmát jeleníti meg:

$out

Megjegyzés:

A OutVariable paraméter által létrehozott változó egy [System.Collections.ArrayList].

Pipeline változó

A PipelineVariable aliasa pv, és sztringértéket vesz fel.

A PipelineVariable az aktuális folyamatelem értékét változóként tárolja minden elnevezett parancshoz, amikor az áthalad a folyamaton.

Az érvényes értékek sztringek, ugyanúgy, mint bármely változónév esetében.

Az alábbiakban egy példa látható arra, hogyan működik a PipelineVariable. Ebben a példában a PipelineVariable paraméter hozzáadódik egy Foreach-Object parancshoz a parancs eredményeinek változókban való tárolásához. Az első Foreach-Object parancsba 1-től 10-ig terjedő számtartomány kerül be, amelynek eredményeit a Left nevű változó tárolja.

Az első Foreach-Object parancs eredményeit a rendszer egy második Foreach-Object parancsba továbbítja, amely szűri az első Foreach-Object parancs által visszaadott objektumokat. A második parancs eredményeit egy Right nevű változó tárolja.

A harmadik Foreach-Object parancsban az első két Foreach-Object csöves parancs eredményeit, amelyeket a Left és a Right változók képviselnek, egy szorzóoperátor segítségével dolgozza fel. A parancs a bal és jobbváltozókban tárolt objektumok szorzását utasítja, és megadja, hogy az eredményeket a következőképpen kell megjeleníteni: "Bal tartomány tag * Jobb tartomány tag = szorzat".

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
...

Részletezés

A részletes álneve vb.

Részletes információkat jelenít meg a parancs által végrehajtott műveletről. Ez az információ hasonlít a nyomkövetésben vagy a tranzakciónaplóban szereplő információkra. Ez a paraméter csak akkor működik, ha a parancs részletes üzenetet hoz létre. Ez a paraméter például akkor működik, ha egy parancs tartalmazza a Write-Verbose parancsmagot.

A Részletes paraméter felülbírálja az $VerbosePreference aktuális parancs változójának értékét. Mivel a $VerbosePreference változó alapértelmezett értéke SilentlyContinue, a részletes üzenetek alapértelmezés szerint nem jelennek meg.

-Verbose:$true hatása megegyezik a -Verbose

-Verbose:$false letiltja a részletes üzenetek megjelenítését. Ezt a paramétert akkor használja, ha a $VerbosePreference értéke nem SilentlyContinue (alapértelmezett).

FigyelmeztetésMűvelet

A WarningAction aliasa: wa.

Meghatározza, hogy a parancsmag hogyan reagál a parancs figyelmeztetésére. Folytatás az alapértelmezett érték. Ez a paraméter csak akkor működik, ha a parancs figyelmeztető üzenetet hoz létre. Ez a paraméter például akkor működik, ha egy parancs tartalmazza a Write-Warning parancsmagot.

A WarningAction paraméter felülbírálja az aktuális parancs $WarningPreference változójának értékét. Mivel a $WarningPreference változó alapértelmezett értéke Folytatás, figyelmeztetések jelennek meg, és a végrehajtás folytatódik, kivéve, ha a WarningAction paramétert használja.

-WarningAction:Continue megjeleníti a figyelmeztető üzeneteket, és folytatja a parancs végrehajtását. A Continue az alapértelmezett.

-WarningAction:Inquire megjeleníti a figyelmeztető üzenetet, és megerősítést kér a végrehajtás folytatása előtt. Ezt az értéket ritkán használják.

-WarningAction:SilentlyContinue letiltja a figyelmeztető üzenetet, és folytatja a parancs végrehajtását.

-WarningAction:Stop megjeleníti a figyelmeztető üzenetet, és leállítja a parancs végrehajtását.

Megjegyzés:

A WarningAction paraméter felülbírálja, de nem helyettesíti a $WarningAction beállításváltozó értékét, ha a paramétert egy parancsban parancsfájl vagy függvény futtatására használják.

WarningVariable

A WarningVariable aliasa wv.

A parancsra vonatkozó figyelmeztetéseket a megadott változóban tárolja.

A rendszer akkor is menti az összes generált figyelmeztetést a változóba, ha a figyelmeztetések nem jelennek meg a felhasználó számára.

Ha hozzá szeretné fűzni a figyelmeztetéseket a változó tartalmához, ahelyett, hogy lecserélné a már ott tárolt figyelmeztetéseket, írjon be egy pluszjelet (+) a változó neve elé.

A következő parancs például létrehozza a $a változót, majd tárolja benne az esetleges figyelmeztetéseket:

Get-Process -Id 6 -WarningVariable a

Az alábbi parancs figyelmeztetéseket ad hozzá a $a változóhoz:

Get-Process -Id 2 -WarningVariable +a

Az alábbi parancs a $atartalmát jeleníti meg:

$a

Ezzel a paraméterrel olyan változót hozhat létre, amely csak adott parancsokból származó figyelmeztetéseket tartalmaz. A változóban tárolt konkrét figyelmeztetésekre tömbjegyzeteket használhat, például $a[0] vagy $warning[1,2].

Megjegyzés:

A WarningVariable paraméter nem rögzíti a függvények vagy szkriptek beágyazott hívásaiból származó figyelmeztetéseket.

Kockázatkezelési paraméter leírásai

Mi lenne, ha

A WhatIf aliasa wi.

A parancs végrehajtása helyett a parancs hatását leíró üzenetet jelenít meg.

A WhatIf paraméter felülbírálja az aktuális parancs $WhatIfPreference változójának értékét. Mivel a $WhatIfPreference változó alapértelmezett értéke 0 (le van tiltva), WhatIf viselkedés nem történik meg a WhatIf paraméter nélkül. További információért írja be a következő parancsot:

Get-Help about_Preference_Variables

-WhatIf:$true ugyanaz a hatása, mint -WhatIf.

-WhatIf:$false letiltja az automatikus WhatIf viselkedést, amely akkor jön létre, ha a $WhatIfPreference változó értéke 1.

Az alábbi parancs például a -WhatIf paramétert használja egy Remove-Item parancsban:

Remove-Item Date.csv -WhatIf

Az elem eltávolítása helyett a PowerShell felsorolja az általa végzett műveleteket és az érintett elemeket. Ez a parancs a következő kimenetet hozza létre:

What if: Performing operation "Remove File" on
Target "C:\ps-test\date.csv".

Megerősítés

A Confirm aliasa vö.

A parancs végrehajtása előtt megerősítést kér.

A Confirm paraméter felülbírálja az $ConfirmPreference aktuális parancs változójának értékét. Az alapértelmezett érték igaz. További információért írja be a következő parancsot:

Get-Help about_Preference_Variables

-Confirm:$true ugyanaz a hatása, mint -Confirm.

-Confirm:$false letiltja az automatikus megerősítést, amely akkor fordul elő, ha a $ConfirmPreference értéke kisebb vagy egyenlő a parancsmag becsült kockázatával.

A következő parancs például a Confirm paramétert használja egy Remove-Item paranccsal. Az elem eltávolítása előtt a PowerShell felsorolja az általa végzett műveleteket és az érintett elemeket, és jóváhagyást kér.

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"):

A Válasz megerősítése lehetőségek a következők:

Válasz	Eredmény
Igen (Y)	Hajtsa végre a műveletet.
Igen mindenkire (A)	Hajtsa végre az összes műveletet, és tiltsa le a későbbi megerősítési lekérdezéseket
	ehhez a parancshoz.
Nem (N):	Ne hajtsa végre a műveletet.
Nem mindenkire (L):	Ne hajtson végre semmilyen műveletet, és ne tiltsa le a későbbi megerősítést
	az adott parancshoz tartozó lekérdezések.
Felfüggesztés (S):	Szüneteltesse a parancsot, és hozzon létre egy ideiglenes munkamenetet.
Segítség (?)	Súgó megjelenítése ezekhez a beállításokhoz.

A Felfüggesztés beállítás várakoztatja a parancsot, és létrehoz egy ideiglenes beágyazott munkamenetet, amelyben addig dolgozhat, amíg készen nem áll a Megerősítés lehetőség kiválasztására. A beágyazott munkamenet parancssora két további ékezetet tartalmaz (>>), amelyek jelzik, hogy az eredeti szülőparancs gyermekművelete. A beágyazott munkamenetben parancsokat és szkripteket futtathat. A beágyazott munkamenet befejezéséhez és az eredeti parancs megerősítési beállításaihoz való visszatéréshez írja be az "exit" parancsot.

A következő példában a Felfüggesztés beállítás (S) használatával ideiglenesen leállítja a parancsokat, miközben a felhasználó ellenőrzi a súgót egy parancsparaméterhez. A szükséges információk beszerzése után a felhasználó beírja az "exit" parancsot a beágyazott kérdés befejezéséhez, majd kiválasztja az Igen (y) választ a Megerősítés lekérdezésre.

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