Применимо к: Exchange Server 2010 SP1
Последнее изменение раздела: 2009-07-09
В этом разделе описываются способ чтения наборов параметров командной консоли Exchange и примеров в справочной документации Exchange, и способ создания команд в таком формате, чтобы эти команды можно было обработать с помощью командной консоли. В командной консоли и справке Microsoft Exchange Server 2010 наборы параметров отображаются в подразделе «Синтаксис» раздела справки. Дополнительные сведения о справке по командлетам см. в разделе Получение справки.
См. следующие разделы:
Соглашения о записи команд в командной консоли Exchange
Командные операторы в командной консоли Exchange
Соглашения о записи команд в командной консоли Exchange
В командной консоли используется ряд соглашений о записи команд, зная которые, проще понять, какие данные являются обязательными и необязательными при выполнении команды и как надо указывать параметры и их значения. Примеры записи наборов параметров в справке командной консоли и справке Exchange 2010 см. в подразделе «Наборы параметров» далее в этом разделе.
Эти соглашения о записи команд перечислены в следующей таблице.
Соглашения о записи команд в командной консоли Exchange
Символ | Описание |
---|---|
- |
Дефис указывает, что следующее слово в командной строке является параметром. Наиболее распространенный параметр — Identity. Дополнительные сведения см. в разделе Параметры. |
< > |
В угловых скобках указываются значения параметра. Эти значения
могут быть вариантами выбора или именами. Например, в строке
|
[ ] |
В квадратные скобки заключаются необязательные параметры и их значения. Если параметр и его значение не заключены в квадратные скобки, такой параметр является обязательным. |
| |
Если в списке значений параметра стоит вертикальная черта,
например |
Эти соглашения о записи команд помогут понять структуру команды. Символы, используемые при описании синтаксиса, в командной строке не вводятся.
Наборы параметров
В справочной документации Exchange параметры всех командлетов отображаются в наборах параметров. Наборы параметров представляют собой группировки параметров, которые можно использовать друг с другом. Параметры, которые указаны в одном наборе параметров, однако отсутствуют в другом наборе, являются взаимоисключающими. Их нельзя использовать одновременно.
Хотя все командлеты имеют наборы параметров, у многих из них есть только один набор параметров. Это означает, что все параметры такого командлета могут использоваться в сочетании друг с другом. Для других командлетов доступно несколько наборов параметров. В следующем примере показаны наборы параметров, доступные для командлета New-SystemMessage:
Скопировать код | |
---|---|
New-SystemMessage -DsnCode <EnhancedStatusCode> -Internal <$true | $false> -Language <CultureInfo> -Text <String> [-DomainController <String>] [-Templ ateInstance <MshObject>] New-SystemMessage -Language <CultureInfo> -QuotaMessageType <WarningMailbox UnlimitedSize | WarningPublicFolderUnlimitedSize | WarningMailbox | Warning PublicFolder | ProhibitSendMailbox | ProhibitPostPublicFolder | ProhibitSen dReceiveMailBox> -Text <String> [-DomainController <String>] [-TemplateInst ance <MshObject>] |
Командлет New-SystemMessage имеет два набора параметров. Первый набор параметров содержит параметры DsnCode и Internal, а второй набор содержит параметр QuotaMessageType. Это означает, что параметры DsnCode и Internal могут использоваться одновременно. Однако их нельзя использовать, если указан параметр QuotaMessageType. Остальные параметры: Language, Text, DomainController и TemplateInstance — перечислены в обоих наборах параметров. Это означает, что они могут использоваться с параметрами DsnCode, Internal, , а также с параметром QuotaMessageType.
Наборы параметров свидетельствуют, что один и тот же командлет можно использовать в нескольких целях. Например, с помощью командлета New-SystemMessage можно настраивать пользовательские уведомления о доставке (DSN) или пользовательские сообщения о квоте почтового ящика. Однако командлеты обычно имеют несколько наборов параметров в связи с тем, что один из параметров задает выполнение функции, несовместимой с другим параметром. Так, в следующем примере показаны наборы параметров для командлета New-AddressList:
Скопировать код | |
---|---|
New-AddressList -Name <String> [-ConditionalCompany <MultiValuedProperty>] [-ConditionalCustomAttribute1 <MultiValuedProperty>] [-ConditionalCustomAtt ribute10 <MultiValuedProperty>] [-ConditionalCustomAttribute11 <MultiValued Property>] [-ConditionalCustomAttribute12 <MultiValuedProperty>] [-Conditio nalCustomAttribute13 <MultiValuedProperty>] [-ConditionalCustomAttribute14 <MultiValuedProperty>] [-ConditionalCustomAttribute15 <MultiValuedProperty> ] [-ConditionalCustomAttribute2 <MultiValuedProperty>] [-ConditionalCustomA ttribute3 <MultiValuedProperty>] [-ConditionalCustomAttribute4 <MultiValued Property>] [-ConditionalCustomAttribute5 <MultiValuedProperty>] [-Condition alCustomAttribute6 <MultiValuedProperty>] [-ConditionalCustomAttribute7 <Mu ltiValuedProperty>] [-ConditionalCustomAttribute8 <MultiValuedProperty>] [- ConditionalCustomAttribute9 <MultiValuedProperty>] [-ConditionalDepartment <MultiValuedProperty>] [-ConditionalStateOrProvince <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-Container <AddressListIdParameter>] [-Disp layName <String>] [-DomainController <Fqdn>] [-IncludedRecipients <Nullable >] [-Organization <OrganizationIdParameter>] [-RecipientContainer <Organiza tionalUnitIdParameter>] [-WhatIf [<SwitchParameter>]] [<CommonParameters>] New-AddressList -Name <String> [-Confirm [<SwitchParameter>]] [-Container < AddressListIdParameter>] [-DisplayName <String>] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-RecipientContainer <Organizati onalUnitIdParameter>] [-RecipientFilter <String>] [-WhatIf [<SwitchParamete r>]] [<CommonParameters>] |
В командлете New-AddressList первый набор параметров содержит параметры, с помощью которых можно создать список адресов на основе значений, указанных в параметрах Company, Department, IncludedRecipients и StateOrProvice. Однако список адресов также можно создать с помощью настраиваемого фильтра, который определяется параметром RecipientFilter. При создании списка адресов настраиваемый фильтр, указанный с помощью параметра RecipientFilter, переопределяет настройку, заданную с использованием параметров первого набора. Поэтому параметр RecipientFilter помещен в отдельный набор параметров. В Exchange 2010 нельзя указать взаимоисключающие параметры в одной командной строке. Как и в случае с командлетом New-SystemMessage, остальные параметры, включенные в оба набора параметров в командлете New-AddressList, могут использоваться в любом сочетании.
Использование кавычек
В прямые кавычки ( " ) чаще всего заключаются
значения с пробелами, которые передаются параметру. Например, если
необходимо передать значение Contoso Receive Connector
параметру Name командлета Set-ReceiveConnector,
значение Contoso Receive Connector
необходимо
заключить в кавычки, как показано в следующем примере:
Скопировать код | |
---|---|
Set-ReceiveConnector -Name "Contoso Receive Connector" |
Если строка не заключена в кавычки, командная консоль пытается интерпретировать каждое слово в строке как новый аргумент командной строки и выводит сообщение об ошибке.
Двойные кавычки и апострофы ( ' ) имеют в
командной консоли разное значение. Если строка заключена в
двойные кавычки, командная консоль заменяет все переменные
соответствующими значениями. Допустим, например, что переменной
$Server
присвоено
значение ServerName
. В командной строке вводится
следующая команда:
Скопировать код | |
---|---|
"$Server Example" |
Выводится следующий результат:
Скопировать код | |
---|---|
ServerName Example |
Переменная $Server
заменяется при выводе
значением ServerName
.
Если строка заключена в апострофы, командная консоль не
пытается заменять переменные соответствующими значениями. Допустим,
что переменной $Server
присвоено
значение ServerName
. В командной строке вводится
следующая команда:
Скопировать код | |
---|---|
'$Server-Example' |
Выводится следующий результат:
Скопировать код | |
---|---|
$Server-Example |
Переменная $Server
не была заменена
значением, так как командная консоль не интерпретирует переменные в
тексте, заключенном в апострофы.
Дополнительные сведения о переменных см. в разделах Пользовательские переменные и Переменные командной консоли.
Escape-символ
Также может потребоваться отображение некоторых знаков,
таких как знак доллара ( $
), прямые
кавычки, апострофы или обратный апостроф
( `
). Эти знаки имеют специальное значение
при их использовании в командной консоли. Чтобы командная консоль
не интерпретировала эти знаки, а выводила их в строке, заключенной
в двойные кавычки, необходимо использовать escape-символ обратного
апострофа ( `
). Например, введите в
командной строке следующую команду:
Скопировать код | |
---|---|
"The price is `$23." |
Отобразится следующий результат:
Скопировать код | |
---|---|
The price is $23. |
Так как со знаком доллара ( $
)
использовался escape-символ обратного апострофа, командная консоль
не интерпретировала знак $
как начало переменной.
Если строка заключена в апострофы, для отображения
любых знаков, кроме апострофа, не нужно использовать escape-символ.
Если в строке, заключенной в апострофы, необходимо отобразить
апостроф, используйте два апострофа ( ''
).
Например, введите в командной строке следующую команду:
Скопировать код | |
---|---|
'Don''t confuse two single quotation marks with a double quotation mark!' |
Отобразится следующий результат:
Скопировать код | |
---|---|
Don't confuse two single quotation marks with a double quotation mark! |
Командные операторы в командной консоли Exchange
Операторы, приведенные в следующей таблице, используются при вводе команд в командной консоли. Некоторые из этих операторов могут совпадать с символами, указанными выше в соглашениях о записи команд. Однако в командной строке они имеют другое значение. В следующей таблице показаны допустимые операторы, которые можно использовать в команде.
Командные операторы командной консоли Exchange
Оператор | Описание |
---|---|
= |
Знак равенства используется в качестве символа присвоения. Значение, находящееся с правой стороны знака равенства, присваивается переменной, расположенной с левой стороны знака равенства. Следующие знаки также являются символами присвоения:
|
: |
Двоеточие используется для отделения имени параметра от значения
параметра, как показано в следующем примере:
|
! |
Восклицательный знак является логическим оператором NOT. Если он используется вместе со знаком равенства ( = ), это сочетание означает «не равно». |
[ ] |
С помощью квадратных скобок указывается индекс положения в
массиве. Например, Скобки также используются, чтобы присвоить переменной тип, как в
следующем примере: |
{ } |
В фигурные скобки заключается выражение в команде, как показано
в следующем примере: |
| |
Вертикальная черта указывает, что результат выполнения одного
командлета передается по конвейеру в другой командлет. Например,
следующая команда передает результат выполнения командлета Get-Mailbox в
командлет Set-Mailbox:
|
> |
Правая угловая скобка используется для вывода результатов
выполнения команды в файл, как показано в следующем примере:
|
>> |
Двойная правая угловая скобка означает, что результат выполнения
команды будет добавлен в файл, если этот файл существует. Если файл
не существует, создается новый файл. Ниже приведен пример
использования двойной правой угловой скобки:
|
" " |
В кавычки заключается строка, которая содержит пробелы. |
$ |
Знак доллара обозначает переменную. Например, команда
|
@ |
Знак @ указывает на связанный массив. Дополнительные сведения см. в разделе Массивы. |
$( ) |
Знак доллара ( |
.. |
Две точки указывают на диапазон значений. Например, если массив
содержит несколько индексов, с помощью следующей команды можно
возвратить значения всех индексов между вторым и пятым, как
показано в следующем примере: |
+ |
Оператор + складывает два значения. Например, |
- |
Оператор - вычитает одно значение из другого. Например,
Оператор - также может использоваться для обозначения
отрицательного значения, такого как |
* |
Подстановочный знак имеет несколько значений. С помощью
подстановочного знака можно сопоставлять строки, умножать числовые
значения; если строковые и числовые значения используются в
сочетании друг с другом, повторять указанное строковое значение
количество раз, определенное числовым значением, как показано в
следующем примере: |
/ |
Оператор / делит одно число на другое. Например, |
% |
При использовании числовой оценки оператор % возвращает
остаток от операции деления. Например, При использовании в конвейере символ процента ( Дополнительные сведения см. в разделе Передача по конвейеру. |
? |
Символ вопросительного знака ( |