ヘルプについて
適用先: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007
トピックの最終更新日: 2006-11-15
Microsoft Exchange Server 2007 の Exchange 管理シェルには、機能を最大限に利用する助けとなるように、多数のヘルプ リソースが用意されています。 ここでは、以下のヘルプ リソースとその機能について説明します。
- Exchange 2007 ヘルプ ファイル Exchange 2007 ヘルプ ファイルには、役割ベースおよびタスク ベースの階層の形で、すべてのコマンドレットのヘルプ トピックが収録されています。コマンドレットのヘルプ トピックは、特定のタスクを実行する方法を示す手順のトピックにもリンクされています。
- ヘルプのコマンドレット Exchange 管理シェルには、適切な情報を見つけてタスクを達成できるように、ヘルプのコマンドレットがいくつか用意されています。
- ヘルプ ビュー Exchange 管理シェルのヘルプには、使用できるコマンドレットについての広範囲にわたる情報が含まれています。 ヘルプ ビューでは、コマンドレットについて必要な情報にアクセスすることができます。
- コマンドレットの役割、コンポーネント、および機能 コマンドレットは、それらがによって管理される役割、コンポーネント、または機能ごとに一覧表示できます。 これにより、管理しようとしている役割、コンポーネント、または機能にとって適切なコマンドレットを見つけられます。
- Tab キーによる補完機能 コマンドレット名とパラメータ名についての Tab キーによる補完機能を使用すると、コマンド ラインで行う必要がある入力量を減らすことができます。
Exchange 2007 ヘルプ ファイル
Exchange 2007 ヘルプ ファイルには、Exchange 管理シェルで各コマンドレットを使用する際に利用できる内容と同じコマンドレットのヘルプ情報が含まれています。ただし、Exchange 2007 ヘルプ ファイルでは、すべてのコマンドレットについてのヘルプがサーバーの役割と管理タスクに従って整理されており、実行しようとしているタスクに関連する特定のコマンドレットを簡単に見つけられます。また、Exchange 2007 ヘルプ ファイルのコマンドレットのトピックは、管理対象の機能を紹介するトピック、その機能を管理するコマンドレットの使用方法を示すトピック、および機能や一般的なシナリオに関する具体的な詳細情報を提供するトピックにリンクされています。
Exchange 2007 ヘルプ ファイルで利用できるコマンドレットのヘルプ トピックの詳細については、「Exchange 管理シェル (SP1 および SP2)」を参照してください。
Exchange 管理シェルのコマンドレットを使用して特定のタスクを実行する方法の詳細については、「操作」を参照してください。
ヘルプのコマンドレット
次の表では、Get-Help、Get-Command、および Get-ExCommand の各コマンドレットを使用して、Exchange 管理シェルで各コマンドレットについて提供されているヘルプの情報にアクセスする方法の例を示します。
表 1 に、Get-Help コマンドレットを使用する方法の例を示します。
表 1 Get-Help コマンドを使用する方法の例
| コマンド | 説明 |
|---|---|
|
Get-Help コマンドレットを単独で使用すると、Exchange 管理シェルのヘルプ システムを使用する方法について、基本的な手順が示されます。 |
|
Get-Help コマンドレットに、引数としてシェル コマンドレットを指定すると、指定したコマンドレットについてのヘルプ情報が表示されます。 たとえば、Get-SystemMessage コマンドレットについてのヘルプ情報を取得するには、次のコマンドを使用します。
|
|
Get-Help コマンドレットに、引数としてシェル コマンドレットとワイルドカード文字を指定すると、入力したテキストに一致するすべてのコマンドレットの一覧が返されます。 いくつかの方法を使用して、シェル コマンドレットの一覧を取得できます。 それには、以下の方法があります。
このようにワイルドカード文字を使用すると、特定の機能について使用可能なすべてのコマンドレットの一覧を簡単に表示できます。 たとえば、Get-Help *-TransportAgent というコマンドを使用すれば、トランスポート エージェントに対して使用できるすべてのコマンドレット動詞の一覧を表示できます。 |
|
Get-Help About_* コマンドでは、Exchange 管理シェルの理解と使用に役立つ一般的な Exchange 管理シェルのヘルプ トピックをすべて含む一覧が表示されます。 表示された一覧に含まれるトピックの詳細を見るには、Get-Help About_<機能名> コマンドを実行します。 たとえば、 |
|
後の「ヘルプ ビュー」を参照してください。 |
|
後の「ヘルプ ビュー」を参照してください。 |
|
後の「ヘルプ ビュー」を参照してください。 |
|
後の「ヘルプ ビュー」を参照してください。 |
|
後の「Role、Component、および Functionality パラメータ」を参照してください。 |
|
後の「Role、Component、および Functionality パラメータ」を参照してください。 |
|
後の「Role、Component、および Functionality パラメータ」を参照してください。 |
表 2 に、Get-Command コマンドレットを使用する方法の例を示します。
表 2 Get-Command コマンドを使用する方法の例
| コマンドレット | 説明 |
|---|---|
|
Get-Command コマンドレットでは、シェルで使用可能なすべてのコマンドレットの一覧が表示されます。 Get-Help コマンドレットと同様に、Get-Command コマンドレットでもワイルドカード文字によって指定の対象を拡大できます。 このコマンドレットを Format-List コマンドレットおよび Format-Table コマンドレットと共に使用すると、より読みやすい形式で表示することができます。 たとえば、コマンドレットのヘルプを一覧形式で表示するには、 |
|
Get-Command <Cmdlet> コマンドでは、指定したコマンドレットのパラメータおよびその他のコンポーネントについて、詳細な情報が表示されます。このコマンドを Format-List コマンドレットおよび Format-Table コマンドレットと共に使用すると、より読みやすい形式で表示することができます。 たとえば、コマンドレットのヘルプを一覧形式で表示するには、 |
|
Get-Command -Noun <CmdletNoun> コマンドでは、指定した名詞付きで存在するすべてのコマンドレットが一覧表示されます。 このコマンドは、特定の機能に関連するすべてのコマンドレットの一覧を表示する場合に役立ちます。 たとえば、Get-Help -Noun SystemMessage コマンドでは、 |
|
Get-Command -Verb <CmdletVerb> コマンドでは、指定した動詞付きで存在するすべてのコマンドレットが一覧表示されます。 このコマンドは、特定の操作に関連するすべてのコマンドレットの一覧を表示する場合に役立ちます。 たとえば、Get-Help -Verb Enable コマンドでは、有効にする操作を実行するために使用できるすべてのコマンドレットが返されます。このコマンドを Format-List コマンドレットおよび Format-Table コマンドレットと共に使用すると、より読みやすい形式で表示することができます。 たとえば、コマンドのヘルプを一覧形式で表示するには、 |
|
Get-ExCommand コマンドレットは Get-Command コマンドレットと同様に動作しますが、Exchange 2007 の管理に使用できるコマンドレットだけを返します。 |
|
Get-PSCommand コマンドレットは、Get-Command コマンドレットと同様に動作しますが、Exchange 2007 の管理に使用されるコマンドレットは除かれます。 |
表 3 に、その他のヘルプ用コマンドを使用する方法の例を示します。
表 3 その他のヘルプ コマンドを使用する方法の例
| コマンドレット | 説明 |
|---|---|
|
QuickRef コマンドを実行すると、最もよく使用される Exchange 管理シェル コマンドレットを一覧で示した、印刷できる HTML の表が開かれます。 この表の最新バージョンを確認するには、Exchange 管理シェルのクイック リファレンスのページを参照してください (このサイトは英語の場合があります)。 |
|
<Cmdlet> -? コマンドを任意のコマンドレットと共に使用すると、Get-Help コマンドレットを使用する場合に提供されるものと同じヘルプ情報が見つかります。 たとえば、「 |
|
Get-Tip コマンドレットでは、新しい Exchange 管理シェルのヒントが生成されます。 |
|
Get-ExBlog コマンドレットを実行すると、Microsoft Internet Explorer が開かれて Exchange チームのブログが表示されます。 |
ヘルプ ビュー
Get-Help コマンドレットのパラメータとしてコマンドレットを指定すると、指定したコマンドレットのヘルプ情報が表示されます。 場合によっては返される情報が多量になることがあるため、特定の情報だけを表示する必要が生じる場合があります。 ヘルプ ビューでは、コマンドレットについて特定の情報を表示できるので、必要でない可能性がある情報をえり分ける必要がありません。
Exchange 管理シェルには、必要な情報を正確に表示するビューが 4 種類用意されています。 特定のパラメータや、類似した一連のパラメータを取得することもできます。表 4 に、それぞれのビューに表示されるセクションを示します。
表 4 Exchange 管理シェルのヘルプ ビュー
| ヘルプ ビュー | 既定値 | 詳細 | 完全 | 例 |
|---|---|---|---|---|
概要 |
X |
X |
X |
X |
構文 |
X |
X |
X |
|
解説 |
X |
X |
X |
|
パラメータ (メタデータなし) |
|
X |
|
|
パラメータ (メタデータあり) |
|
|
X |
|
入力の種類 |
|
|
X |
|
戻り値の種類 |
|
|
X |
|
エラー |
|
|
X |
|
メモ |
|
|
X |
|
例 |
|
X |
X |
X |
関連リンク |
X |
|
X |
|
コメント |
X |
X |
|
|
表 5 では、各ビューについて説明し、それぞれのビューを呼び出すコマンドの例を示します。
表 5 Exchange 管理シェルのヘルプ ビューの例
| ヘルプ ビュー | 例 | 説明 |
|---|---|---|
|
|
|
|
|
パラメータの詳細については、「パラメータ」を参照してください。 |
|
|
パラメータの詳細については、「パラメータ」を参照してください。 |
|
|
|
Exchange 管理シェルでは、これらの 4 種類のヘルプ ビューに加えて、特定のパラメータや、類似した一連のパラメータに関する説明およびメタデータにもアクセスできます。 パラメータを、Get-Help <cmdlet> コマンドと一緒に指定することができます。 次の例は、どのようにすると、Set-Mailbox コマンドレットの ForwardingAddress パラメータに関する説明を表示できるかを示しています。
Get-Help Set-Mailbox -Parameter ForwardingAddress
パラメータの名前の一部を、ワイルドカード文字 (*) と共に指定すると、特定のコマンドレットで使用できる類似した一連のパラメータを表示することもできます。 次の例は、どのようにすると、"Quota" という単語を含む Set-Mailbox コマンドレットのパラメータをすべて表示できるかを示しています。
Get-Help Set-Mailbox -Parameter *Quota*
.gif "note") 注 : |
|---|
| Get-Help コマンドレットで Parameter パラメータを使用してパラメータが 1 つしかないコマンドレットのヘルプを取得する場合、ワイルドカード文字 (*) を使用しても、Get-Help コマンドレットは何も結果を返しません。 これは Microsoft Windows PowerShell の既知の問題です。 |
Role、Component、および Functionality パラメータ
特定のコマンドレットを指定しないで Get-Help コマンドレットを呼び出すと、Exchange 管理シェルで使用可能なすべてのコマンドレットの一覧が表示されます。 ただし、特定のサーバーの役割またはコンポーネントの機能を管理するコマンドレットや、機能の特定の範囲内にあるオブジェクトに影響を与えるコマンドレットの一覧を表示することもできます。 Get-Help コマンドレットでは、 Role、Component、および Functionality という 3 つのパラメータを使用して、それらの表示を行うことができます。
Role、Component、または Functionality パラメータを指定して Get-Help コマンドレットを使用するときには、これらのパラメータと共に指定する値をワイルドカード文字 (*) で囲む必要があります。 以下に、各パラメータを指定して Get-Help を呼び出す方法の例を示します。
Get-Help -Role *Mailbox*
Get-Help -Component *Recipient*
Get-Help -Functionality *Server*
以降の表では、Get-Help コマンドレットで、Role、Component,、および Functionality パラメータと共に使用できるすべての値を示します。 表 6 は、Role パラメータと共に使用できる値の一覧です。
表 6 Get-Help -Role で有効な値
| 役割 | 値 | 代わりに指定できる値 |
|---|---|---|
メールボックス |
|
|
ハブ トランスポート |
|
|
クライアント アクセス |
|
|
ユニファイド メッセージング |
|
|
エッジ トランスポート |
|
|
組織管理者 |
|
|
サーバー管理者 |
|
|
受信者管理者 |
|
|
Windows の管理者 |
|
|
読み取り専用 |
|
|
表 7 は、Component パラメータと共に使用できる値の一覧です。
表 7 Get-Help -Component で有効な値
| 値 | 値 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
表 8 は、Functionality パラメータと共に使用できる値の一覧です。
表 8 Get-Help -Functionality で有効な値
| 値 |
|---|
|
|
|
Tab キーによる補完機能
Tab キーによる補完機能によって、Exchange 管理シェルを使用するときに必要な入力を減らすことができます。コマンドレット名を部分的に入力して Tab キーを押すと、一致するコマンドレットが見つかれば、コマンドレット名が Exchange 管理シェルによって最後まで入力されます。 一致するコマンドレット名が複数見つかった場合は、Tab キーを押すたびにそれぞれのコマンドレット名が順番に表示されます。 コマンドレット名で Tab キーによる補完機能を使用するときには、少なくとも動詞とハイフン (-) を指定する必要があります。 以下の例では、コマンドレット名を入力するときに、どのように Tab キーによる補完機能を使用できるかを示します。
Get-Transport<Tab>
Enable-<Tab>
最初の例で Tab キーを押すと、Get-Transport で始まるすべてのコマンドレット名が順番に、Exchange に表示されます。2 番目の例では、Enable という動詞が付くすべてのコマンドレットが順に表示されます。
コマンドレット名の場合と同様に、部分的に入力したパラメータ名を Exchange 管理シェルに最後まで入力させる場合も、Tab キーによる補完機能を使用できます。 パラメータ名について Tab キーによる補完機能を使用するときには、直接入力するか、Tab キーによる補完機能を使用して完全なコマンドレット名を指定する必要があります。 以下の例では、パラメータ名を入力するときに、どのように Tab キーによる補完機能を使用できるかを示します。
Set-Mailbox -Email<Tab>
New-TransportRule -Cond<Tab>
最初の例で Tab キーを押すと、Set-Mailbox コマンドレットの、Email で始まるすべてのパラメータ名が順番に、Exchange 管理シェルに表示されます。2 番目の例では、Tab キーを押すと、New-TransportRule コマンドレットの Condition パラメータが、Exchange 管理シェルによって最後まで入力されます。
参照している情報が最新であることを確認したり、他の Exchange Server 2007 ドキュメントを見つけたりするには、Exchange Server TechCenter を参照してください。