Многие командлеты используют параметры. Параметры – это элементы, которые предоставляют командлету определенную информацию. Это могут быть данные, которые идентифицируют объект и его атрибуты и которые необходимы для работы командлета. Это также могут быть данные, которые позволяют определить, каким образом командлет будет выполнять ту или иную задачу. Перед именем параметра ставится знак дефиса (-), а после имени указывается значение самого параметра:
Копировать код | |
---|---|
Verb-Noun -ParameterName <ParameterValue> |
В приведенном выше примере дефис, стоящий перед именем параметра, сообщает среде управления Exchange о том, что слово, которое указано после дефиса, является параметром командлета и что следующее после параметра слово – это значение самого параметра.
Позиционные параметры
Позиционный параметр – это такой параметр, значение
которого можно использовать не указывая при этом имени самого
параметра. Параметр является позиционным, если атрибут
Parameter Position
представлен целым числом. Это число
указывает место (позицию) командлета в командной строке, по
которому находится значение этого параметра.
Большая часть командлетов имеют только один позиционный
параметр – Identity. Если командлет имеет параметр
Identity, то этот параметр всегда имеет позицию
1
. Если параметр не является позиционным, то такой
параметр считается named
параметром. Для параметров
такого типа необходимо указывать имя параметра и его значение.
Приведенные ниже команды используются для выполнения
одной и той же задачи – для возврата сведений о конфигурации для
получающего соединителя, который называется
"Contoso"
.
Копировать код | |
---|---|
Get-ReceiveConnector -Identity "Contoso" Get-ReceiveConnector "Contoso" |
Подробные сведения о параметре
В разделе "Параметры" представлено описание информации (иначе – метаданные), которая описывает тот или иной параметр. Эту информацию можно получить используя командлет Get-Help. В приведенном ниже примере используется командлет Get-Service.
Копировать код | |
---|---|
PARAMETERS -ServiceName System.String[] Parameter required? false Parameter position? 1 Default value * Accept pipeline input? true Accept wildcard characters? True |
В этом примере, в котором рассматривается командлет Get-Service, содержится описание данных применительно к типам значений, которые могут быть переданы параметру ServiceName. Не все командлеты имеют такие подробные сведения. Однако, большинство командлетов тем не менее включают в себя настройки для каждого параметра (см. таблицу 1).
Таблица 1 Настройки параметров
Настройка | Описание |
---|---|
Required? |
Данная настройка указывает, будет ли выполняться командлет в том
случае, если пользователь не укажет параметр. Если для
Required? указано |
Position? |
Эта настройка сообщает о том, следует ли перед значением
параметра указывать имя параметра. Если для Position?
установлено Если для Position? указано число, то это означает, что требуется указать только значение, а имя указывать не нужно. |
Default value |
Данная настройка указывает на то, какое будет использовано значение по умолчанию в том случае, если не будет указано другое значение. |
Accept pipeline input? |
Данная настройка указывает, может ли параметр получить значение используя для этого данные, возвращаемые другим командлетом. |
Accept wildcard characters? |
Данная настройка указывает, может ли значение параметра содержать подстановочные знаки и применяться к нескольким объектам. |
Логические параметры
Логические параметры используются в среде
управления Exchange для того, чтобы определить, включена
($True
) или отключена ($False
) данная
функция или опция. Значение, которое задается для логического
параметра, сохраняется в конфигурации объекта, в который вносятся
изменения. При установке значения логического параметра могут быть
использованы следующие значения: $True
,
1
, $False
, 0
. Со значениями
$True
и $False
необходимо использовать
знак доллара ($
). В некоторых командах используется
знак двоеточия (:), который разделяет имя и значение логического
параметра. Для логических параметров этот знак указывать
необязательно. Данный пример демонстрирует отключение получающего
соединителя "Contoso.com":
Копировать код | |
---|---|
Set-ReceiveConnector "Contoso.com" -Enabled $False |
Параметры-переключатели
Параметры-переключатели используются в среде
управления Exchange для того, чтобы установить состояние для
последующего выполнения команды. Состояние между выполняемыми
командами не сохраняется. Параметры-переключатели имеют сходство с
логическими параметрами, но при этом используются для других целей
и имеют другой синтаксис. Для параметров-переключателей требуется
указывать какое-либо значение. Если в командной строке для
параметра-переключателя не было указано значение, тогда по
умолчанию будет принято значение $True
. Как и
логические параметры, параметры-переключатели могут иметь только
следующие значения: $True
, 1
,
$False
или 0
. Со значениями
$True
и $False
необходимо использовать
знак доллара ($
). В отличие от логических параметров,
для параметров-переключателей между именем параметра-переключателя
и его значением необходимо ставить знак двоеточия (:). В первом
примере, перед тем как запустить синхронизацию EdgeSync, среда
управления Exchange должна вывести на экран запрос подтверждения.
Во втором примере для среды управления Exchange установлен запрет
на вывод запроса подтверждения, который должен выводиться на экран
перед удалением получающего соединителя "Contoso.com":
Копировать код | |
---|---|
Start-EdgeSynchronization -Confirm Remove-ReceiveConnector "Contoso.com" -Confirm:$False |
Общие параметры
Общими параметрами называются параметры, которые автоматически добавляются в среде управления Exchange ко всем командам. Эти параметры выполняют функции, которые могут использоваться с командами, к которым эти параметры применяются. В таблице 2 перечислены все общие параметры, имеющиеся в среде управления Exchange. С командлетами можно также использовать три дополнительных параметра: WhatIf, Confirm и ValidateOnly. Для получения дополнительных сведений об этих трех параметрах см. разделПараметры WhatIf, Confirm и ValidateOnly.
Таблица 2: Общие параметры среды управления Exchange
Имя параметра | Обязательный | Тип | Описание | ||
---|---|---|---|---|---|
Verbose |
Необязательный |
System.Boolean |
При использовании данного параметра команда должна предоставить подробную информацию о выполняемой операции.
|
||
Debug |
Необязательный |
System.Boolean |
Этот параметр указывает, что команда должна предоставить об операции информацию, которая может понадобиться программисту. |
||
ErrorAction |
Необязательный |
System.Enum |
Этот параметр позволяет управлять поведением команды в момент возникновения ошибки. Имеются следующие значения:
|
||
ErrorVariable |
Необязательный |
System.String |
Данный параметр позволяет указать имя переменной, которое будет
использоваться командой для записи ошибок, возникших в процессе
обработки. Эта переменная добавляется вместе с переменной
|
||
OutVariable |
Необязательный |
System.String |
Данный параметр позволяет указать имя переменной, которое
команда будет применять к объектам, появившимся в результате
выполнения этой команды. Это действие эквивалентно передаче
(конвейеризации) команды в |