Enable-CmdletExtensionAgent

Модуль:
Exchange PowerShell

Этот командлет доступен только в локальной среде Exchange.

Командлет Enable-CmdletExtensionAgent используется для включения существующих агентов расширения командлетов.

Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.

Синтаксис

Default (По умолчанию) 

Enable-CmdletExtensionAgent
    [-Identity] <CmdletExtensionAgentIdParameter>
    [-Confirm]
    [-DomainController <Fqdn>]
    [-WhatIf]
    [<CommonParameters>]

Описание

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

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

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

Для его запуска необходимо получить соответствующие разрешения. Хотя в этой статье перечислены все параметры командлета, у вас может не быть доступа к некоторым параметрам, если они не включены в назначенные вам разрешения. Сведения о необходимых разрешениях для запуска командлетов и использования параметров в организации см. в статье Find the permissions required to run any Exchange cmdlet.

Примеры

Пример 1

Enable-CmdletExtensionAgent "Scripting Agent"

В этом примере показано включение агента расширения командлетов с именем Scripting Agent. Прежде чем включить агент сценариев, необходимо настроить %ExchangeInstallPath%Bin\CmdletExtensionAgents\ScriptingAgentConfig.xml.sample файл и переименовать ScriptingAgentConfig.xml его на всех серверах Exchange Server в вашей организации. Если вы не настроите файл, все командлеты, не относящиеся к Get, не будут работать.

Параметры

-Confirm

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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

  • Деструктивные командлеты (например, командлеты Remove-) имеют встроенную паузу, которая заставляет вас подтвердить команду перед продолжением. Можно пропускать запросы на подтверждение этих командлетов, используя следующий синтаксис: -Confirm:$false.
  • Большинство других командлетов (например, командлеты New- и Set-) не имеют встроенной паузы. Для этих командлетов указание параметра Confirm без значения приводит к паузе, которая вынуждает вас подтвердить команду перед продолжением.

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

Тип:SwitchParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:cf

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-DomainController

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр DomainController указывает контроллер домена, который используется этим командлетом для чтения или записи данных в Active Directory. Вы определяете контроллер домена по его полному доменному имени (FQDN). Например, dc01.contoso.com.

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

Тип:Fqdn
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Identity

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр Identity указывает отключенный агент расширения командлета, который вы хотите включить. Вы можете использовать любое значение, однозначно определяющее агент. Например:

  • имя;
  • различающееся имя (DN);
  • GUID

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

Тип:CmdletExtensionAgentIdParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:1
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-WhatIf

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Переключатель WhatIf показывает, что команда делает без каких-либо изменений. С этим параметром не нужно указывать значение.

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

Тип:SwitchParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:wi

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в статье about_CommonParameters.

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

Input types

Чтобы просмотреть типы входных данных, которые принимает этот командлет, см. Типы входных и выходных данных командлета. Если поле "Типы входных данных" для командлета пусто, командлет не принимает входные данные.

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

Output types

Чтобы просмотреть типы возвращаемых данных, также называемые типами вывода, которые принимает этот командлет, см. раздел Типы ввода и вывода командлета. Если поле "Типы выходных данных" пусто, командлет не возвращает данные.