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

Последнее изменение раздела: 2010-01-14

Многие командлеты используют параметры. Параметры – это элементы, которые предоставляют командлету определенную информацию. Это могут быть данные, которые идентифицируют объект и его атрибуты и которые необходимы для работы командлета. Это также могут быть данные, которые позволяют определить, каким образом командлет будет выполнять ту или иную задачу. Перед именем параметра ставится знак дефиса (-), а после имени указывается значение самого параметра:

Скопировать код
Verb-Noun -ParameterName <ParameterValue> 

В приведенном выше примере дефис, стоящий перед именем параметра, сообщает командной консоли Exchange о том, что слово, которое указано после дефиса, является параметром командлета и что следующее после параметра слово – это значение самого параметра.

В данном разделе рассматриваются следующие параметры и их поведение в командной консоли:

Позиционные параметры

Логические параметры

Параметры-переключатели

Общие параметры

Позиционные параметры

Позиционный параметр – это такой параметр, значение которого можно использовать, не указывая при этом имени самого параметра. Параметр является позиционным, если атрибут Parameter Position представлен целым числом. Это число указывает место (позицию) командлета в командной строке, по которому находится значение этого параметра. Дополнительные сведения о различных атрибутах, которые образуют параметр, см. в разделе Подробные сведения о параметре.

У большинства командлетов есть только один позиционный параметр, Identity. Identity, если он доступен для командлета, он всегда находится в позиции 1. Некоторые командлеты имеют несколько позиционных параметров. С помощью данных командлетов можно указать значения для каждого позиционного параметра в порядке, указанном атрибутом Parameter Position для каждого параметра. Для надлежащего функционирования значения для каждого параметра должны быть правильно расположены в командной строке.

Если параметр не является позиционным, то он считается параметром named. Для параметров типа named необходимо указывать имя параметра и его значение.

С помощью следующих двух команд выполняется задача по возврату сведений о конфигурации для получающего соединителя, который называется "Contoso".

Скопировать код
Get-ReceiveConnector -Identity "Contoso"
Get-ReceiveConnector "Contoso"

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

Скопировать код
Set-ExampleCmdlet "Seattle Users" $True "Contoso.com"
Set-ExampleCmdlet -Name "Seattle Users" -Enabled $True -Domain "Contoso.com"

Подробные сведения о параметре

Атрибуты для каждого параметра, также известные как метаданные, приведены в разделе ПАРАМЕТРЫ справки командной консоли. Доступ к ней можно получить с помощью командлета 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. Не все командлеты имеют такие подробные сведения. Однако большинство командлетов включает в себя настройки для каждого параметра (см. таблицу ниже).

Свойства параметра

Свойство Описание

Required?

Указывает, будет ли выполняться командлет в том случае, если пользователь не укажет параметр. Если для параметра Required? указано значение True, в командной консоли будет предложено ввести значение, если параметр не был задан в командной строке.

Position?

Указывает, следует ли перед значением параметра указывать имя параметра. Если для параметра Position? установлено значение Named, требуется указать имя параметра.

Если значением Position? является целое число, требуется указать только значение, а имя указывать необязательно.

Default value

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

Accept pipeline input?

Указывает, может ли параметр получить значение, используя для этого данные, возвращаемые другим командлетом.

Accept wildcard characters?

Указывает, может ли значение параметра содержать подстановочные знаки и применяться к нескольким объектам.

Логические параметры

Логические параметры используются в командной консоли, чтобы определить, включена определенная функция или значение ($True) или отключена ($False) Значение, задаваемое для логического параметра, сохраняется в конфигурации объекта, в который вносятся изменения. При установке значения логического параметра могут быть использованы следующие значения: $True , 1, $False , 0. Знак доллара ($) необходимо использовать со значениями $True и $False. В некоторых командах используется знак двоеточия (:), который разделяет имя и значение логического параметра. Для логических параметров этот знак указывать необязательно. Данный пример демонстрирует отключение получающего соединителя "Contoso.com":

Скопировать код
Set-ReceiveConnector "Contoso.com" -Enabled $False

Параметры-переключатели

Параметры-переключатели обычно используются, чтобы указать, должна ли текущая команда отправить дополнительные запросы или активировать другой параметр для запуска команды. Состояние между выполняемыми командами не сохраняется. Параметры-переключатели имеют сходство с логическими параметрами, но при этом используются для других целей и требуют другой синтаксис. Для параметров-переключателей не требуется значение. При указании параметра-переключателя в командной строке без значения по умолчанию будет установлено $True.

Некоторые командлеты могут быть запущены, как если бы параметр-переключатель был включен в командную строку, даже если пользователь не выполнял этого действия. Такое поведение обычно обусловлено использованием параметра-переключателя Confirm для командлетов, случайный запуск которых может привести к потере данных. При использовании параметра-переключателя Confirm такой командлет всегда будет запрашивать подтверждение перед запуском, если пользователь явно не задал для командлета другое поведение, переопределяющее параметр-переключатель. Переопределить параметр-переключатель можно, указав в командной строке параметр-переключатель Confirm со значением :$False. В отличие от других параметров, между параметрами-переключателями и значением $False необходимо использовать знак двоеточия (:).

В первом примере показан код, при использовании которого командлет Start-EdgeSynchronization выведет на экран запрос подтверждения перед запуском синхронизации EdgeSync. Во втором примере для командлета Remove-ReceiveConnector установлен запрет на вывод запроса подтверждения, который должен отображаться перед удалением получающего соединителя "Contoso.com":

Скопировать код
Start-EdgeSynchronization -Confirm
Remove-ReceiveConnector "Contoso.com" -Confirm:$False

Общие параметры

Общими параметрами называются параметры, которые автоматически добавляются в командной консоли ко всем командам. Эти параметры выполняют функции, которые могут использоваться с командами, к которым эти параметры применяются. В следующей таблице перечислены все общие параметры, имеющиеся в командной консоли. С командлетами можно также использовать три дополнительных параметра: WhatIf, Confirm и ValidateOnly. Для получения дополнительных сведений об этих трех параметрах см. раздел Параметры WhatIf, Confirm и ValidateOnly.

Общие параметры командной консоли Exchange

Имя параметра Обязательный Тип Описание

Debug

Дополнительный

System.Boolean

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

ErrorAction

Дополнительный

System.Enum

Параметр ErrorAction управляет поведением команды при возникновении ошибки. Имеются следующие значения:

  • Continue (значение, заданное по умолчанию)

  • Stop

  • SilentContinue

  • Inquire (запрашивает пользователя о дальнейших действиях)

ErrorVariable

Необязательный

System.String

Параметр ErrorVariable задает имя переменной, используемое командой для записи ошибок, возникших в процессе обработки. Эта переменная добавляется вместе с переменной $ERROR.

OutVariable

Необязательный

System.String

Параметр OutVariable задает имя переменной, используемое командой для объектов, являющихся результатами выполнения команды. Это действие эквивалентно передаче (конвейеризации) команды в Set-Variable <name> -Passthru:$true.

Verbose

Необязательный

System.Boolean

Параметр Verbose указывает, что команда должна предоставить подробные сведения о выполняемой операции.

Примечание.
Большинство командлетов Get возвращают сводные данные, содержащие наиболее часто используемые свойства, только в том случае, если они выполняются пользователем. Для того чтобы командлет Get возвращал все свойства объекта, необходимо передать выходные данные команды командлету Format-List.

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

Дополнительные сведения