Set-CsRegistrar
Topic Last Modified: 2012-03-26
Enables you to modify the properties of one or more Registrars. Registrars are used to authenticate logon requests, and to maintain information about user status and availability.
Syntax
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>]]
Detailed Description
The Registrar is perhaps the most important component in Microsoft Lync Server 2010; without a Registrar, users would not be able to log on to the system, and Lync Server 2010 would not be able to keep track of users and their current status. When a user logs on to Lync Server, the endpoint the user is logging on from (be it a computer, a mobile phone, or some other device) sends a REGISTER request to the registration server; in turn the server responds by challenging the client device for authentication credentials. If the client passes the challenge (that is, if the client presents a valid set of credentials), then the user is authenticated and endpoint information such as IP address, port, and user name is logged in the registration database. When a user logs off, this information is then removed from the database. In between log on and log off, the Registrar keeps status information up-to-date and helps to route messages to and from the user.
The Set-CsRegistrar cmdlet provides a way for you to modify the properties of one or more Registrars in your organization. These modifications include changing port settings as well as specifying the action that should be taken if a Registrar should become unavailable.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsRegistrar cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsRegistrar\b"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
Xds Identity |
Service location of the Registrar to be modified. For example: -Identity "Registrar:atl-cs-001.litwareinc.com". Note that you can leave off the prefix "Registrar:" when specifying a Registrar. For example: -Identity "atl-cs-001.litwareinc.com". |
ArchivingServer |
Optional |
String |
Service location of the Archiving Server to be associated with the Registrar. For example: -ArchivingServer "ArchivingServer:atl-cs-001.litwareinc.com". |
BackupRegistrar |
Optional |
String |
Service location of the Registrar to be used if this Registrar is not available. For example: -BackupRegistrar "Registrar:dublin-cs-001.litwareinc.com". |
EdgeServer |
Optional |
String |
Service location of the Edge Server to be associated with the Registrar. For example: -EdgeServer "EdgeServer:atl-edge-001.litwareinc.com". |
EnableAutomaticFailover |
Optional |
Boolean |
If True, the backup Registrar will be employed any time the primary Registrar is unavailable. If False, the backup Registrar will not be used if the primary Registrar is not available. This parameter also affects users who have registered with a backup Registrar. If this parameter is set to True, then those users will be dropped from the backup Registrar and re-registered on the primary Registrar if and when that Registrar becomes available. |
FailbackDetectionInterval |
Optional |
TimeSpan |
Specifies the amount of time that the system will wait before checking to see if a Registrar that had become unavailable is now available. If you have set EnableAutomaticFailover to True, the system will "failover" to the backup Registrar any time a Registrar becomes unavailable. That simply means that the system will take users who are logged-on to the failed Registrar and attempt to log them on to the backup Registrar. The FailbackDetectionInterval property specifies the amount of time that the system will wait before checking to see if the original Registrar is available again. If so, Lync Server will then attempt to "failback" to that Registrar. Failback simply means reverting back to the Registrar initially in use; in other words, logging users back on to their original Registrar. Note that failback is an automated process only. You cannot manually failback from one Registrar to another. The detection interval can be set to any value between 30 seconds and 84,400 seconds (24 hours); specify the time span using the format hours:minutes:seconds. For example, this sets the interval to 1 hour and 15 minutes: - FailbackDetectionInterval 01:15:00. This parameter cannot be used unless you have specified a backup Registrar. |
FailureDetectionInterval |
Optional |
TimeSpan |
Specifies the time interval that the system will wait before deciding that a Registrar is unavailable. If EnableAutomaticFailover has been set to True, the system will then attempt to log users on to the backup Registrar instead. The detection interval can be set to any value between 30 seconds and 84,400 seconds (24 hours); specify the time span using the format hours:minutes:seconds. For example, this sets the interval to 1 hour and 15 minutes: - FailureDetectionInterval 01:15:00. This parameter cannot be used unless you have specified a backup Registrar. |
MonitoringServer |
Optional |
String |
Service location of the Monitoring Server to be associated with the Registrar. For example: -MonitoringServer "MonitoringServer:atl-cs-001.litwareinc.com". |
Registrar |
Optional |
String |
Service location of the Registrar. |
SipPort |
Optional |
Integer |
Port used for SIP (Session Initiation Protocol) traffic. |
SipHealthPort |
Optional |
String |
Port used for monitoring server health. |
SipServerTcpPort |
Optional |
String |
SIP listening port. The default value is 5060. |
UserServer |
Optional |
String |
Service location of the User Services server to be associated with the Registrar. For example: -UserServer "UserServer:atl-cs-001.litwareinc.com". |
WebPort |
Optional |
Integer |
Port used for communicating with Web servers. |
WebServer |
Optional |
String |
Service location of the Web Server to be associated with the Registrar. For example: -WebServer "WebServer:atl-cs-001.litwareinc.com". |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Input Types
None. Set-CsRegistrar does not accept pipelined input.
Return Types
Set-CsRegistrar does not return any objects or values. Instead, the command modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayRegistrar object.
Example
-------------------------- Example 1 --------------------------
Set-CsRegistrar -Identity "Registrar:atl-cs-001.litwareinc.com" -SipPort 5072
The command shown in Example 1 sets the SIP port for the Registrar Registrar:atl-cs-001.litwareinc.com to 5072.
-------------------------- Example 2 --------------------------
Get-CsService -Registrar | ForEach-Object {Set-CsRegistrar -Identity $_.Identity -SipPort 5072}
The preceding command sets the SIP port for all the Registrars in the organization to 5072. To do this, the command first uses Get-CsService and the Registrar parameter to return a collection of all the Registrars currently in use. This collection is then piped to the ForEach-Object cmdlet, which takes each Registrar in the collection and runs the Set-CsRegistrar cmdlet in order to change the SIP port to 5072.
-------------------------- Example 3 --------------------------
Set-CsRegistrar -Identity "Registrar:atl-cs-001.litwareinc.com" -BackupRegistrar "Registrar:dublin-cs-001.litwareinc.com" -EnableAutomaticFailover $True
Example 3 configures both a backup Registrar (BackupRegistrar) and automatic failover (EnableAutomaticFailover) for the Registrar Registrar:atl-cs-001.litwareinc.com.