PowerShell　コマンドレット - ささやかな日々記

PowerShellを扱う上でコマンドレットとはという説明をしたいと思います。

簡単に言うとPowerShellであらかじめ用意されている命令（コマンド）を指します。

次のコマンドレットを打つことで利用可能なコマンドレット一覧を表示できます。

PS C:\> Get-Command

CommandType Name Version Source
----------- ---- ------- ------

Cmdlet Add-AppxPackage 2.0.0.0 Appx
Cmdlet Add-AppxProvisionedPackage 3.0 Dism
Cmdlet Add-AppxVolume 2.0.0.0 Appx
Cmdlet Add-BitsFile 2.0.0.0 BitsTransfer
Cmdlet Add-CertificateEnrollmentPolicyServer 1.0.0.0 PKI

…

次にコマンドレットの使い方を調べる場合にはGet-Helpを実行するのですが、まずGet-Help自体の使い方を確認するために以下のコマンドレットを実行します。

PS C:\> Get-Help

トピック
Windows PowerShell のヘルプシステム

概要
Windows PowerShell のコマンドレットと概念に関するヘルプを表示します。

詳細説明
Windows PowerShell ヘルプでは、Windows PowerShell コマンドレット、
関数、スクリプト、およびモジュールと、Windows PowerShell 言語の
要素などの概念について説明します。

Windows PowerShell にヘルプファイルが含まれていなくても、オンラインでヘルプトピックを
参照できます。また、Update-Help コマンドレットを使用してヘルプファイルを
コンピューターにダウンロードし、Get-Help コマンドレットを使用してコマンドラインで
ヘルプトピックを表示できます。

Update-Help コマンドレットを使用すると、更新されたヘルプファイルをリリース時に
ダウンロードして、ローカルのヘルプコンテンツが古くならないようにすることもできます。

ヘルプファイルがない場合は、Get-Help を実行すると、コマンドレット、関数、
およびスクリプトについて、自動生成されたヘルプが表示されます。

オンラインヘルプ
Windows PowerShell のオンラインヘルプは、TechNet ライブラリにあります。
まずは、http://go.microsoft.com/fwlink/?LinkID=108518 を参照してください。

任意のコマンドレッドまたは関数のオンラインヘルプを表示するには、次のように入力します。

Get-Help <コマンドレット名> -Online

UPDATE-HELP
コンピューターにヘルプファイルをダウンロードしてインストールするには、次の手順を実行します。

1.[管理者として実行] オプションを使用して Windows PowerShell を起動します。
2.次のように入力します。

Update-Help

ヘルプファイルがインストールされたら、Get-Help コマンドレットを使用して、
ヘルプトピックを表示できます。また、Update-Help コマンドレットを使用すると、
ローカルのヘルプファイルが常に最新の状態で保たれるように、更新された
ヘルプファイルをダウンロードできます。

Update-Help コマンドレットの詳細を確認するには、次のように入力します。

Get-Help Update-Help -Online

または、http://go.microsoft.com/fwlink/?LinkID=210614 を参照してください。

GET-HELP
Get-Help コマンドレットを実行すると、コンピューターに保存されているヘルプファイルのコンテンツから、
コマンドラインにヘルプが表示されます。ヘルプファイルがない場合に Get-Help を実行すると、
コマンドレットと関数について基本的なヘルプが表示されます。また、Get-Help を使用して、
コマンドレットと関数についてオンラインヘルプを表示することもできます。

コマンドレットのヘルプを表示するには、次のように入力します。

Get-Help <コマンドレット名>

オンラインヘルプを表示するには、次のように入力します。

Get-Help <コマンドレット名> -Online

概念説明のトピックのタイトルは "About_" で始まります。
概念または言語要素のヘルプを表示するには、次のように入力します。

Get-Help About_<トピック名>

すべてのヘルプファイルで単語や語句を検索するには、次のように入力します。

Get-Help <検索用語>

Get-Help コマンドレットの詳細を確認するには、次のように入力します。

Get-Help Get-Help -Online

または、http://go.microsoft.com/fwlink/?LinkID=113316 を参照してください。

・・・

その内の

コマンドレットのヘルプを表示するには、次のように入力します。

Get-Help <コマンドレット名>

この記述のようにすることでコマンドレットの使い方を表示できます。

PS C:\> Get-Help New-Item

名前
New-Item

構文
New-Item [-Path] <string> [<CommonParameters>]

New-Item [[-Path] <string>] [<CommonParameters>]

エイリアス
ni

注釈
Get-Help を実行しましたが、このコンピューターにこのコマンドレットのヘルプファイルは見つかりませんでした。ヘルプの
一部だけが表示されています。
-- このコマンドレットを含むモジュールのヘルプファイルをダウンロードしてインストールするには、Update-Help を使
用してください。
-- このコマンドレットのヘルプトピックをオンラインで確認するには、「Get-Help New-Item -Online」と入力するか、
https://go.microsoft.com/fwlink/?LinkID=113353 を参照してください。