![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
「マイクロソフト系技術情報 Wiki」は、「Open棟梁Project」,「OSSコンソーシアム .NET開発基盤部会」によって運営されています。
PowerShell の勘所、
などのトピック情報を纏めています。
以前から、オブジェクトベースのプログラム、スクリプト（perl、WSH）などは存在したが、
PowerShellが唯一のオブジェクト・ベースのシェル（perlに似ている）である。
＃OSレイヤから少々遠いためシェルというよりシェルスクリプトという意見もある。
別物として使用する必要がある。
PowerShell の各バージョンは、以下のOSに添付されているか、別途ダウンロードできます。
新しいOSほど、新しいPowerShellに対応します。
また、旧OSでは、新しいPowerShellのサポートがありません。
PowerShellのバージョンに依存しそうな場合は、対象とするOSが何か確認ください。
| --Windows PC-- | PowerShell 1.0 | PowerShell 2.0 | PowerShell 3.0 | PowerShell 4.0 |
| Windows XP SP2 | PS1 | n/a | n/a | |
| Windows XP SP3 | PS1 | PS2 | n/a | n/a |
| Windows Vista SP1 | PS1 | PS2 | n/a | n/a |
| Windows Vista SP2 | PS1 | PS2 | n/a | n/a |
| Windows 7 | OS添付 | n/a | n/a | |
| Windows 7 SP1 | OS添付 | PS3 | PS4 | |
| Windows 8 | OS添付(*1) | OS添付 | PS4 | |
| Windows 8.1 | OS添付(*1) | OS添付 |
(*1) Windows 8/8.1 の PowerShell 2.0 スクリプトは、PowerShell 4.0 の下位互換で実行できます。
PowerShell を -version 2.0 指定で実行する場合は .NET Framework 3.5 をインストールすると有効になります。
| --Windows Server-- | PowerShell 1.0 | PowerShell 2.0 | PowerShell 3.0 | PowerShell 4.0 |
| Windows Server 2003R2 | PS1 | n/a | n/a | |
| Windows Server 2003 SP2 | PS1 | PS2 | n/a | n/a |
| Windows Server 2008 SP1 | OS添付 | PS2 | PS3 | n/a |
| Windows Server 2008 SP2 | OS添付 | PS2 | PS3 | n/a |
| Windows Server 2008R2 SP1 | OS添付 | PS3 | PS4 | |
| Windows Server 2012 | OS添付(*1) | OS添付 | PS4 | |
| Windows Server 2012 R2 | OS添付(*1) | OS添付 |
(*1) Windows Server 2012/2012R2 の PowerShell 2.0 スクリプトは、PowerShell 4.0 の下位互換で実行できます。
PowerShell を -version 2.0 指定で実行する場合は .NET Framework 3.5 をインストールすると有効になります。
http://www.microsoft.com/en-us/download/details.aspx?id=34595 (現在、英語版)
http://www.microsoft.com/en-us/download/details.aspx?id=39347 (現在、英語版)
PowerShell を手で（シェルとして）逐次実行できます。
変数は $ で始まる 英数字記号 の名前を使用します。
後述の様に スコープ($global:, $script:) をつけることも出来ます。
下の様に ${ } で囲むと、名前にスペースを含むこともできますが、混乱やスペルミスの元になりやすいので避けましょう。
PS E:\temp> ${var test 1} = 123
PS E:\temp> $a = ${var test 1} + "123"
PS E:\temp> $a
246
PS E:\temp>
未初期化の初期状態は $null と同じです。
文脈によっては 0 や "" (空文字列) と解釈されます。
PS E:\temp> $var001 PS E:\temp> $var001 -eq 0 False PS E:\temp> $var001 -eq $null True PS E:\temp> $a1 = $var001 + 2 PS E:\temp> $a1 2 PS E:\temp> $a1 = $var001 + "abc" PS E:\temp> $a1 abc PS E:\temp>
上の例では、変数 $var001 は未初期化なので、 $null と同じです。
変数をそのまま出力すると、$null は 何も表示されません。
また、 -eq 比較演算子を使って、 0 や $null と比較すると、$null であることが判断できます。
未初期化変数は、数値を足し算した場合は、0 が、文字列を連結した場合は、"" が、それぞれ仮定されます。
Set-StrictMode? を使用すると、未初期化変数を参照する際にエラーとして検出できます。
PS E:\temp> Set-StrictMode -Version 1.0
PS E:\temp> $a1 = $var001 + 2
変数 '$var001' は、設定されていないために取得できません。
発生場所 行:1 文字:14
+ $a1 = $var001 <<<< + 2
+ CategoryInfo : InvalidOperation: (var001:Token) []、RuntimeExcep
tion
+ FullyQualifiedErrorId : VariableIsUndefined
PS E:\temp>
PowerShellの変数は、変数を使用する場所がスコープの範囲になります。
などがスコープの境界になります。
if文は、下の様に -で始まる比較演算子を使います。
$var1 = sub2 $arg1 $arg2
if ( ( $var1 -eq 1 ) -or ( $var1 -gt 10 ) ) {
...
}
条件のANDやORは、 それぞれを ( ... )で囲んで -and や -or で結びます。
論理のANDやORによるビット演算は、 -band や -bor の -b で始まる演算子を使います。
$file = get-item $dirname
if ( $file.Attributes -band [System.IO.FileAttributes]::Directory ) {
...
}
bit演算結果が0以外の場合は、真 とみなされます。
if文の演算子の詳細は、powershellコマンドプロンプトの中で 「get-help about_Comparison_Operators」を参照してください。
配列は、以下の形式で定義できます。
$array1 = @() $array2 = @(1,2,3) $array3 = 1,2,3
( ) で囲まなくても、「,」で並べると、配列になります。
コマンドや関数への引数を「,」で区切った場合も配列になるので、書き間違いに注意。
$ret1 = sub1 2,3,4 # これは @(2,3,4) の配列で引数１つ $ret2 = sub1 2 3 4 # これは 引数３つ $ret3 = sub1 2,3 4 # これは @(2,3)の配列１つと 数値4 の 引数２つ
また、配列の添え字は、$変数名[添え字] で参照します。
添え字に 負数 を指定すると、配列の末尾からの添え字を指定できます。
$var1 = $array2[1] # 上の $array2 から 2 を取り出す $var2 = $array2[-1] # 上の $array2 から 3 を取り出す
配列について詳しくは、 PowerShellコマンドプロンプトで「get-help about_array」 を参照ください。
PowerShellの一番強力な機能が、パイプラインです。
Unix/Linuxのshellコマンドや、Windowsのコマンドプロンプトでも、「|」を使って、コマンドを複数並べてパイプラインが記述できます。
ですが、それらは、標準出力のテキストを次のコマンドの標準入力へ渡す、にすぎません。
PowerShellでは、PowerShellのオブジェクトをパイプで渡すことができます。
そして、ほとんどのPowerShellコマンドがオブジェクトを出力します。
また、オブジェクトには、多くのプロパティを含んでいます。
後処理のために、オブジェクトにプロパティを追加することもできます。
このため、プロパティを判定してフィルタしたり、プロパティを使ってソートできます。
最後に Format-List や Format-Table などのコマンドを使って、一部のプロパティを整形して表示します。
.ps1スクリプト内で定義する関数(function)や、自作のCmdletでも、オブジェクトを返すようにしておくと、再利用しやすくなります。
パイプラインの例は、後述の オブジェクトへメンバー追加 の例を参照ください。
パイプラインの詳細は、PowerShellコマンドプロンプトで「get-help about_pipeline」を参照ください。
PowerShellでは、Add-Member を使って、オブジェクトに動的にメンバーを追加できます。
OSや他のライブラリが返したオブジェクトに、情報を追加しながら、パイプラインを使って、順次処理する。といったことができます。
function dirinfo {
param(
[Parameter(Mandatory = $true, ValueFromPipeline = $true)]
[object]$dir,
[boolean]$totalup = $false
)
# 空っぽの配列
$dirs = @()
# $dir へ プロパティ追加
$dir | Add-Member -MemberType NoteProperty -Name TotalFiles -Value 0
$dir | Add-Member -MemberType NoteProperty -Name TotalSize -Value 0
foreach ($f in (get-childitem $dir.FullName)) {
if ( $f.Attributes -band [System.IO.FileAttributes]::Directory ) {
# サブフォルダの情報
$ret = dirinfo $f $totalup
if ( $totalup ) {
# 末尾の情報を $dir へ加算
$dir.TotalFiles += $ret[-1].TotalFiles
$dir.TotalSize += $ret[-1].TotalSize
}
$dirs += $ret # サブフォルダ全体を覚える
} else {
$dir.TotalFiles += 1
$dir.TotalSize += $f.Length
$dirs += $f
}
}
$dirs += $dir # $dir自身を末尾に覚える
# 覚えたものをまとめて返す
write-output $dirs
}
dirinfo (get-item "c:\program files") | sort-object totalsize -Descending |
where { $_.TotalSize -gt 1 } | select-object -first 5 |
format-list -Property TotalFiles, TotalSize, Fullname
(行は折り返して表示しています。実行する際は、１行に入力してください。)
実行例のパイプラインでは、以下のことをしています
Add-Member の解説については、下も参照ください。
サブフォルダのファイルサイズを集計する例については、下も参照ください。
.ps1ファイルの中でエラーが発生すると、既定では、赤文字でエラー表示されて、そのまま次の行が実行されます。
エラーを処理するには、下のいずれか必要です。
Trap {
エラー処理
}
コマンド .... -ErrorAction "stop"
$ErrorActionPreference = "stop"
try {
コマンド ....
} catch [Exception] {
エラー処理
}
try/catch の例は、上の ps_test.ps1 を参照ください。
その他の例、説明は、以下のサイトも参照ください。
PowerShell は、 PSSnapin と Module で拡張されます。
Windows の役割を追加すると、役割を管理する Cmdlet が一緒にインストールされます。
また、何らかの製品をインストールした際に、PowerShell Cmdlet が追加でインストールされることもあります。
PowerShellコマンドプロンプトを開いた状態では、それらの追加された Cmdlet はまだ使用できません。
PowerShellコマンドプロンプトの中で、「Add-PSSnapin」あるいは「Import-Module」を使って、読み込みます。
読み込みの際に指定する PSSnapin名、 Module名 は、役割、製品の管理者用ドキュメントを参照してください。
インストールされている module は、 「get-module -listavailable」で確認することができます。
debugは、 debug用print文、 デバッグ用環境、を使ってデバッグできます。
debug用print文は、 スクリプトの中に write-host コマンドを埋め込む方法です。
write-host を使用すると、 引数に指定した値が PowerShellコマンドプロンプトへ出力されます。
(write-output は、 関数の出力になるので、debug用には使わないでください。)
デバッグ用環境 は、 PowerShell ISE (Integrated Scripting Environment) 環境が使用できます。
PowerShell ISE を使用すると、ブレークポイントの設定、ステップ実行が、メニュー操作で行えます。
通常の PowerShellコマンドプロンプトのままでも、
Set-PsBreakpoint? 等の debug用のコマンドを使用して、１行ずつステップ実行することも出来ます。
PS E:\temp> Set-PsBreakpoint -command .\ps_scope1.ps1
ID Script Line Command Variable Action
-- ------ ---- ------- -------- ------
0 .\ps_scope1.ps1
PS E:\temp> .\ps_scope1.ps1
デバッグ モードを開始します。ヘルプを表示するには、h または ?
を使用してください。
ヒット '.\ps_scope1.ps1' のコマンドのブレークポイント
.\ps_scope1.ps1
[DBG]: PS E:\temp>>> s
ps_scope1.ps1:2 $global:g1 = "0"
[DBG]: PS E:\temp>>> s
ps_scope1.ps1:3 $script:s1 = "0"
[DBG]: PS E:\temp>>> s
ps_scope1.ps1:4 $v1 = "0"
[DBG]: PS E:\temp>>> s
ps_scope1.ps1:6 write-host "before : g1=$global:g1 s1=$script:s1 v1=$v1
v2=$v2"
[DBG]: PS E:\temp>>> s
before : g1=0 s1=0 v1=0 v2=
ps_scope1.ps1:8 function test1 {
[DBG]: PS E:\temp>>> s
ps_scope1.ps1:17 test1
[DBG]: PS E:\temp>>> s
ps_scope1.ps1:9 write-host "start test1 : g1=$global:g1 s1=$script:s1
v1=$v1 v2=$v2"
[DBG]: PS E:\temp>>>コマンドを探すには、下の様に、コマンド名の一部を*で省略して Get-Command を実行します。
Get-Command *event
オブジェクトのメンバーやプロパティを確認するには、下の様にコマンドの出力を パイプ で Get-Member に渡します
Get-ChildItem | Get-Member
コマンドの説明や引数の構文を確認するには、get-help を使います。
get-help get-childitem
Windows Server 2012 では、 ヘルプの文章が online から取得する様になっていることがあります。
必要に応じて 「get-help コマンド -online」のようにするか、
表示されたURLをブラウザで表示して構文を確認ください。
WinSvr2012以降は管理コンソールの裏はPowerShellコマンドレットになる。
皆、テキストベース→オブジェクトベースのShellの違いに混乱する。
Like This
↓パイプ ↓ラムダ式的な
get-service | where-object {$_.Status -eq "Running"}
パイプしなくてもキャスト（暗黙）でつなげられる。非同期ジョブ、リモート、ワークフローなど。
＃この資料では、PowerShell 3.0 の beta/RC 版をベースにしてるため、 PowerShell 2.0 にはないコマンドも紹介されています。
＃ただ、WMIオブジェクトの使い方、リモートや権限などのtipsは、PowerShell 2.0 でも参考になります。
Updated: June 24, 2013
Applies To: Windows PowerShell 2.0, Windows PowerShell 3.0, Windows PowerShell 4.0
Tags: :シェル, :インフラストラクチャ, :Windows
