HOME > 共通パラメータ
共通パラメータ
共通パラメータは、すべてのコマンドレットで使用できるパラメータです。
解説
共通パラメータは、すべてのコマンドレットで使用できる共通的なパラメータです。
コマンドレットによっては定義はされていても機能しないものもあります。
共通パラメータ
| パラメータ | 説明 |
|---|---|
| -Verbose | 詳細なメッセージを表示する ※コマンドの実行過程を詳細に追跡できる ※メッセージはWrite-Verboseメソッドによって生成される （例）Get-Process -Verbose |
| -Debug | デバッグログを表示する （例）Get-Process -Debug |
| -ErrorAction 処理 | エラー発生時の処理を指定する
|
| -ErrorVariable 変数 | エラーが発生時に内容を格納する変数を指定する ※変数名の前にプラス記号（+）を付けると既存の内容にエラーを追加する （例）Get-Process -ErrorVariable err |
| -WarningAction 処理 | 警告発生時の処理を指定する ※指定する処理は-ErrorAction欄をご覧ください。 （例）Get-Process -WarningAction Continue |
| -WarningVariable 変数 | 警告メッセージを格納する変数を指定する （例）Get-Process -WarningVariable obj |
| -InformationAction 処理 | 情報メッセージが出力されたときのアクションを指定する ※指定する処理は-ErrorAction欄をご覧ください。 （例）Get-Process -InformationAction Continue |
| -InformationVariable 変数 | 情報メッセージを格納する変数を指定する （例）Get-Process -InformationVariable inf |
| -OutVariable 変数 | 出力オブジェクトを格納する変数を指定する ※変数名の前にプラス記号（+）を付けると、既存の内容に出力を追加する （例）Get-Process -OutVariable obj |
| -OutBuffer 数 | パイプラインに送られる前にバッファに蓄積するオブジェクト数を指定する （例）Get-Process -OutBuffer 10 |
| -PipelineVariable 変数 | 現在のパイプライン要素の値を格納する変数を指定する （例）Get-Process | ForEach-Object -PipelineVariable proc { Write-Host $proc.Name } |
準共通パラメータ
準共通パラメータは、一部のコマンドレットで使用できる共通的なパラメータです。
| パラメータ | 説明 |
|---|---|
| -UseTransaction | コマンドレットをトランザクション内で実行する |
| -Credential 資格情報 | 資格情報を指定する |
| -WhatIf | コマンド実行時の結果を表示するが実際には実行しない ※コマンドの影響を事前に確認できる （例）Remove-Item -Path "C:\test.txt" -WhatIf |
| -Confirm | コマンドを実行する前に確認を求める ※誤った操作を実行するリスクを減らせる （例）Remove-Item -Path "C:\test.txt" -Confirm |
