Set-ServerComponentState
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
Set-ServerComponentState コマンドレットを使用して、指定したサーバー上の Microsoft Exchange コンポーネントとエンドポイントを構成および更新します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Set-ServerComponentState
[-Identity] <ServerIdParameter>
-Component <String>
-Requester <String>
-State <ServiceState>
[-Confirm]
[-DomainController <Fqdn>]
[-LocalOnly]
[-RemoteOnly]
[-TimeoutInSeconds <Int32>]
[-WhatIf]
[<CommonParameters>] 説明
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Set-ServerComponentState -Identity MailboxServer01 -Component UMCallRouter -Requester Maintenance -State Activeこの例では、保守モードによる要求に応じて、ユニファイド メッセージング (UM) コンポーネントの状態をアクティブに設定します。
例 2
Set-ServerComponentState -Identity Exch5 -Component ServerWideOffline -State Inactive -Requester Maintenance
Set-ServerComponentState -Identity Exch5 -Component ServerWideOffline -State Active -Requester Maintenanceこの例では、セキュリティ更新プログラムや累積的な更新プログラムのインストールなど、メンテナンスのためにサーバーを準備します。
最初のコマンドは、すべてのサーバー コンポーネントの状態を非アクティブに変更します。
2 番目のコマンドは、メンテナンスが終了した後に状態を [アクティブ] に変更します (必須)。
注: Microsoft Exchange IMAP4 および Microsoft Exchange POP3 サービスは、関連する ImapProxy および PopProxy コンポーネントが非アクティブ状態の場合に停止します。 関連する ImapProxy と PopProxy コンポーネントがアクティブ状態に変更された後、サービスを手動で再起動することが必要になる場合があります。
パラメーター
-Component
Component パラメーターは、状態を設定するコンポーネントまたはエンドポイントを指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
| 適用対象: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Confirm
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
| 適用対象: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-DomainController
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
DomainController パラメーターは、エッジ トランスポート サーバーではサポートされません。 エッジ トランスポート サーバーは、Active Directory ライトウェイト ディレクトリ サービス (AD LDS) のローカル インスタンスを使用してデータの読み書きを行います。
| 型: | Fqdn |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
| 適用対象: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Identity
Identity パラメーターは、このコマンドを実行する Exchange サーバーを指定します。 サーバーを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- FQDN
- 識別名 (DN)
- Exchange の従来の DN
| 型: | ServerIdParameter |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
| 適用対象: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-LocalOnly
LocalOnly スイッチは、変更が Exchange サーバーのレジストリにのみ書き込まれ、Active Directory には書き込まれないように指定します。 このスイッチで値を指定する必要はありません。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
| 適用対象: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-RemoteOnly
RemoteOnly スイッチは、変更が Active Directory にのみ書き込まれ、Exchange サーバーのレジストリには書き込まれないように指定します。 このスイッチで値を指定する必要はありません。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
| 適用対象: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Requester
Requester パラメーターは、この状態の変更を要求するシステムを指定します。 有効な値は次のとおりです。
- HealthAPI
- 保守
- 欠場
- 機能的な
- 展開
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
| 適用対象: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-State
State パラメーターは、コンポーネントに必要な状態を指定します。 有効な値は次のとおりです。
- アクティブ
- 非アクティブ
- 排水
| 型: | ServiceState |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
| 適用対象: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-TimeoutInSeconds
このパラメーターは、Microsoft の内部使用のために予約されています。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
| 適用対象: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-WhatIf
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
| 適用対象: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。