Get-CsProxyConfiguration
トピックの最終更新日: 2012-03-23
組織内で現在使用されているプロキシ サーバーの構成設定に関する情報を戻します。
構文
Get-CsProxyConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsProxyConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]
解説
Microsoft Lync Server 2010 では、プロキシ サーバーの構成設定によってプロキシ サーバーを管理できます。この構成設定はグローバル スコープとサービス スコープ (ただし、エッジ サーバー およびレジストラー サービスに限ります) の両方で適用でき、クライアント エンドポイントが使用できる認証プロトコルや、プロキシ サーバーの送受信接続での圧縮の使用の有無などを制御できます。Lync Server 2010 をインストールすると、プロキシ サーバーの構成設定のグローバル コレクションが自動的に作成されます。既に説明したように、サービス スコープで追加のコレクションを作成することもできます。
Get-CsProxyConfiguration コマンドレットを使用すると、組織内で現在使用されているプロキシ サーバーの任意の構成設定に関する情報を戻すことができます。
このコマンドレットを実行できるユーザー: 既定では、次のグループのメンバーは Get-CsProxyConfiguration コマンドレットのローカル実行を承認されています。RTCUniversalUserAdmins、RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsProxyConfiguration"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
省略可能 |
Xds Identity |
戻すプロキシ サーバーの構成設定の一意の識別子です。グローバル設定を戻すには、次の構文を使用します。-Identity global です。サービス スコープで構成された設定を戻すには、次のような構文を使用します。-Identity "service:EdgeServer:atl-cs-001.litwareinc.com" です。Identity 指定時はワイルドカードを使用できないことに注意してください。ワイルドカードを使用する (またはその必要がある) 場合は、代わりに Filter パラメーターを使用してください。 このパラメーターを指定しないと、Get-CsProxyConfiguration は組織内で現在使用されているプロキシ サーバーの構成設定をすべて戻します。 |
Filter |
省略可能 |
文字列 |
戻すプロキシの構成設定を指定するときに、ワイルドカードを使用できます。たとえば次の構文では、サービス スコープで構成されたすべての設定を戻します。-Filter "service:*" です。 Filter パラメーターと Identity パラメーターの両方を同じコマンドで使用することはできません。 |
LocalStore |
省略可能 |
スイッチ パラメーター |
中央管理ストア 自体からではなく、中央管理ストア のローカル レプリカからプロキシ構成データを取得します。 |
入力の種類
なし。Get-CsProxyConfiguration はパイプライン入力を受け入れません。
戻り値の種類
Get-CsProxyConfiguration を実行すると、Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings オブジェクトのインスタンスが戻されます。
例
-------------------------- 例 1 --------------------------
Get-CsProxyConfiguration
例 1 に示すコマンドでは、組織内で現在使用されているすべてのプロキシの構成設定のコレクションを戻します。Get-CsProxyConfiguration をパラメーターなしで呼び出すことで、これを実行しています。
-------------------------- 例 2 --------------------------
Get-CsProxyConfiguration -Identity "service:EdgeServer:atl-cs-001.litwareinc.com"
例 2 では、service:EdgeServer:atl-cs-001.litwareinc.com という Identity を持つプロキシ構成設定に関する情報を戻しています。Identity は一意である必要があるため、このコマンドが複数の設定のコレクションを戻すことはありません。
-------------------------- 例 3 --------------------------
Get-CsProxyConfiguration -Filter "service:*"
上記のコマンドでは、サービス スコープで構成されているすべてのプロキシの設定に関する情報を戻します。これを行うため、Get-CsProxyConfiguration に Filter パラメーターを指定して呼び出しています。フィルター値 "service:*" を指定することにより、文字列値 "service:" で始まる Identity の設定のみが返されます。
-------------------------- 例 4 --------------------------
Get-CsProxyConfiguration | Where-Object {$_.UseCertificateForClientToProxyAuth -eq $False}
例 4 では、認証メカニズムとしてクライアント証明書を使用することが許可されていないプロキシの構成設定に関する情報を戻します。このタスクを実行するため、まず Get-CsProxyConfiguration を使用して、現在使用されているすべてのプロキシの構成設定のコレクションを戻しています。次に、このコレクションを Where-Object コマンドレットにパイプ処理し、UseCertificateForClientToProxyAuth プロパティが False に等しい設定のみを選択しています。
-------------------------- 例 5 --------------------------
Get-CsProxyConfiguration | Where-Object {$_.MaxClientMessageBodySizeKb -lt 5000}
上記のコマンドでは、クライアント メッセージの本文サイズの上限が 5,000 KB 未満のすべてのプロキシの構成設定を戻します。これを行うため、まず Get-CsProxyConfiguration をパラメーターなしで呼び出しています。これにより、現在使用されているすべてのプロキシの構成設定のコレクションを戻しています。次に、このコレクションを Where-Object にパイプ処理し、MaxClientMessageBodySizeKb プロパティが 5,000 KB 未満の設定を抽出しています。