New-CsProxyConfiguration
トピックの最終更新日: 2012-03-26
プロキシの構成設定の新しいコレクションを作成します。UNRESOLVED_TOKEN_VAL(ps-intro-in-LS2010)
構文
New-CsProxyConfiguration -Identity <XdsIdentity> [-AcceptClientCompression <$true | $false>] [-AcceptServerCompression <$true | $false>] [-AllowPartnerPollingSubscribes <$true | $false>] [-Confirm [<SwitchParameter>]] [-DisableNtlmFor2010AndLaterClients <$true | $false>] [-DnsCacheRecordCount <UInt32>] [-EnableLoggingAllMessageBodies <$true | $false>] [-EnableWhiteSpaceKeepAlive <$true | $false>] [-Force <SwitchParameter>] [-InMemory <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 では、サービス EdgeServer:atl-edge-001.litwareinc.com のプロキシの構成設定の新しいコレクションを作成しています。これらの新しい設定では、2 つを除いて、プロキシ サーバーのプロパティの既定値がすべて使用されます。例外の 2 つは、True に設定される RequestServerCompression と 256 に設定される MaxClientMessageBodySizeKb です。プロキシ サーバーの設定が既にサービス EdgeServer:atl-edge-001.litwareinc.com に対して構成されている場合、このコマンドは失敗することに注意してください。
New-CsProxyConfiguration -Identity "service:EdgeServer:atl-edge-001.litwareinc.com" -RequestServerCompression $True -MaxClientMessageBodySizeKb 256
例 2
例 2 に示すコマンドでは、作成当初はメモリ内のみに存在するプロキシ サーバーの設定のコレクションを作成する方法を示しています。これを実行するために、最初のコマンドは、New-CsProxyConfiguration コマンドレットを次の 2 つのパラメーターと共に呼び出します。Identity (設定の ID を指定します)、および InMemory (新しい設定をメモリ内のみに作成する必要があることを示します)。結果のオブジェクトは、変数 $x に保存されます。
仮想の設定が作成されたら、2 番目と 3 番目のコマンドを使用して、RequestServerCompression および MaxClientMessageBodySizeKb プロパティの値をそれぞれ変更します。最後に、4 番目のコマンドを使用して、仮想のプロキシ サーバーの構成設定をサービス EdgeServer:atl-edge-001.litwareinc.com に適用する設定の実際のコレクションに変更します。最後のコマンドは必須です。Set-CsProxyConfiguration コマンドレットを呼び出さない場合、EdgeServer:atl-edge-001.litwareinc.com に適用される設定はありません。また、Windows PowerShell セッションを終了するか、変数 $x を削除すると、直ちに仮想の設定は失われます。
$x = New-CsProxyConfiguration -Identity "service:EdgeServer:atl-edge-001.litwareinc.com" -InMemory
$x.RequestServerCompression = $True
$x.MaxClientMessageBodySizeKb = 256
Set-CsProxyConfiguration -Instance $x
解説
Lync Server により、プロキシ サーバー構成設定を使用してプロキシ サーバーを管理することができます。この構成設定はグローバル スコープとサービス スコープ (ただし、エッジ サーバー およびレジストラー サービスに限ります) の両方で適用でき、クライアント エンドポイントが使用できる認証プロトコルや、プロキシ サーバーの送受信接続での圧縮の使用の有無などを制御できます。Lync Server をインストールすると、プロキシ サーバーの構成設定のグローバル コレクションが自動的に作成されます。既に説明したように、サービス スコープで追加のコレクションを作成することもできます。これらの新しいコレクションは、New-CsProxyConfiguration コマンドレットを使用して作成します。
このコマンドレットを実行できるユーザー: 既定では、次のグループのメンバーが New-CsProxyConfiguration コマンドレットをローカルで実行することを承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsProxyConfiguration"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
必須 |
Microsoft.Rtc.Management.Xds.XdsIdentity |
作成するプロキシ サーバー構成設定の一意の識別子。プロキシ サーバーの構成設定はサービス スコープでのみ作成できます。また作成の対象は、エッジ サーバー とレジストラー サービスのみです。グローバル スコープでは設定を作成できません。同様に、既に対象のサービスでプロキシ サーバー設定のコレクションがホストされている場合は、サービス スコープで設定を作成できません。たとえば、既に Registrar:atl-cs-001.litwareinc.com サービスでプロキシ サーバー設定がホストされている場合、このサービスに対して新しい設定を作成するコマンドはすべて失敗します。 新しいプロキシ サーバー設定に ID を指定するには、次のような構文を使用します。-Identity "service:Registrar:atl-cs-001.litwareinc.com"。 |
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 に設定すると、Microsoft Lync Server はすべてのインスタント メッセージの実際の内容を記録します。プライバシーを守るため、通常はメッセージの内容を削除し、通信のエンドポイントに関する情報のみをログ ファイルに記録します。 既定値は False です。 |
EnableWhiteSpaceKeepAlive |
省略可能 |
System.Boolean |
True (既定値) に設定すると、プロキシ サーバーは、クライアントが定期的に "空白 メッセージ" (内容のない空のメッセージ) を送信して接続がアクティブのまま維持されていることを示すよう期待します。 |
Force |
省略可能 |
System.Management.Automation.SwitchParameter |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
InMemory |
省略可能 |
System.Management.Automation.SwitchParameter |
永続的な変更としてオブジェクトをコミットせずに、オブジェクト参照を作成します。このパラメーターを指定して呼び出したコマンドレットの出力を変数に割り当てる場合、オブジェクト参照のプロパティを変更し、コマンドレットに対応する Set- コマンドレットを呼び出してそれらの変更をコミットできます。 |
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 Service) とカスタム領域のどちらで処理されるのかを示します。カスタム領域は、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 |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
入力の種類
なし。New-CsProxyConfiguration コマンドレットは、パイプ処理された入力を受け入れません。
戻り値の種類
New-CsProxyConfiguration コマンドレットは、Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings オブジェクトの新しいインスタンスを作成します。