コマンドレットのパラメータを列挙してみる。2011の19日目の記事、そしてこれが私の記事では3回目となります。今回も前々回、前回からの引き続きでバックグラウンドジョブについての話題です。2.0におけるバックグラウンドジョブの機能の使い方を解説してきましたが、今回はPowerShellの次期バージョンである3.0に追加される予定の機能のうち、ジョブ関係のものをピックアップしてみます。Framework(WMF)3.0のCTP2が公開されています。3.0が含まれています。注意:本記事で取り上げた内容は製品のプレビュー版をもとに記述しています。そのためリリース版では内容が一致しない可能性があることをご承知おきください。using:ラベル前回、ジョブに値を渡す方法について解説しましたが、-argumentListに引数として渡すというのは正直めんどうです。呼び出し元のグローバル変数を直接ジョブ側から参照したいですよね。v3では新たに変数に付けるusing:ラベルというのが追加されました。このラベルをジョブのスクリプトブロック内で使うと、呼び出し元の変数を参照することができます。3.0」と表示され、たしかにジョブのスクリプトブロックから呼び出し元の変数を参照できていることがわかります。残念ながらこの方法を使ってもスクリプトブロックをジョブに渡すことはできないようです。相変わらず文字列にキャストされてしまいました。-asJobで複数リモートコンピュータに対してジョブを走らせた場合、そのジョブに対して$job|Receive-Jobがなぜか機能しない、と書きましたがこの問題が解決されています。そもそもなんでこの問題が発生していたのか、面白いのでちょっと解説します。(ByPropertyName)」フラグがついていたのが原因でした。複数コンピュータに対して実行したジョブは子ジョブを複数持ちますが、親ジョブ自体は配列ではありません。そのLocationプロパティには子ジョブが実行されているコンピュータ名が"remote01,remote02,remote03"のようなカンマ区切りの文字列として格納されています。よってこのジョブオブジェクトをパイプラインを通じてReceive-Jobコマンドレットに渡すと、ValueFromPipelineByPropertyName属性が付いている-locationパラメータにジョブオブジェクトのLocationプロパティの値が渡されますが、その値はカンマ区切りの文字列なので正しく解釈されず、結果として期待の動作をしなかったわけです。-locationのValueFromPipelineByPropertyName属性が取り除かれ、問題なく動作するようになりました。他の変更点としてはReceive-Jobにジョブが完了するまで待つための-waitパラメータが追加されました。$job|Wait-Job|Receive-Jobと違いが分からないかも...。Get-Jobコマンドレットの変更点Get-Jobに-filterパラメータが追加されました。連想配列でジョブにフィルタをかけられるものです。@{State="Completed";Location="localhost"}where-objectを使わずともフィルタできるので便利、かも。個人的には-filterパラメータはいろんなコマンドレットで定義されているものの、使い方がそれぞれ異なるのがとてもとてもイヤです。覚えられないのでヘルプを引くところから始まっちゃいますので。パフォーマンスの関係上、Where-Objectを使うよりコマンドレット内部でフィルタしたほうが速くなるというのはわかるのですが、もう少しフィルタ方式に統一性を持たせられなかったんだろうかとか思いますね。Get-Jobにはほかに-afterと-beforeというパラメータが追加されています。これは後述するPSScheduledJobの完了時刻をDateTimeで範囲指定し、フィルタするものです。Workflowです。文字通り、PowerShellでワークフローが記述できるようになります。Workflowは関数の一種なのですが、長時間を要するタスクやリモート実行や並列実行などで使うことを主目的としているようです。functionキーワードの代わりにworkflowキーワードでワークフローを定義すると、自動的に実行対象コンピュータ名や資格情報といったパラメータが複数定義されるので、これらのパラメータを特に定義なしで利用することができます。workflow内ではparallelブロックを定義でき、その中に記述された各行は並列に実行されます。for/foreachステートメントで-parallelパラメータが利用可能になり、繰り返し処理やコレクションの列挙を並列して行うことができるようになります。自動定義されるパラメータに-asJobがあり、これを利用するとworkflowをジョブとして実行できます。このジョブは通常のジョブとは違い、新たに追加されたSuspend-JobコマンドレットとResume-Jobを使うことによって、ジョブの一時中断と再開ができます。このジョブの中断と再開は、リモートコンピュータ上でワークフローを走らせてるときでも可能ですし、中断後リモートセッションが切断されたあとに再開することもできますし、リモートコンピュータがシャットダウンしても再起動後にジョブを再開することまでできてしまいます。これらはWMFにおけるリモート基盤を支えているWinRMの最新バージョン、WinRM3.0が実現している機能です。connectionと称しているようです。Workflowに変換したり(逆もできる?)、Invoke-Expressionでxamlを実行したりできるらしいです。WF側でもPowerShellの多くの機能がアクティビティとして使用できたりして、WFとPowerShellがWMFというシステム管理フレームワークの主要なパーツとして密に連携していくようです。Workflowではできないことがとてもたくさんあります。forの中でbreakやcontinueステートメントが使えないとかStart-Sleepは-Secondパラメータしか指定できない(ミリ秒単位でスリープかけられない)とか色々あります。WorkflowとPSスクリプトの違いというドキュメントが公開されるんじゃないかと思います。ちなみにWinRM3.0のおかげでワークフローではない通常のリモートジョブでも、New-PSSessionで作成したセッションの中でジョブを実行した場合、そのジョブが動作しているコンピュータへのセッションを切断(Disconnect-PSSession)したあと、セッションに再接続(Connect-PSSessionやReceive-PSSession)すればジョブの結果を取得したりすることができます。セッションを作製したインスタンス(powershell.exe)でそのセッションを切断すると、それ以降は別のインスタンスやコンピュータからそのセッションにConnect-PSSessionで接続することができます。8でも2000を超える膨大な量になります。8では従来のコマンドプロンプトから実行するコンソールexeコマンドのほとんどすべてをPowerShellコマンドレットに置き換える措置のためです。従来のコマンドは互換性のために残されますが、netsh.exeなど一部のコマンドではPowerShellへの移行を促すメッセージが表示されたりするようになるようです。8に新しく追加されるモジュールの一つで、schtasks.exeを置き換えるものとなります。これまでPowerShellでタスクスケジューラを扱うにはschtasks.exeを使うか、WMIのWin32_ScheduledJobを使う必要があり面倒でしたが、このモジュールに含まれるコマンドレットを用いるとそれが容易に行えるようになります。「notepad.exeを毎日朝10:00に起動する。testとすれば可能であるはずです。Preview版ではこのコードは機能しません。タスクのトリガを作成するNew-ScheduledTaskTriggerコマンドレットが正しいオブジェクトを作ってくれないのです。これは将来のバージョンできっと修正されるかと思います。トリガを定義する部分をはずせば(あんまり意味はないですが)このコードは動作するので、やり方はたぶんあってると思います。Register-ScheduledTaskコマンドレットには-asJobパラメータがあり、タスクスケジューラへの登録をジョブとしてバックグラウンドで行うことができます。ScheduledTasksモジュールはWMIを利用してタスクスケジューラを操作するので、ほかのWMI関係のコマンドレットと同様ですね。Discoveryという機能によりImport-Moduleは実行しなくてもScheduledTasksモジュールに含まれるコマンドレットを利用することができます。Discoveryとは現在読み込まれていて実行可能なコマンドレットの中にない、未知のコマンドレットを実行しようとしたとき、Modulesフォルダに存在するモジュールから同名のコマンドレットが定義されているものを探し出し、発見できたらそのモジュールを読み込んだうえでコマンドレットを実行するという優れた機能です。Discoveryによってモジュールがシェルに読み込まれればあとは快適にコマンドレットを実行できるようになります。PSScheduledJobモジュールScheduledTasksモジュールは-asJobパラメータが定義されているくらいで実はそれほどPowerShellのジョブとは関係ないのですが、ScheduledTasksモジュールが内包しているPSScheduledJobモジュールはPowerShellのジョブ機能と大いに関係があります。hoge.ps1"を指定して、みたいなまわりくどいことをする必要がありました。新しく追加されるPSScheduledJobモジュールに含まれるコマンドレット群はこの問題を解消します。PowerShellスクリプト(.ps1)あるいはスクリプトブロックをPSScheduledJobとして直接タスクスケジューラに登録できるようになり、PowerShellとタスクスケジューラのシームレスな連携を実現します。3.0に付属のモジュールなので、Win7などでも使用可能になる予定です。使用例を見ていきましょう。ScheduledJobTest1まずNew-JobTriggerコマンドレットによってトリガー(具体的には実行時刻など)を定義します。ここでは決められた時刻に1回実行するものと、毎日同じ時刻に実行するものの2つを定義してみました。これらの時刻に実行したい内容をスクリプトブロックに記述し、これらをRegister-ScheduledJobコマンドレットで登録してやります。するとこのスクリプトブロックはタスクスケジューラに登録され、指定時刻になると指定したスクリプトブロックの内容が実行されます。ライブラリ\Microsoft\Windows\PowerShell\ScheduledJobs」に登録されています。このタスクのアクションは具体的には次のようになっています。Wait-Job"これによると、指定時刻に実際にタスクスケジューラによって実行されるのはpowershell.exeであり、Start-Jobコマンドレットを使って登録したスケジュールをPowerShellのジョブとして実行していることがわかります。Start-Jobコマンドレットの-DefinitionNameパラメータなどはPSScheduledJobのために追加されたもので、これによりRegister-ScheduledJobが出力したPSScheduledJob定義をファイルから読み込んでジョブとして実行できるようになっています。PSScheduledJob定義とジョブの出力は-DefinitionPathで指定されているフォルダの下にxmlファイルとして保存されているので興味がある方は覗いてみるといいかもしれません。スケジュールしたジョブの実行結果はどうやって受け取ればいいのでしょうか。ScheduledJobTest1とすることでJobオブジェクトとして取得することができるようになります。あとは通常のジョブと同じ取り扱いができるので、$job|Receive-Jobなどで実行結果を取得できます。ちなみにPSScheduledJobはそれを定義したインスタンス以外でも参照することができます。PSScheduledJobしたあとGet-Job|Receive-JobしてPSScheduledJobの結果を参照、みたいなことができます。ここで紹介した一連の操作ではスクリプトブロックをPSScheduledJobにしましたが、Register-ScheduledJobコマンドレットの-FilePathパラメータを用いれば.ps1ファイルをPSScheduledJobとして登録することも可能です。現行バージョンのPowerShellはとにかく起動が遅いため、タスクスケジューラにスクリプトを登録しても実行が始まるまで何十秒も待たされるなどはざらでしたが、PSv3は起動がずいぶん速くなり、スペックや状況にもよるとは思いますがpowershell.exeの起動後ほんの数秒でスクリプトが走り始めます。この速度のおかげもあってPSScheduledJobはきっととても有効に機能するんじゃないかと思います。3.0で増強されるバックグラウンドジョブ関係の機能をまとめてみました。これらの新機能のおかげで、時間のかかる処理や定期実行する処理を扱うのが飛躍的にやりやすくなりそうです。3.0で追加される機能は他にもたくさんあって、このブログでもいつか全部紹介したいと思ってるのですが、今回取り上げたジョブ関係はその中でもかなり重要な機能増加を多く含んでいると言えるでしょう。8のリリースに備えてジョブ関係から予習しておくのは悪くないと思いますよ。なんか25日のアドベントカレンダーのうち3回もバックグラウンドジョブネタをやって、PSアドベントカレンダーというより私だけ一人でPSジョブアドベントカレンダーをやってる感じでちょっと申し訳ないんですが、どうか許してください。前回は今回で終了するって言ってたんですが、実はまだジョブ関係の小ネタが残ってるので最終日25日にさせてください。今日のところはこのへんで。明日はwaritohutsuさんの登場です。|Tweet昨日の記事で取り上げたJavaScriptSerializerを用いると、連想配列から楽にJSONを作成できることが分かったのですが、この記事を書いていて思ったのは、「PowerShellの連想配列って意外に使えるな」という点でした。現在のところ、PowerShellは独自のクラスを記述する方法がありません(Add-Typeコマンドレットを用いてC#などでクラスを書いて利用することはできますが)。Add-Memberコマンドレットを用いると、既存のオブジェクトに対し、任意のプロパティやPowerShellスクリプトで記述したメソッドを追加することはできます。素のオブジェクトであるPSObjectをNew-Objectして作ったオブジェクトでもこれは可能なので、一応ユーザー定義オブジェクトを作ることは可能です。Add-Memberコマンドレットを使うのはちょっとめんどくさいです。PowerShellインアクション」ではAdd-Memberを使いPowerShellの関数を駆使してクラス定義構文のようなものを実装した例はありますが、いささか大仰な感は否めません。連想配列をユーザー定義オブジェクト代わりに使うと、簡単にできますしそこそこ便利に使えます。連想配列をオブジェクトの代わりにすることのメリットとデメリット連想配列をオブジェクトの代わりにすることのメリットは以下の三点があるかと思います。簡単な記述(連想配列のリテラル)でオブジェクトが作成できるPowerShellの連想配列リテラル@{}を使うことで、簡単に記述できます。それを配列化するのも@()を使うと容易です。})ドット演算子で値の参照、設定ができるPowerShellの連想配列は「連想配列[キー名]」のほかに、「連想配列.キー名」でもアクセスできる。連想配列の配列に対してWhere-Objectコマンドレットでフィルタをかけることができるこれは2とも関係しているのですが、通常のオブジェクトと同様にWhere-Objectコマンドレットでのフィルタ、ForEach-Objectコマンドレットでの列挙が可能です。$_.name}このようにメリットはあるのですが、本物のオブジェクトではないのでそれに起因するデメリットがいくつかあります。要素(プロパティ)をいくらでも自由に追加できてしまうこれはメリットではあるのですが、デメリットでもある点です。後述するデメリットのせいで、同じキーをもつ連想配列の配列を作ったつもりでも、どれかのキー(プロパティ名)を間違えていた場合、それを検出するのが困難です。メソッドがうまく記述できない連想配列要素にスクリプトブロックを指定し、&演算子で実行することでメソッド的なことはできます。このスクリプトブロック内では$thisが使えず、オブジェクトのプロパティにアクセスすることができないのでいまいちです。$pcItem.price}ならOKだが...Get-Member、Format-List、Format-Tableなどが使えないこれらのコマンドレットはあくまで連想配列オブジェクト(Hashtable)に対して行われるので、意図した結果になりません。8000こんな表示になってしまいます。連想配列をユーザー定義オブジェクトに変換する関数ConvertTo-PSObjectこのように、連想配列の記述のお手軽さは捨てがたいものの、いくつかの問題点もあるのが現実です。そこで連想配列のお手軽さを生かしつつ、ユーザー定義オブジェクトの利便性も取るにはどうすればいいか考えました。結論は、「連想配列を変換してユーザー定義オブジェクトにする関数を書く」というものでした。それが以下になります。}}ご覧のようにコード的には割にシンプルなものが出来ました。連想配列またはその配列をパラメータにとり、またはパイプラインから渡し、連想配列要素をプロパティまたはメソッドに変換してPSObjectにAdd-Memberしてるだけです。-recurseパラメータを付けると連想配列内に連想配列がある場合に再帰的にすべてPSObjectに変換します。それでは実際の使用例を挙げます。パラメータに連想配列を渡すとPSObjectに変換する。連想配列をコードで組み立てていく例。「私の名前はmutaguchiです。」と表示$muta.speak("こんにちは。※配列要素に連想配列以外の値が含まれている場合は展開しないこのように簡単な関数一つで、連想配列にあった問題点をすべて解消しつつ簡単な記述で独自のオブジェクトを記述できるようになりました。便利だと思いますのでぜひ使ってみてください。余談ですが、今回使用したNotePropertyはプロパティに代入できる型を指定したり、リードオンリーなプロパティを作ったりすることができません。いうのを作りたい場合はScriptPropertyを使います。Add-Memberコマンドレットの-valueパラメータにゲッターを、-secondValueパラメータにセッターをそれぞれスクリプトブロックで記述します。こいつはあまりいけてないです。これらのスクリプトブロック内で参照するフィールドを別途Add-MemberでNotePropertyを使って作成する必要があるのですが、これをprivateにすることができません。よってGet-Memberでもばっちり表示されてしまいますし、フィールドを直接書き換えたりもできてしまいます。今回のように連想配列をPSObjectに変換する場合はprivateフィールド名も自動生成する必要があるのですが、それをScriptProperty内のゲッター、セッターから取得する方法がなく、たぶんInvoke-Expressionを使うしかありません。これらを踏まえて元の連想配列要素の値の型を引き継ぎ、それ以外の型を代入できないようにしたScriptPropertyバージョンも一応書いてみました。ConvertTo-PSObject関数のelse句の部分を以下に置き換えます。"]`$args[0]}"|iexまあこれはいまいちなんで参考程度に。2012/08/23追記この記事を書いた時は知らなかったのですが、実は単にNotePropertyだけを持つユーザー定義オブジェクトを作成するのであれば、もっと簡単な方法があります。3.0$o=[pscustomobject]@{Code=137;Name="23インチ液晶ディスプレイ"}3つのコードはほぼ等価です。2.0と3.0では連想配列リテラルを用いて簡単にカスタムオブジェクトを作れるようになりました。hogeとしないといけない。hogeだとSet-Contentのエイリアスが動いちゃうwなんかすげー危ないコマンドレットな気がするよ。呼び出しをブロックしてしまうためです。呼び出しを通過させるようにするには、以下のスクリプトを実行してください。呼び出しが許可されます。ファイアウォール嫌いーリモートでGet-WMIObjectするときにひつよう----------------------------------------------------------------------------------------------------[PowerShell]Get-Serviceしょぼすぎ2007年11月26日00:55Get-Serviceの戻り値が.NETのSystem.ServiceProcess.ServiceControllerなんすけど、Descriptionプロパティとかないねんな。Set-ServiceでDescriptionを設定できたりする。win32_serviceで調べるらしいwなんだこの中途半端な実装は。ServiceControllerオブジェクトに対しps1xmlファイルでDescriptionやStartModeをScriptPropertyにして実装しとけよーと思った。拡張できるんだからさ。|TweetPowerShellのRead-Hostコマンドレットには-asSecureStringパラメーターってのがあって、これを指定するとSystem.Security.SecureStringオブジェクトが作れるのです(New-Objectでも作れるけど)。これを何に使うかよくわかりません。何に使うんですか?MSDNのサンプルは難しすぎて分からないし、「PowerShellインアクション」に書いてあることに意味があるとは思えないし。なんか分かりやすい使い方ないですかーちなみにRead-Hostで入力するときに****で表示されるようになるのはいいんですけど、結果を普通のStringでも得られるようにしたほうがよっぽど使い道あると思うんですけど!SecureStringなんかPowerShellで使う場面あるのかー?あらかじめSecureStringを作っておいて、Read-Hostで読み込んだ結果と比較してOKなら認証完了!みたいな使い方できんもんでしょうか。あーExchange2007で使うのかーhttp://winzenz.blogspot.com/2006/08/creating-new-mailbox-using-powershell.htmlさらに追記。|Tweetそもそもヘルプを読んでも使い方がよくわからないのですが、インアクションを読んで何となくわかりだしました。aなどのようにエラーパイプラインを標準パイプラインに結合させて、$aにSystem.Management.Automation.ErrorRecordオブジェクトが入ります。このオブジェクトにWrite-Errorで指定した各パラメータのエラー情報の各プロパティが格納されているわけですな。同じエラーを複数回発生させたいときに使えるんじゃないでしょうか。孝http://www.amazon.co.jp/Windows-PowerShell%E5%AE%9F%E8%B7%B5%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%97%E3%83%86%E3%82%A3%E3%83%B3%E3%82%B0%E2%80%95%E3%82%AA%E3%83%96%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E6%8C%87%E5%90%91%E3%81%A8%E9%9B%86%E5%90%88%E6%8C%87%E5%90%91%E3%81%AE%E7%B5%B1%E5%90%88%E3%82%B7%E3%82%A7%E3%83%AB-%E8%B1%8A%E7%94%B0-%E5%AD%9D/dp/4798017272/ref=pd_sim_b_1/249-8968983-2214760前者は翻訳本です。家にあるんですがまだ読み切れてない・・・スクリプト文法・仕様にマニアックに取り組んだ本です。日本語版買っとこうと思います。後者はどんな本でしょうね。これも買ってみないと。言語としてオブジェクト指向とからめた解説が読めるんでしょうか。年末に向けて数冊出るとか出ないとかの噂ですよ。|TweetBookmarkletとは、ブラウザのURL欄に入力して表示中のページに何らかのアクションを起こすスクリプトのことで、「お気に入り」や「ブックマーク」に指定することで再利用可能になります。ありがちだと思いますが、HTMLソースを表示するBookmarkletを書いてみました。\>/g,">").replace(/\n/g,""));実はこれを書いたのにはわけがあって、W-ZERO3[es]上で動作するPocketIEにソースを見る機能がないため作成したのですが...。肝心のPocketIE上ではうまく動作しません(泣outerHTMLなどが取れないみたいですね。innerHTMLも駄目。writeとかalertとか使えるのに惜しいです。URLEncodeもなんか変で、\が%5Cにならず/になっちゃいます。最初これがエラーの原因かと思いましたが違いました。@mutaguchiBooks書籍版。