Set-ClientAccessServer
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
Set-ClientAccessServer コマンドレットを使用して、クライアント アクセス サーバーロールに関連付けられている設定を変更します。
注: Exchange 2013 以降では、代わりに Set-ClientAccessService コマンドレットを使用します。 Set-ClientAccessServer を使用するスクリプトがある場合は、Set-ClientAccessService を使用するようにスクリプトを更新します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
AlternateServiceAccount
Set-ClientAccessServer
[-Identity] <ClientAccessServerIdParameter>
[-AlternateServiceAccountCredential <PSCredential[]>]
[-CleanUpInvalidAlternateServiceAccountCredentials]
[-Confirm]
[-DomainController <Fqdn>]
[-IrmLogEnabled <Boolean>]
[-IrmLogMaxAge <EnhancedTimeSpan>]
[-IrmLogMaxDirectorySize <Unlimited>]
[-IrmLogMaxFileSize <ByteQuantifiedSize>]
[-IrmLogPath <LocalLongFullPath>]
[-IsOutOfService <Boolean>]
[-RemoveAlternateServiceAccountCredentials]
[-WhatIf]
[<CommonParameters>]
Identity
Set-ClientAccessServer
[-Identity] <ClientAccessServerIdParameter>
[-Array <ClientAccessArrayIdParameter>]
[-AutoDiscoverServiceInternalUri <Uri>]
[-AutoDiscoverSiteScope <MultiValuedProperty>]
[-Confirm]
[-DomainController <Fqdn>]
[-IrmLogEnabled <Boolean>]
[-IrmLogMaxAge <EnhancedTimeSpan>]
[-IrmLogMaxDirectorySize <Unlimited>]
[-IrmLogMaxFileSize <ByteQuantifiedSize>]
[-IrmLogPath <LocalLongFullPath>]
[-IsOutOfService <Boolean>]
[-WhatIf]
[<CommonParameters>]
説明
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Set-ClientAccessServer -Identity "MBX-01" -AutoDiscoverServiceInternalUri "https://mbx01.contoso.com/autodiscover/autodiscover.xml" -AutoDiscoverSiteScope "Mail"
次の使用例は、MBX-01 という名前のサーバー上のクライアント アクセス サービスで、Mail という名前の Active Directory サイトの内部自動検出 URL を構成します。
パラメーター
-AlternateServiceAccountCredential
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
AlternateServiceAccountCredential パラメーターは、2010 の共存環境で Kerberos 認証に通常使用される代替サービス アカウントのユーザー名とパスワードExchange Server指定します。 複数の値をコンマで区切って指定できます。
このパラメーターの値には、Get-Credential コマンドレットが必要です。 このコマンドを一時停止し、資格情報の入力を求めるメッセージを表示するには、値(Get-Credential)を使用します。 または、このコマンドを実行する前に、資格情報を変数 (たとえば、$cred = Get-Credential) に保存し、このパラメーターに変数名 ($cred) を使用します。 詳細については、Get-Credentialに関するページをご覧ください。
パラメーターのプロパティ
| 型: | PSCredential[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AlternateServiceAccount
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Array
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
このパラメーターは、Microsoft の内部使用のために予約されています。
パラメーターのプロパティ
| 型: | ClientAccessArrayIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AutoDiscoverServiceInternalUri
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
AutoDiscoverServiceInternalUri パラメーターは、自動検出サービスの内部 URL を指定します。
パラメーターのプロパティ
| 型: | Uri |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AutoDiscoverSiteScope
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
AutoDiscoverSiteScope パラメーターは、自動検出サービスが権限を持つ Active Directory サイトを指定します。 内部 URL を使用して自動検出サービスに接続するクライアントが、指定されたサイト上に存在する必要があります。
使用可能な Active Directory サイトを表示するには、Get-ADSite コマンドレットを使用します。
複数の値を指定するには、次の構文を使用します: Value1,Value2,...ValueN。 値にスペースを含める、または引用符を必要とする場合は、次の構文を使用します: "Value1","Value2",..."ValueN"。
パラメーターのプロパティ
| 型: | MultiValuedProperty |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CleanUpInvalidAlternateServiceAccountCredentials
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
CleanUpInvalidAlternateServiceAccountCredentials スイッチは、無効になっている過去に構成された代替サービス アカウントを削除するかどうかを指定します。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AlternateServiceAccount
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DomainController
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
パラメーターのプロパティ
| 型: | Fqdn |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Identity パラメーターは、変更するサーバーを指定します。 サーバーを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- 識別名 (DN)
- FQDN
- GUID
パラメーターのプロパティ
| 型: | ClientAccessServerIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-IrmLogEnabled
適用対象: Exchange Server 2010
このパラメーターは Exchange Server 2010 でのみ使用できます。
IrmLogEnabled パラメーターは、Information Rights Management (IRM) に対してログ記録を有効にするかどうかを指定します。 有効な値は $true または $false です。 既定値は $true です。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IrmLogMaxAge
適用対象: Exchange Server 2010
このパラメーターは Exchange Server 2010 でのみ使用できます。
IrmLogMaxAge パラメーターは、IRM ログの最大有効期間を指定します。 指定した値より古いログが削除されます。
値を指定するには、dd.hh:mm:ss の形式で期間として入力します。ここで、d = 日、h = 時間、m = 分、s = 秒です。
たとえば、15 時間の間隔を指定するには、「15:00:00」と入力します。 既定値は 30 日 (30.00:00:00) です。
パラメーターのプロパティ
| 型: | EnhancedTimeSpan |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IrmLogMaxDirectorySize
適用対象: Exchange Server 2010
このパラメーターは Exchange Server 2010 でのみ使用できます。
IrmLogMaxDirectorySize パラメーターは、IRM ログの最大ディレクトリ サイズを指定します。 ディレクトリの最大サイズに達すると、サーバーは最初に古いログ ファイルを削除します。
有効値は、909.5 テラバイト (999999999999999 バイト) までの数値、または値の unlimited です。 既定値は、250 メガバイト (262144000 バイト) です。
値を入力するときは、値に以下の単位のいずれかを付加した形式で記述します。
- B (バイト)
- KB (キロバイト)
- MB (メガバイト)
- GB (ギガバイト)
- TB (テラバイト)
通常、非修飾値はバイトとして扱われますが、小さな値は最も近いキロバイトに切り上げられます。
パラメーターのプロパティ
| 型: | Unlimited |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IrmLogMaxFileSize
適用対象: Exchange Server 2010
このパラメーターは Exchange Server 2010 でのみ使用できます。
IrmLogMaxFileSize パラメーターは、IRM ログの最大サイズを指定します。 この値は、IrmLogMaxDirectorySize パラメーター値より大きくすることはできません。
有効な値は、最大 4 ギガバイト (4294967296 バイト) までの数値です。 既定値は、10 メガバイト (10485760 バイト) です。
値を入力するときは、値に以下の単位のいずれかを付加した形式で記述します。
- B (バイト)
- KB (キロバイト)
- MB (メガバイト)
- GB (ギガバイト)
通常、非修飾値はバイトとして扱われますが、小さな値は最も近いキロバイトに切り上げられます。
このパラメーターの値は、ReceiveProtocolLogMaxDirectorySize パラメーターの値以下である必要があります。
パラメーターのプロパティ
| 型: | ByteQuantifiedSize |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IrmLogPath
適用対象: Exchange Server 2010
このパラメーターは Exchange Server 2010 でのみ使用できます。
IrmLogPath パラメーターは、IRM ログ ファイルの場所を指定します。 既定の場所は %ExchangeInstallPath%Logging\IRMLogs です。
このパラメーターの値を $null に設定すると、IRM ログを効果的に無効にします。 ただし、IrmLogEnabled パラメーターの値が$trueされている場合、Exchange はアプリケーション イベント ログにエラーを追加します。 IRM ログを無効にする推奨される方法は、IrmLogEnabled パラメーターを $false に設定することです。
パラメーターのプロパティ
| 型: | LocalLongFullPath |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IsOutOfService
適用対象: Exchange Server 2010
このパラメーターは Exchange Server 2010 でのみ使用できます。
このパラメーターは、Microsoft の内部使用のために予約されています。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RemoveAlternateServiceAccountCredentials
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
RemoveAlternateServiceAccountCredentials スイッチは、過去に配布された代替サービス アカウントを削除するかどうかを指定します。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AlternateServiceAccount
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。