Set-CsRegistrar
トピックの最終更新日: 2012-03-26
1 つまたは複数のレジストラーのプロパティを変更できます。レジストラーは、ログオン要求の認証と、ユーザーの状態や連絡可能性に関する情報の維持のために使用されます。
構文
Set-CsRegistrar [-Identity <XdsGlobalRelativeIdentity>] [-ArchivingServer <String>] [-BackupRegistrar <String>] [-Confirm [<SwitchParameter>]] [-EdgeServer <String>] [-EnableAutomaticFailover <$true | $false>] [-FailbackDetectionInterval <TimeSpan>] [-FailureDetectionInterval <TimeSpan>] [-Force <SwitchParameter>] [-MonitoringServer <String>] [-Registrar <String>] [-SipHealthPort <UInt16>] [-SipPort <UInt16>] [-SipServerTcpPort <UInt16>] [-UserServer <String>] [-WebPort <UInt16>] [-WebServer <String>] [-WhatIf [<SwitchParameter>]]
解説
レジストラーは、おそらく Microsoft Lync Server 2010 の中で最も重要なコンポーネントです。レジストラーがなければ、ユーザーはシステムにログオンできず、Lync Server 2010 はユーザーの追跡とユーザーの現在の状態の把握を行うことができないからです。Lync Server にユーザーがログオンすると、ユーザーがログオンしたエンドポイント (コンピューター、携帯電話、またはその他のデバイス) は REGISTER 要求を登録サーバーに送信します。次に、サーバーは、クライアント デバイスに対する認証資格情報のチャレンジによって応答します。クライアントがチャレンジをパスすると (つまり、クライアントが有効な資格情報のセットを提出すると)、ユーザーは認証され、IP アドレス、ポート、およびユーザー名などのエンドポイント情報が登録データベースに記録されます。ユーザーがログオフすると、この情報はデータベースから削除されます。ログオンからログオフまでの間、レジストラーは最新の状態情報を保持し、ユーザー間でのメッセージのルーティングを支援します。
Set-CsRegistrar コマンドレットでは、組織内の 1 つまたは複数のレジストラーのプロパティを変更できます。ポート設定を変更できるほか、レジストラーが使用できなくなった場合に実行するアクションの指定も変更できます。
このコマンドレットを実行できるメンバー。既定では、次のグループのメンバーが Set-CsRegistrar コマンドレットのローカル実行を承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsRegistrar\b"}
パラメーター
パラメーター | 必須かどうか | 型 | 説明 |
---|---|---|---|
Identity |
省略可能 |
Xds Identity |
変更するレジストラーのサービスの場所です。次に例を示します。-Identity "Registrar:atl-cs-001.litwareinc.com" です。 レジストラーを指定するときに、"Registrar:" プレフィックスを省略できることに注意してください。次に例を示します。-Identity "atl-cs-001.litwareinc.com"。 |
ArchivingServer |
省略可能 |
文字列 |
レジストラーに関連付ける アーカイブ サーバー サービスの場所。次に例を示します。-ArchivingServer "ArchivingServer:atl-cs-001.litwareinc.com" です。 |
BackupRegistrar |
省略可能 |
文字列 |
このレジストラーが使用できない場合に使用するレジストラーのサービスの場所です。次に例を示します。-BackupRegistrar "Registrar:dublin-cs-001.litwareinc.com" です。 |
EdgeServer |
省略可能 |
文字列 |
レジストラーに関連付ける エッジ サーバー サービスの場所。次に例を示します。-EdgeServer "EdgeServer:atl-edge-001.litwareinc.com" です。 |
EnableAutomaticFailover |
省略可能 |
ブール値 |
True に設定されていると、プライマリ レジストラーが使用できなくなった場合いつでも、バックアップ レジストラーを使用します。False に設定されていると、プライマリ レジストラーが使用できなくなった場合に、バックアップ レジストラーを使用しません。 このパラメーターは、バックアップ レジストラーに登録されているユーザーにも影響します。このパラメーターが True に設定されていると、それらのユーザーはバックアップ レジストラーから削除され、そのレジストラーが使用可能になった場合は、プライマリ レジストラーに再登録されます。 |
FailbackDetectionInterval |
省略可能 |
TimeSpan |
使用不可能になったレジストラーが使用可能に戻ったかどうかチェックするまで、システムが待機する時間を指定します。EnableAutomaticFailover を True に設定した場合は、レジストラーが使用不可能になったときは必ず、システムはバックアップ レジストラーにフェールオーバーします。これは単純に、障害が発生したレジストラーにログインしているユーザーを選択し、バックアップ レジストラーに対するユーザーのログオンを試行することを意味します。 FailbackDetectionInterval プロパティは、元のレジストラーが再び使用可能になったかどうかチェックするまで、システムが待機する時間を指定します。使用可能になった場合、Lync Server はその後に、レジストラーへの "フェールバック" を試行します。フェールバックは単純に、当初使用していたレジストラーに復帰することを意味します。つまり、ユーザーを元のレジストラーに再びログオンさせます。 フェールバックは自動化されたプロセス専用であることに注意してください。あるレジストラーから他のレジストラーに手動でフェールバックさせることはできません。 検出間隔は、30 ~ 84,400 秒 (24 時間) の任意の値に設定できます。時間を "時間 : 分 : 秒" の形式で指定します。たとえば、間隔を 1 時間 15 分に設定する場合は、- FailbackDetectionInterval 01:15:00 です。 バックアップ レジストラーを指定していない場合は、このパラメーターを使用することはできません。 |
FailureDetectionInterval |
省略可能 |
TimeSpan |
レジストラーが使用できないと判断するまで、システムが待機する時間を指定します。EnableAutomaticFailover が True に設定されている場合、システムはその後に、代わりにバックアップ レジストラーに対するユーザーのログオンを試行します。 検出間隔は、30 ~ 84,400 秒 (24 時間) の任意の値に設定できます。時間を "時間 : 分 : 秒" の形式で指定します。たとえば、間隔を 1 時間 15 分に設定する場合は、- FailureDetectionInterval 01:15:00 です。 バックアップ レジストラーを指定していない場合は、このパラメーターを使用することはできません。 |
MonitoringServer |
省略可能 |
文字列 |
レジストラーに関連付ける 監視サーバー サービスの場所。次に例を示します。-MonitoringServer "MonitoringServer:atl-cs-001.litwareinc.com" です。 |
Registrar |
省略可能 |
文字列 |
レジストラーのサービスの場所です。 |
SipPort |
省略可能 |
整数 |
SIP (セッション開始プロトコル) トラフィックに使用するポートです。 |
SipHealthPort |
省略可能 |
文字列 |
サーバーの状態を監視する際に使用するポート。 |
SipServerTcpPort |
省略可能 |
文字列 |
SIP リッスン ポート。既定値は 5060 です。 |
UserServer |
省略可能 |
文字列 |
レジストラーに関連付ける ユーザー サービス サーバーの場所。次に例を示します。-UserServer "UserServer:atl-cs-001.litwareinc.com" です。 |
WebPort |
省略可能 |
整数 |
Web サーバーとの通信に使用するポートです。 |
WebServer |
省略可能 |
文字列 |
レジストラーに関連付ける Web サーバーのサービスの場所です。次に例を示します。-WebServer "WebServer:atl-cs-001.litwareinc.com" です。 |
Force |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
WhatIf |
省略可能 |
スイッチ パラメーター |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
スイッチ パラメーター |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
なし。Set-CsRegistrar はパイプライン入力を受け入れません。
戻り値の種類
Set-CsRegistrar を実行しても、オブジェクトや値が戻されることはありません。代わりに、Microsoft.Rtc.Management.Xds.DisplayRegistrar オブジェクトの既存のインスタンスを変更します。
例
-------------------------- 例 1 --------------------------
Set-CsRegistrar -Identity "Registrar:atl-cs-001.litwareinc.com" -SipPort 5072
例 1 に示すコマンドでは、レジストラー Registrar:atl-cs-001.litwareinc.com の SIP ポートを 5072 に設定します。
-------------------------- 例 2 --------------------------
Get-CsService -Registrar | ForEach-Object {Set-CsRegistrar -Identity $_.Identity -SipPort 5072}
上記のコマンドでは、組織内のすべてのレジストラーの SIP ポートを 5072 に設定します。この処理を行うため、まず Get-CsService と Registrar パラメーターを使用して、現在使用されているすべてのレジストラーのコレクションを戻しています。次に、このコレクションは ForEach-Object コマンドレットにパイプ処理され、コレクションの各レジストラーを取り出し、Set-CsRegistrar コマンドレットを使用して SIP ポートを 5072 に変更しています。
-------------------------- 例 3 --------------------------
Set-CsRegistrar -Identity "Registrar:atl-cs-001.litwareinc.com" -BackupRegistrar "Registrar:dublin-cs-001.litwareinc.com" -EnableAutomaticFailover $True
例 3 では、レジストラー Registrar:atl-cs-001.litwareinc.com のバックアップ レジストラー (BackupRegistrar) と自動フェールオーバー (EnableAutomaticFailover) の両方を構成しています。