Set-CsRegistrarConfiguration
トピックの最終更新日: 2012-03-26
既存のレジストラー構成設定コレクションのプロパティ値を変更します。レジストラーは、ログオン要求を認証したり、ユーザーの状態や空き時間の情報を維持したりするために使用されます。
構文
Set-CsRegistrarConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-DefaultEndpointExpiration <Int32>] [-EnableDHCPServer <$true | $false>] [-Force <SwitchParameter>] [-MaxEndpointExpiration <Int32>] [-MaxEndpointsPerUser <UInt16>] [-MinEndpointExpiration <Int32>] [-WhatIf [<SwitchParameter>]]
Set-CsRegistrarConfiguration [-Confirm [<SwitchParameter>]] [-DefaultEndpointExpiration <Int32>] [-EnableDHCPServer <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-MaxEndpointExpiration <Int32>] [-MaxEndpointsPerUser <UInt16>] [-MinEndpointExpiration <Int32>] [-WhatIf [<SwitchParameter>]]
解説
レジストラーは、おそらく Microsoft Lync Server 2010 の中で最も重要なコンポーネントです。結局のところ、レジストラーがなければ、ユーザーはシステムにログオンできず、Lync Server 2010 はユーザーの追跡とユーザーの現在の状態の把握を行うことができないからです。ユーザーが Lync Server にログオンする際、ユーザーがログオンしているエンドポイントからレジストラーへ REGISTER 要求が送信されます。これに対し、サーバーはクライアント デバイスに対する認証資格情報のチャレンジによって応答します。クライアントがチャレンジをパスすると (つまり、クライアントが有効な資格情報のセットを提出すると)、ユーザーは認証され、IP アドレス、ポート、およびユーザー名などのエンドポイント情報が登録データベースに記録されます。ユーザーがログオフすると、この情報はデータベースから削除されます。レジストラーはログオンからログオフまでの間、状態の情報を最新に保ち、ユーザーが送受信するメッセージのルーティングを支援します。
レジストラー構成設定は、グローバル スコープ、サイト スコープ、またはサービス スコープで適用でき、エンドポイントおよびエンドポイント サブスクリプションの管理を行うことができます (サービス スコープの設定は、レジストラー サービスでのみ使用されます)。Set-CsRegistrarConfiguration コマンドレットを使用して、組織内で現在使用されている任意 (またはすべて) のレジストラー構成コレクションを変更できます。
このコマンドレットを実行できるユーザー: 既定では、Set-CsRegistrarConfiguration コマンドレットをローカルで実行する権限があるのは、RTCUniversalServerAdmins グループのメンバーです。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsRegistrarConfiguration"}
パラメーター
パラメーター | 必須かどうか | 型 | 説明 |
---|---|---|---|
Identity |
省略可能 |
Xds Identity |
変更するレジストラー構成設定の一意の識別子です。グローバル設定を変更するには、次の構文を使用します。-Identity global。サイト スコープで構成された設定を変更するには、次のような構文を使用します。-Identity site:Redmond。サービス レベルで設定を変更するには、次のような構文を使用します。-Identity service:Registrar:atl-cs-001.litwareinc.com。ただし、レジストラー設定を適用できるのは、レジストラー サービスのみです。これらの設定を他のサービスに適用しようとすると、エラー メッセージが表示されます。 |
Instance |
省略可能 |
RegistrarSettings オブジェクト |
個々のパラメーター値を設定するのではなく、オブジェクトへの参照をコマンドレットに渡せるようにします。 |
DefaultEndpointExpiration |
省略可能 |
整数 |
エンドポイントのログオン時に、有効期限のタイムアウトを要求するオプションがあります。これはエンドポイントがシステムへのログオン状態を保持することのできる時間を指定するもので、これを過ぎるとサーバーにコンタクトして延長を要求する必要があります。DefaultEndpointExpiration プロパティは、特定のタイムアウト値を要求しないクライアントの有効期限のタイムアウト間隔を表します。 DefaultEndpointExpiration は 300 (5 分) ~ 900 (15 分) の範囲の値にする必要があります。既定値は 600 (10 分) です。 |
EnableDHCPServer |
省略可能 |
ブール値 |
エンドポイントが DHCP サーバーを使用してレジストラーを探すことができるかどうかを示します。True の場合、クライアントは、最初の起動時に DHCP Inform メッセージを送信します。DHCP サーバーは、ユーザー ログオンに使用できるレジストラーの完全修飾ドメイン名 (FQDN) を送信して応答します。 |
MaxEndpointExpiration |
省略可能 |
整数 |
エンドポイントのログオン時に、有効期限のタイムアウトを要求するオプションがあります。これはエンドポイントがシステムへのログオン状態を保持することのできる時間を指定するもので、これを過ぎるとサーバーにコンタクトして延長を要求する必要があります。MaxEndpointExpiration プロパティは、クライアントに付与できる最大時間を表します。たとえば、最大時間が 600 秒に設定され、クライアントが 800 秒のタイムアウト間隔を要求する場合、クライアントには次の最大有効期限が付与されます。600 秒です。 MaxEndpointExpiration は 300 (5 分) ~ 900 (15 分) の範囲の値にする必要があります。既定値は 900 です。 |
MaxEndpointsPerUser |
省略可能 |
整数 |
1 ユーザーがシステムに同時に接続できるエンドポイントの最大数を表します (たとえば、コンピューターと携帯電話の両方を使用して Lync Server 2010 にログオンしているユーザーは、2 つのエンドポイントを使用していることになります)。MaxEndPointsPerUser は 1 ~ 64 の範囲の値に設定する必要があります。既定値は 8 です。 |
MinEndpointExpiration |
省略可能 |
整数 |
エンドポイントのログオン時に、有効期限のタイムアウトを要求するオプションがあります。これはエンドポイントがシステムへのログオン状態を保持することのできる時間を指定するもので、これを過ぎるとサーバーにコンタクトして延長を要求する必要があります。MinEndpointExpiration プロパティは、クライアントに付与できる最小時間を表します。たとえば、最小時間が 600 秒に設定され、クライアントが 200 秒のタイムアウト間隔を要求する場合、クライアントには次の最小有効期限が付与されます。600 秒です。 MinEndpointExpiration は 300 (5 分) ~ 900 (15 分) の範囲の値にする必要があります。既定値は 300 です。 |
Force |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
WhatIf |
省略可能 |
スイッチ パラメーター |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
スイッチ パラメーター |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings オブジェクトです。Set-CsRegistrarConfiguration は、レジストラー設定オブジェクトのインスタンスをパイプ処理で受け入れます。
戻り値の種類
Set-CsRegistrarConfiguration は、値またはオブジェクトを戻しません。代わりに、Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings オブジェクトのインスタンスを構成します。
例
-------------------------- 例 1 --------------------------
Set-CsRegistrarConfiguration -Identity site:Redmond -EnableDHCPServer $True
上記のコマンドは、Redmond サイト (-Identity site:Redmond) に適用されるレジストラー構成設定を変更します。この例では、EnableDHCPServer プロパティの値を True に設定しています。
-------------------------- 例 2 --------------------------
Get-CsRegistrarConfiguration | Where-Object {$_.MaxEndpointsPerUser -gt 8} | Set-CsRegistrarConfiguration -MaxEndpointsPerUser 8
例 2 では、ユーザーに 8 つを超えるエンドポイントを許可しているレジストラー構成設定を変更します。これを実行するため、まず Get-CsRegistrarConfiguration をパラメーターを指定せずに呼び出し、組織内で使用しているすべてのレジストラー構成設定のコレクションを戻します。次に、このコレクションを Where-Object コマンドレットにパイプ処理し、MaxEndpointsPerUser プロパティが 8 より大きい (-gt) 設定のみを抽出します。最後に、このフィルター後のコレクションを Set-CsRegistrarCollection へパイプ処理し、コレクション内の各項目の最大エンドポイント数を 8 に設定します。
-------------------------- 例 3 --------------------------
Get-CsRegistrarConfiguration -Filter "site:*"| Set-CsRegistrarConfiguration -EnableDHCPServer $False
例 3 に示すコマンドは、レジストラー構成設定コレクションをホストする、組織内の各サイトの DHCP 経由のクライアント登録を無効にします。これを行うため、Get-CsRegistrarConfiguration に Filter パラメーターを指定して呼び出します。パラメーター値 "site:*" により、サイト スコープで構成されている設定のデータのみが戻るようにします。次に、このコレクションを Set-CsRegistrarConfiguration にパイプ処理し、EnableDHCPServer パラメーターとパラメーター値 $False を使用して、クライアントが DHCP サーバーを使ってレジストラーを探すことができないようにします。