Set-CsProxyConfiguration
トピックの最終更新日: 2012-03-27
プロキシ サーバー構成設定の既存のコレクションを変更します。UNRESOLVED_TOKEN_VAL(ps-intro-in-LS2010)
構文
Set-CsProxyConfiguration [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Set-CsProxyConfiguration [-Instance <PSObject>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-AcceptClientCompression <$true | $false>] [-AcceptServerCompression <$true | $false>] [-AllowPartnerPollingSubscribes <$true | $false>] [-Confirm [<SwitchParameter>]] [-DisableNtlmFor2010AndLaterClients <$true | $false>] [-DnsCacheRecordCount <UInt32>] [-EnableLoggingAllMessageBodies <$true | $false>] [-EnableWhiteSpaceKeepAlive <$true | $false>] [-Force <SwitchParameter>] [-LoadBalanceEdgeServers <$true | $false>] [-LoadBalanceInternalServers <$true | $false>] [-MaxClientCompressionCount <UInt32>] [-MaxClientMessageBodySizeKb <UInt32>] [-MaxKeepAliveInterval <UInt32>] [-MaxServerCompressionCount <UInt32>] [-MaxServerMessageBodySizeKb <UInt32>] [-OutgoingTlsCount <UInt32>] [-Realm <IRealmChoice>] [-RequestServerCompression <$true | $false>] [-TestFeatureList <String>] [-TestParameterList <String>] [-TreatAllClientsAsRemote <$true | $false>] [-UseCertificateForClientToProxyAuth <$true | $false>] [-UseKerberosForClientToProxyAuth <$true | $false>] [-UseNtlmForClientToProxyAuth <$true | $false>] [-WhatIf [<SwitchParameter>]]
例
例 1
例 1 では、service:EdgeServer:atl-edge-001.litwareinc.com という ID を持つすべてのプロキシ構成設定が、サーバー圧縮を受け入れるように変更されます。これを行うため、AcceptServerCompression パラメーターを True にして指定し、Set-CsProxyConfiguration コマンドレットを呼び出します。
Set-CsProxyConfiguration -Identity service:EdgeServer:atl-edge-001.litwareinc.com -AcceptServerCompression $True
例 2
例 2 では、サーバー圧縮を受け入れるすべてのプロキシ構成設定が検出され、クライアント圧縮も受け入れるようにそれらの設定が変更されます。これを行うため、このコマンドはまずパラメーターを何も指定せずに Get-CsProxyConfiguration コマンドレットを呼び出し、組織で使用中のすべてのプロキシ設定のコレクションを戻します。次に、このコレクションは Where-Object コマンドレットにパイプ処理され、AcceptServerCompressio プロパティが True と等しい設定のみを選択します。このフィルター処理されたコレクションは Set-CsProxyConfiguration コマンドレットにパイプ処理され、コレクション内の各項目の AcceptClientCompression プロパティが True に設定されます。
Get-CsProxyConfiguration | Where-Object {$_.AcceptServerCompression -eq $True} | Set-CsProxyConfiguration -AcceptClientCompression $True
例 3
例 3 は、サービス スコープで構成されているすべてのプロキシ設定を変更する方法を示しています。これを行うため、このコマンドはまず Filter パラメーターを指定して Get-CsProxyConfiguration コマンドレットを呼び出します。フィルター値 "service:*" により、ID が文字列値 "service:" で始まる設定のみが返されます。このフィルター処理されたコレクションは Set-CsProxyConfiguration コマンドレットにパイプ処理され、コレクション内の各項目の UseNtlmForClientToProxyAuth プロパティが False に設定されます。
Get-CsProxyConfiguration -Filter service:* | Set-CsProxyConfiguration -UseNtlmForClientToProxyAuth $False
解説
Lync Server により、プロキシ サーバー構成設定を使用してプロキシ サーバーを管理できます。この設定はグローバル スコープとサービス スコープ (ただし、エッジ サーバーおよびレジストラー サービスのみが対象) の両方で適用でき、クライアント エンドポイントが使用できる認証プロトコルや、プロキシ サーバーの送受信接続での圧縮の使用の有無などを制御できます。Lync Server をインストールすると、プロキシ サーバーの構成設定のグローバル コレクションが自動的に作成されます。既に説明したように、サービス スコープで追加のコレクションを作成することもできます。
Set-CsProxyConfiguration コマンドレットにより、プロキシ サーバー構成設定の既存コレクションのプロパティ値を変更することができます。
このコマンドレットを実行できるメンバー。既定では、次のグループのメンバーが、Set-CsProxyConfiguration コマンドレットをローカルで実行することを承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsProxyConfiguration"}
パラメーター
パラメーター | 必須かどうか | 型 | 説明 |
---|---|---|---|
AcceptClientCompression |
省略可能 |
System.Boolean |
True (既定値) に設定すると、プロキシ サーバーはクライアント エンドポイントからの着信圧縮要求をすべて受け入れます。 |
AcceptServerCompression |
省略可能 |
System.Boolean |
True (既定値) に設定すると、プロキシ サーバーは他のサーバーからの着信圧縮要求をすべて受け入れます。 |
AllowPartnerPollingSubscribes |
省略可能 |
System.Boolean |
True に設定すると、パートナー アプリケーションは周期的に状態変化をサービスにポーリングすることができます。既定値は False ($False) です。 |
Confirm |
省略可能 |
System.Management.Automation.SwitchParameter |
コマンドの実行前に確認メッセージを表示します。 |
DisableNtlmFor2010AndLaterClients |
省略可能 |
System.Boolean |
True に設定すると、Lync からログオンするユーザーは認証で Kerberos プロトコルを使用する必要があります。既定値は False です。 |
DnsCacheRecordCount |
省略可能 |
System.UInt32 |
DNS レコード キャッシュで管理できるレコードの最大数。既定値は 3000 です。 |
EnableLoggingAllMessageBodies |
省略可能 |
System.Boolean |
True に設定すると、Lync Server はすべてのインスタント メッセージの実際の内容を記録します。プライバシーを守るため、通常はメッセージの内容を削除し、通信のエンドポイントに関する情報のみをログ ファイルに記録します。 既定値は False です。 |
EnableWhiteSpaceKeepAlive |
省略可能 |
System.Boolean |
True (既定値) に設定すると、プロキシ サーバーは、クライアントが定期的に "空白メッセージ" (内容のない空のメッセージ) を送信して接続がアクティブのまま維持されていることを示すよう予期します。 |
Force |
省略可能 |
System.Management.Automation.SwitchParameter |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
Identity |
省略可能 |
Microsoft.Rtc.Management.Xds.XdsIdentity |
変更するプロキシ サーバー構成設定の一意の識別子。グローバル設定を変更するには、次の構文を使用します。-Identity global。サービス スコープで構成された設定を変更するには、次のような構文を使用します。-Identity "service:EdgeServer:atl-edge-001.litwareinc.com"。 このパラメーターを指定しない場合、Set-CsProxyConfiguration コマンドレットは自動的にグローバル設定を変更します。 |
Instance |
省略可能 |
ProxySettings オブジェクト |
個々のパラメーター値を設定するのではなく、オブジェクトへの参照をコマンドレットに渡せるようにします。 |
LoadBalanceEdgeServers |
省略可能 |
System.Boolean |
True に設定すると、エッジ サーバーへの要求に、ソフトウェアによる負荷分散を使用します。既定値は True ($True) です。 |
LoadBalanceInternalServers |
省略可能 |
System.Boolean |
True に設定すると、レジストラーおよびその他の内部サーバーへの要求に、ソフトウェアによる負荷分散を使用します。既定値は True ($True) です。 |
MaxClientCompressionCount |
省略可能 |
System.UInt32 |
任意の時点での圧縮可能なクライアントとサーバー間接続の最大数を示します。この制限数を超えた追加接続は圧縮されません。圧縮数は、0 ~ 65535 の範囲の整数に設定できます。既定値は 15000 です。 |
MaxClientMessageBodySizeKb |
省略可能 |
System.UInt32 |
クライアント エンドポイントから送信されるメッセージ本文の最大許容サイズ (キロバイト)。既定値は 128 で、これは、本文のサイズが 128 KB を超えるメッセージは拒否されることを意味します。クライアント メッセージの本文サイズは、64 ~ 256 の範囲の整数値に設定できます。 |
MaxKeepAliveInterval |
省略可能 |
System.UInt32 |
サーバーがクライアントとの接続がまだ有効であることを確認するまでの経過時間 (分) を指定します。既定値は 20 分です。 |
MaxServerCompressionCount |
省略可能 |
System.UInt32 |
任意の時点での圧縮可能なサーバー間接続の最大数を示します。この制限数を超えた追加接続は圧縮されません。サーバー圧縮数は、0 ~ 65535 の範囲の整数に設定できます。既定値は 1024 です。 |
MaxServerMessageBodySizeKb |
省略可能 |
System.UInt32 |
別のサーバーから送信されるメッセージ本文の最大許容サイズ (キロバイト)。既定値は 5000 で、これは、本文のサイズが 5000 KB を超えるメッセージは拒否されることを意味します。サーバー メッセージの本文サイズは、1000 ~ 20000 の範囲の整数値に設定できます。 |
OutgoingTlsCount |
省略可能 |
System.UInt32 |
各内部サーバーで使用できるトランスポート層セキュリティ (TLS) 接続の最大数を指定します。TLS 接続の最小数は 1、最大数は 4 です。OutgoingTlsCount は既定で 4 に設定されます。 |
Realm |
省略可能 |
Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.IRealmChoice |
セキュリティ資格情報が、既定のプロキシ サーバー領域 (SIP Communications Services) とカスタム領域のどちらで処理されるのかを示します。カスタム領域は、New-CsSipProxyCustom コマンドレットを使用して指定 (および作成) する必要があります。 |
RequestServerCompression |
省略可能 |
System.Boolean |
True (既定値) に設定すると、プロキシ サーバーは他のサーバーへの発信接続すべてにおいて圧縮を使用するよう要求します。 |
TestFeatureList |
省略可能 |
System.String |
PARAMVALUE: String |
TestParameterList |
省略可能 |
System.String |
PARAMVALUE: String |
TreatAllClientsAsRemote |
省略可能 |
System.Boolean |
True に設定すると、プロキシ サーバーは、すべてのクライアント接続が エッジ サーバー を通過する外部接続であるかのように機能します。既定値は False です。 |
UseCertificateForClientToProxyAuth |
省略可能 |
System.Boolean |
True (既定値) に設定すると、クライアント エンドポイントは、認証の際に証明書を使用することを許可されます。 |
UseKerberosForClientToProxyAuth |
省略可能 |
System.Boolean |
True (既定値) に設定すると、クライアント エンドポイントは、認証の際に Kerberos プロトコルを使用することを許可されます。Kerberos は NTML よりセキュアなプロトコルですが、クライアントがサーバーとは異なる領域に属していると使用できません。 |
UseNtlmForClientToProxyAuth |
省略可能 |
System.Boolean |
True (既定値) に設定すると、クライアント エンドポイントは、認証の際に NTLM プロトコルを使用することを許可されます。NTLM は Kerberos よりセキュアではないプロトコルですが、クライアントがサーバーとは異なるドメインに属していても使用することができます。この点は、Kerberos 認証の場合と異なります。 |
WhatIf |
省略可能 |
System.Management.Automation.SwitchParameter |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings オブジェクト。Set-CsProxyConfiguration コマンドレットは、プロキシ設定オブジェクトのパイプ処理されたインスタンスを受け入れます。
戻り値の種類
Set-CsProxyConfiguration コマンドレットを実行しても値やオブジェクトが戻されることはありません。代わりに、Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings オブジェクトのインスタンスが構成されます。