获取帮助

项目
08/09/2014

适用于： 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 帮助文件包含按照基于角色和基于任务的层次结构列出的所有 cmdlet 帮助主题，这些 cmdlet 帮助主题也链接到说明如何执行特定任务的步骤主题。
帮助 cmdlet Exchange 命令行管理程序提供若干帮助 cmdlet，使用这些 cmdlet 可以找到完成任务所需的适当信息。
帮助视图 Exchange 命令行管理程序中的帮助包含大量有关可用 cmdlet 的信息。使用帮助视图可以访问所需的 cmdlet 信息。
Cmdlet 角色、组件和功能 可以按照 Cmdlet 管理的角色、组件或功能列出 Cmdlet。这可让您根据希望管理的角色、组件或功能来找到适当的 cmdlet。
制表符完成 输入 cmdlet 名称和参数名称时可以使用制表符完成功能，以减少必须在命令行上执行的键入次数。

Exchange 2007 帮助文件

Exchange 2007 帮助文件包含有关 Exchange 命令行管理程序中每个 cmdlet 的相同可用 cmdlet 帮助信息。但是，在 Exchange 2007 帮助文件中，所有 cmdlet 的帮助都按照服务器角色和管理任务进行组织，以帮助您轻松找到与要执行的任务关联的特定 cmdlet。此外，Exchange 2007 帮助文件中的 cmdlet 主题均链接到相关主题，这些主题介绍它们管理的功能、显示如何使用 cmdlet 管理相应功能以及提供有关功能或常见方案的特定详细信息。

有关 Exchange 2007 帮助文件中提供的 cmdlet 帮助主题的详细信息，请参阅 Exchange 命令行管理程序（SP1 和 SP2）。

有关如何使用 Exchange 命令行管理程序 cmdlet 执行特定任务的详细信息，请参阅操作。

帮助 Cmdlet

下表中的示例介绍如何使用 Get-Help cmdlet、Get-Command cmdlet 及 Get-ExCommand cmdlet 访问有关 Exchange 命令行管理程序中每个 cmdlet 的帮助信息。

表 1 提供了如何使用 Get-Help cmdlet 的示例。

表 1 如何使用 Get-Help 命令的示例

命令	说明
`Get-Help`	单独使用 Get-Help cmdlet 时，它会提供有关如何使用 Exchange 命令行管理程序帮助系统的基本说明。
`Get-Help <cmdlet>`	为 Get-Help cmdlet 提供一个命令行管理程序 cmdlet 作为参数时，它会显示该 cmdlet 的帮助信息。例如，若要检索 Get-SystemMessage cmdlet 的帮助信息，请使用下列命令： `Get-Help Get-SystemMessage`
`Get-Help <cmdlet>`	为 Get-Help cmdlet 提供 shell cmdlet 作为参数并使用通配符时，Get-Help cmdlet 会返回与提供的文本匹配的所有 cmdlet 的列表。可以使用多种方法检索 shell cmdlet 的列表。这些方法包括下列内容： *Get-Help Rules 此命令返回结尾为 `Rules` 单词的所有 cmdlet。 Get-Help GetRules* 此命令返回开头为 `Get` 单词且结尾为 `Rules` 单词的所有 cmdlet。 Get-Help Get-Export* 此命令返回开头为 `Get-Export` 短语的所有 cmdlet。按照这种方式使用通配符，就可以轻松查看某个特定功能可用的所有 cmdlet 的列表。例如，使用 *Get-Help -TransportAgent** 命令，可以查看传输代理可用的所有 cmdlet 动词列表。
`Get-Help About_*`	Get-Help About_* 命令提供所有常规 Exchange 命令行管理程序帮助主题的列表，以帮助您更好地理解和使用 Exchange 命令行管理程序。如果希望了解所显示的列表中某个主题的详细信息，请运行 Get-Help About_<feature> 命令。例如，如果希望了解有关 `Where` 语句的详细信息，请运行 `Get-Help About_Where`。
`Get-Help <cmdlet> -Detailed`	请参阅此主题中稍后介绍的“帮助视图”部分。
`Get-Help <cmdlet> -Full`	请参阅此主题中稍后介绍的“帮助视图”部分。
`Get-Help <cmdlet> -Examples`	请参阅此主题中稍后介绍的“帮助视图”部分。
`Get-Help <cmdlet> -Parameter <parameter name>`	请参阅此主题中稍后介绍的“帮助视图”部分。
`Get-Help -Role <server role>`	请参阅此主题中稍后介绍的“角色、组件和功能参数”部分。
`Get-Help -Component <component feature>`	请参阅此主题中稍后介绍的“角色、组件和功能参数”部分。
`Get-Help -Functionality <Global \| User \| Server>`	请参阅此主题中稍后介绍的“角色、组件和功能参数”部分。

表 2 提供了如何使用 Get-Command cmdlet 的示例。

表 2 如何使用 Get-Command 命令的示例

Cmdlet	说明
`Get-Command`	Get-Command cmdlet 提供命令行管理程序中可用的所有 cmdlet 的列表。与 Get-Help cmdlet 类似，Get-Command cmdlet 也允许使用通配符扩展。您可以将此 cmdlet 与 Format-List 及 Format-Table cmdlet 结合使用，使显示内容更具可读性。例如，使用 `Get-Command \| Format-List` 可采用列表格式显示 cmdlet 帮助。
`Get-Command <Cmdlet>`	Get-Command <Cmdlet> 命令提供有关指定的 cmdlet 参数和其他组件的详细信息。可以将此命令与 Format-List cmdlet 和 Format-Table cmdlet 一起使用，使显示内容更具可读性。例如，使用 `Get-Command Get-SystemMessage \| Format-List` 可采用列表格式显示 cmdlet 帮助。
`Get-Command -Noun <CmdletNoun>`	Get-Command -Noun <CmdletNoun> 命令可列出含有指定名词的所有 cmdlet。当需要查看与特定功能关联的所有 cmdlet 的列表时，此命令很有用。例如，Get-Help -Noun SystemMessage 命令可返回 for the `SystemMessage` 功能可用的所有 cmdlet。可以将此命令与 Format-List cmdlet 和 Format-Table cmdlet 一起使用，使显示内容更具可读性。例如，使用 `Get-SystemMessage -Noun Get \| Format-List` 可采用列表格式显示命令帮助。
`Get-Command -Verb <CmdletVerb>`	Get-Command -Verb <CmdletVerb> 命令可列出含有指定动词的所有 cmdlet。需要查看与特定操作关联的所有 cmdlet 的列表时，此命令很有用。例如，Get-Help -Verb Enable 命令返回可用于执行启用操作的所有 cmdlet。可以将此命令与 Format-List cmdlet 和 Format-Table cmdlet 一起使用，使显示内容更具可读性。例如，使用 `Get-Command -Verb SystemMessage \| Format-List` 可采用列表格式显示命令帮助。
`Get-ExCommand`	Get-ExCommand cmdlet 的作用与 Get-Command cmdlet 相同，但它仅返回可用于管理 Exchange 2007 的 cmdlet。
`Get-PSCommand`	Get-PSCommand cmdlet 的作用与 Get-Command cmdlet 相同，但它排除用于管理 Exchange 2007 的 cmdlet。

表 3 提供了如何使用其他帮助命令的示例。

表 3 如何使用其他帮助命令的示例

Cmdlet	说明
`QuickRef`	QuickRef 命令可打开一个可打印的 HTML 图表，其中列出最常用的 Exchange 命令行管理程序 cmdlet。若要查看此图表的最新版本，请参阅 Exchange Management Shell Quick Reference（Exchange 命令行管理程序快速参考）。
`<Cmdlet> -?`	将 <Cmdlet> -? 命令与任何 cmdlet 结合使用，可查找当使用 Get-Help cmdlet 时提供的相同帮助信息。例如，键入 `Get-SystemMessage -?` 可显示针对 Get-SystemMessage cmdlet 的详细帮助信息。
`Get-Tip`	Get-Tip cmdlet 可生成新的 Exchange 命令行管理程序每日提示。
`Get-ExBlog`	Get-ExBlog cmdlet 可打开 Microsoft Internet Explorer 以显示 Exchange 团队博客。

帮助视图

将某个 cmdlet 指定为 Get-Help cmdlet 的参数时，会显示该指定 cmdlet 的帮助信息。在某些情况下，返回的信息可能很广泛，而您仅希望查看特定的信息。使用帮助视图，就可以查看有关某个 cmdlet 的特定信息，无须排列可能不需要的信息。

Exchange 命令行管理程序提供四种视图，它们准确提供您需要的信息。此外，也可以检索特定参数或类似的参数集。表 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 命令行管理程序帮助视图示例

帮助视图	示例	说明
`Default`	`Get-Help Set-Mailbox`	使用 `Get-Help <`cmdlet`>` 命令时，会显示默认视图。
`Detailed`	`Get-Help Set-Mailbox -Detailed`	使用 `Get-Help <`cmdlet`> -Detailed` 命令时，会显示 `Detailed` 视图。`Parameters` 部分中返回的参数不包括参数元数据。有关参数的详细信息，请参阅参数。
`Full`	`Get-Help Set-Mailbox - Full`	使用命令 `Get-Help <`cmdlet`> -Full` 时，会显示 `Full` 视图。`Parameters` 部分中返回的参数包括下列参数元数据： `Required?` `Position?` `Default value` `Accept pipeline input?` `Accept wildcard characters?` 有关参数的详细信息，请参阅参数。
`Examples`	`Get-Help Set-Mailbox -Examples`	使用 `Get-Help <`cmdlet`> -Examples` 命令时，会显示 `Examples` 视图。

除了这四种帮助视图以外，还可以使用 Exchange 命令行管理程序查看有关特定参数或一组类似参数的说明和元数据。可以一起指定参数与 Get-Help <cmdlet> 命令。以下示例说明如何显示 Set-Mailbox cmdlet 的 ForwardingAddress 参数的说明：

Get-Help Set-Mailbox -Parameter ForwardingAddress

还可以一起指定参数的部分名称与通配符 (*)，显示特定 cmdlet 的一组类似参数。以下示例说明如何显示 Set-Mailbox cmdlet 的包含“Quota”一词的所有参数：

Get-Help Set-Mailbox -Parameter *Quota*

注意：
在将 Parameter 参数与 Get-Help cmdlet 一起使用检索仅有一个参数的 cmdlet 的帮助时，Get-Help cmdlet 不会返回任何结果，即使使用通配符 (*) 也是如此。这是 Microsoft Windows PowerShell 中的已知问题。

角色、组件和功能参数

在不指定特定 cmdlet 的情况下调用 Get-Help cmdlet 时，将显示 Exchange 命令行管理程序中所有可用 cmdlet 的列表。但是，您可能要查看可管理特定服务器角色或组件功能或者可跨某个特定功能作用域来影响对象的 cmdlet 列表。可以通过在 Get-Help cmdlet 中使用下列三个参数来达到此目的：Role、Component 和 Functionality。

结合使用 Get-Help cmdlet 与 Role、Component 或 Functionality 参数时，您必须在用这些参数指定的值的两边加上通配符(*)。下列示例说明了如何用每个参数调用 Get-Help：

Get-Help -Role *Mailbox*
Get-Help -Component *Recipient*
Get-Help -Functionality *Server*

下面的表中列出了 Get-Help cmdlet 的 Role、Component 及 Functionality 参数的所有可能值。表 6 列出了 Role 参数的可能值。

表 6 Get-Help -Role 的有效值

角色	值	替代值
邮箱	`Mailbox`	`MB`
集线器传输	`Hub`	`HT`
客户端访问	`ClientAccess`	`CA`
统一消息	`UnifiedMessaging`	`UM`
边缘传输	`Edge`	`ET`
组织管理员	`OrgAdmin`	`OA`
服务器管理员	`SrvAdmin`	`SV`
收件人管理员	`RcptAdmin`	`RA`
Windows 管理员	`WinAdmin`	`WA`
只读	`ReadOnly`	`RO`

表 7 列出了可用于 Component 参数的值。

表 7 Get-Help -Component 的有效值

值	值
`Addressing`	`Mailflow`
`Agent`	`ManagedFolder`
`Antispam`	`Mobility`
`AutoDiscover`	`OAB`
`Calendaring`	`Outlook`
`Certificate`	`OWA`
`Classification`	`Permission`
`Client`	`Pop`
`Cluster`	`PublicFolder`
`Compliance`	`Queuing`
`Delegate`	`Recipient`
`Diagnostic`	`Routing`
`Domain`	`Rule`
`Extensibility`	`Search`
`FreeBusy`	`Server`
`GAL`	`Statistics`
`Group`	`Storage`
`HighAvailability`	`UM`
`Imap`	`VirtualDirectory`
`Mailbox`

表 8 列出了可用于 Functionality 参数的值。

表 8 Get-Help -Functionality 的有效值

值
`Global`
`Server`
`User`

制表符完成

制表符完成功能减少了用户使用 Exchange 命令行管理程序时必须执行的键入操作。键入 cmdlet 名称的一部分时，按 Tab 键，如果找到匹配的 cmdlet，Exchange 命令行管理程序会完成该 cmdlet 名称。如果找到多个匹配的 cmdlet 名称，则按 Tab 键将循环显示每个 cmdlet 名称。若对 cmdlet 名称使用制表符完成功能，至少需要输入动词和连字符 (-)。下列示例说明了输入 cmdlet 名称时如何使用制表符完成功能：

Get-Transport<Tab>
Enable-<Tab>

在第一个示例中按 Tab 键时，Exchange 命令行管理程序会循环显示以 Get-Transport 开头的所有 cmdlet 名称。在第二个示例中，Exchange 命令行管理程序会循环显示含有动词 Enable 的所有 cmdlet。

与 cmdlet 名称相同，当您希望 Exchange 命令行管理程序完成您输入的部分参数名称时，也可以使用制表符完成功能。对参数名称使用制表符完成功能时，必须通过直接键入或使用制表符完成功能来指定完整的 cmdlet 名称。下列示例说明了输入参数名称时如何使用制表符完成功能：

Set-Mailbox -Email<Tab>
New-TransportRule -Cond<Tab>

在第一个示例中按 Tab 键时，Exchange 命令行管理程序会循环显示 Set-Mailbox cmdlet 的以 Email 开头的所有参数名称。在第二个示例中，按 Tab 键时，Exchange 命令行管理程序会完成 New-TransportRule cmdlet 的 Condition 参数。