2011/12/19
PowerShell 3.0で追加されるバックグラウンドジョブ関係の新機能 [PS Advent Calendar '11]
はじめに
PowerShell Advent Calendar 2011の19日目の記事、そしてこれが私の記事では3回目となります。今回も前々回、前回からの引き続きでバックグラウンドジョブについての話題です。前回までは現行バージョンであるPowerShell 2.0におけるバックグラウンドジョブの機能の使い方を解説してきましたが、今回はPowerShellの次期バージョンである3.0に追加される予定の機能のうち、ジョブ関係のものをピックアップしてみます。現在PowerShell 3.0を含むWindows Management Framework(WMF)3.0のCTP2が公開されています。またWindows 8 Developer Preview / Windows Server 8 Developer PreviewにはWMF3.0 CTP1相当のPowerShell 3.0が含まれています。
注意:本記事で取り上げた内容は製品のプレビュー版をもとに記述しています。そのためリリース版では内容が一致しない可能性があることをご承知おきください。
using:ラベル
前回、ジョブに値を渡す方法について解説しましたが、-argumentListに引数として渡すというのは正直めんどうです。呼び出し元のグローバル変数を直接ジョブ側から参照したいですよね。そこでPowerShell v3では新たに変数に付けるusing:ラベルというのが追加されました。このラベルをジョブのスクリプトブロック内で使うと、呼び出し元の変数を参照することができます。具体例。
$test="PowerShell 3.0" Start-Job {$using:test}|Wait-Job|Receive-Job
とすると、「PowerShell 3.0」と表示され、たしかにジョブのスクリプトブロックから呼び出し元の変数を参照できていることがわかります。これは便利ですね。ただし残念ながらこの方法を使ってもスクリプトブロックをジョブに渡すことはできないようです。相変わらず文字列にキャストされてしまいました。
Receive-Jobコマンドレットの変更点
前々回に、Invoke-Command -asJobで複数リモートコンピュータに対してジョブを走らせた場合、そのジョブに対して$job|Receive-Jobがなぜか機能しない、と書きましたがこの問題が解決されています。そもそもなんでこの問題が発生していたのか、面白いのでちょっと解説します。
実はReceive-Jobコマンドレットの-locationパラメータに「パイプライン入力を許可する true (ByPropertyName)」フラグがついていたのが原因でした。複数コンピュータに対して実行したジョブは子ジョブを複数持ちますが、親ジョブ自体は配列ではありません。そしてそのLocationプロパティには子ジョブが実行されているコンピュータ名が"remote01,remote02,remote03"のようなカンマ区切りの文字列として格納されています。よってこのジョブオブジェクトをパイプラインを通じてReceive-Jobコマンドレットに渡すと、ValueFromPipelineByPropertyName属性が付いている-locationパラメータにジョブオブジェクトのLocationプロパティの値が渡されますが、その値はカンマ区切りの文字列なので正しく解釈されず、結果として期待の動作をしなかったわけです。
v3ではReceive-Job -locationのValueFromPipelineByPropertyName属性が取り除かれ、問題なく動作するようになりました。
他の変更点としてはReceive-Jobにジョブが完了するまで待つための-waitパラメータが追加されました。が、$job|Wait-Job|Receive-Jobと違いが分からないかも…。
Get-Jobコマンドレットの変更点
Get-Jobに-filterパラメータが追加されました。連想配列でジョブにフィルタをかけられるものです。
Get-Job -filter @{State="Completed";Location="localhost"}
where-objectを使わずともフィルタできるので便利、かも。しかし個人的には-filterパラメータはいろんなコマンドレットで定義されているものの、使い方がそれぞれ異なるのがとてもとてもイヤです。まず覚えられないのでヘルプを引くところから始まっちゃいますので。パフォーマンスの関係上、Where-Objectを使うよりコマンドレット内部でフィルタしたほうが速くなるというのはわかるのですが、もう少しフィルタ方式に統一性を持たせられなかったんだろうかとか思いますね。
Get-Jobにはほかに-afterと-beforeというパラメータが追加されています。これは後述するPSScheduledJobの完了時刻をDateTimeで範囲指定し、フィルタするものです。
PowerShell Workflow
PowerShell3.0というかWMF3.0のおそらく目玉機能の一つがPowerShell Workflowです。文字通り、PowerShellでワークフローが記述できるようになります。
Workflowは関数の一種なのですが、長時間を要するタスクやリモート実行や並列実行などで使うことを主目的としているようです。functionキーワードの代わりにworkflowキーワードでワークフローを定義すると、自動的に実行対象コンピュータ名や資格情報といったパラメータが複数定義されるので、これらのパラメータを特に定義なしで利用することができます。またworkflow内ではparallelブロックを定義でき、その中に記述された各行は並列に実行されます。またfor/foreachステートメントで-parallelパラメータが利用可能になり、繰り返し処理やコレクションの列挙を並列して行うことができるようになります。
自動定義されるパラメータに-asJobがあり、これを利用するとworkflowをジョブとして実行できます。このジョブは通常のジョブとは違い、新たに追加されたSuspend-JobコマンドレットとResume-Jobを使うことによって、ジョブの一時中断と再開ができます。このジョブの中断と再開は、リモートコンピュータ上でワークフローを走らせてるときでも可能ですし、中断後リモートセッションが切断されたあとに再開することもできますし、リモートコンピュータがシャットダウンしても再起動後にジョブを再開することまでできてしまいます。これらはWMFにおけるリモート基盤を支えているWinRMの最新バージョン、WinRM3.0が実現している機能です。このようにセッションを再接続してもタスクを継続できるような接続をrobust(堅牢な), resilient(弾力性のある、障害から容易に回復する) connectionと称しているようです。
PowerShell WorkflowはWindows Workflow Foundation(WF)と密接な関係があり、WFのデザイナで作ったxamlをPS Workflowに変換したり(逆もできる?)、Invoke-Expressionでxamlを実行したりできるらしいです。WF側でもPowerShellの多くの機能がアクティビティとして使用できたりして、WFとPowerShellがWMFというシステム管理フレームワークの主要なパーツとして密に連携していくようです。このあたりの話はWFの専門家であるAhfさんがPSアドベントカレンダーの23日目にしてくださる予定なので、楽しみですね!
なおPS Workflowは従来のPSスクリプトとは異なった利用状況を想定しているため、あるいはWFの機能と合わせるため、PSスクリプトではできるのにPS Workflowではできないことがとてもたくさんあります。forの中でbreakやcontinueステートメントが使えないとかStart-Sleepは-Secondパラメータしか指定できない(ミリ秒単位でスリープかけられない)とか色々あります。そのうちPS WorkflowとPSスクリプトの違いというドキュメントが公開されるんじゃないかと思います。
ちなみにWinRM3.0のおかげでワークフローではない通常のリモートジョブでも、New-PSSessionで作成したセッションの中でジョブを実行した場合、そのジョブが動作しているコンピュータへのセッションを切断(Disconnect-PSSession)したあと、セッションに再接続(Connect-PSSessionやReceive-PSSession)すればジョブの結果を取得したりすることができます。またセッションを作製したインスタンス(powershell.exe)でそのセッションを切断すると、それ以降は別のインスタンスやコンピュータからそのセッションにConnect-PSSessionで接続することができます。
ScheduledTasksモジュール
PowerShell3.0が含まれる次期Windowsでは大量のモジュールが追加され、それらのモジュールに含まれるコマンドレットの総数はWindows 8でも2000を超える膨大な量になります。これはWindows 8やWindows Server 8では従来のコマンドプロンプトから実行するコンソールexeコマンドのほとんどすべてをPowerShellコマンドレットに置き換える措置のためです。もちろん従来のコマンドは互換性のために残されますが、netsh.exeなど一部のコマンドではPowerShellへの移行を促すメッセージが表示されたりするようになるようです。参考:Window 8の機能の概要 − @IT
ScheduledTasksモジュールというタスクスケジューラを扱うモジュールもWindows 8 / Windows Server 8に新しく追加されるモジュールの一つで、schtasks.exeを置き換えるものとなります。これまでPowerShellでタスクスケジューラを扱うにはschtasks.exeを使うか、WMIのWin32_ScheduledJobを使う必要があり面倒でしたが、このモジュールに含まれるコマンドレットを用いるとそれが容易に行えるようになります。たとえば「notepad.exeを毎日朝10:00に起動する。バッテリ駆動のときでも実行」というタスクを「test」という名前で登録するには、
$action = New-ScheduledTaskAction -Execute "notepad.exe" $trigger = New-ScheduledTaskTrigger -At "10AM" -Daily $setting = New-ScheduledTaskSettings -AllowStartIfOnBatteries New-ScheduledTask -action $action -trigger $trigger -setting $setting|Register-ScheduledTask -TaskName test
とすれば可能であるはずです。実はServer 8 Developer Preview版ではこのコードは機能しません。タスクのトリガを作成するNew-ScheduledTaskTriggerコマンドレットが正しいオブジェクトを作ってくれないのです。これは将来のバージョンできっと修正されるかと思います。ただトリガを定義する部分をはずせば(あんまり意味はないですが)このコードは動作するので、やり方はたぶんあってると思います。
Register-ScheduledTaskコマンドレットには-asJobパラメータがあり、タスクスケジューラへの登録をジョブとしてバックグラウンドで行うことができます。ScheduledTasksモジュールはWMIを利用してタスクスケジューラを操作するので、ほかのWMI関係のコマンドレットと同様ですね。
なおScheduledTasksモジュールはデフォルトでは読み込まれていないので、使用するには本来Import-Moduleコマンドレットを使用しなければならないところですが、PowerShell3.0のCmdlet Discoveryという機能によりImport-Moduleは実行しなくてもScheduledTasksモジュールに含まれるコマンドレットを利用することができます。Cmdlet Discoveryとは現在読み込まれていて実行可能なコマンドレットの中にない、未知のコマンドレットを実行しようとしたとき、Modulesフォルダに存在するモジュールから同名のコマンドレットが定義されているものを探し出し、発見できたらそのモジュールを読み込んだうえでコマンドレットを実行するという優れた機能です。初回だけモジュールの検索とロードの手順が実行されるので待たされますが、一度Cmdlet Discoveryによってモジュールがシェルに読み込まれればあとは快適にコマンドレットを実行できるようになります。
PSScheduledJobモジュール
ScheduledTasksモジュールは-asJobパラメータが定義されているくらいで実はそれほどPowerShellのジョブとは関係ないのですが、ScheduledTasksモジュールが内包しているPSScheduledJobモジュールはPowerShellのジョブ機能と大いに関係があります。
従来PowerShellスクリプトをタスクスケジューラに登録するにはコマンドラインに"powershell.exe"を、引数に"-file hoge.ps1"を指定して、みたいなまわりくどいことをする必要がありました。しかし新しく追加されるPSScheduledJobモジュールに含まれるコマンドレット群はこの問題を解消します。PowerShellスクリプト(.ps1)あるいはスクリプトブロックをPSScheduledJobとして直接タスクスケジューラに登録できるようになり、PowerShellとタスクスケジューラのシームレスな連携を実現します。こちらはWindows 8/Server 8に付属のモジュールではなく、PowerShell 3.0に付属のモジュールなので、Win7などでも使用可能になる予定です。
使用例を見ていきましょう。
$triggers = @() $triggers += New-JobTrigger -at "2012/01/01 11:11:10" -Once $triggers += New-JobTrigger -at "10:00" -Daily $sb = { "This is Scheduled Job." Get-Date } Register-ScheduledJob -ScriptBlock $sb -Trigger $triggers -Name ScheduledJobTest1
まずNew-JobTriggerコマンドレットによってトリガー(具体的には実行時刻など)を定義します。ここでは決められた時刻に1回実行するものと、毎日同じ時刻に実行するものの2つを定義してみました。そしてこれらの時刻に実行したい内容をスクリプトブロックに記述し、これらをRegister-ScheduledJobコマンドレットで登録してやります。
するとこのスクリプトブロックはタスクスケジューラに登録され、指定時刻になると指定したスクリプトブロックの内容が実行されます。このタスクは「タスクスケジューラ― ライブラリ\Microsoft\Windows\PowerShell\ScheduledJobs」に登録されています。
このタスクのアクションは具体的には次のようになっています。
powershell.exe -NoLogo -NonInteractive -WindowStyle Hidden -Command "Import-Module PSScheduledJob; Start-Job -DefinitionName 'ScheduledJobTest2' -DefinitionPath 'C:\Users\Administrator\AppData\Local\WindowsPowerShell\ScheduledJobs' -WriteToStore | Wait-Job"
これによると、指定時刻に実際にタスクスケジューラによって実行されるのはpowershell.exeであり、Start-Jobコマンドレットを使って登録したスケジュールをPowerShellのジョブとして実行していることがわかります。Start-Jobコマンドレットの-DefinitionNameパラメータなどはPSScheduledJobのために追加されたもので、これによりRegister-ScheduledJobが出力したPSScheduledJob定義をファイルから読み込んでジョブとして実行できるようになっています。PSScheduledJob定義とジョブの出力は-DefinitionPathで指定されているフォルダの下にxmlファイルとして保存されているので興味がある方は覗いてみるといいかもしれません。
さて、スケジュールしたジョブの実行結果はどうやって受け取ればいいのでしょうか。実はこれはすごく簡単で、PSScheduledJob(ここではScheduledJobTest1という名前で定義しました)がタスクスケジューラによって一度以上実行された後は、
$job=Get-Job -name ScheduledJobTest1
とすることでJobオブジェクトとして取得することができるようになります。あとは通常のジョブと同じ取り扱いができるので、
$job|Receive-Job
などで実行結果を取得できます。
ちなみにPSScheduledJobはそれを定義したインスタンス以外でも参照することができます。具体的にはpowershell.exeでジョブをスケジューリングして終了→また別のpowershell.exeを立ち上げてimport-module PSScheduledJobしたあとGet-Job|Receive-JobしてPSScheduledJobの結果を参照、みたいなことができます。
ここで紹介した一連の操作ではスクリプトブロックをPSScheduledJobにしましたが、Register-ScheduledJobコマンドレットの-FilePathパラメータを用いれば.ps1ファイルをPSScheduledJobとして登録することも可能です。
現行バージョンのPowerShellはとにかく起動が遅いため、タスクスケジューラにスクリプトを登録しても実行が始まるまで何十秒も待たされるなどはざらでしたが、PSv3は起動がずいぶん速くなり、スペックや状況にもよるとは思いますがpowershell.exeの起動後ほんの数秒でスクリプトが走り始めます。この速度のおかげもあってPSScheduledJobはきっととても有効に機能するんじゃないかと思います。
おわりに
今回はPowerShell 3.0で増強されるバックグラウンドジョブ関係の機能をまとめてみました。これらの新機能のおかげで、時間のかかる処理や定期実行する処理を扱うのが飛躍的にやりやすくなりそうです。PowerShell 3.0で追加される機能は他にもたくさんあって、このブログでもいつか全部紹介したいと思ってるのですが、今回取り上げたジョブ関係はその中でもかなり重要な機能増加を多く含んでいると言えるでしょう。PowerShell 3.0やWindows 8/Server 8のリリースに備えてジョブ関係から予習しておくのは悪くないと思いますよ。
なんか25日のアドベントカレンダーのうち3回もバックグラウンドジョブネタをやって、PSアドベントカレンダーというより私だけ一人でPSジョブアドベントカレンダーをやってる感じでちょっと申し訳ないんですが、どうか許してください。そして前回は今回で終了するって言ってたんですが、実はまだジョブ関係の小ネタが残ってるので最終日25日にさせてください。では今日のところはこのへんで。明日はwaritohutsuさんの登場です。よろしくお願いします。
2010/02/13
PowerShell基礎文法最速マスター
PowerShellは.NET Framework 2.0を利用するWindowsのシステム管理用シェルである。シェルであるためコンソールで対話的にコマンドを実行することができるのはもちろん、スクリプトファイル(*.ps1)を記述しバッチ的に実行することも可能である。ここではPowerShellスクリプトで(コンソールでも使用は可能だが)用いることのできる基礎文法を紹介する。なお、PowerShellでは文法上、大文字小文字を区別しない。
※(★2.0)の注釈があるものはPowerShell 2.0で新たに追加された要素である。
1.基礎
表示
コンソールに文字列を表示。
"Hello world"
コマンドレット(後述)を使用した場合。
Write-Host "Hello world"
コマンドレット
PowerShellはコマンドレットと呼ばれる100種類以上のコマンドライン・ツール群を単独で、あるいはパイプライン(後述)で連結して使用するのが基本となる。コマンドレットは原則verb-nounという命名規則にしたがっている。パラメータをつける場合は「-パラメータ名」あるいは「-パラメータ名 パラメータ値」を指定する。
# コマンドレットの一覧表示 Get-Command # サービスの一覧を表示 Get-Service # アプリケーション イベントログの最新15個のエントリを表示 Get-EventLog -logName Application -newest 15
パイプライン
コマンドレットが値を返却する場合、.NET Frameworkのオブジェクトが含まれる配列であることが多い。このオブジェクト配列がパイプラインを渡って後続のコマンドレットに入力される。
# プロセスのリスト(System.Diagnostics.Processオブジェクトの配列)を取得し、 # Where-Objectコマンドレットでハンドル数(handlesプロパティ)の値が500より大きいものだけを取り出し # Select-Objectコマンドレットで最初の5つのオブジェクトだけを切りだして表示 Get-Process | Where-Object {$_.handles -gt 500} | Select-Object -first 5 # C:\Windows 配下のフォルダ、ファイルの一覧(System.IO.DirectoryInfo,System.IO.FileInfoオブジェクトの配列)を取得し、 # ForEach-Objectコマンドレットで配列を列挙しすべてのオブジェクトのFullNameプロパティ(フルパス)の値を表示 Get-ChildItem C:\Windows | ForEach-Object {$_.FullName} # 通常の配列に関してもパイプラインを使用可能。 # 重複を取り除き、ソートをかける @(3,5,10,1,2,1,1,1,2,6,4,4)|Sort-Object|Get-Unique
コメント
# コメント
マルチラインコメント(★2.0)
<# 複数行に渡る コメントです #>
変数の宣言
PowerShellは変数の宣言をしなくても変数を使用可能。以下のようにするとどのような型でも代入可能な変数が作られる。
$a = 1 $a = $b = $c = 1 #複数変数に一度に同じ値を代入する場合 $items = Get-ChildItem # コマンドレットの戻り値を格納
変数の型を指定することは可能。以下のようにするとint型のみ格納可能な変数が作られる。
[int]$a = 1
あるいは、コマンドレットを用いて$aという変数を宣言することもできる。この場合変数の型は指定できない。
New-Variable -name a
変数のスコープ
# どのスコープからも読み書き可能 $global:a = 1 # 現在のスコープからのみ読み書き可能 $private:a = 1 # 現在のスクリプトからのみ読み書き可能 $script:a = 1
文法チェック
以下を実行することで未定義の変数を参照するとエラーが出るようになる。
Set-PSDebug -strict
スクリプトの実行
デフォルトの実行ポリシーではスクリプトの実行は不許可であるため、以下のようにポリシーを変更しておく。(RemoteSignedはローカルにあるスクリプトファイルは無条件で実行可、リモートにあるスクリプトファイルは署名付きのもののみ実行可)
Set-ExecutionPolicy RemoteSigned
スクリプト/コマンドを実行するにはコマンドラインで次のようにする。
コマンドを実行する
powershell -command {Get-ChildItem C:\}
ファイルを実行する
powershell .\script.ps1
ドットソース(スクリプトの内容をグローバルスコープに読み込む)
powershell . .\script.ps1
ファイルを実行する(★2.0)
powershell -file script.ps1
PowerShellスクリプトから別のスクリプトを実行する場合(関数のインクルードにも用いられる)
.\script.ps1 . .\script.ps1 # ドットソース
デバッガの起動
Set-PSDebug -trace 2
ステップ実行
Set-PSDebug -step
2.数値
数値の表現
PowerShellにおける数値は.NET Frameworkの数値を表す構造体のインスタンスである。数値には整数、浮動小数点があり、変数に代入した段階で適切な型が設定される。
# int型(System.Int32型) $int = 1 # System.Double型 $double = 1.001
四則演算
# 足し算 $i = 1 + 1 # 引き算 $i = 1 - 1 # 掛け算 $i = 1 * 1 # 割り算 $i = 1 / 1
余りと商の求め方
# 割り算の余り $mod = 7 % 3 # 上記の場合の商 $div = (7 - 7 % 3) / 3
べき乗
# 2の8乗 $i = [math]::Pow(2,8)
インクリメントとデクリメント
# インクリメント $i++ # デクリメント $i--
3.文字列
PowerShellにおける文字列は.NET Frameworkの System.Stringクラスのインスタンスである。
文字列の表現
文字列はシングルクォーテーションかダブルクォーテーションで囲む。ダブルクォーテーションの中では`t(タブ)や`r`n(改行)などの特殊文字が使用でき、変数が展開される。
$str1 = 'abc' $str2 = "def" $str3 = "a`tbc`r`n" #変数展開(結果は abc def) $str4 = "$str1 def"
文字列操作
各種文字列操作
# 結合 $join1 = "aaa" + "bbb" $join2 = [string]::Join(",",@("aaa","bbb","ccc") ) # 結合(★2.0) $join2 = @("aaa","bbb","ccc") -join "," # 分割 $record1 = "aaa,bbb,ccc".Split(",") # 分割(★2.0) $record2 = "aaa,bbb,ccc" -split "," # 長さ $length = "abcdef".Length # 切り出し $substr = "abcd".SubString(0,2) # ab
正規表現検索
# hitした場合はTrue,しなかった場合はFalse $result = "abcd" -match "cd" # 最初に見つかった文字列。添え字の1,2…には()内のサブ式にhitした文字列が格納。 $matches[0]
正規表現置換
$result = "abc" -replace "c","d"
4.配列
PowerShellにおける配列は.NET Frameworkの System.Arrayクラスのインスタンスである。
配列の参照と代入
# 5個の要素を持つ配列宣言と代入 $arr1 = @(1,3,5,7,9) # 以下のようにも記述できる $arr1 = 1,3,5,7,9 # 型指定する場合 [int[]]$arr1 = @(1,3,5,7,9) # 1〜10までの要素を持つ配列宣言と代入 $arr2 = @(1..10) # 1要素の配列宣言と代入 $arr3 = @(1) $arr3 = ,1 # 空の配列宣言と代入 $arr4 = @()
配列の要素の参照と代入
# 4番目の要素を参照 $ret = $arr2[3] # 6〜9番目の要素を含んだ配列を参照 $ret = $arr2[5..8] # 1〜4番目と8番目の要素を含んだ配列を参照 $ret = $arr2[0..3+7] # 配列の末尾の要素を取り出す $ret = $arr2[-1] # 5番目の要素に値を代入 $arr2[4] = 11 # 3より小さな要素を含んだ配列を返す $ret = $arr2 -lt 3
配列の個数
$arr1_num = $arr1.Length
配列の操作
$arr1 = @(1,3,5,7,9) $arr2 = @(1..10) # 配列の末尾に要素を加える(push) $arr2 += 50 # 配列を結合し新しい配列を作成 $arr5 = $arr1 + $arr2 # 配列にある要素が含まれるかどうか(ここではTrue) $arr2 -contains 2
5.ハッシュ
PowerShellにおけるハッシュは.NET Frameworkの System.Collections.Hashtableクラスのインスタンスである。
ハッシュ変数の宣言と代入
# 3つの要素を持つハッシュの宣言と代入 $hash1 = @{a=1;b=2;c=3} # 空のハッシュの宣言と代入 $hash2 = @{}
ハッシュの要素の参照と代入
# 要素の参照 $hash1.a $hash1["a"] #要素の代入 $hash1.b = 5 $hash1["b"] = 5
ハッシュの操作
# ハッシュに要素を追加 $hash1.d = 4 $hash1.Add("e",5) # ハッシュの要素の削除 $hash1.Remove("a") # ハッシュのキーの取得 $keys = $hash1.Keys # ハッシュの値の取得 $values = $hash1.Values # ハッシュの要素を列挙 foreach ($key in $hash1.Keys) { $key + ":" + $hash1[$key] } # キーの存在確認 $hash1.Contains("b")
6.制御文
if文
if (条件) { }
if 〜 else文
if (条件) { } else{ }
if 〜 elsif 文
if (条件) { } elseif (条件) { }
while/do文
while (条件) { } do { } while (条件)
for文
for ($i = 0; $i -lt 5; $i++) { }
foreach文
foreach ($item in $items) { }
switch文
case を書かないのが特徴的。またスクリプトブロックを条件文に記述できる。
switch ($i) { 1 {"1";break} 2 {"2";break} {$_ -lt 5} {"5より小さい";break} default {"default句";break} } # ここで$iに配列を指定すると配列要素すべてに対してswitch文が実行される。
比較演算子
比較演算子の一覧。PowerShellではPerlの文字列比較演算子のような記述をおこなうが、Perlとは異なり文字列も数値も同じ書式である。
$num1 -eq $num2 # $num1は$num2と等しい $num1 -ne $num2 # $num1は$num2は等しくない $num1 -lt $num2 # $num1は$num2より小さい $num1 -gt $num2 # $num1は$num2より大きい $num1 -le $num2 # $num1は$num2以下 $num1 -ge $num2 # $num1は$num2以上
論理演算子
# 論理否定 $ret = -not $true $ret = !$true # 論理積 $ret = $true -and $false # 論理和 $ret = $true -or $false # 排他的論理和 $ret = $true -xor $false
ビット演算子
# ビット単位の否定 $ret = -bnot 0x14F4 # ビット単位の積 $ret = 0x14F4 -band 0xFF00 # 上記結果を16進数で表示する場合 $ret = (0x14F4 -band 0xFF00).ToString("X") # ビット単位の和 $ret = 0x14F4 -bor 0xFF00 # ビット単位の排他的論理和 $ret = 0x14F4 -bxor 0xFF00
7.サブルーチン
PowerShellのサブルーチンには関数とフィルタがある。関数とフィルタは呼び出し行の前で宣言する必要がある。 filter構文もfunction構文と並んで独自関数を記述するものだが、filter構文はパイプラインに渡されたオブジェクトをフィルタするのに用いる。 functionとの違いは、パイプラインに渡した配列を一度に処理するか(function)個別に処理するか(filter)
# 関数宣言の基本 function Get-Test { return "test" } # 注:returnを付けなくても関数内で出力された値はすべて呼び出し元に返却される。返却したくない場合は出力値をを[void]にキャストするか|Out-Nullに渡す。 # 引数を指定する場合 function Get-Test { param($param1,$param2) return $param1 + $param2 } # 引数を指定する場合の簡易的な記述法 function Get-Test($param1,$param2) { return $param1 + $param2 } # 引数の型を指定する場合 function Get-Test { param([string]$param1,[string]$param2) return $param1 + $param2 } # 関数の呼び出し方(,区切りではなくスペース区切りであることに注意) Get-Test "引数1" "引数2" # 引数の順序はパラメータ名(引数名)を指定すると自由に指定可能 Get-Test -param2 "引数2" -param1 "引数1" # フィルタ宣言の基本 filter Get-Odd { if($_ % 2 -eq 1){ return $_ }else{ return } } # フィルタの使用 @(1..10) | Get-Odd
8.テキストファイル入出力
コマンドレットで可能。エンコーディングは日本語環境のデフォルトではShift-JIS。コマンドレット出力のテキストファイルへの書き出しに関してはリダイレクトも可能。この場合エンコーディングはUnicode。
$str1 = "testテスト" Set-Content test.txt $str1 # 書き込み Add-Content test.txt "追記" # 追記 $str2 = Get-Content test.txt # 読み込み Set-Content test.txt $str1 -encoding UTF8 # UTF-8で書き込み # リダイレクト Get-Process > test.txt # 書き込み Get-Process >> test.txt # 追記 Get-Process | Out-File test.txt -encoding UTF8 # エンコーディングを指定する場合
9.例外
PowerShellで例外が発生すると、デフォルトではエラーメッセージを表示し次の行を実行する(シェル変数$ErrorActionPreferenceの設定により挙動の変更可能)。VBでいうとOn Error Resume Nextに近い。エラーが発生すると$Errorにエラー情報の配列が格納され、$?にFalseが格納される。エラーをトラップするには次の構文を使用する。VBでいうとOn Error Goto lineに近い。
# すべてのエラーをトラップ trap { } # エラーの型名を指定してトラップ trap [System.Management.Automation.CommandNotFoundException] { } # エラーを発生させる throw "エラー" throw New-Object NullReferenceException
構造化例外処理(★2.0)
# 基本 try{ } catch{ } finally{ } # エラーの型を指定してcatch try{ } catch [System.Net.WebException],[System.IO.IOException]{ }
10.知っておいたほうがよい文法
行継続文字
1行にすると長いコードを複数行に書くには行継続文字`を用いる。VBの_。
$items = Get-ChildItem a*,b*,c*,d*,e* ` -force -recurce
ただし以下のような場合は`を使用しなくてもよい
$items = Get-ChildItem a*,b*,c*,d*,e* -force –recurse Get-Process | Where-Object {$_.handles -gt 500} | Select-Object -first 5
ステートメント分割
ステートメントを分割するには改行コードもしくは;を使用する。VBの:。JavaScriptと同様、文末に;はつけてもつけなくてもよい。
$i = 1; $j = 5; $k = $i + $j
ヒア文字列
複数行の文字列を記述する方法。
$str = @" aaaaaa bbbbb cccc ddd ee "@
.NET Frameworkクラスの利用
.NET Frameworkに含まれているクラスのプロパティやメソッドを使用できる。基本的に完全修飾名を指定しなければいけないが、"System."は省略可能。また、intなど型エイリアスがいくつか定義されている。
# スタティックメンバの使用 [System.Math]::Pow(2,8) # インスタンスの生成とメソッドの実行 $arrayList = New-Object System.Collections.ArrayList $arrayList.Add("a") # コンストラクタがある場合。複数ある場合は配列として指定 $message = New-Object System.Net.Mail.Message from@example.com,to@example.com # COMオブジェクトの生成 $wshShell = New-Object -com WScript.Shell # デフォルトで読み込まれていないアセンブリを読み込む [void] [System.Reflection.Assembly]::LoadWithPartialName("System.Windows.Forms") [System.Windows.Forms.MessageBox]::Show("hello!") # クラスにどんなメンバがあるかの確認 # インスタンスメンバ Get-ChildItem | Get-Member # スタティックメンバ [math] | Get-Member -static
キャスト
-asを使った場合はキャスト失敗時もエラーにならずNullが格納される。
$dt = [System.DateTime]"2010/02/13" $dt = "2010/02/13" -as [System.DateTime]
ユーザー定義オブジェクト
PowerShellにはクラスを定義する構文はないが、空のオブジェクト(PSObject)を生成し、任意のプロパティ(ノートプロパティ)を付加することができる。
$obj = New-Object PSObject $property = New-Object System.Management.Automation.PSNoteProperty "Name","名前" $obj.PSObject.Members.Add($property)
シェル変数
あらかじめ定義されている変数。シェル変数には自動変数(変更不可能)とユーザー定義変数(変更すると挙動を変更することができる)がある。自動変数の例を挙げる。
$_ :現在パイプラインにわたっているオブジェクト
$args :関数やスクリプトに与えられたパラメータの配列
$pshome :PowerShellがインストールされているフォルダのフルパス
$MyInvocation :スクリプトの実行情報。$myInvocation.ScriptNameでスクリプトのフルパス取得(★2.0)。$myInvocation.MyCommand.Path(1.0の場合)
$true :true。
$false :false。
$null :null。
サブ式
$()内には複数行のコードが記述できる。
$arr = $(1;2;1+4)
式モードとコマンドモード
PowerShellの構文解析は式モードとコマンドモードがある。式モードは通常のモード。コマンドモードは引用符がなくても文字列を文字列として扱う。コマンドレットのパラメータなどはコマンドモードで扱われる。ただしコマンドモードになるところでも()もしくは$()もしくは@()をつけるとその中身は式モードとして解釈、実行される。
$i = 1 + 1 # 式モード Write-Host aaa # コマンドモード(表示:aaa) Write-Host aaa bbb # コマンドモード(表示:aaa bbb) Write-Host 1+1 # コマンドモード(表示:1+1) Write-Host (1+1) # 式モード(表示:2) $itemCount = @(Get-ChildItem).Length # 式モード
実行演算子とスクリプトブロック
&演算子を用いるとスクリプトブロック{}の内容を実行できる。この場合、スクリプトブロック内のコードは別スコープになる。
$script = {$i = 1+6; Write-Host $i} &$script & 'C:\Program Files\Internet Explorer\iexplore.exe' # パスにスペースの含まれるファイルを実行したりするのにも使える
フォーマット演算子
-f演算子を使うと、.NET Frameworkのカスタム書式が使用可能。
"{0:#,##0}Bytes" -f 38731362 # 表示:38,731,362Bytes
バイト数の簡易表記
$i = 1KB # 1024が代入される $i = 1MB # 1048576が代入される $i = 1GB # 1073741824が代入される
そのほかの基礎文法最速マスターへのリンク
プログラミング基礎文法最速マスターまとめ - ネットサービス研究室
http://d.hatena.ne.jp/seikenn/20100203/programmingMaster
PowerShellの詳しい機能解説についてはこちらの記事を参照してください。
PowerShell的システム管理入門 ―― PowerShell 2.0で始める、これからのWindowsシステム管理術 ―― ─ @IT
進化したPowerShell 2.0 ─ @IT
文法や機能について詳しく学びたい方には書籍もあります
Windows PowerShellポケットリファレンス
PowerShellによるWindowsサーバ管理術
2006/11/11
ファイルの属性を変更するには?
コマンドプロンプトだとattribコマンドを使うところですが、PowerShellだとこんな感じになります。test.txtファイルにReadOnlyとHidden属性をつけます。
set-itemproperty -path test.txt -name attributes -value "ReadOnly","Hidden"
属性はコンマ区切りの配列で指定するところがポイントです。一つなら"ReadOnly"などで大丈夫です。
このコマンドラインはちょっと冗長ですね。エイリアスとパラメータの省略を駆使するとこうなります。
sp test.txt attributes "Readonly","Hidden"
まあこんなもんでしょう。
元記事:http://blogs.wankuma.com/mutaguchi/archive/2006/11/11/44626.aspx2006/11/05
12/16わんくま勉強会でPowerShellの話をします
12/16のわんくま同盟大阪勉強会#4で私がPowerShellのお話をすることになりました。
題して、
「Windows PowerShell 〜.NETベースのシェル・スクリプト実行環境〜」
です。今回はPowerShellの概要紹介と、デモを中心にやろうと思っています。マニアックなのはまた後日にw
デモは会場から「こんなんできませんか?」ってのを聞いてその場でコマンドラインを叩くとか無茶をやってみようかと思っていますがそこまでマスターできてないかもしれません、そのときはごめんなさい。
今(まだ?)、MSのサイトで落とせる資料を初めとする各種英語資料と戦っています。早くPPTを作り始めないといけませんね。大勢の前で話すのは、大学院の修士論文発表会以来です。学会とかそれなりに発表歴はあるのですが、それまでで一番長いですね(40分)。
詳細はhttp://www.wankuma.com/seminar/20061216osaka4/Default.aspxです。
お時間のあるかたはぜひ足をお運びくださいませ〜。
2006/11/01
コマンドレットオンラインヘルプ作成ワンライナー
PowerShellのコマンドレットのヘルプを引くには、get-help コマンド名 -detailなどとしますが、コマンドラインでいちいち打つのは邪魔くさい、一覧のヘルプファイルが欲しい、という場合に便利なワンライナーを書いてみました。
カレントにファイルが作成されますので、適宜cdで移動してください。
コマンドレットのヘルプのHTMLを作成するワンライナー
get-command -commandtype cmdlet|%{"" + (get-help $_.Name -detail|out-string).Replace("&","&").Replace("<","<").Replace(">",">").Replace("`n","
"|out-file($_.name + ".html")}
") +"
HTMLのインデックスを作成するワンライナー
$temp="
- ";get-command -commandtype cmdlet|%{$temp+="
- " + $_.name + " "};$temp+="
これを実行すると、カレントディレクトリに、コマンドレットのヘルプが記述された「コマンドレット名.html」というファイルが、登録されている数だけ作成され、インデックスとなるファイルが「index.html」として作成されます。
あとはindex.htmlを開いて読みたいコマンドレットのリンクをクリックしてください。
関連リンクに実際にリンクを張るなど、改造しだすといろいろできると思いますが、まずはワンライナーとしてここに載せておきます。
Copyright © 2005-2018 Daisuke Mutaguchi All rights reserved
mailto: mutaguchi at roy.hi-ho.ne.jp
プライバシーポリシー