Применимо к: Exchange Server 2010 SP1

Последнее изменение раздела: 2009-12-14

В Microsoft Exchange Server 2010 командная консоль Exchange позволяет использовать различные справочные ресурсы. Этот раздел включает в себя следующие подразделы, описывающие справочные ресурсы и функции.

Справка Exchange 2010

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

Дополнительные сведения о разделах справки по командлетам, доступных в справке Exchange 2010 см. в разделе Командлеты Exchange 2010.

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

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

Важно!
Для просмотра списка командлетов Exchange, соответствующих указанному строковому значению, используется командлет Get-ExCommand. Дополнительные сведения см. в таблице «Примеры использования различных справочных команд» далее в разделе.

В следующей таблице приведены примеры использования командлета Get-Help.

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

Примеры Описание

Get-Help

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

Get-Help <cmdlet>

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

Get-Help Get-SystemMessage

Get-Help About_*

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

Get-Help About_wildcards.

Get-Help <cmdlet> -Detailed

Описание см. далее в разделе Варианты просмотра справки.

Get-Help <cmdlet> -Full

Описание см. далее в разделе Варианты просмотра справки.

Get-Help <cmdlet> -Examples

Описание см. далее в разделе Варианты просмотра справки.

Get-Help <cmdlet> -Parameter <parameter name>

Описание см. далее в разделе Фильтр параметров.

Get-Help <cmdlet> -Online

Описание см. далее в разделе Интерактивная справка.

В следующей таблице приведены примеры использования командлета Get-Command.

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

Примеры Описание

Get-Command

Командлет Get-Command предоставляет список всех командлетов, доступных в командной консоли Exchange. Командлет Get-Command разрешает использование подстановочных знаков.

Get-Command *<string>*

Если строка заключена в подстановочные знаки (*), командлет Get-Command возвращает список всех доступных командлетов и функций, содержащих это строковое значение. Например, чтобы найти все командлеты или функции, содержащие строковое значение «mailbox», используйте команду Get-Command *mailbox*.

Командлеты Exchange 2010 отображаются в виде функций в выходных данных командлета Get-Command.

Get-Command -Noun <CmdletNoun>

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

Get-Command -Verb <CmdletVerb>

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

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

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

Примеры Описание

Get-ExCommand

Команда Get-ExCommand возвращает список всех доступных командлетов Exchange.

Get-ExCommand *<string>*

Если строка заключена в подстановочные знаки (*), то командлет Get-ExCommand возвращает список всех доступных командлетов Exchange, содержащих это строковое значение. Например, чтобы найти все командлеты Exchange, содержащие строковое значение "mailbox", используйте команду Get-ExCommand *mailbox*.

Командлеты Exchange 2010 отображаются в виде функций в выходных данных команды Get-ExCommand.

QuickRef

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

Сведения о том, как открыть эту диаграмму напрямую, см. в разделе Краткий справочник по командной консоли Exchange.

<Cmdlet> -?

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

Get-Tip

Командлет Get-Tip создает один новый полезный совет командной консоли Exchange. Этот командлет работает, только если установлены средства управления Exchange.

Get-ExBlog

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

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

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

В командной консоли Exchange предусмотрено четыре варианта просмотра, которые позволяют просматривать различные типы сведений. Также можно получить определенные параметры или группы параметров.

Следующая таблица содержит разделы, отображаемые при каждом варианте просмотра.

Варианты просмотра справки в командной консоли Exchange

Вариант просмотра справки По умолчанию Подробный Полное Примеры

Краткое описание

X

X

X

X

Синтаксис

X

X

X

 

Описание

X

X

X

 

Параметры без метаданных

 

X

 

 

Параметры с метаданными

 

 

X

 

Входные данные

 

 

X

 

Выходные данные

 

 

X

 

Ошибки

 

 

X

 

Примеры

 

X

X

X

Связанные ссылки

X

 

X

 

Замечания

X

X

 

 

В следующей таблице описываются все варианты просмотра и приводится пример команды, вызывающей каждый из вариантов.

Примеры вариантов просмотра справки по командной консоли Exchange

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

По умолчанию

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.

Фильтр параметров

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

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

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

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

Интерактивная справка

Если для командлета указано несколько параметров, для этого командлета будет сложно прочитать справочные сведения в командной консоли Exchange. В Exchange 2010 доступен переключатель Online. При использовании переключателя Online командная консоль Exchange открывает в веб-браузере по умолчанию интерактивную версию раздела справки по командлету. Интерактивный раздел справки содержит те же сведения, что и справка по командлету в командной консоли Exchange, но позволяет просматривать данные в более широком окне, выполнять поиск необходимого раздела по терминам, а также перемещаться по связанным ссылкам внутри раздела. Например, для просмотра интерактивной справки по командлету Set-Mailbox используйте следующую команду.

Скопировать код 
Get-Help Set-Mailbox -Online

Чтобы использовать переключатель Online, необходимо подключить компьютер к Интернету.

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

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

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

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

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

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

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