Enable-CmdletExtensionAgent
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
Enable-CmdletExtensionAgent コマンドレットを使用して、既存のコマンドレット拡張エージェントを有効にします。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Enable-CmdletExtensionAgent
[-Identity] <CmdletExtensionAgentIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-WhatIf]
[<CommonParameters>] 説明
コマンドレット拡張エージェントは、Exchange Server 2010 以降の Exchange コマンドレットで使用されます。 他のMicrosoftまたはサード パーティ製品によって提供されるコマンドレットでは、コマンドレット拡張エージェントを使用できません。
コマンドレット拡張エージェントを有効にすると、エージェントは組織内のすべての Exchange サーバーで実行されます。 有効にしたエージェントはコマンドレットから使用可能になり、コマンドレットはそのエージェントを使用して追加の操作を実行できます。
エージェントを有効にする場合は、その前に、エージェントの動作とエージェントが組織に与える影響を把握してください。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Enable-CmdletExtensionAgent "Scripting Agent"この例では、Scripting Agent というコマンドレット拡張エージェントを有効にします。 スクリプト エージェントを有効にする前に、%ExchangeInstallPath%Bin\CmdletExtensionAgents\ScriptingAgentConfig.xml.sample ファイルを構成し、組織内のすべての Exchange サーバーでScriptingAgentConfig.xmlに名前を変更する必要があります。 変更しないと、Get 以外のコマンドレットがすべて失敗します。
パラメーター
-Confirm
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- 破壊的なコマンドレット (Remove-* コマンドレットなど) には、続行する前にコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (New-* コマンドレットや Set-* コマンドレットなど) には、一時停止が組み込まれています。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-DomainController
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Identity
Identity パラメーターは、有効にする無効なコマンドレット拡張エージェントを指定します。 エージェントを一意に識別する任意の値を使用できます。 たとえば、次のように入力します。
- 名前
- 識別名 (DN)
- GUID
| Type: | CmdletExtensionAgentIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-WhatIf
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。