В Microsoft Exchange Server 2007 командная консоль Exchange дает возможность воспользоваться большим количеством справочных материалов. В этом разделе описаны следующие справочные материалы и функции:

Файл справки Exchange 2007

Файл справки Exchange 2007 содержит те же справочные сведения о командлетах, которые доступны по каждому командлету в командной консоли Exchange. Однако в файле справки сервера Exchange 2007 сведения о командлетах упорядочены по роли сервера и по задаче администрирования, что упрощает поиск отдельных командлетов, связанных с задачей, которую нужно выполнить. Кроме того, в разделах по командлетам в файле справки Exchange 2007 есть ссылки на разделы, в которых описываются функции, которыми управляют командлеты, объясняется, как использовать командлеты для управления ими, и приводятся сведения о функциях и часто используемых сценариях.

Дополнительные сведения о разделах справки по командлетам в файле справки Exchange 2007 см. в разделе Командная консоль Exchange (пакеты обновления 1 и 2).

Дополнительные сведения об использовании командлетов командной консоли Exchange для выполнения отдельных задач см. в разделе Операции.

Справочные командлеты

В таблице ниже приведены примеры того, как при помощи командлетов Get-Help, Get-Command и Get-ExCommand получить доступ к справочным сведениям, доступным для каждого командлета в командной консоли Exchange.

В таблице 1 приведены примеры того, как использовать командлет Get-Help

Таблица 1   Примеры использования команды Get-Help

Команда Описание

Get-Help

Если командлет Get-Help используется самостоятельно, он дает основные указания по использованию справочной системы командной консоли Exchange.

Get-Help <cmdlet>

Когда в качестве аргумента командлета Get-Help указывается командлет среды управления, выдается информация по этому командлету. Например, чтобы получить справочную информацию по командлету Get-SystemMessage, используйте следующую команду:

Get-Help Get-SystemMessage

Get-Help <*cmdlet*>

Если в качестве аргумента командлета Get-Help указать командлет среду управления и использовать в нем подстановочные знаки, командлет Get-Help возвратит список командлетов, соответствующий введенному тексту. Получить список командлетов можно несколькими способами. Среди них:

  • Get-Help *Rules   Такая команда выдаст все командлеты, название которых заканчивается словом Rules.

  • Get-Help Get*Rules   Такая команда выдаст все командлеты, название которых начинается словом Get и заканчивается словом Rules.

  • Get-Help Get-Export*   Такая команда выдаст все командлеты, название которых начинается словосочетанием Get-Export.

Используя подстановочные знаки таким образом, можно просмотреть командлеты, связанные с определенной функцией. Например, при помощи команды Get-Help *-TransportAgent можно просмотреть список командлетов, связанных с агентами передачи.

Get-Help About_*

Команда Get-Help About_* выдает список всех общих разделов справки командной консоли Exchange, в которых можно получить подробную информацию о командной консоли Exchange. Если нужно прочесть раздел, стоящий в списке, выполните команду Get-Help About_<функция>. Например, если нужно получить сведения о выражении 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

Таблица 2   Примеры использования команды Get-Command

Командлет Описание

Get-Command

Командлет Get-Command выдает список всех командлетов, используемых в командной консоли. Как и командлет Get-Help, командлет Get-Command допускает использование подстановочных знаков. Этот командлет можно использовать вместе с командлетами Format-List и Format-Table, чтобы результаты было удобнее читать. Например, команда Get-Command | Format-List отобразит справку по командлетам в виде списка.

Get-Command <Cmdlet>

Команда Get-Command <командлет> выдает подробную информацию о параметрах и прочих компонентах указанного командлета. Эту команду можно использовать вместе с командлетами Format-List и Format-Table, чтобы результаты было удобнее читать. Например, команда Get-Command Get-SystemMessage | Format-List отобразит справку по командлетам в виде списка.

Get-Command -Noun <CmdletNoun>

Команда Get-Command -Noun <существительное из названия командлета> выдает список командлетов, в названии которых есть указанное существительное. Команда эта полезна, когда нужно просмотреть список командлетов, связанных с определенной функцией. Например, команда Get-Help -Noun SystemMessage выдаст все командлеты, связанные с функцией SystemMessage. Эту команду можно использовать вместе с командлетами Format-List и Format-Table, чтобы результаты было удобнее читать. Например, команда Get-SystemMessage -Noun Get | Format-List отобразит справку по командам в виде списка.

Get-Command -Verb <CmdletVerb>

Команда Get-Command -Verb <глагол из названия командлета> выдает список всех командлетов, в названии которых есть указанный глагол. Команда эта полезна, когда нужно просмотреть список командлетов, связанных с определенным действием. Например, команда Get-Help -Verb Enable выдаст все командлеты, связанные с выполнением включения. Эту команду можно использовать вместе с командлетами Format-List и Format-Table, чтобы результаты было удобнее читать. Например, команда Get-Command -Verb SystemMessage | Format-List отобразит справку по командам в виде списка.

Get-ExCommand

Командлет Get-ExCommand работает так же, как командлет Get-Command, но выдает только командлеты, связанные с управлением Exchange 2007.

Get-PSCommand

Командлет Get-PSCommand работает так же, как командлет Get-Command, но исключает из результатов командлеты, связанные с управлением Exchange 2007.

В таблице 3 приводятся примеры того, как используются различные справочные команды.

Таблица 3   Примеры использования различных справочных команд

Командлет Описание

QuickRef

Команда QuickRef открывает схему в формате HTML, пригодную для печати, в которой перечислены наиболее часто используемые командлеты командные консоли Exchange.

Последнюю версию схемы можно посмотреть в Кратком руководстве по командной консоли Exchange.

<Cmdlet> -?

Команда <командлет> -? с названием любого командлета выдает ту же справочную информацию, что и командлет Get-Help. Например, введите Get-SystemMessage -?, чтобы просмотреть подробную справку по командлету Get-SystemMessage.

Get-Tip

Командлет Get-Tip выдает один из советов дня командной консоли Exchange.

Get-ExBlog

Командлет Get-ExBlog открывает в Microsoft Internet Explorer страницу журнала команды Exchange.

Варианты просмотра справки

Если в качестве параметра командлета Get-Help указан командлет, отображаются сведения об указанном командлете. В некоторых случаях сведения могут быть весьма обширными, тогда как вам нужна более конкретная информация. Варианты просмотра справки позволяют просмотреть конкретную информацию, не отыскивая ее среди ненужных сведений.

В командной консоли 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 <командлет>.

Detailed

Get-Help Set-Mailbox -Detailed

Вариант просмотра Detailed используется при выполнении команды Get-Help <командлет> -Detailed. Параметры в разделе Parameters не содержат сведений о метаданных.

Для получения дополнительных сведений о параметрах см. раздел Параметры.

Full

Get-Help Set-Mailbox - Full

Вариант просмотра Full используется при выполнении команды Get-Help <командлет> -Full. Параметры в разделе Parameters содержат сведений о следующих метаданных:

  • Required?

  • Position?

  • Default value

  • Accept pipeline input?

  • Accept wildcard characters?

Для получения дополнительных сведений о параметрах см. раздел Параметры.

Examples

Get-Help Set-Mailbox -Examples

Вариант просмотра Examples используется при выполнении команды Get-Help <командлет> -Examples.

Кроме этих четырех вариантов просмотра, командная консоль Exchange дает возможность просматривать описание и метаданные для конкретного параметра или ряда схожих параметров. Параметр можно указать вместе с командой Get-Help <командлет>. В приведенном ниже примере отображается описание параметра ForwardingAddress для командлета Set-Mailbox:

Копировать код 
Get-Help Set-Mailbox -Parameter ForwardingAddress

Также можно просмотреть набор схожих параметров определенного командлета, если указать часть названия параметра с подстановочным знаком (*). В приведенном ниже примере отображаются все параметры командлета Set-Mailbox, название которых содержит слово «Quota»:

Копировать код 
Get-Help Set-Mailbox -Parameter *Quota*
Примечание.
Если параметр Parameter используется с командлетом Get-Help для получения справочных сведений о командлете, имеющем только один параметр, выполнение командлета Get-Help не приведет к получению каких-либо результатов даже при использовании подстановочного знака (*). Это известная проблема Microsoft Windows PowerShell.

Параметры ролей, компонентов и функций

Если командлет Get-Help вызывается без указания командлета, он выдает список всех командлетов, используемых в командной консоли Exchange. Иногда нужно получить список командлетов, управляющих определенной серверной ролью или компонентом, или список командлетов, связанных с объектами определенной области функций. Командлет Get-Help позволяет сделать это при помощи трех параметров: Role, Component и Functionality.

Если командлет Get-Help используется с параметром Role, Component или Functionality, необходимо выделить значения параметров подстановочными знаками (*). Ниже приведены примеры вызова командлета Get-Help с каждым из трех параметров:

Копировать код 
Get-Help -Role *Mailbox*
Get-Help -Component *Recipient*
Get-Help -Functionality *Server*

В следующих таблицах приведены списки значений, которые могут принимать параметры Role, Component, и Functionality в командлете Get-Help. В таблице 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

Завершение клавишей TAB

Завершение клавишей TAB позволяет уменьшить объем данных, которые вводятся вручную в командной консоли Exchange. Если при вводе части имени командлета нажать клавишу TAB, командная консоль Exchange завершит ввод имени командлета, если соответствующий командлет будет найден. Если найдено несколько названий, они будут вписываться по очереди при каждом нажатии клавиши TAB. При использовании завершения клавишей TAB необходимо ввести по крайней мере глагол и дефис (-). Ниже приведены примеры использования завершения клавишей TAB при вводе названия командлета:

Копировать код 
Get-Transport<Tab>
Enable-<Tab>

В первом примере при нажатии клавиши TAB командная консоль Exchange по очереди выдает имена командлетов, которые начинаются с Get-Transport. Во втором примере командная консоль Exchange по очереди выдает командлеты, имена которых содержат глагол Enable.

Так же как и в случае с именами командлетов, при нажатии клавиши TAB командная консоль Exchange может завершать частично введенные имена параметров. Когда используется завершение клавишей TAB для названий параметров, необходимо указать полное название командлета — либо ввести вручную, либо воспользоваться завершением клавишей TAB. Ниже приведены примеры использования завершения клавишей TAB при вводе названия параметра:

Копировать код 
Set-Mailbox -Email<Tab>
New-TransportRule -Cond<Tab>

В первом примере при нажатии клавиши TAB командная консоль Exchange по очереди выдает имена параметров, которые начинаются с Email, для командлета Set-Mailbox. Во втором примере при нажатии клавиши TAB командная консоль Exchange завершает параметр Condition для командлета New-TransportRule.