特集
» 2007年08月30日 00時00分 公開

Windows PowerShellコマンド&スクリプティング入門:PowerShellの基本(前編) (3/5)

[山田祥寛,著]

 PowerShellを利用するに当たって、何はおいても、まず「コマンドレット(Cmdlet)」の理解は欠かせない。コマンドレットとは、要は、PowerShellで利用可能なコマンドのことである。標準で129種類にも及ぶコマンドレットが提供されており、これらコマンドレットを組み合わせることで、従来、コマンド・プロンプトやWSHでは実現できなかった(もしくは困難であった)処理を限りなく短いコードで実現することができる。

 まずPowerShellで利用可能なコマンドレットをざっと確認してみることにしよう。利用可能なコマンドレットの一覧を取得するのはGet-Commandコマンドレットの役割だ。Get-Commandコマンドレットを利用することで、名前(Name)、構文(Definition)などを確認することができる*

* デフォルトで、Get-Commandコマンドは表形式でコマンドレットを表示するため、構文の後半は省略されてしまう。完全な構文を表示したい場合には、「Get-Command | Format-List」のように記述することで、リスト形式で情報を出力することができる。


※利用可能なコマンドレットの一覧を取得する(Get-Commandコマンド)

PS > Get-Command …コマンドレット一覧の表示

CommandType Name          Definition
----------- ----          ----------
Cmdlet      Add-Content   Add-Content [-Path] <String[]> [-Value] <Object[...
Cmdlet      Add-History   Add-History [[-InputObject] <PSObject[]>] [-Pass...
Cmdlet      Add-Member    Add-Member [-MemberType] <PSMemberTypes> [-Name]...
Cmdlet      Add-PSSnapin  Add-PSSnapin [-Name] <String[]> [-PassThru] [-Ve...
Cmdlet      Clear-Content Clear-Content [-Path] <String[]> [-Filter <Strin...
Cmdlet      Clear-Item    Clear-Item [-Path] <String[]> [-Force] [-Filter ...
……(以下省略)……

 もっとも、本稿でこれら膨大なコマンドレットの機能を網羅していくことは現実的でないし、そもそも本稿の趣旨ではない。ここでは、コマンドレットの基本的な命名ルールとコマンドレットの機能を理解するのに欠かせないヘルプ機能についてのみ押さえておくことにしたい。

■命名ルールは「動詞-名詞」
  100種類以上ものコマンドレットが用意されていると聞くと、それだけで腰が引けてしまう方もいるかもしれないが、コマンドレットは名前から直感的に機能が想像できる分かりやすさが特徴の1つでもある。コマンドレットの名前は、「動詞-名詞」という一貫した命名規則に従っている。例えば、先ほど登場した「Get-ChildItem」であれば、「カレント・フォルダの配下に含まれる子フォルダ/ファイル(ChildItem)の一覧を取得する」という意味であるし(*)、「Rename-Item」であれば、「フォルダ/ファイル、レジストリなど項目(Item)の名前を変更する(Rename)」という意味になる。

* 厳密には、Get-ChildItemは、フォルダ/ファイル情報の取得に特化したコマンドレットではないので要注意。詳細についてはあらためて後述する。


 すべてのコマンドレットがこの命名規則に従っていることから、知らないコマンドレットに遭遇した場合にもその意味を類推することは比較的容易であるし、新たな機能を探す場合にもアタリをつけやすい。ちなみに、標準的なコマンドレットで多く利用されている動詞/名詞には、以下のようなものがある。

名前 概要
動詞
Add 追加する
Clear すべて削除する
ConvertXxxxx 変換する
Copy 複製する
Export エクスポートする
Format 整形する
Get 取得する
Import インポートする
Move 移動する
New 新規に作成する
Remove 削除する
Set 設定する
Start 開始する
Stop 停止する
Write 書き込み/表示する
名詞
Alias エイリアス
Content 文字列
History コマンド履歴
Item(ChildItem) 項目(フォルダ/ファイル、レジストリ項目など)
Location 作業場所(カレントフォルダなど)
Object オブジェクト
Path パス
Process プロセス
Service サービス
コマンドレットを構成する主な動詞/名詞

■詳細情報の確認にはGet-Helpコマンドレットを使う
  コマンドレットの類推ができるようになれば、その後のコマンドレット個々の用法を調べるのは簡単だ。先ほどのGet-Commandコマンドレットではコマンドレットの概要情報を出力するのみであったが、より詳細な構文や用例を確認するには、Get-Helpコマンドレットを利用すればよい(「Get-ChildItem -?」のように、コマンドレットの末尾に「-?」オプションを付けてもよい)。例えば、先ほどから何回か登場しているGet-ChildItemコマンドレットに関する詳細情報を確認したければ、次のリストのように記述すればよい。

※Get-ChildItemコマンドレットの詳細情報を確認する

PS > Get-Help Get-ChildItem

名前
    Get-ChildItem

概要
    1 つ以上の指定された場所から項目および子項目を取得します。

構文
    Get-ChildItem [[-path] <string[]>] [[-filter] <string>] [-include <string[]>] [-exclude <string[]>] [-name] [-recurse] [-force] [<CommonParameters>]

    Get-ChildItem [-literalPath] <string[]> [[-filter] <string>] [-include <string[]>] [-exclude <string[]>] [-name] [-
    recurse] [-force] [<CommonParameters>]
……(以下省略)……

 Get-Helpコマンドレットは、デフォルトで指定されたコマンド名、構文、詳細説明、関連するリンクなど、コマンドレットに関する基本的な情報だけを表示するが、-detailedオプションを付与することでパラメータの説明、例文を、-fullオプションを付与することで更に入力の種類や戻り値の型、メモなど、ヘルプとして用意されたすべての情報を、それぞれ出力することも可能だ。PowerShellのヘルプで用意されている例文は、量も豊富で、解説もかみ砕かれているので、初めてコマンドレットを利用する場合には、必ず一度は目を通すことをお勧めしたい。

 冒頭述べたように、PowerShellで用意されているコマンドレットは実に多彩であるが、まずは命名ルールとヘルプを活用するだけでも、十分自由に利用できるはずだ。最初はヘルプの例文をそのまま実行してみるもよし、気になるコマンドレットを実際にどんどん動かしてみることをお勧めしたい。

既存ユーザーにも優しい「エイリアス」

 PowerShellのコマンドレットは「動詞-名詞」の一貫性のある命名規則に沿っていることから、直感的に機能を理解しやすく、覚えやすいものとなっているのが特徴だ。もっとも難点がないわけでもない。というのも、次のような問題があるからだ。

  • 名前が冗長であるため、(タブ補完機能*を利用するにせよ)タイピングが面倒である
  • 従来のコマンド・プロンプトに慣れてきたユーザーにとっては、新たにコマンドを覚えなおさなくてはならない

* PowerShellには入力途中のコマンド名を補完する「タブ補完機能」が用意されている。タブ補完機能を利用するには、コマンドの入力中に[Tab]キーを押下すればよい。すると、入力された文字列が合致するコマンドが、[Tab]キーを押すたびに順次表示されるので、正しい候補が表示された時点で[Enter]キーや空白キーなどを押すと、確定させることができる。例えば「g」「e」「t」「-」と4文字入力してから[Tab]キーを押すと、そのたびに「Get-Acl」「Get-Alias」「Get-AuthenticodeSignature」……などと表示されるので、適切なものが表示された時点で、[Enter]キーや空白キーなどを押せばよい。


 しかし心配することはない。PowerShellでは、主要なコマンドレットに対してエイリアス(別名)を提供しているのだ。例えば、カレント・フォルダ配下の情報を取得するためのGet-ChildItemコマンドレット――これはエイリアスを利用することで、以下のように書き換えることも可能だ。

PS > dir
PS > ls

 いうまでもなく、dir/lsコマンドは、それぞれコマンド・プロンプト、UNIXシェルで利用可能なコマンド名である。このほかにも、カレント・フォルダを変更するcdエイリアス、配下のフォルダ/ファイルを削除するrmdirエイリアス、フォルダ/ファイルを移動するmoveエイリアスなどなど、エイリアスは標準でも100種類ほど用意されている。

 現在利用可能なエイリアスを確認するには、Get-Aliasコマンドレットを利用すればよい。

※Get-Aliasコマンドレットでエイリアスの一覧を取得する

PS > Get-Alias

CommandType  Name   Definition
-----------  ----   ----------
Alias        ac     Add-Content
Alias        asnp   Add-PSSnapin
Alias        clc    Clear-Content
Alias        cli    Clear-Item
Alias        clp    Clear-ItemProperty
Alias        clv    Clear-Variable
Alias        cpi    Copy-Item
……(以下省略)……

 これらエイリアスを利用することで、従来のユーザーもほとんど違和感なく、コマンドレットにアクセスすることができるというわけだ。

 ちなみに、エイリアスは必要に応じて自分で登録することも可能だ。例えば、Remove-Itemコマンドレット(指定された項目を削除)のエイリアスとして「remove」を設定するならば、以下のように記述すればよい*

PS > Set-Alias remove Remove-Item

* 現在のセッション上で行ったエイリアスの定義は、その場限りのものであり、PowerShellを起動する都度に行う必要がある。このような毎回利用するエイリアスの定義は、プロファイル上で行うのが好ましい。プロファイルについては次回解説予定。


Copyright© Digital Advantage Corp. All Rights Reserved.

RSSについて

アイティメディアIDについて

メールマガジン登録

@ITのメールマガジンは、 もちろん、すべて無料です。ぜひメールマガジンをご購読ください。