共通パラメーターについて

簡単な説明

任意のコマンドレットで使用できるパラメーターについて説明します。

長い説明

一般的なパラメーターは、任意のコマンドレットで使用できる一連のコマンドレット パラメーターです。 これらはコマンドレット開発者ではなく PowerShell によって実装され、任意のコマンドレットで自動的に使用できます。

共通パラメーターは任意のコマンドレットで使用できますが、すべてのコマンドレットに影響を与えるわけではありません。 たとえば、コマンドレットで詳細な出力が生成されない場合、Verbose 共通パラメーターを使用しても効果はありません。

共通パラメーターは、 CmdletBinding 属性または Parameter 属性を使用する高度な関数でも使用できます。

いくつかの一般的なパラメーターは、PowerShell 基本設定変数を使用して設定したシステム既定値または基本設定をオーバーライドします。 基本設定変数とは異なり、一般的なパラメーターは、それらが使用されているコマンドにのみ影響します。

詳細については、about_Preference_Variablesを参照してください。

次の一覧に共通パラメーターが表示されます。 それらのエイリアスはかっこで囲まれています。

• Debug (db)
• ErrorAction (ea)
• ErrorVariable (ev)
• InformationAction (infa)
• 情報変数 (iv)
• アウト変数 (ov)
• アウトバッファ (ob)
• パイプライン変数 (PV)
• Verbose (VB)
• WarningAction (wa)
• 警告変数 (wv)

Action パラメーターは ActionPreference 型の値です。 ActionPreference は、次の値を持つ列挙体です。

パラメーターには、名前または値を使用できます。

一般的なパラメーターに加えて、多くのコマンドレットでリスク軽減パラメーターが提供されています。 システムまたはユーザー データに対するリスクを伴うコマンドレットは、通常、これらのパラメーターを提供します。

リスク軽減パラメーターは次のとおりです。

• もしも( ウィスコンシン)
• Confirm (参照)

一般的なパラメーターの説明

-Debug

コマンドによって実行された操作に関するプログラマ レベルの詳細を表示します。 このパラメーターは、コマンドがデバッグ メッセージを生成する場合にのみ機能します。 たとえば、このパラメーターは、コマンドに Write-Debug コマンドレットが含まれている場合に機能します。

Type: SwitchParameter
Aliases: db

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

既定では、 $DebugPreference 変数の値が SilentlyContinue であるため、デバッグ メッセージは表示されません。

対話モードでは、 Debug パラメーターは、現在のコマンドの $DebugPreference 変数の値をオーバーライドし、 $DebugPreference の値を Inquire に設定します。

非対話型モードでは、 Debug パラメーターは現在のコマンドの $DebugPreference 変数の値をオーバーライドし、 $DebugPreference の値を Continue に設定します。

-Debug:$true は、 -Debugと同じ効果を持ちます。 -Debug:$falseを使用して、$DebugPreferenceが既定の SilentlyContinue でない場合にデバッグ メッセージの表示を抑制します。

-エラーアクション

コマンドから終了しないエラーにコマンドレットが応答する方法を決定します。 このパラメーターは、コマンドが終了しないエラー ( Write-Error コマンドレットのエラーなど) を生成する場合にのみ機能します。

Type: ActionPreference
Aliases: ea
Accepted values: Break, Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue

Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

ErrorAction パラメーターは、現在のコマンドの$ErrorActionPreference変数の値をオーバーライドします。 $ErrorActionPreference変数の既定値は Continue であるため、ErrorAction パラメーターを使用しない限り、エラー メッセージが表示され、実行が続行されます。

ErrorAction パラメーターは、コマンドの正常な完了を妨げるエラー (データの不足、無効なパラメーター、アクセス許可の不十分など) の終了には影響しません。

-ErrorAction:Break エラーが発生したとき、または例外が発生したときにデバッガーを入力します。

-ErrorAction:Continue はエラー メッセージを表示し、コマンドの実行を続行します。 Continue はデフォルト値です。

-ErrorAction:Ignore は、エラー メッセージを抑制し、コマンドの実行を続行します。 SilentlyContinue とは異なり、Ignore はエラー メッセージを$Error自動変数に追加しません。 無視値は PowerShell 3.0 で導入されています。

-ErrorAction:Inquire はエラー メッセージを表示し、実行を続行する前に確認を求められます。 この値はほとんど使用しません。

-ErrorAction:SilentlyContinue は、エラー メッセージを抑制し、コマンドの実行を続行します。

-ErrorAction:Stop はエラー メッセージを表示し、コマンドの実行を停止します。

-ErrorAction:Suspend は、PowerShell 6 以降でサポートされていないワークフローでのみ使用できます。

-エラー変数

ErrorVariable は、コマンドに関するエラーメッセージを、指定された変数と $Error 自動変数に格納します。 詳細については、「 about_Automatic_Variables

Type: String
Aliases: ev

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

既定では、新しいエラー メッセージによって、変数に既に格納されているエラー メッセージが上書きされます。 変数の内容にエラーメッセージを追加するには、変数名の前にプラス記号 (+) を入力します。

たとえば、次のコマンドは、 $a 変数を作成し、エラーを格納します。

Get-Process -Id 6 -ErrorVariable a

次のコマンドは、エラー メッセージを $a 変数に追加します。

Get-Process -Id 2 -ErrorVariable +a

次のコマンドは、 $aの内容を表示します。

$a

このパラメータを使用すると、特定のコマンドからのエラーメッセージのみを含み、 $Error 自動変数の動作に影響を与えない変数を作成できます。 $Error自動変数には、セッション内のすべてのコマンドからのエラー メッセージが含まれています。 $a[0]や$error[1,2]などの配列表記を使用して、変数に格納されている特定のエラーを参照できます。

-InformationAction(インフォメーションアクション)

PowerShell 5.0 で導入されました。 使用されるコマンドまたはスクリプト内で、InformationAction 共通パラメーターは、既定で $InformationPreference に設定されている基本設定変数の値をオーバーライドします。 Write-Information のスクリプトでを使用すると、Write-Information パラメーターの値に応じて値が表示されます。 $InformationPreferenceの詳細については、「about_Preference_Variables」を参照してください。

Type: ActionPreference
Aliases: ia
Accepted values: Break, Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue

Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

-InformationAction:Break Write-Information コマンドが発生した時点でデバッガーを入力します。

-InformationAction:Stop は、 Write-Information コマンドの発生時にコマンドまたはスクリプトを停止します。

-InformationAction:Ignore は情報メッセージを抑制し、コマンドの実行を続行します。 SilentlyContinue とは異なり、Ignore は情報メッセージを完全に忘れます。情報メッセージは情報ストリームに追加されません。

-InformationAction:Inquire は、 Write-Information コマンドで指定した情報メッセージを表示し、続行するかどうかを確認します。

-InformationAction:Continue は情報メッセージを表示し、実行を続けます。

-InformationAction:Suspend は PowerShell 6 以降ではサポートされていません。これはワークフローでのみ使用できます。

-InformationAction:SilentlyContinue 情報メッセージが表示されない (既定) の場合、スクリプトは中断されずに続行されるため、効果はありません。

-情報変数

PowerShell 5.0 で導入されました。 それが使用されるコマンドまたはスクリプト内で、 InformationVariable 共通パラメータは、 Write-Information コマンドを追加して指定した文字列を変数に格納します。 Write-Information値は、InformationAction 共通パラメーターの値に応じて表示されます。InformationAction 共通パラメーターを追加しない場合、Write-Information 基本設定変数の値に応じて$InformationPreference文字列が表示されます。 $InformationPreferenceの詳細については、「about_Preference_Variables」を参照してください。

Type: String
Aliases: iv

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-アウトバッファ

パイプラインを介してオブジェクトが送信される前にバッファーに蓄積するオブジェクトの数を決定します。 このパラメーターを省略すると、オブジェクトは生成時に送信されます。

Type: Int32
Aliases: ob

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

このリソース管理パラメーターは、上級ユーザー向けに設計されています。 このパラメーターを使用すると、PowerShell は OutBuffer + 1のバッチで次のコマンドレットにデータを送信します。

次の例では、ForEach-Object コマンドレットを使用するプロセス ブロック間Write-Host表示します。 表示は、2 または 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

-アウト変数

パイプラインに沿って出力を送信するだけでなく、指定した変数にコマンドからの出力オブジェクトを格納します。

Type: String
Aliases: ov

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

変数に出力を追加するには、既に格納されている出力を置き換える代わりに、変数名の前にプラス記号 (+) を入力します。

たとえば、次のコマンドは、 $out 変数を作成し、その中にプロセス オブジェクトを格納します。

Get-Process PowerShell -OutVariable out

次のコマンドは、プロセス オブジェクトを $out 変数に追加します。

Get-Process iexplore -OutVariable +out

次のコマンドは、 $out 変数の内容を表示します。

$out

-パイプライン変数

PipelineVariable を使用すると、このパラメーターを使用するコマンドによって、次のパイプライン セグメントに渡される最新の値にアクセスできます。 パイプライン内のすべてのコマンドは、名前付き PipelineVariable を使用して値にアクセスできます。 値は、変数が次のパイプライン セグメントに渡されるときに変数に割り当てられます。 これにより、 PipelineVariable は特定の一時変数よりも使いやすくなり、複数の場所に割り当てる必要がある場合があります。

$_や$PSItemとは異なり、PipelineVariable を使用すると、パイプライン コマンドは、直前のコマンド以外のコマンドによって渡された (および保存された) パイプライン値にアクセスできます。 パイプライン コマンドは、パイプラインを通過する次の項目の処理中にパイプされた最後の値にアクセスできます。 これにより、コマンドはその出力を前のコマンド (またはそれ自体) に フィードバック できます。

Type: String
Aliases: pv

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

有効な値は文字列であり、変数名の場合と同じです。

PipelineVariable のしくみの例を次に示します。 この例では、 PipelineVariable パラメーターを Foreach-Object コマンドに追加して、コマンドの結果を変数に格納します。 1 から 5 までの数値の範囲は、最初の Foreach-Object コマンドにパイプ処理され、その結果は $temp という名前の変数に格納されます。

最初の Foreach-Object コマンドの結果は、2 番目の Foreach-Object コマンドにパイプ処理され、 $temp と $_の現在の値が表示されます。

# Create a variable named $temp
$temp=8
Get-Variable temp
# Note that the variable just created is not available on the
# pipeline when -PipelineVariable creates the same variable name
1..5 | ForEach-Object -PipelineVariable temp -Begin {
    Write-Host "Step1[BEGIN]:`$temp=$temp"
} -Process {
  Write-Host "Step1[PROCESS]:`$temp=$temp - `$_=$_"
  Write-Output $_
} | ForEach-Object {
  Write-Host "`tStep2[PROCESS]:`$temp=$temp - `$_=$_"
}
# The $temp variable is deleted when the pipeline finishes
Get-Variable temp

Name                           Value
----                           -----
temp                           8

Step1[BEGIN]:$temp=
Step1[PROCESS]:$temp= - $_=1
        Step2[PROCESS]:$temp=1 - $_=1
Step1[PROCESS]:$temp=1 - $_=2
        Step2[PROCESS]:$temp=2 - $_=2
Step1[PROCESS]:$temp=2 - $_=3
        Step2[PROCESS]:$temp=3 - $_=3
Step1[PROCESS]:$temp=3 - $_=4
        Step2[PROCESS]:$temp=4 - $_=4
Step1[PROCESS]:$temp=4 - $_=5
        Step2[PROCESS]:$temp=5 - $_=5

Get-Variable: Cannot find a variable with the name 'temp'.

-Verbose

コマンドによって実行された操作に関する詳細情報を表示します。 この情報は、トレースまたはトランザクション ログ内の情報に似ています。 このパラメーターは、コマンドが詳細メッセージを生成する場合にのみ機能します。 たとえば、このパラメーターは、コマンドに Write-Verbose コマンドレットが含まれている場合に機能します。

Type: SwitchParameter
Aliases: vb

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Verbose パラメーターは、現在のコマンドの$VerbosePreference変数の値をオーバーライドします。 変数の既定値は SilentlyContinueであるため、詳細メッセージは既定では表示されません。

-Verbose:$true と同じ効果があります。 -Verbose

-Verbose:$false は、詳しいメッセージの表示を抑制します。 このパラメーターは、 $VerbosePreference の値が SilentlyContinue (既定値) でない場合に使用します。

-警告アクション

コマンドレットがコマンドからの警告に応答する方法を決定します。 Continue が既定値です。 このパラメーターは、コマンドによって警告メッセージが生成された場合にのみ機能します。 たとえば、このパラメーターは、コマンドに Write-Warning コマンドレットが含まれている場合に機能します。

Type: ActionPreference
Aliases: wa
Accepted values: Break, Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue

Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

WarningAction パラメーターは、現在のコマンドの$WarningPreference変数の値をオーバーライドします。 $WarningPreference変数の既定値は Continue であるため、WarningAction パラメーターを使用しない限り、警告が表示され、実行が続行されます。

-WarningAction:Break は、警告が発生したときにデバッガーに入ります。

-WarningAction:Continue は警告メッセージを表示し、コマンドの実行を続行します。 Continue はデフォルト値です。

-WarningAction:Inquire は警告メッセージを表示し、実行を続行する前に確認を求められます。 この値はほとんど使用しません。

-WarningAction:SilentlyContinue は警告メッセージを抑制し、コマンドの実行を続行します。

-WarningAction:Stop は警告メッセージを表示し、コマンドの実行を停止します。

-警告変数

コマンドに関する警告を、指定した変数に格納します。

Type: String
Aliases: wv

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

生成されたすべての警告は、警告がユーザーに表示されない場合でも、変数に保存されます。

変数コンテンツに警告を追加するには、既に保存されている可能性がある警告を置き換える代わりに、変数名の前にプラス記号 (+) を入力します。

たとえば、次のコマンドは、 $a 変数を作成し、その変数に警告を格納します。

Get-Process -Id 6 -WarningVariable a

次のコマンドは、 $a 変数に警告を追加します。

Get-Process -Id 2 -WarningVariable +a

次のコマンドは、 $aの内容を表示します。

$a

このパラメーターを使用すると、特定のコマンドからの警告のみを含む変数を作成できます。 $a[0]や$warning[1,2]などの配列表記を使用して、変数に格納されている特定の警告を参照できます。

リスク管理パラメーターの説明

-もしも

コマンドを実行する代わりに、コマンドの効果を説明するメッセージを表示します。

Type: SwitchParameter
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

WhatIf パラメーターは、現在のコマンドの$WhatIfPreference変数の値をオーバーライドします。 $WhatIfPreference変数の既定値は 0 (無効) であるため、WhatIf の動作は WhatIf パラメーターなしでは実行されません。 詳細については、「 about_Preference_Variables

-WhatIf:$true は、 -WhatIfと同じ効果を持ちます。

-WhatIf:$false では、 $WhatIfPreference 変数の値が 1 の場合に発生する WhatIf の自動動作が抑制されます。

たとえば、次のコマンドでは、-WhatIf コマンドで Remove-Item パラメーターを使用します。

Remove-Item Date.csv -WhatIf

PowerShell では、アイテムを削除する代わりに、実行する操作と影響を受けるアイテムが一覧表示されます。 このコマンドでは次の出力が生成されます。

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

-Confirm

コマンドを実行する前に確認メッセージを表示します。

Type: SwitchParameter
Aliases: cf

Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

Confirm パラメーターは、現在のコマンドの$ConfirmPreference変数の値をオーバーライドします。 既定値は true です。 詳細については、「 about_Preference_Variables

-Confirm:$true は、 -Confirmと同じ効果を持ちます。

-Confirm:$false は、 $ConfirmPreference の値がコマンドレットの推定リスク以下である場合に発生する自動確認を抑制します。

たとえば、次のコマンドでは、Confirm コマンドで Remove-Item パラメーターを使用します。 アイテムを削除する前に、PowerShell によって実行される操作と影響を受けるアイテムが一覧表示され、承認を求められます。

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

Confirm応答オプションは次のとおりです。

Suspend オプションは、コマンドを保留状態にし、Confirm オプションを選択する準備ができるまで作業できる一時的な入れ子になったセッションを作成します。 入れ子になったセッションのコマンド プロンプトには、元の親コマンドの子操作であることを示す追加のキャレット (>>) が 2 つあります。 入れ子になったセッションでコマンドとスクリプトを実行できます。 入れ子になったセッションを終了し、元のコマンドの Confirm オプションに戻すには、「exit」と入力します。

次の例では、 Suspend オプション (S) を使用して、ユーザーがコマンド パラメーターのヘルプを確認している間、コマンドを一時的に停止します。 必要な情報を取得した後、ユーザーは"exit" を入力して入れ子になったプロンプトを終了し、 Confirm クエリに対する Yes (y) 応答を選択します。

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

キーワード

about_Common_Parameters

こちらもご覧ください

• プレファレンス変数について
• 書く-Debug
• 書き込みエラー
• 書く-Verbose
• 書き込み警告