SEブログ

【PowerShell】Pipeline(パイプライン)とは何か

 

こんにちは!SE ブログの相馬です。

 

 

 

今回はパイプラインについて書きました。早速パイプラインとは何かから説明します。

 

 

 

パイプラインとは

 

 

パイプラインとは、先行のコマンドの結果をパイプラインを使って次のコマンドに渡してあげる為のものです。PowerShell では、パイプラインを |(縦棒)で書きます。例えばイメージとしてこんな感じです。ここでは、Get-ChildItem コマンドレットを使って、C ドライブの Program Files というフォルダの中にあるファイルやフォルダをテキストファイルとして出力します。ですのでパイプの前と後の処理としてはこんな感じです。

 

Command-1 | Command-2 | Command-3


# 実際のコマンド(C:\Program Files 以下ディレクトリ情報をテキストファイルに出力する)
Get-ChildItem -Path "C:\Program Files" | Out-File -FilePath "C:\temp\programfiles.txt"

 

 

上の処理の順番について説明しますと

 

 

  1. Get-ChildItem コマンドレットで C:\Program Files 以下のディレクトリの情報(ファイルやフォルダの情報)を取得する。
  2. 取得した情報を Out-File コマンドレットで C:\temp\programfiles.txt を指定してテキストファイルとして出力する。

 

 

Get-ChildItem コマンドレットについては @IT の記事が参考になります。Out-File コマンドレットは TechNet の記事が分かりやすいです。

 

【 Get-ChildItem 】コマンドレット――ディレクトリの情報を取得する | @IT

Out-File コマンドレットの使用 | Microsoft TechNet

 

 

パイプラインとはコマンドレットの処理結果の情報を、パイプラインを使って、次のコマンドレットに渡す事までお分かりいただけたかと思います。それでは、パイプラインでは実際どんな情報が渡されるのでしょうか?次に進みます。

 

 

 

パイプラインで流れる情報はオブジェクト

 

 

パイプラインの前と後ではコマンドレットを使いますが、処理結果の情報としてコンソールにはテキストが表示されます。では、実際にパイプを使って渡す内容はこのテキストデータかというと実はそうではないのです。パイプラインで受け渡しされる情報、つまりその中を流れる情報、つまりデータはオブジェクトになります。オブジェクトとしてデータが渡されるので、次のコマンドレットではそのオブジェクトを操作できます。ですので必要に応じてオブジェクトの中に入っているなどの情報を取り出せたりするので便利です。

 

 

例えば、別の記事に書いてあるのですが、これが分かり易いと思います。ここでは、AD に参加しているコンピューターの情報を取得して、取得したオブジェクトをパイプラインで渡して、その中にあるプロパティを取り出して整形しています。

 

Get-ADComputer `
 -Filter * `
 -Property * | `
Format-Table `
 Name, `
 OperatingSystem, `
 OperatingSystemServicePack, `
 OperatingSystemVersion `
 -Wrap –Auto


# 実行結果

Name OperatingSystem OperatingSystemServicePack OperatingSystemVersion
---- --------------- -------------------------- ----------------------
DEVDC01 Windows Server 2016 Standard Evaluation 10.0 (14393) 
DEVDC02 Windows Server 2016 Standard Evaluation 10.0 (14393) 

 

 

 

上の処理の順番について説明します。

 

 

  1. Get-ADComputer コマンドレットで AD に参加しているコンピューターを全て取得する。
  2. 取得したオブジェクトを Format-Table コマンドレットで必要なプロパティだけ指定して整形して表示する。

 

 

こんな感じで最初のコマンドレットで、とりあえず欲しい情報を取得して、次のコマンドレットでその情報の中にあるものを必要な分だけ取り出して表示したり、データに出力したりする事ができます。このオブジェクトというのは理解していない方はなかなか分かりにくいと思いますが、ここでは箱みたいな物だと思ってください。

 

 

上の処理では AD に参加しているコンピューター一覧みたいな表が箱だと思ってもらい、その箱の中にはプロパティという個々のコンピューターが持っている情報があるので、そのプロパティを必要な分だけ指定して、箱から取り出して綺麗に並び替えて表示してあげるようなイメージになります。

 

 

以下の記事も参考いただけると幸いです。

 

【Active Directory】PowerShellでオブジェクト一覧を取得する

 

 

以上になります。パイプラインについてはご理解いただけましたでしょうか。

 

 

パイプラインは難しくなく、色んなサンプルスクリプトを見てゆけば理解ができるようになります。ただしオブジェクトというキーワードがここで出てきましたので、オブジェクトについてよく理解するほうが PowerShell を学習する上では非常に重要になります。

 

 

では最後までお読みいただきありがとうございました!